public abstract class

ActionProvider

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

Class Overview

This class is a mediator for accomplishing a given task, for example sharing a file. It is responsible for creating a view that performs an action that accomplishes the task. This class also implements other functions such a performing a default action.

An ActionProvider can be optionally specified for a MenuItem and in such a case it will be responsible for creating the action view that appears in the ActionBar as a substitute for the menu item when the item is displayed as an action item. Also the provider is responsible for performing a default action if a menu item placed on the overflow menu of the ActionBar is selected and none of the menu item callbacks has handled the selection. For this case the provider can also optionally provide a sub-menu for accomplishing the task at hand.

There are two ways for using an action provider for creating and handling of action views:

  • Setting the action provider on a MenuItem directly by calling setActionProvider(ActionProvider).
  • Declaring the action provider in the menu XML 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

Public Constructors
ActionProvider(Context context)
Creates a new instance.
Public Methods
boolean hasSubMenu()
Determines if this ActionProvider has a submenu associated with it.
abstract View onCreateActionView()
Factory method for creating 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.
[Expand]
Inherited Methods
From class java.lang.Object

Public Constructors

public ActionProvider (Context context)

Since: API Level 14

Creates a new instance.

Parameters
context Context for accessing resources.

Public Methods

public boolean hasSubMenu ()

Since: 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
  • true if the item backed by this provider should have an associated submenu

public abstract View onCreateActionView ()

Since: API Level 14

Factory method for creating new action views.

Returns
  • A new action view.

public boolean onPerformDefaultAction ()

Since: 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.

public void onPrepareSubMenu (SubMenu subMenu)

Since: 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 that will be displayed