MenuItemCompat

const val SHOW_AS_ACTION_ALWAYS = 2: 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.

const val SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW = 8: 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.

const val SHOW_AS_ACTION_IF_ROOM = 1: Int

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

const val SHOW_AS_ACTION_NEVER = 0: Int

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

const val SHOW_AS_ACTION_WITH_TEXT = 4: Int

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

@ReplaceWith(expression = "item.collapseActionView()")
java-static fun collapseActionView(item: MenuItem!): 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 it will have its onMenuItemActionCollapse method invoked. The listener may return false from this method to prevent collapsing the action view.

@ReplaceWith(expression = "item.expandActionView()")
java-static fun expandActionView(item: MenuItem!): 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 it will have its onMenuItemActionExpand method invoked. The listener may return false from this method to prevent expanding the action view.

java-static fun getActionProvider(item: MenuItem): ActionProvider?

Gets the ActionProvider.

@ReplaceWith(expression = "item.getActionView()")
java-static fun getActionView(item: MenuItem!): View!

Returns the currently set action view for this menu item.

java-static fun getAlphabeticModifiers(item: MenuItem): Int

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

java-static fun getContentDescription(item: MenuItem): CharSequence?

Retrieve the content description associated with this menu item.

java-static fun getIconTintMode(item: MenuItem): PorterDuff.Mode?

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

java-static fun getNumericModifiers(item: MenuItem): Int

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

java-static fun getTooltipText(item: MenuItem): CharSequence?

Retrieve the tooltip text associated with this menu item.

@ReplaceWith(expression = "item.isActionViewExpanded()")
java-static fun isActionViewExpanded(item: MenuItem!): Boolean

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

java-static fun setActionProvider(item: MenuItem, provider: 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.

@ReplaceWith(expression = "item.setActionView(resId)")
java-static fun setActionView(item: MenuItem!, 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.

@ReplaceWith(expression = "item.setActionView(view)")
java-static fun setActionView(item: MenuItem!, 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.

java-static fun setAlphabeticShortcut(item: MenuItem, alphaChar: Char, alphaModifiers: Int): Unit

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.

java-static fun setContentDescription(item: MenuItem, contentDescription: CharSequence?): Unit

Change the content description associated with this menu item.

java-static fun setIconTintList(item: MenuItem, tint: ColorStateList?): Unit

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

Subsequent calls to setIcon or setIcon will automatically mutate the icon and apply the specified tint and tint mode.

java-static fun setIconTintMode(item: MenuItem, tintMode: PorterDuff.Mode?): Unit

Specifies the blending mode used to apply the tint specified by setIconTintList to the item's icon. The default mode is SRC_IN.

java-static fun setNumericShortcut(
    item: MenuItem,
    numericChar: Char,
    numericModifiers: Int
): Unit

Change the numeric shortcut and modifiers associated with this item.

See Menu for the menu types that support shortcuts.

java-static fun setOnActionExpandListener(
    item: MenuItem!,
    listener: MenuItemCompat.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.

java-static fun setShortcut(
    item: MenuItem,
    numericChar: Char,
    alphaChar: Char,
    numericModifiers: Int,
    alphaModifiers: Int
): Unit

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.

@ReplaceWith(expression = "item.setShowAsAction(actionEnum)")
java-static fun setShowAsAction(item: MenuItem!, actionEnum: Int): Unit

Sets how this item should display in the presence of a compatible Action Bar. If the given item is compatible, this will call the item's supported implementation of setShowAsAction.

java-static fun setTooltipText(item: MenuItem, tooltipText: CharSequence?): Unit

Change the tooltip text associated with this menu item.