Added in API level 1

MenuItem

---

Kotlin |Java

interface MenuItem

android.view.MenuItem

Interface for direct access to a previously created menu item.

An Item is returned by calling one of the android.view.Menu#add methods.

For a feature set of specific menu types, see Menu.

Developer Guides

For information about creating menus, read the Menus developer guide.

Summary

Nested classes
abstract	OnActionExpandListener Interface definition for a callback to be invoked when a menu item marked with MenuItem.SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW is expanded or collapsed.
abstract	OnMenuItemClickListener Interface definition for a callback to be invoked when a menu item is clicked.

Constants
static Int	SHOW_AS_ACTION_ALWAYS Always show this item as a button in an Action Bar.
static Int	SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW This item's action view collapses to a normal menu item.
static Int	SHOW_AS_ACTION_IF_ROOM Show this item as a button in an Action Bar if the system decides there is room for it.
static Int	SHOW_AS_ACTION_NEVER Never show this item as a button in an Action Bar.
static Int	SHOW_AS_ACTION_WITH_TEXT When this item is in the action bar, always show it with a text label even if it also has an icon specified.

Public methods
abstract Boolean	collapseActionView() Collapse the action view associated with this menu item.
abstract Boolean	expandActionView() Expand the action view associated with this menu item.
abstract ActionProvider?	getActionProvider() Gets the ActionProvider.
abstract View?	getActionView() Returns the currently set action view for this menu item.
open Int	getAlphabeticModifiers() Return the modifier for this menu item's alphabetic shortcut.
abstract Char	getAlphabeticShortcut() Return the char for this menu item's alphabetic shortcut.
open CharSequence?	getContentDescription() Retrieve the content description associated with this menu item.
abstract Int	getGroupId() Return the group identifier that this menu item is part of.
abstract Drawable?	getIcon() Returns the icon for this item as a Drawable (getting it from resources if it hasn't been loaded before).
open BlendMode?	getIconTintBlendMode() Returns the blending mode used to apply the tint to this item's icon, if specified.
open ColorStateList?	getIconTintList()
open PorterDuff.Mode?	getIconTintMode() Returns the blending mode used to apply the tint to this item's icon, if specified.
abstract Intent?	getIntent() Return the Intent associated with this item.
abstract Int	getItemId() Return the identifier for this menu item.
abstract ContextMenu.ContextMenuInfo?	getMenuInfo() Gets the extra information linked to this menu item.
open Int	getNumericModifiers() Return the modifiers for this menu item's numeric (12-key) shortcut.
abstract Char	getNumericShortcut() Return the char for this menu item's numeric (12-key) shortcut.
abstract Int	getOrder() Return the category and order within the category of this item.
abstract SubMenu?	getSubMenu() Get the sub-menu to be invoked when this item is selected, if it has one.
abstract CharSequence?	getTitle() Retrieve the current title of the item.
abstract CharSequence?	getTitleCondensed() Retrieve the current condensed title of the item.
open CharSequence?	getTooltipText() Retrieve the tooltip text associated with this menu item.
abstract Boolean	hasSubMenu() Check whether this item has an associated sub-menu.
abstract Boolean	isActionViewExpanded() Returns true if this menu item's action view has been expanded.
abstract Boolean	isCheckable() Return whether the item can currently display a check mark.
abstract Boolean	isChecked() Return whether the item is currently displaying a check mark.
abstract Boolean	isEnabled() Return the enabled state of the menu item.
abstract Boolean	isVisible() Return the visibility of the menu item.
abstract MenuItem	setActionProvider(actionProvider: ActionProvider?) Sets the ActionProvider responsible for creating an action view if the item is placed on the action bar.
abstract MenuItem	setActionView(view: View?) Set an action view for this menu item.
abstract MenuItem	setActionView(resId: Int) Set an action view for this menu item.
abstract MenuItem	setAlphabeticShortcut(alphaChar: Char) Change the alphabetic shortcut associated with this item.
open MenuItem	setAlphabeticShortcut(alphaChar: Char, alphaModifiers: Int) Change the alphabetic shortcut associated with this item.
abstract MenuItem	setCheckable(checkable: Boolean) Control whether this item can display a check mark.
abstract MenuItem	setChecked(checked: Boolean) Control whether this item is shown with a check mark.
open MenuItem	setContentDescription(contentDescription: CharSequence?) Change the content description associated with this menu item.
abstract MenuItem	setEnabled(enabled: Boolean) Sets whether the menu item is enabled.
abstract MenuItem	setIcon(icon: Drawable?) Change the icon associated with this item.
abstract MenuItem	setIcon(iconRes: Int) Change the icon associated with this item.
open MenuItem	setIconTintBlendMode(blendMode: BlendMode?) Specifies the blending mode used to apply the tint specified by setIconTintList(android.content.res.ColorStateList) to this item's icon.
open MenuItem	setIconTintList(tint: ColorStateList?) Applies a tint to this item's icon.
open MenuItem	setIconTintMode(tintMode: PorterDuff.Mode?) Specifies the blending mode used to apply the tint specified by setIconTintList(android.content.res.ColorStateList) to this item's icon.
abstract MenuItem	setIntent(intent: Intent?) Change the Intent associated with this item.
abstract MenuItem	setNumericShortcut(numericChar: Char) Change the numeric shortcut associated with this item.
open MenuItem	setNumericShortcut(numericChar: Char, numericModifiers: Int) Change the numeric shortcut and modifiers associated with this item.
abstract MenuItem	setOnActionExpandListener(listener: MenuItem.OnActionExpandListener?) Set an OnActionExpandListener on this menu item to be notified when the associated action view is expanded or collapsed.
abstract MenuItem	setOnMenuItemClickListener(menuItemClickListener: MenuItem.OnMenuItemClickListener?) Set a custom listener for invocation of this menu item.
abstract MenuItem	setShortcut(numericChar: Char, alphaChar: Char) Change both the numeric and alphabetic shortcut associated with this item.
open MenuItem	setShortcut(numericChar: Char, alphaChar: Char, numericModifiers: Int, alphaModifiers: Int) Change both the numeric and alphabetic shortcut associated with this item.
abstract Unit	setShowAsAction(actionEnum: Int) Sets how this item should display in the presence of an Action Bar.
abstract MenuItem	setShowAsActionFlags(actionEnum: Int) Sets how this item should display in the presence of an Action Bar.
abstract MenuItem	setTitle(title: Int) Change the title associated with this item.
abstract MenuItem	setTitle(title: CharSequence?) Change the title associated with this item.
abstract MenuItem	setTitleCondensed(title: CharSequence?) Change the condensed title associated with this item.
open MenuItem	setTooltipText(tooltipText: CharSequence?) Change the tooltip text associated with this menu item.
abstract MenuItem	setVisible(visible: Boolean) Sets the visibility of the menu item.

Constants

SHOW_AS_ACTION_ALWAYS

Added in API level 11

static val SHOW_AS_ACTION_ALWAYS: Int

Always show this item as a button in an Action Bar. Use sparingly! If too many items are set to always show in the Action Bar it can crowd the Action Bar and degrade the user experience on devices with smaller screens. A good rule of thumb is to have no more than 2 items set to always show at a time.

Value: 2

SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW

Added in API level 14

static val SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW: Int

This item's action view collapses to a normal menu item. When expanded, the action view temporarily takes over a larger segment of its container.

Value: 8

SHOW_AS_ACTION_IF_ROOM

Added in API level 11

static val SHOW_AS_ACTION_IF_ROOM: Int

Show this item as a button in an Action Bar if the system decides there is room for it.

Value: 1

SHOW_AS_ACTION_NEVER

Added in API level 11

static val SHOW_AS_ACTION_NEVER: Int

Never show this item as a button in an Action Bar.

Value: 0

SHOW_AS_ACTION_WITH_TEXT

Added in API level 11

static val SHOW_AS_ACTION_WITH_TEXT: Int

When this item is in the action bar, always show it with a text label even if it also has an icon specified.

Value: 4

Public methods

collapseActionView

Added in API level 14

abstract fun collapseActionView(): Boolean

Collapse the action view associated with this menu item. The menu item must have an action view set, as well as the showAsAction flag SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW. If a listener has been set using setOnActionExpandListener(android.view.MenuItem.OnActionExpandListener) it will have its OnActionExpandListener.onMenuItemActionCollapse(MenuItem) method invoked. The listener may return false from this method to prevent collapsing the action view.

Return
Boolean	true if the action view was collapsed, false otherwise.

expandActionView

Added in API level 14

abstract fun expandActionView(): Boolean

Expand the action view associated with this menu item. The menu item must have an action view set, as well as the showAsAction flag SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW. If a listener has been set using setOnActionExpandListener(android.view.MenuItem.OnActionExpandListener) it will have its OnActionExpandListener.onMenuItemActionExpand(MenuItem) method invoked. The listener may return false from this method to prevent expanding the action view.

Return
Boolean	true if the action view was expanded, false otherwise.

getActionProvider

Added in API level 14

abstract fun getActionProvider(): ActionProvider?

Gets the ActionProvider.

Return
ActionProvider?	The action provider. This value may be null.

See Also

• android.view.ActionProvider
• #setActionProvider(ActionProvider)

getActionView

Added in API level 11

abstract fun getActionView(): View?

Returns the currently set action view for this menu item.

Return
View?	This item's action view This value may be null.

See Also

• #setActionView(View)
• #setShowAsAction(int)

getAlphabeticModifiers

Added in API level 26

open fun getAlphabeticModifiers(): Int

Return the modifier for this menu item's alphabetic shortcut. The modifier is a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON. For example, KeyEvent.META_FUNCTION_ON|KeyEvent.META_CTRL_ON

Return
Int	Modifier associated with the keyboard shortcut.

getAlphabeticShortcut

Added in API level 1

abstract fun getAlphabeticShortcut(): Char

Return the char for this menu item's alphabetic shortcut.

Return
Char	Alphabetic character to use as a shortcut.

getContentDescription

Added in API level 26

open fun getContentDescription(): CharSequence?

Retrieve the content description associated with this menu item.

Return
CharSequence?	The content description. This value may be null.

getGroupId

Added in API level 1

abstract fun getGroupId(): Int

Return the group identifier that this menu item is part of. The group identifier can not be changed after the menu is created.

Return
Int	The menu item's group identifier.

getIcon

Added in API level 1

abstract fun getIcon(): Drawable?

Returns the icon for this item as a Drawable (getting it from resources if it hasn't been loaded before). Note that if you call setIconTintList(android.content.res.ColorStateList) or setIconTintMode(android.graphics.PorterDuff.Mode) on this item, and you use a custom menu presenter in your application, you have to apply the tinting explicitly on the Drawable returned by this method.

Return
Drawable?	The icon as a Drawable. This value may be null.

getIconTintBlendMode

Added in API level 29

open fun getIconTintBlendMode(): BlendMode?

Returns the blending mode used to apply the tint to this item's icon, if specified.

Return
BlendMode?	the blending mode used to apply the tint to this item's icon This value may be null.

See Also

• #setIconTintBlendMode(BlendMode)

getIconTintList

Added in API level 26

open fun getIconTintList(): ColorStateList?

Return
ColorStateList?	the tint applied to this item's icon This value may be null.

See Also

• #setIconTintList(ColorStateList)

getIconTintMode

Added in API level 26

open fun getIconTintMode(): PorterDuff.Mode?

Returns the blending mode used to apply the tint to this item's icon, if specified.

Return
PorterDuff.Mode?	the blending mode used to apply the tint to this item's icon This value may be null.

See Also

• #setIconTintMode(PorterDuff.Mode)
• #setIconTintBlendMode(BlendMode)

getIntent

Added in API level 1

abstract fun getIntent(): Intent?

Return the Intent associated with this item. This returns a reference to the Intent which you can change as desired to modify what the Item is holding.

Return
Intent?	Returns the last value supplied to setIntent, or null.

See Also

• #setIntent

getItemId

Added in API level 1

abstract fun getItemId(): Int

Return the identifier for this menu item. The identifier can not be changed after the menu is created.

Return
Int	The menu item's identifier.

getMenuInfo

Added in API level 1

abstract fun getMenuInfo(): ContextMenu.ContextMenuInfo?

Gets the extra information linked to this menu item. This extra information is set by the View that added this menu item to the menu.

Return
ContextMenu.ContextMenuInfo?	The extra information linked to the View that added this menu item to the menu. This can be null.

See Also

• android.view.View.OnCreateContextMenuListener

getNumericModifiers

Added in API level 26

open fun getNumericModifiers(): Int

Return the modifiers for this menu item's numeric (12-key) shortcut. The modifier is a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON. For example, KeyEvent.META_FUNCTION_ON|KeyEvent.META_CTRL_ON

Return
Int	Modifier associated with the numeric shortcut.

getNumericShortcut

Added in API level 1

abstract fun getNumericShortcut(): Char

Return the char for this menu item's numeric (12-key) shortcut.

Return
Char	Numeric character to use as a shortcut.

getOrder

Added in API level 1

abstract fun getOrder(): Int

Return the category and order within the category of this item. This item will be shown before all items (within its category) that have order greater than this value.

An order integer contains the item's category (the upper bits of the integer; set by or/add the category with the order within the category) and the ordering of the item within that category (the lower bits). Example categories are Menu.CATEGORY_SYSTEM, Menu.CATEGORY_SECONDARY, Menu.CATEGORY_ALTERNATIVE, Menu.CATEGORY_CONTAINER. See Menu for a full list.

Return
Int	The order of this item.

getSubMenu

Added in API level 1

abstract fun getSubMenu(): SubMenu?

Get the sub-menu to be invoked when this item is selected, if it has one. See hasSubMenu().

Return
SubMenu?	The associated menu if there is one, else null

getTitle

Added in API level 1

abstract fun getTitle(): CharSequence?

Retrieve the current title of the item.

Return
CharSequence?	The title. This value may be null.

getTitleCondensed

Added in API level 1

abstract fun getTitleCondensed(): CharSequence?

Retrieve the current condensed title of the item. If a condensed title was never set, it will return the normal title.

Return
CharSequence?	The condensed title, if it exists. Otherwise the normal title. This value may be null.

getTooltipText

Added in API level 26

open fun getTooltipText(): CharSequence?

Retrieve the tooltip text associated with this menu item.

Return
CharSequence?	The tooltip text. This value may be null.

hasSubMenu

Added in API level 1

abstract fun hasSubMenu(): Boolean

Check whether this item has an associated sub-menu. I.e. it is a sub-menu of another menu.

Return
Boolean	If true this item has a menu; else it is a normal item.

isActionViewExpanded

Added in API level 14

abstract fun isActionViewExpanded(): Boolean

Returns true if this menu item's action view has been expanded.

Return
Boolean	true if the item's action view is expanded, false otherwise.

See Also

• #expandActionView()
• #collapseActionView()
• #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW
• android.view.MenuItem.OnActionExpandListener

isCheckable

Added in API level 1

abstract fun isCheckable(): Boolean

Return whether the item can currently display a check mark.

Return
Boolean	If a check mark can be displayed, returns true.

See Also

• #setCheckable

isChecked

Added in API level 1

abstract fun isChecked(): Boolean

Return whether the item is currently displaying a check mark.

Return
Boolean	If a check mark is displayed, returns true.

See Also

• #setChecked

isEnabled

Added in API level 1

abstract fun isEnabled(): Boolean

Return the enabled state of the menu item.

Return
Boolean	If true the item is enabled and hence invokable; else it is not.

isVisible

Added in API level 1

abstract fun isVisible(): Boolean

Return the visibility of the menu item.

Return
Boolean	If true the item is visible; else it is hidden.

setActionProvider

Added in API level 14

abstract fun setActionProvider(actionProvider: ActionProvider?): MenuItem

Sets the ActionProvider responsible for creating an action view if the item is placed on the action bar. The provider also provides a default action invoked if the item is placed in the overflow menu.

Note: Setting an action provider overrides the action view set via setActionView(int) or setActionView(android.view.View).

Parameters
actionProvider	ActionProvider?: The action provider. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• android.view.ActionProvider

setActionView

Added in API level 11

abstract fun setActionView(view: View?): MenuItem

Set an action view for this menu item. An action view will be displayed in place of an automatically generated menu item element in the UI when this item is shown as an action within a parent.

Note: Setting an action view overrides the action provider set via setActionProvider(android.view.ActionProvider).

Parameters
view	View?: View to use for presenting this item to the user. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #setShowAsAction(int)

setActionView

Added in API level 11

abstract fun setActionView(resId: Int): MenuItem

Set an action view for this menu item. An action view will be displayed in place of an automatically generated menu item element in the UI when this item is shown as an action within a parent.

Note: Setting an action view overrides the action provider set via setActionProvider(android.view.ActionProvider).

Parameters
resId	Int: Layout resource to use for presenting this item to the user.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #setShowAsAction(int)

setAlphabeticShortcut

Added in API level 1

abstract fun setAlphabeticShortcut(alphaChar: Char): MenuItem

Change the alphabetic shortcut associated with this item. The shortcut will be triggered when the key that generates the given character is pressed along with the corresponding modifier key. The default modifier is KeyEvent.META_CTRL_ON in case nothing is specified. Case is not significant and shortcut characters will be displayed in lower case. Note that menu items with the characters '\b' or '\n' as shortcuts will get triggered by the Delete key or Carriage Return key, respectively.

See Menu for the menu types that support shortcuts.

Parameters
alphaChar	Char: The alphabetic shortcut key. This is the shortcut when using a keyboard with alphabetic keys.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setAlphabeticShortcut

Added in API level 26

open fun setAlphabeticShortcut(
    alphaChar: Char, 
    alphaModifiers: Int
): MenuItem

Change the alphabetic shortcut associated with this item. The shortcut will be triggered when the key that generates the given character is pressed along with the modifier keys. Case is not significant and shortcut characters will be displayed in lower case. Note that menu items with the characters '\b' or '\n' as shortcuts will get triggered by the Delete key or Carriage Return key, respectively.

See Menu for the menu types that support shortcuts.

Parameters
alphaChar	Char: The alphabetic shortcut key. This is the shortcut when using a keyboard with alphabetic keys.
alphaModifiers	Int: The modifier associated with the shortcut. It should be a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setCheckable

Added in API level 1

abstract fun setCheckable(checkable: Boolean): MenuItem

Control whether this item can display a check mark. Setting this does not actually display a check mark (see setChecked for that); rather, it ensures there is room in the item in which to display a check mark.

See Menu for the menu types that support check marks.

Parameters
checkable	Boolean: Set to true to allow a check mark, false to disallow. The default is false.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #setChecked
• #isCheckable
• android.view.Menu#setGroupCheckable

setChecked

Added in API level 1

abstract fun setChecked(checked: Boolean): MenuItem

Control whether this item is shown with a check mark. Note that you must first have enabled checking with setCheckable or else the check mark will not appear. If this item is a member of a group that contains mutually-exclusive items (set via Menu.setGroupCheckable(int, boolean, boolean), the other items in the group will be unchecked.

See Menu for the menu types that support check marks.

Parameters
checked	Boolean: Set to true to display a check mark, false to hide it. The default value is false.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #setCheckable
• #isChecked
• android.view.Menu#setGroupCheckable

setContentDescription

Added in API level 26

open fun setContentDescription(contentDescription: CharSequence?): MenuItem

Change the content description associated with this menu item.

Parameters
contentDescription	CharSequence?: The new content description. This value may be null.

Return
MenuItem	This value cannot be null.

setEnabled

Added in API level 1

abstract fun setEnabled(enabled: Boolean): MenuItem

Sets whether the menu item is enabled. Disabling a menu item will not allow it to be invoked via its shortcut. The menu item will still be visible.

Parameters
enabled	Boolean: If true then the item will be invokable; if false it is won't be invokable.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setIcon

Added in API level 1

abstract fun setIcon(icon: Drawable?): MenuItem

Change the icon associated with this item. This icon will not always be shown, so the title should be sufficient in describing this item. See Menu for the menu types that support icons.

Parameters
icon	Drawable?: The new icon (as a Drawable) to be displayed. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setIcon

Added in API level 1

abstract fun setIcon(iconRes: Int): MenuItem

Change the icon associated with this item. This icon will not always be shown, so the title should be sufficient in describing this item. See Menu for the menu types that support icons.

This method will set the resource ID of the icon which will be used to lazily get the Drawable when this item is being shown.

Parameters
iconRes	Int: The new icon (as a resource ID) to be displayed.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setIconTintBlendMode

Added in API level 29

open fun setIconTintBlendMode(blendMode: BlendMode?): MenuItem

Specifies the blending mode used to apply the tint specified by setIconTintList(android.content.res.ColorStateList) to this item's icon. The default mode is BlendMode.SRC_IN.

Parameters
blendMode	BlendMode?: the blending mode used to apply the tint, may be null to clear tint

Return
MenuItem	This value cannot be null.

See Also

• #setIconTintList(ColorStateList)

setIconTintList

Added in API level 26

open fun setIconTintList(tint: ColorStateList?): MenuItem

Applies a tint to this item's icon. Does not modify the current tint mode, which is PorterDuff.Mode.SRC_IN by default.

Subsequent calls to setIcon(android.graphics.drawable.Drawable) or setIcon(int) will automatically mutate the icon and apply the specified tint and tint mode using Drawable.setTintList(ColorStateList).

Parameters
tint	ColorStateList?: the tint to apply, may be null to clear tint

Return
MenuItem	This value cannot be null.

See Also

• #getIconTintList()
• android.graphics.drawable.Drawable#setTintList(ColorStateList)

setIconTintMode

Added in API level 26

open fun setIconTintMode(tintMode: PorterDuff.Mode?): MenuItem

Specifies the blending mode used to apply the tint specified by setIconTintList(android.content.res.ColorStateList) to this item's icon. The default mode is PorterDuff.Mode.SRC_IN.

Parameters
tintMode	PorterDuff.Mode?: the blending mode used to apply the tint, may be null to clear tint

Return
MenuItem	This value cannot be null.

See Also

• #setIconTintList(ColorStateList)
• android.graphics.drawable.Drawable#setTintMode(PorterDuff.Mode)
• android.graphics.drawable.Drawable#setTintBlendMode(BlendMode)

setIntent

Added in API level 1

abstract fun setIntent(intent: Intent?): MenuItem

Change the Intent associated with this item. By default there is no Intent associated with a menu item. If you set one, and nothing else handles the item, then the default behavior will be to call android.content.Context#startActivity with the given Intent.

Note that setIntent() can not be used with the versions of android.view.Menu#add that take a Runnable, because Runnable.run does not return a value so there is no way to tell if it handled the item. In this case it is assumed that the Runnable always handles the item, and the intent will never be started.

Parameters
intent	Intent?: The Intent to associated with the item. This Intent object is not copied, so be careful not to modify it later. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #getIntent

setNumericShortcut

Added in API level 1

abstract fun setNumericShortcut(numericChar: Char): MenuItem

Change the numeric shortcut associated with this item.

See Menu for the menu types that support shortcuts.

Parameters
numericChar	Char: The numeric shortcut key. This is the shortcut when using a 12-key (numeric) keyboard.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setNumericShortcut

Added in API level 26

open fun setNumericShortcut(
    numericChar: Char, 
    numericModifiers: Int
): MenuItem

Change the numeric shortcut and modifiers associated with this item.

See Menu for the menu types that support shortcuts.

Parameters
numericChar	Char: The numeric shortcut key. This is the shortcut when using a 12-key (numeric) keyboard.
numericModifiers	Int: The modifier associated with the shortcut. It should be a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setOnActionExpandListener

Added in API level 14

abstract fun setOnActionExpandListener(listener: MenuItem.OnActionExpandListener?): MenuItem

Set an OnActionExpandListener on this menu item to be notified when the associated action view is expanded or collapsed. The menu item must be configured to expand or collapse its action view using the flag SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW.

Parameters
listener	MenuItem.OnActionExpandListener?: Listener that will respond to expand/collapse events This value may be null.

Return
MenuItem	This menu item instance for call chaining This value cannot be null.

setOnMenuItemClickListener

Added in API level 1

abstract fun setOnMenuItemClickListener(menuItemClickListener: MenuItem.OnMenuItemClickListener?): MenuItem

Set a custom listener for invocation of this menu item. In most situations, it is more efficient and easier to use Activity.onOptionsItemSelected(MenuItem) or Activity.onContextItemSelected(MenuItem).

Parameters
menuItemClickListener	MenuItem.OnMenuItemClickListener?: The object to receive invokations. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• android.app.Activity#onOptionsItemSelected(MenuItem)
• android.app.Activity#onContextItemSelected(MenuItem)

setShortcut

Added in API level 1

abstract fun setShortcut(
    numericChar: Char, 
    alphaChar: Char
): MenuItem

Change both the numeric and alphabetic shortcut associated with this item. Note that the shortcut will be triggered when the key that generates the given character is pressed along with the corresponding modifier key. The default modifier is KeyEvent.META_CTRL_ON in case nothing is specified. Also note that case is not significant and that alphabetic shortcut characters will be handled in lower case.

See Menu for the menu types that support shortcuts.

Parameters
numericChar	Char: The numeric shortcut key. This is the shortcut when using a numeric (e.g., 12-key) keyboard.
alphaChar	Char: The alphabetic shortcut key. This is the shortcut when using a keyboard with alphabetic keys.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setShortcut

Added in API level 26

open fun setShortcut(
    numericChar: Char, 
    alphaChar: Char, 
    numericModifiers: Int, 
    alphaModifiers: Int
): MenuItem

Change both the numeric and alphabetic shortcut associated with this item. Note that the shortcut will be triggered when the key that generates the given character is pressed along with the corresponding modifier key. Also note that case is not significant and that alphabetic shortcut characters will be handled in lower case.

See Menu for the menu types that support shortcuts.

Parameters
numericChar	Char: The numeric shortcut key. This is the shortcut when using a numeric (e.g., 12-key) keyboard.
numericModifiers	Int: The numeric modifier associated with the shortcut. It should be a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON.
alphaChar	Char: The alphabetic shortcut key. This is the shortcut when using a keyboard with alphabetic keys.
alphaModifiers	Int: The alphabetic modifier associated with the shortcut. It should be a combination of KeyEvent.META_META_ON, KeyEvent.META_CTRL_ON, KeyEvent.META_ALT_ON, KeyEvent.META_SHIFT_ON, KeyEvent.META_SYM_ON, KeyEvent.META_FUNCTION_ON.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setShowAsAction

Added in API level 11

abstract fun setShowAsAction(actionEnum: Int): Unit

Sets how this item should display in the presence of an Action Bar. The parameter actionEnum is a flag set. One of SHOW_AS_ACTION_ALWAYS, SHOW_AS_ACTION_IF_ROOM, or SHOW_AS_ACTION_NEVER should be used, and you may optionally OR the value with SHOW_AS_ACTION_WITH_TEXT. SHOW_AS_ACTION_WITH_TEXT requests that when the item is shown as an action, it should be shown with a text label.

Parameters
actionEnum	Int: How the item should display. One of SHOW_AS_ACTION_ALWAYS, SHOW_AS_ACTION_IF_ROOM, or SHOW_AS_ACTION_NEVER. SHOW_AS_ACTION_NEVER is the default.

See Also

• android.app.ActionBar
• #setActionView(View)

setShowAsActionFlags

Added in API level 14

abstract fun setShowAsActionFlags(actionEnum: Int): MenuItem

Sets how this item should display in the presence of an Action Bar. The parameter actionEnum is a flag set. One of SHOW_AS_ACTION_ALWAYS, SHOW_AS_ACTION_IF_ROOM, or SHOW_AS_ACTION_NEVER should be used, and you may optionally OR the value with SHOW_AS_ACTION_WITH_TEXT. SHOW_AS_ACTION_WITH_TEXT requests that when the item is shown as an action, it should be shown with a text label.

Note: This method differs from setShowAsAction(int) only in that it returns the current MenuItem instance for call chaining.

Parameters
actionEnum	Int: How the item should display. One of SHOW_AS_ACTION_ALWAYS, SHOW_AS_ACTION_IF_ROOM, or SHOW_AS_ACTION_NEVER. SHOW_AS_ACTION_NEVER is the default.

Return
MenuItem	This MenuItem instance for call chaining. This value cannot be null.

See Also

• android.app.ActionBar
• #setActionView(View)

setTitle

Added in API level 1

abstract fun setTitle(title: Int): MenuItem

Change the title associated with this item.

Some menu types do not sufficient space to show the full title, and instead a condensed title is preferred. See Menu for more information.

Parameters
title	Int: The resource id of the new text to be displayed.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

See Also

• #setTitleCondensed(CharSequence)

setTitle

Added in API level 1

abstract fun setTitle(title: CharSequence?): MenuItem

Change the title associated with this item.

Parameters
title	CharSequence?: The new text to be displayed. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setTitleCondensed

Added in API level 1

abstract fun setTitleCondensed(title: CharSequence?): MenuItem

Change the condensed title associated with this item. The condensed title is used in situations where the normal title may be too long to be displayed.

Parameters
title	CharSequence?: The new text to be displayed as the condensed title. This value may be null.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.

setTooltipText

Added in API level 26

open fun setTooltipText(tooltipText: CharSequence?): MenuItem

Change the tooltip text associated with this menu item.

Parameters
tooltipText	CharSequence?: The new tooltip text. This value may be null.

Return
MenuItem	This value cannot be null.

setVisible

Added in API level 1

abstract fun setVisible(visible: Boolean): MenuItem

Sets the visibility of the menu item. Even if a menu item is not visible, it may still be invoked via its shortcut (to completely disable an item, set it to invisible and disabled).

Parameters
visible	Boolean: If true then the item will be visible; if false it is hidden.

Return
MenuItem	This Item so additional setters can be called. This value cannot be null.