Android APIs
public abstract class

ActionProvider

extends Object
java.lang.Object
   ↳ android.view.ActionProvider
Known Direct Subclasses

Class Overview

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:

  • Set the action provider on a MenuItem directly by calling setActionProvider(ActionProvider).
  • Declare the action provider in an XML menu resource. For example:
     
       <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" />
     
     

Summary

Nested Classes
interface ActionProvider.VisibilityListener Listens to changes in visibility as reported by refreshVisibility()
Public Constructors
ActionProvider(Context context)
Creates a new instance.
Public Methods
boolean hasSubMenu()
Determines if this ActionProvider has a submenu associated with it.
boolean isVisible()
If overridesItemVisibility() returns true, the return value of this method will help determine the visibility of the MenuItem this ActionProvider is bound to.
abstract View onCreateActionView()
This method was deprecated in API level 16. use onCreateActionView(MenuItem)
View onCreateActionView(MenuItem forItem)
Factory method called by the Android framework to create new action views.
boolean onPerformDefaultAction()
Performs an optional default action.
void onPrepareSubMenu(SubMenu subMenu)
Called to prepare an associated submenu for the menu item backed by this ActionProvider.
boolean overridesItemVisibility()
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.
void refreshVisibility()
If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on overridesItemVisibility() and isVisible().
void setVisibilityListener(ActionProvider.VisibilityListener listener)
Set a listener to be notified when this ActionProvider's overridden visibility changes.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ActionProvider (Context context)

Added in API level 14

Creates a new instance. ActionProvider classes should always implement a constructor that takes a single Context parameter for inflating from menu XML.

Parameters
context Context: Context for accessing resources.

Public Methods

public boolean hasSubMenu ()

Added in API level 14

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.

Returns
boolean true if the item backed by this provider should have an associated submenu

public boolean isVisible ()

Added in API level 16

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.

Returns
boolean true if the MenuItem this ActionProvider is bound to is visible, false if it is invisible. The default implementation returns true.

public abstract View onCreateActionView ()

Added in API level 14

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.

Returns
View A new action view.

public View onCreateActionView (MenuItem forItem)

Added in API level 16

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.

Parameters
forItem MenuItem: MenuItem to create the action view for
Returns
View the new action view

public boolean onPerformDefaultAction ()

Added in API level 14

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:

The default implementation does not perform any action and returns false.

Returns
boolean

public void onPrepareSubMenu (SubMenu subMenu)

Added in API level 14

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.

Parameters
subMenu SubMenu: Submenu that will be displayed

public boolean overridesItemVisibility ()

Added in API level 16

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.

Returns
boolean true if this ActionProvider overrides the visibility of the MenuItem it is bound to, false otherwise. The default implementation returns false.

See also:

public void refreshVisibility ()

Added in API level 16

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.

public void setVisibilityListener (ActionProvider.VisibilityListener listener)

Added in API level 16

Set a listener to be notified when this ActionProvider's overridden visibility changes. This should only be used by MenuItem implementations.

Parameters
listener ActionProvider.VisibilityListener: listener to set