| java.lang.Object | |
| ↳ | android.support.v4.view.MenuItemCompat |
Helper for accessing features in MenuItem
introduced after API level 4 in a backwards compatible fashion.
Note: You cannot get an instance of this class. Instead,
it provides static methods that correspond to the methods in MenuItem, but take a MenuItem object as an additional
argument.
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| MenuItemCompat.OnActionExpandListener | Interface definition for a callback to be invoked when a menu item marked with SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW is expanded or collapsed. |
||||||||||
| Constants | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| int | SHOW_AS_ACTION_ALWAYS | Always show this item as a button in an Action Bar. | |||||||||
| int | SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW | This item's action view collapses to a normal menu item. | |||||||||
| 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. | |||||||||
| int | SHOW_AS_ACTION_NEVER | Never show this item as a button in an Action Bar. | |||||||||
| 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 Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Collapse the action view associated with this menu item.
| |||||||||||
Expand the action view associated with this menu item.
| |||||||||||
Gets the
ActionProvider. | |||||||||||
Returns the currently set action view for this menu item.
| |||||||||||
Returns true if this menu item's action view has been expanded.
| |||||||||||
Sets the
ActionProvider responsible for creating an action view if
the item is placed on the action bar. | |||||||||||
Set an action view for this menu item.
| |||||||||||
Set an action view for this menu item.
| |||||||||||
Set an
MenuItemCompat.OnActionExpandListener on this menu
item to be notified when the associated action view is expanded or collapsed. | |||||||||||
Sets how this item should display in the presence of a compatible Action Bar.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
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.
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.
Show this item as a button in an Action Bar if the system decides there is room for it.
Never show this item as a button in an Action Bar.
When this item is in the action bar, always show it with a text label even if it also has an icon specified.
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(MenuItem, android.support.v4.view.MenuItemCompat.OnActionExpandListener)
it will have its onMenuItemActionCollapse(MenuItem)
method invoked. The listener may return false from this method to prevent collapsing
the action view.
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(MenuItem, OnActionExpandListener)
it will have its onMenuItemActionExpand(MenuItem)
method invoked. The listener may return false from this method to prevent expanding
the action view.
Gets the ActionProvider.
Returns the currently set action view for this menu item.
| item | the item to query |
|---|
Returns true if this menu item's action view has been expanded.
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(MenuItem, View).
| item | item to change |
|---|---|
| provider | The action provider. |
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(MenuItem, ActionProvider).
| item | the item to change |
|---|---|
| resId | Layout resource to use for presenting this item to the user. |
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.
| item | the item to change |
|---|---|
| view | View to use for presenting this item to the user. |
Set an MenuItemCompat.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.
| listener | Listener that will respond to expand/collapse events |
|---|
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(int).
| item | - the item to change |
|---|---|
| actionEnum | - How the item should display. |