Menu

Kotlin |Java

interface Menu

android.view.Menu

Known Direct Subclasses

ContextMenu, SubMenu

ContextMenu	Extension of `Menu` for context menus providing functionality to modify the header of the context menu.
SubMenu	Subclass of `Menu` for sub menus.

Interface for managing the items in a menu.

By default, every Activity supports an options menu of actions or options. You can add items to this menu and handle clicks on your additions. The easiest way of adding menu items is inflating an XML file into the Menu via MenuInflater. The easiest way of attaching code to clicks is via Activity#onOptionsItemSelected(MenuItem) and Activity#onContextItemSelected(MenuItem).

Different menu types support different features:

Context menus: Do not support item shortcuts and item icons.
Options menus: The icon menus do not support item check marks and only show the item's condensed title. The expanded menus (only available if six or more menu items are visible, reached via the 'More' item in the icon menu) do not show item icons, and item check marks are discouraged.
Sub menus: Do not support item icons, or nested sub menus.

Summary

Constants
static Int	`CATEGORY_ALTERNATIVE` Category code for the order integer for items/groups that are alternative actions on the data that is currently displayed -- or/add this with your base value.
static Int	`CATEGORY_CONTAINER` Category code for the order integer for items/groups that are part of a container -- or/add this with your base value.
static Int	`CATEGORY_SECONDARY` Category code for the order integer for items/groups that are user-supplied secondary (infrequently used) options -- or/add this with your base value.
static Int	`CATEGORY_SYSTEM` Category code for the order integer for items/groups that are provided by the system -- or/add this with your base value.
static Int	`FIRST` First value for group and item identifier integers.
static Int	`FLAG_ALWAYS_PERFORM_CLOSE` Flag for `performShortcut(int,android.view.KeyEvent,int)`: if set, always close the menu after executing the shortcut.
static Int	`FLAG_APPEND_TO_GROUP` Flag for `addIntentOptions`: if set, do not automatically remove any existing menu items in the same group.
static Int	`FLAG_PERFORM_NO_CLOSE` Flag for `performShortcut`: if set, do not close the menu after executing the shortcut.
static Int	`NONE` Value to use for group and item identifier integers when you don't care about them.
static Int	`SUPPORTED_MODIFIERS_MASK` A mask of all supported modifiers for MenuItem's keyboard shortcuts

Public methods
abstract MenuItem!	`add(title: CharSequence!)` Add a new item to the menu.
abstract MenuItem!	`add(titleRes: Int)` Add a new item to the menu.
abstract MenuItem!	`add(groupId: Int, itemId: Int, order: Int, title: CharSequence!)` Add a new item to the menu.
abstract MenuItem!	`add(groupId: Int, itemId: Int, order: Int, titleRes: Int)` Variation on `add(int,int,int,java.lang.CharSequence)` that takes a string resource identifier instead of the string itself.
abstract Int	`addIntentOptions(groupId: Int, itemId: Int, order: Int, caller: ComponentName!, specifics: Array<Intent!>!, intent: Intent!, flags: Int, outSpecificItems: Array<MenuItem!>!)` Add a group of menu items corresponding to actions that can be performed for a particular Intent.
abstract SubMenu!	`addSubMenu(title: CharSequence!)` Add a new sub-menu to the menu.
abstract SubMenu!	`addSubMenu(titleRes: Int)` Add a new sub-menu to the menu.
abstract SubMenu!	`addSubMenu(groupId: Int, itemId: Int, order: Int, title: CharSequence!)` Add a new sub-menu to the menu.
abstract SubMenu!	`addSubMenu(groupId: Int, itemId: Int, order: Int, titleRes: Int)` Variation on `addSubMenu(int,int,int,java.lang.CharSequence)` that takes a string resource identifier for the title instead of the string itself.
abstract Unit	`clear()` Remove all existing items from the menu, leaving it empty as if it had just been created.
abstract Unit	`close()` Closes the menu, if open.
abstract MenuItem!	`findItem(id: Int)` Return the menu item with a particular identifier.
abstract MenuItem!	`getItem(index: Int)` Gets the menu item at the given index.
abstract Boolean	`hasVisibleItems()` Return whether the menu currently has item items that are visible.
abstract Boolean	`isShortcutKey(keyCode: Int, event: KeyEvent!)` Is a keypress one of the defined shortcut keys for this window.
abstract Boolean	`performIdentifierAction(id: Int, flags: Int)` Execute the menu item action associated with the given menu identifier.
abstract Boolean	`performShortcut(keyCode: Int, event: KeyEvent!, flags: Int)` Execute the menu item action associated with the given shortcut character.
abstract Unit	`removeGroup(groupId: Int)` Remove all items in the given group.
abstract Unit	`removeItem(id: Int)` Remove the item with the given identifier.
abstract Unit	`setGroupCheckable(group: Int, checkable: Boolean, exclusive: Boolean)` Control whether a particular group of items can show a check mark.
open Unit	`setGroupDividerEnabled(groupDividerEnabled: Boolean)` Enable or disable the group dividers.
abstract Unit	`setGroupEnabled(group: Int, enabled: Boolean)` Enable or disable all menu items that are in the given group.
abstract Unit	`setGroupVisible(group: Int, visible: Boolean)` Show or hide all menu items that are in the given group.
abstract Unit	`setQwertyMode(isQwerty: Boolean)` Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).
abstract Int	`size()` Get the number of items in the menu.

