| java.lang.Object | |
| ↳ | android.view.ActionProvider |
 Known Direct Subclasses
|
An ActionProvider defines rich menu interaction in a single component. ActionProvider can generate action views for use in the action bar, dynamically populate submenus of a MenuItem, and handle default menu item invocations.
An ActionProvider can be optionally specified for a MenuItem and will be
responsible for creating the action view that appears in the ActionBar
in place of a simple button in the bar. When the menu item is presented in a way that
does not allow custom action views, (e.g. in an overflow menu,) the ActionProvider
can perform a default action.
There are two ways to use an action provider:
MenuItem directly by calling
setActionProvider(ActionProvider).
<item android:id="@+id/my_menu_item"
android:title="Title"
android:icon="@drawable/my_menu_item_icon"
android:showAsAction="ifRoom"
android:actionProviderClass="foo.bar.SomeActionProvider" />
| Nested Classes | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| ActionProvider.VisibilityListener | Listens to changes in visibility as reported by refreshVisibility(). |
||||||||||
| Public Constructors | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a new instance.
| |||||||||||
| Public Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
Determines if this ActionProvider has a submenu associated with it.
| |||||||||||
If
overridesItemVisibility() returns true, the return value of this method
will help determine the visibility of the MenuItem this ActionProvider is bound to. | |||||||||||
This method was deprecated
in API level 16.
use
onCreateActionView(MenuItem)
| |||||||||||
Factory method called by the Android framework to create new action views.
| |||||||||||
Performs an optional default action.
| |||||||||||
Called to prepare an associated submenu for the menu item backed by this ActionProvider.
| |||||||||||
The result of this method determines whether or not
isVisible() will be used
by the MenuItem this ActionProvider is bound to help determine its visibility. | |||||||||||
If this ActionProvider is associated with an item in a menu,
refresh the visibility of the item based on
overridesItemVisibility() and
isVisible(). | |||||||||||
Set a listener to be notified when this ActionProvider's overridden visibility changes.
| |||||||||||
|
[Expand]
Inherited Methods | |||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|
|
From class
java.lang.Object
| |||||||||||
Creates a new instance. ActionProvider classes should always implement a constructor that takes a single Context parameter for inflating from menu XML.
| context | Context for accessing resources. |
|---|
Determines if this ActionProvider has a submenu associated with it.
Associated submenus will be shown when an action view is not. This
provider instance will receive a call to onPrepareSubMenu(SubMenu)
after the call to onPerformDefaultAction() and before a submenu is
displayed to the user.
If overridesItemVisibility() returns true, the return value of this method
will help determine the visibility of the MenuItem this ActionProvider is bound to.
If the MenuItem's visibility is explicitly set to false by the application, the MenuItem will not be shown, even if this method returns true.
This method was deprecated
in API level 16.
use onCreateActionView(MenuItem)
Factory method called by the Android framework to create new action views.
This method has been deprecated in favor of onCreateActionView(MenuItem).
Newer apps that wish to support platform versions prior to API 16 should also
implement this method to return a valid action view.
Factory method called by the Android framework to create new action views. This method returns a new action view for the given MenuItem.
If your ActionProvider implementation overrides the deprecated no-argument overload
onCreateActionView(), overriding this method for devices running API 16 or later
is recommended but optional. The default implementation calls onCreateActionView()
for compatibility with applications written for older platform versions.
| forItem | MenuItem to create the action view for |
|---|
Performs an optional default action.
For the case of an action provider placed in a menu item not shown as an action this method is invoked if previous callbacks for processing menu selection has handled the event.
A menu item selection is processed in the following order:
MenuItem.OnMenuItemClickListener.onMenuItemClick.
Activity.onOptionsItemSelected(MenuItem)
Fragment.onOptionsItemSelected(MenuItem)
Intent set via
MenuItem.setIntent(android.content.Intent)
The default implementation does not perform any action and returns false.
Called to prepare an associated submenu for the menu item backed by this ActionProvider.
if hasSubMenu() returns true, this method will be called when the
menu item is selected to prepare the submenu for presentation to the user. Apps
may use this to create or alter submenu content right before display.
| subMenu | Submenu that will be displayed |
|---|
The result of this method determines whether or not isVisible() will be used
by the MenuItem this ActionProvider is bound to help determine its visibility.
If this ActionProvider is associated with an item in a menu,
refresh the visibility of the item based on overridesItemVisibility() and
isVisible(). If overridesItemVisibility() returns false, this call
will have no effect.
Set a listener to be notified when this ActionProvider's overridden visibility changes. This should only be used by MenuItem implementations.
| listener | listener to set |
|---|