Menu

CATEGORY_ALTERNATIVE

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.

Constant Value: 262144 (0x00040000)

CATEGORY_CONTAINER

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.

Constant Value: 65536 (0x00010000)

CATEGORY_SECONDARY

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.

Constant Value: 196608 (0x00030000)

CATEGORY_SYSTEM

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.

Constant Value: 131072 (0x00020000)

FIRST

int FIRST

First value for group and item identifier integers.

Constant Value: 1 (0x00000001)

FLAG_ALWAYS_PERFORM_CLOSE

int FLAG_ALWAYS_PERFORM_CLOSE

Flag for performShortcut(int, KeyEvent, int): if set, always close the menu after executing the shortcut. Closing the menu also resets the prepared state.

Constant Value: 2 (0x00000002)

FLAG_APPEND_TO_GROUP

int FLAG_APPEND_TO_GROUP

Flag for addIntentOptions(int, int, int, ComponentName, Intent[], Intent, int, MenuItem[]): if set, do not automatically remove any existing menu items in the same group.

Constant Value: 1 (0x00000001)

FLAG_PERFORM_NO_CLOSE

int FLAG_PERFORM_NO_CLOSE

Flag for performShortcut(int, KeyEvent, int): if set, do not close the menu after executing the shortcut.

Constant Value: 1 (0x00000001)

NONE

int NONE

Value to use for group and item identifier integers when you don't care about them.

Constant Value: 0 (0x00000000)

add

MenuItem add (int groupId, 
                int itemId, 
                int order, 
                CharSequence title)

Add a new item to the menu. This item displays the given title for its label.

add

MenuItem add (int titleRes)

Add a new item to the menu. This item displays the given title for its label.

add

MenuItem add (CharSequence title)

Add a new item to the menu. This item displays the given title for its label.

add

MenuItem add (int groupId, 
                int itemId, 
                int order, 
                int titleRes)

Variation on add(int, int, int, CharSequence) that takes a string resource identifier instead of the string itself.

addIntentOptions

int addIntentOptions (int groupId, 
                int itemId, 
                int order, 
                ComponentName caller, 
                Intent[] specifics, 
                Intent intent, 
                int flags, 
                MenuItem[] outSpecificItems)

Add a group of menu items corresponding to actions that can be performed for a particular Intent. The Intent is most often configured with a null action, the data that the current activity is working with, and includes either the CATEGORY_ALTERNATIVE or CATEGORY_SELECTED_ALTERNATIVE to find activities that have said they would like to be included as optional action. You can, however, use any Intent you want.

See queryIntentActivityOptions(ComponentName, Intent[], Intent, int) for more * details on the caller, specifics, and intent arguments. The list returned by that function is used to populate the resulting menu items.

All of the menu items of possible options for the intent will be added with the given group and id. You can use the group to control ordering of the items in relation to other items in the menu. Normally this function will automatically remove any existing items in the menu in the same group and place a divider above and below the added items; this behavior can be modified with the flags parameter. For each of the generated items setIntent(Intent) is called to associate the appropriate Intent with the item; this means the activity will automatically be started for you without having to do anything else.

addSubMenu

SubMenu addSubMenu (int groupId, 
                int itemId, 
                int order, 
                CharSequence title)

Add a new sub-menu to the menu. This item displays the given title for its label. To modify other attributes on the submenu's menu item, use getItem().

Note that you can only have one level of sub-menus, i.e. you cannnot add a subMenu to a subMenu: An UnsupportedOperationException will be thrown if you try.

addSubMenu

SubMenu addSubMenu (int titleRes)

Add a new sub-menu to the menu. This item displays the given title for its label. To modify other attributes on the submenu's menu item, use getItem().

addSubMenu

SubMenu addSubMenu (CharSequence title)

Add a new sub-menu to the menu. This item displays the given title for its label. To modify other attributes on the submenu's menu item, use getItem().

addSubMenu

SubMenu addSubMenu (int groupId, 
                int itemId, 
                int order, 
                int titleRes)

Variation on addSubMenu(int, int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself.

clear

void clear ()

Remove all existing items from the menu, leaving it empty as if it had just been created.

close

void close ()

Closes the menu, if open.

findItem

MenuItem findItem (int id)

Return the menu item with a particular identifier.

getItem

MenuItem getItem (int index)

Gets the menu item at the given index.

hasVisibleItems

boolean hasVisibleItems ()

Return whether the menu currently has item items that are visible.

isShortcutKey

boolean isShortcutKey (int keyCode, 
                KeyEvent event)

Is a keypress one of the defined shortcut keys for this window.

performIdentifierAction

boolean performIdentifierAction (int id, 
                int flags)

Execute the menu item action associated with the given menu identifier.

performShortcut

boolean performShortcut (int keyCode, 
                KeyEvent event, 
                int flags)

Execute the menu item action associated with the given shortcut character.

removeGroup

void removeGroup (int groupId)

Remove all items in the given group.

removeItem

void removeItem (int id)

Remove the item with the given identifier.

setGroupCheckable

void setGroupCheckable (int group, 
                boolean checkable, 
                boolean exclusive)

Control whether a particular group of items can show a check mark. This is similar to calling setCheckable(boolean) on all of the menu items with the given group identifier, but in addition you can control whether this group contains a mutually-exclusive set items. This should be called after the items of the group have been added to the menu.

setGroupEnabled

void setGroupEnabled (int group, 
                boolean enabled)

Enable or disable all menu items that are in the given group.

setGroupVisible

void setGroupVisible (int group, 
                boolean visible)

Show or hide all menu items that are in the given group.

setQwertyMode

void setQwertyMode (boolean isQwerty)

Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).

size

int size ()

Get the number of items in the menu. Note that this will change any times items are added or removed from the menu.