com.actionbarsherlock.view

Class ActionProvider

java.lang.Object

com.actionbarsherlock.view.ActionProvider

Direct Known Subclasses:

ShareActionProvider

public abstract class ActionProvider
extends java.lang.Object

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 MenuItem.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" />
   
   

See Also:

MenuItem.setActionProvider(ActionProvider), MenuItem.getActionProvider()

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ActionProvider.SubUiVisibilityListener

Constructor Summary

Constructors

Constructor and Description
ActionProvider(android.content.Context context) Creates a new instance.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	hasSubMenu() Determines if this ActionProvider has a submenu associated with it.
abstract android.view.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.
void	setSubUiVisibilityListener(ActionProvider.SubUiVisibilityListener listener)
void	subUiVisibilityChanged(boolean isVisible) Notify the system that the visibility of an action view's sub-UI such as an anchored popup has changed.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ActionProvider

public ActionProvider(android.content.Context context)

Creates a new instance.

Parameters:

context - Context for accessing resources.

Method Detail

onCreateActionView

public abstract android.view.View onCreateActionView()

Factory method for creating new action views.

Returns:

A new action view.

onPerformDefaultAction

public boolean onPerformDefaultAction()

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:

• Receiving a call to MenuItem.OnMenuItemClickListener.onMenuItemClick.
• Receiving a call to Activity.onOptionsItemSelected(MenuItem)
• Receiving a call to Fragment.onOptionsItemSelected(MenuItem)
• Launching the Intent set via MenuItem.setIntent(android.content.Intent)
• Invoking this method.

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

hasSubMenu

public boolean hasSubMenu()

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

onPrepareSubMenu

public void onPrepareSubMenu(SubMenu subMenu)

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

subUiVisibilityChanged

public void subUiVisibilityChanged(boolean isVisible)

Notify the system that the visibility of an action view's sub-UI such as an anchored popup has changed. This will affect how other system visibility notifications occur.

setSubUiVisibilityListener

public void setSubUiVisibilityListener(ActionProvider.SubUiVisibilityListener listener)