android.view
public
interface
android.view.MenuItem
Interface for direct access to a previously created menu item.
An Item is returned by calling one of the add(int)
methods.
For a feature set of specific menu types, see Menu.
Nested Classes
Summary
Details
Public Methods
public
char
getAlphabeticShortcut()
Return the char for this menu item's alphabetic shortcut.
Returns
- Alphabetic character to use as a shortcut.
public
int
getGroupId()
Return the group identifier that this menu item is part of. The group
identifier can not be changed after the menu is created.
Returns
- The menu item's group identifier.
public
Drawable
getIcon()
Returns the icon for this item as a Drawable (getting it from resources if it hasn't been
loaded before).
public
Intent
getIntent()
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.
public
int
getItemId()
Return the identifier for this menu item. The identifier can not
be changed after the menu is created.
Returns
- The menu item's identifier.
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.
Returns
- The extra information linked to the View that added this
menu item to the menu. This can be null.
public
char
getNumericShortcut()
Return the char for this menu item's numeric (12-key) shortcut.
Returns
- Numeric character to use as a shortcut.
public
int
getOrder()
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 CATEGORY_SYSTEM,
CATEGORY_SECONDARY, CATEGORY_ALTERNATIVE,
CATEGORY_CONTAINER. See Menu for a full list.
public
SubMenu
getSubMenu()
Get the sub-menu to be invoked when this item is selected, if it has
one. See
hasSubMenu().
Returns
- The associated menu if there is one, else null
Retrieve the current title of the item.
public
CharSequence
getTitleCondensed()
Retrieve the current condensed title of the item. If a condensed
title was never set, it will return the normal title.
Returns
- The condensed title, if it exists.
Otherwise the normal title.
public
boolean
hasSubMenu()
Check whether this item has an associated sub-menu. I.e. it is a
sub-menu of another menu.
Returns
- If true this item has a menu; else it is a
normal item.
public
boolean
isCheckable()
Return whether the item can currently display a check mark.
Returns
- If a check mark can be displayed, returns true.
public
boolean
isChecked()
Return whether the item is currently displaying a check mark.
Returns
- If a check mark is displayed, returns true.
public
boolean
isEnabled()
Return the enabled state of the menu item.
Returns
- If true the item is enabled and hence invokable; else it is not.
public
boolean
isVisible()
Return the visibility of the menu item.
Returns
- If true the item is visible; else it is hidden.
public
MenuItem
setAlphabeticShortcut(char alphaChar)
Change the alphabetic shortcut associated with this item. The shortcut
will be triggered when the key that generates the given character is
pressed alone or along with with the alt key. 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
| The alphabetic shortcut key. This is the shortcut when
using a keyboard with alphabetic keys. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setCheckable(boolean checkable)
Control whether this item can display a check mark. Setting this does
not actually display a check mark (see
setChecked(boolean) 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
| Set to true to allow a check mark, false to
disallow. The default is false. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setChecked(boolean checked)
Control whether this item is shown with a check mark. Note that you
must first have enabled checking with
setCheckable(boolean) or else
the check mark will not appear. If this item is a member of a group that contains
mutually-exclusive items (set via
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
| Set to true to display a check mark, false to hide
it. The default value is false. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setEnabled(boolean enabled)
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
| If true then the item will be invokable; if false it is
won't be invokable. |
Returns
- This Item so additional setters can be called.
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
| The new icon (as a Drawable) to be displayed. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setIcon(int iconRes)
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
| The new icon (as a resource ID) to be displayed. |
Returns
- This Item so additional setters can be called.
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
startActivity(Intent) with the given Intent.
Note that setIntent() can not be used with the versions of
add(int) that take a Runnable, because 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
| The Intent to associated with the item. This Intent
object is not copied, so be careful not to
modify it later. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setNumericShortcut(char numericChar)
Change the numeric shortcut associated with this item.
See Menu for the menu types that support shortcuts.
Parameters
numericChar
| The numeric shortcut key. This is the shortcut when
using a 12-key (numeric) keyboard. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setShortcut(char numericChar, char alphaChar)
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 alone or along with with the alt
key. Also note that case is not significant and that alphabetic shortcut
characters will be displayed in lower case.
See Menu for the menu types that support shortcuts.
Parameters
numericChar
| The numeric shortcut key. This is the shortcut when
using a numeric (e.g., 12-key) keyboard. |
alphaChar
| The alphabetic shortcut key. This is the shortcut when
using a keyboard with alphabetic keys. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setTitle(int title)
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
| The resource id of the new text to be displayed. |
Returns
- This Item so additional setters can be called.
Change the title associated with this item.
Parameters
title
| The new text to be displayed. |
Returns
- This Item so additional setters can be called.
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
| The new text to be displayed as the condensed title. |
Returns
- This Item so additional setters can be called.
public
MenuItem
setVisible(boolean visible)
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
| If true then the item will be visible; if false it is
hidden. |
Returns
- This Item so additional setters can be called.