Parameters
`groupId`	Int: The group identifier that this item should be part of. This can be used to define groups of items for batch state changes. Normally use `NONE` if an item should not be in a group.
`itemId`	Int: Unique item ID. Use `NONE` if you do not need a unique ID.
`order`	Int: The order for the item. Use `NONE` if you do not care about the order. See `MenuItem#getOrder()`.
`title`	CharSequence!: The text to display for the item.

Parameters
`groupId`	Int: The group identifier that the items should be part of. This can also be used to define groups of items for batch state changes. Normally use `NONE` if the items should not be in a group.
`itemId`	Int: Unique item ID. Use `NONE` if you do not need a unique ID.
`order`	Int: The order for the items. Use `NONE` if you do not care about the order. See `MenuItem#getOrder()`.
`caller`	ComponentName!: The current activity component name as defined by queryIntentActivityOptions().
`specifics`	Array<Intent!>!: Specific items to place first as defined by queryIntentActivityOptions().
`intent`	Intent!: Intent describing the kinds of items to populate in the list as defined by queryIntentActivityOptions().
`flags`	Int: Additional options controlling how the items are added.
`outSpecificItems`	Array<MenuItem!>!: Optional array in which to place the menu items that were generated for each of the specifics that were requested. Entries may be null if no activity was found for that specific action.

Parameters
`keyCode`	Int: the key code from `KeyEvent` to check.
`event`	KeyEvent!: the `KeyEvent` to use to help check.

Parameters
`id`	Int: Identifier associated with the menu item.
`flags`	Int: Additional option flags or 0.

Parameters
`keyCode`	Int: The keycode of the shortcut key.
`event`	KeyEvent!: Key event message.
`flags`	Int: Additional option flags or 0.

Parameters
`group`	Int: The group of items to operate on.
`checkable`	Boolean: Set to true to allow a check mark, false to disallow. The default is false.
`exclusive`	Boolean: If set to true, only one item in this group can be checked at a time; checking an item will automatically uncheck all others in the group. If set to false, each item can be checked independently of the others.

Parameters
`group`	Int: The group of items to operate on.
`enabled`	Boolean: If true the items will be enabled, else they will be disabled.

Parameters
`group`	Int: The group of items to operate on.
`visible`	Boolean: If true the items are visible, else they are hidden.

Summary

Constants

CATEGORY_ALTERNATIVE

CATEGORY_CONTAINER

CATEGORY_SECONDARY

CATEGORY_SYSTEM

FIRST

FLAG_ALWAYS_PERFORM_CLOSE

FLAG_APPEND_TO_GROUP

FLAG_PERFORM_NO_CLOSE

NONE

SUPPORTED_MODIFIERS_MASK

Public methods

add

add

add

add

addIntentOptions

addSubMenu

addSubMenu

addSubMenu

addSubMenu

clear

close

findItem

getItem

hasVisibleItems

isShortcutKey

performIdentifierAction

performShortcut

removeGroup

removeItem

setGroupCheckable

setGroupDividerEnabled

setGroupEnabled

setGroupVisible

setQwertyMode

size