ActionProvider

Kotlin |Java

abstract class ActionProvider

kotlin.Any
↳	android.view.ActionProvider

Known Direct Subclasses

MediaRouteActionProvider, ShareActionProvider

MediaRouteActionProvider	The media route action provider displays a `media route button` in the application's `ActionBar` to allow the user to select routes and to control the currently selected route.
ShareActionProvider	This is a provider for a share action.

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 android.app.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 MenuItem#setActionProvider(ActionProvider).

Declare the action provider in an XML menu resource. For example:

<code>
    &lt;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" /&gt;
  </code>

Summary

Nested classes
abstract	`VisibilityListener` Listens to changes in visibility as reported by `ActionProvider#refreshVisibility()`.

Public constructors
`ActionProvider(context: Context)` Creates a new instance.

Public methods
open Boolean	`hasSubMenu()` Determines if this ActionProvider has a submenu associated with it.
open 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()` Factory method called by the Android framework to create new action views.
open View	`onCreateActionView(forItem: MenuItem)` Factory method called by the Android framework to create new action views.
open Boolean	`onPerformDefaultAction()` Performs an optional default action.
open Unit	`onPrepareSubMenu(subMenu: SubMenu)` Called to prepare an associated submenu for the menu item backed by this ActionProvider.
open 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.
open Unit	`refreshVisibility()` If this ActionProvider is associated with an item in a menu, refresh the visibility of the item based on `overridesItemVisibility()` and `isVisible()`.
open Unit	`setVisibilityListener(listener: ActionProvider.VisibilityListener?)` Set a listener to be notified when this ActionProvider's overridden visibility changes.

Public constructors

ActionProvider

Added in API level 14

ActionProvider(context: Context)

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. This value cannot be `null`.

Public methods

hasSubMenu

Added in API level 14

open fun hasSubMenu(): Boolean

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(android.view.SubMenu) after the call to onPerformDefaultAction() and before a submenu is displayed to the user.

Return
`Boolean`	true if the item backed by this provider should have an associated submenu

isVisible

Added in API level 16

open fun isVisible(): Boolean

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.

Return
`Boolean`	true if the MenuItem this ActionProvider is bound to is visible, false if it is invisible. The default implementation returns true.

onCreateActionView

Added in API level 14
Deprecated in API level 16

abstract fun onCreateActionView(): View

Deprecated: use onCreateActionView(android.view.MenuItem)

Factory method called by the Android framework to create new action views.

This method has been deprecated in favor of onCreateActionView(android.view.MenuItem). Newer apps that wish to support platform versions prior to API 16 should also implement this method to return a valid action view.

Return
`View`	A new action view. This value cannot be `null`.

onCreateActionView

Added in API level 16

open fun onCreateActionView(forItem: MenuItem): 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.

Parameters
`forItem`	MenuItem: MenuItem to create the action view for This value cannot be `null`.

Return
`View`	the new action view This value cannot be `null`.

onPerformDefaultAction

Added in API level 14

open fun onPerformDefaultAction(): Boolean

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 android.content.Intent set via MenuItem.setIntent(android.content.Intent)
Invoking this method.

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

onPrepareSubMenu

Added in API level 14

open fun onPrepareSubMenu(subMenu: SubMenu): Unit

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 This value cannot be `null`.

overridesItemVisibility

Added in API level 16

open fun overridesItemVisibility(): Boolean

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.

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

See Also

#isVisible()

refreshVisibility

Added in API level 16

open fun refreshVisibility(): Unit

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.

setVisibilityListener

Added in API level 16

open fun setVisibilityListener(listener: ActionProvider.VisibilityListener?): Unit

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 This value may be `null`.