Start line:  
End line:  

Snippet Preview

Snippet HTML Code

Stack Overflow Questions
   * Copyright (C) 2011 The Android Open Source Project
   * Licensed under the Apache License, Version 2.0 (the "License");
   * you may not use this file except in compliance with the License.
   * You may obtain a copy of the License at
  * Unless required by applicable law or agreed to in writing, software
  * distributed under the License is distributed on an "AS IS" BASIS,
  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  * See the License for the specific language governing permissions and
  * limitations under the License.
 package com.actionbarsherlock.view;
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 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(com.actionbarsherlock.view.ActionProvider).
  • Declaring the action provider in the menu XML resource. For example:
       <item android:id="@+id/my_menu_item"
         android:actionProviderClass="" />

 public abstract class ActionProvider {
Creates a new instance.

context Context for accessing resources.
     public ActionProvider(Context context) {

Factory method for creating new action views.

A new action view.
     public abstract View onCreateActionView();

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.

    public boolean onPerformDefaultAction() {
        return false;

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

true if the item backed by this provider should have an associated submenu
    public boolean hasSubMenu() {
        return 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
    public void onPrepareSubMenu(SubMenu subMenu) {

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.

Pending future API approval
    public void subUiVisibilityChanged(boolean isVisible) {
        if ( != null) {


Internal use only
    public void setSubUiVisibilityListener(SubUiVisibilityListener listener) {
         = listener;


Internal use only
    public interface SubUiVisibilityListener {
        public void onSubUiVisibilityChanged(boolean isVisible);
New to GrepCode? Check out our FAQ X