FileDocCategorySizeDatePackage
MenuBuilder.javaAPI DocAndroid 5.1 API44747Thu Mar 12 22:22:10 GMT 2015com.android.internal.view.menu

MenuBuilder

public class MenuBuilder extends Object implements android.view.Menu
Implementation of the {@link android.view.Menu} interface for creating a standard menu UI.

Fields Summary
private static final String
TAG
private static final String
PRESENTER_KEY
private static final String
ACTION_VIEW_STATES_KEY
private static final String
EXPANDED_ACTION_VIEW_ID
private static final int[]
sCategoryToOrder
private final android.content.Context
mContext
private final android.content.res.Resources
mResources
private boolean
mQwertyMode
Whether the shortcuts should be qwerty-accessible. Use isQwertyMode() instead of accessing this directly.
private boolean
mShortcutsVisible
Whether the shortcuts should be visible on menus. Use isShortcutsVisible() instead of accessing this directly.
private Callback
mCallback
Callback that will receive the various menu-related events generated by this class. Use getCallback to get a reference to the callback.
private ArrayList
mItems
Contains all of the items for this menu
private ArrayList
mVisibleItems
Contains only the items that are currently visible. This will be created/refreshed from {@link #getVisibleItems()}
private boolean
mIsVisibleItemsStale
Whether or not the items (or any one item's shown state) has changed since it was last fetched from {@link #getVisibleItems()}
private ArrayList
mActionItems
Contains only the items that should appear in the Action Bar, if present.
private ArrayList
mNonActionItems
Contains items that should NOT appear in the Action Bar, if present.
private boolean
mIsActionItemsStale
Whether or not the items (or any one item's action state) has changed since it was last fetched.
private int
mDefaultShowAsAction
Default value for how added items should show in the action list.
private android.view.ContextMenu.ContextMenuInfo
mCurrentMenuInfo
Current use case is Context Menus: As Views populate the context menu, each one has extra information that should be passed along. This is the current menu info that should be set on all items added to this menu.
CharSequence
mHeaderTitle
Header title for menu types that have a header (context and submenus)
android.graphics.drawable.Drawable
mHeaderIcon
Header icon for menu types that have a header and support icons (context)
android.view.View
mHeaderView
Header custom view for menu types that have a header and support custom views (context)
private android.util.SparseArray
mFrozenViewStates
Contains the state of the View hierarchy for all menu views when the menu was frozen.
private boolean
mPreventDispatchingItemsChanged
Prevents onItemsChanged from doing its junk, useful for batching commands that may individually call onItemsChanged.
private boolean
mItemsChangedWhileDispatchPrevented
private boolean
mOptionalIconsVisible
private boolean
mIsClosing
private ArrayList
mTempShortcutItemList
private CopyOnWriteArrayList
mPresenters
private MenuItemImpl
mExpandedItem
Currently expanded menu item; must be collapsed when we clear.
Constructors Summary
public MenuBuilder(android.content.Context context)

    
                   
       
                                                   
             
        
                                        
           
    

                  
       
           
    

       
        mContext = context;
        mResources = context.getResources();
        
        mItems = new ArrayList<MenuItemImpl>();
        
        mVisibleItems = new ArrayList<MenuItemImpl>();
        mIsVisibleItemsStale = true;
        
        mActionItems = new ArrayList<MenuItemImpl>();
        mNonActionItems = new ArrayList<MenuItemImpl>();
        mIsActionItemsStale = true;
        
        setShortcutsVisibleInner(true);
Methods Summary
public android.view.MenuItemadd(java.lang.CharSequence title)

        return addInternal(0, 0, 0, title);
public android.view.MenuItemadd(int titleRes)

        return addInternal(0, 0, 0, mResources.getString(titleRes));
public android.view.MenuItemadd(int group, int id, int categoryOrder, java.lang.CharSequence title)

        return addInternal(group, id, categoryOrder, title);
public android.view.MenuItemadd(int group, int id, int categoryOrder, int title)

        return addInternal(group, id, categoryOrder, mResources.getString(title));
public intaddIntentOptions(int group, int id, int categoryOrder, android.content.ComponentName caller, android.content.Intent[] specifics, android.content.Intent intent, int flags, android.view.MenuItem[] outSpecificItems)

        PackageManager pm = mContext.getPackageManager();
        final List<ResolveInfo> lri =
                pm.queryIntentActivityOptions(caller, specifics, intent, 0);
        final int N = lri != null ? lri.size() : 0;

        if ((flags & FLAG_APPEND_TO_GROUP) == 0) {
            removeGroup(group);
        }

        for (int i=0; i<N; i++) {
            final ResolveInfo ri = lri.get(i);
            Intent rintent = new Intent(
                ri.specificIndex < 0 ? intent : specifics[ri.specificIndex]);
            rintent.setComponent(new ComponentName(
                    ri.activityInfo.applicationInfo.packageName,
                    ri.activityInfo.name));
            final MenuItem item = add(group, id, categoryOrder, ri.loadLabel(pm))
                    .setIcon(ri.loadIcon(pm))
                    .setIntent(rintent);
            if (outSpecificItems != null && ri.specificIndex >= 0) {
                outSpecificItems[ri.specificIndex] = item;
            }
        }

        return N;
private android.view.MenuItemaddInternal(int group, int id, int categoryOrder, java.lang.CharSequence title)
Adds an item to the menu. The other add methods funnel to this.

        final int ordering = getOrdering(categoryOrder);
        
        final MenuItemImpl item = createNewMenuItem(group, id, categoryOrder, ordering, title,
                mDefaultShowAsAction);

        if (mCurrentMenuInfo != null) {
            // Pass along the current menu info
            item.setMenuInfo(mCurrentMenuInfo);
        }
        
        mItems.add(findInsertIndex(mItems, ordering), item);
        onItemsChanged(true);
        
        return item;
public voidaddMenuPresenter(MenuPresenter presenter)
Add a presenter to this menu. This will only hold a WeakReference; you do not need to explicitly remove a presenter, but you can using {@link #removeMenuPresenter(MenuPresenter)}.

param
presenter The presenter to add

        addMenuPresenter(presenter, mContext);
public voidaddMenuPresenter(MenuPresenter presenter, android.content.Context menuContext)
Add a presenter to this menu that uses an alternate context for inflating menu items. This will only hold a WeakReference; you do not need to explicitly remove a presenter, but you can using {@link #removeMenuPresenter(MenuPresenter)}.

param
presenter The presenter to add
param
menuContext The context used to inflate menu items

        mPresenters.add(new WeakReference<MenuPresenter>(presenter));
        presenter.initForMenu(menuContext, this);
        mIsActionItemsStale = true;
public android.view.SubMenuaddSubMenu(java.lang.CharSequence title)

        return addSubMenu(0, 0, 0, title);
public android.view.SubMenuaddSubMenu(int titleRes)

        return addSubMenu(0, 0, 0, mResources.getString(titleRes));
public android.view.SubMenuaddSubMenu(int group, int id, int categoryOrder, java.lang.CharSequence title)

        final MenuItemImpl item = (MenuItemImpl) addInternal(group, id, categoryOrder, title);
        final SubMenuBuilder subMenu = new SubMenuBuilder(mContext, this, item);
        item.setSubMenu(subMenu);
        
        return subMenu;
public android.view.SubMenuaddSubMenu(int group, int id, int categoryOrder, int title)

        return addSubMenu(group, id, categoryOrder, mResources.getString(title));
public voidchangeMenuMode()
Dispatch a mode change event to this menu's callback.

        if (mCallback != null) {
            mCallback.onMenuModeChange(this);
        }
public voidclear()

        if (mExpandedItem != null) {
            collapseItemActionView(mExpandedItem);
        }
        mItems.clear();
        
        onItemsChanged(true);
public voidclearAll()

        mPreventDispatchingItemsChanged = true;
        clear();
        clearHeader();
        mPreventDispatchingItemsChanged = false;
        mItemsChangedWhileDispatchPrevented = false;
        onItemsChanged(true);
public voidclearHeader()

        mHeaderIcon = null;
        mHeaderTitle = null;
        mHeaderView = null;
        
        onItemsChanged(false);
public final voidclose(boolean allMenusAreClosing)
Closes the visible menu.

param
allMenusAreClosing Whether the menus are completely closing (true), or whether there is another menu coming in this menu's place (false). For example, if the menu is closing because a sub menu is about to be shown, allMenusAreClosing is false.

        if (mIsClosing) return;

        mIsClosing = true;
        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else {
                presenter.onCloseMenu(this, allMenusAreClosing);
            }
        }
        mIsClosing = false;
public voidclose()
{@inheritDoc}

        close(true);
public booleancollapseItemActionView(MenuItemImpl item)

        if (mPresenters.isEmpty() || mExpandedItem != item) return false;

        boolean collapsed = false;

        stopDispatchingItemsChanged();
        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else if ((collapsed = presenter.collapseItemActionView(this, item))) {
                break;
            }
        }
        startDispatchingItemsChanged();

        if (collapsed) {
            mExpandedItem = null;
        }
        return collapsed;
private MenuItemImplcreateNewMenuItem(int group, int id, int categoryOrder, int ordering, java.lang.CharSequence title, int defaultShowAsAction)

        return new MenuItemImpl(this, group, id, categoryOrder, ordering, title,
                defaultShowAsAction);
booleandispatchMenuItemSelected(com.android.internal.view.menu.MenuBuilder menu, android.view.MenuItem item)

        return mCallback != null && mCallback.onMenuItemSelected(menu, item);
private voiddispatchPresenterUpdate(boolean cleared)

        if (mPresenters.isEmpty()) return;

        stopDispatchingItemsChanged();
        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else {
                presenter.updateMenuView(cleared);
            }
        }
        startDispatchingItemsChanged();
private voiddispatchRestoreInstanceState(android.os.Bundle state)

        SparseArray<Parcelable> presenterStates = state.getSparseParcelableArray(PRESENTER_KEY);

        if (presenterStates == null || mPresenters.isEmpty()) return;

        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else {
                final int id = presenter.getId();
                if (id > 0) {
                    Parcelable parcel = presenterStates.get(id);
                    if (parcel != null) {
                        presenter.onRestoreInstanceState(parcel);
                    }
                }
            }
        }
private voiddispatchSaveInstanceState(android.os.Bundle outState)

        if (mPresenters.isEmpty()) return;

        SparseArray<Parcelable> presenterStates = new SparseArray<Parcelable>();

        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else {
                final int id = presenter.getId();
                if (id > 0) {
                    final Parcelable state = presenter.onSaveInstanceState();
                    if (state != null) {
                        presenterStates.put(id, state);
                    }
                }
            }
        }

        outState.putSparseParcelableArray(PRESENTER_KEY, presenterStates);
private booleandispatchSubMenuSelected(SubMenuBuilder subMenu, MenuPresenter preferredPresenter)

        if (mPresenters.isEmpty()) return false;

        boolean result = false;

        // Try the preferred presenter first.
        if (preferredPresenter != null) {
            result = preferredPresenter.onSubMenuSelected(subMenu);
        }

        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else if (!result) {
                result = presenter.onSubMenuSelected(subMenu);
            }
        }
        return result;
public booleanexpandItemActionView(MenuItemImpl item)

        if (mPresenters.isEmpty()) return false;

        boolean expanded = false;

        stopDispatchingItemsChanged();
        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else if ((expanded = presenter.expandItemActionView(this, item))) {
                break;
            }
        }
        startDispatchingItemsChanged();

        if (expanded) {
            mExpandedItem = item;
        }
        return expanded;
public intfindGroupIndex(int group)

        return findGroupIndex(group, 0);
public intfindGroupIndex(int group, int start)

        final int size = size();
        
        if (start < 0) {
            start = 0;
        }
        
        for (int i = start; i < size; i++) {
            final MenuItemImpl item = mItems.get(i);
            
            if (item.getGroupId() == group) {
                return i;
            }
        }

        return -1;
private static intfindInsertIndex(java.util.ArrayList items, int ordering)

        for (int i = items.size() - 1; i >= 0; i--) {
            MenuItemImpl item = items.get(i);
            if (item.getOrdering() <= ordering) {
                return i + 1;
            }
        }
        
        return 0;
public android.view.MenuItemfindItem(int id)

        final int size = size();
        for (int i = 0; i < size; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.getItemId() == id) {
                return item;
            } else if (item.hasSubMenu()) {
                MenuItem possibleItem = item.getSubMenu().findItem(id);
                
                if (possibleItem != null) {
                    return possibleItem;
                }
            }
        }
        
        return null;
public intfindItemIndex(int id)

        final int size = size();

        for (int i = 0; i < size; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.getItemId() == id) {
                return i;
            }
        }

        return -1;
MenuItemImplfindItemWithShortcutForKey(int keyCode, android.view.KeyEvent event)

        // Get all items that can be associated directly or indirectly with the keyCode
        ArrayList<MenuItemImpl> items = mTempShortcutItemList;
        items.clear();
        findItemsWithShortcutForKey(items, keyCode, event);

        if (items.isEmpty()) {
            return null;
        }

        final int metaState = event.getMetaState();
        final KeyCharacterMap.KeyData possibleChars = new KeyCharacterMap.KeyData();
        // Get the chars associated with the keyCode (i.e using any chording combo)
        event.getKeyData(possibleChars);

        // If we have only one element, we can safely returns it
        final int size = items.size();
        if (size == 1) {
            return items.get(0);
        }

        final boolean qwerty = isQwertyMode();
        // If we found more than one item associated with the key,
        // we have to return the exact match
        for (int i = 0; i < size; i++) {
            final MenuItemImpl item = items.get(i);
            final char shortcutChar = qwerty ? item.getAlphabeticShortcut() :
                    item.getNumericShortcut();
            if ((shortcutChar == possibleChars.meta[0] &&
                    (metaState & KeyEvent.META_ALT_ON) == 0)
                || (shortcutChar == possibleChars.meta[2] &&
                    (metaState & KeyEvent.META_ALT_ON) != 0)
                || (qwerty && shortcutChar == '\b" &&
                    keyCode == KeyEvent.KEYCODE_DEL)) {
                return item;
            }
        }
        return null;
voidfindItemsWithShortcutForKey(java.util.List items, int keyCode, android.view.KeyEvent event)

        final boolean qwerty = isQwertyMode();
        final int metaState = event.getMetaState();
        final KeyCharacterMap.KeyData possibleChars = new KeyCharacterMap.KeyData();
        // Get the chars associated with the keyCode (i.e using any chording combo)
        final boolean isKeyCodeMapped = event.getKeyData(possibleChars);
        // The delete key is not mapped to '\b' so we treat it specially
        if (!isKeyCodeMapped && (keyCode != KeyEvent.KEYCODE_DEL)) {
            return;
        }

        // Look for an item whose shortcut is this key.
        final int N = mItems.size();
        for (int i = 0; i < N; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.hasSubMenu()) {
                ((MenuBuilder)item.getSubMenu()).findItemsWithShortcutForKey(items, keyCode, event);
            }
            final char shortcutChar = qwerty ? item.getAlphabeticShortcut() : item.getNumericShortcut();
            if (((metaState & (KeyEvent.META_SHIFT_ON | KeyEvent.META_SYM_ON)) == 0) &&
                  (shortcutChar != 0) &&
                  (shortcutChar == possibleChars.meta[0]
                      || shortcutChar == possibleChars.meta[2]
                      || (qwerty && shortcutChar == '\b" &&
                          keyCode == KeyEvent.KEYCODE_DEL)) &&
                  item.isEnabled()) {
                items.add(item);
            }
        }
public voidflagActionItems()
This method determines which menu items get to be 'action items' that will appear in an action bar and which items should be 'overflow items' in a secondary menu. The rules are as follows:

Items are considered for inclusion in the order specified within the menu. There is a limit of mMaxActionItems as a total count, optionally including the overflow menu button itself. This is a soft limit; if an item shares a group ID with an item previously included as an action item, the new item will stay with its group and become an action item itself even if it breaks the max item count limit. This is done to limit the conceptual complexity of the items presented within an action bar. Only a few unrelated concepts should be presented to the user in this space, and groups are treated as a single concept.

There is also a hard limit of consumed measurable space: mActionWidthLimit. This limit may be broken by a single item that exceeds the remaining space, but no further items may be added. If an item that is part of a group cannot fit within the remaining measured width, the entire group will be demoted to overflow. This is done to ensure room for navigation and other affordances in the action bar as well as reduce general UI clutter.

The space freed by demoting a full group cannot be consumed by future menu items. Once items begin to overflow, all future items become overflow items as well. This is to avoid inadvertent reordering that may break the app's intended design.

        // Important side effect: if getVisibleItems is stale it may refresh,
        // which can affect action items staleness.
        final ArrayList<MenuItemImpl> visibleItems = getVisibleItems();

        if (!mIsActionItemsStale) {
            return;
        }

        // Presenters flag action items as needed.
        boolean flagged = false;
        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter presenter = ref.get();
            if (presenter == null) {
                mPresenters.remove(ref);
            } else {
                flagged |= presenter.flagActionItems();
            }
        }

        if (flagged) {
            mActionItems.clear();
            mNonActionItems.clear();
            final int itemsSize = visibleItems.size();
            for (int i = 0; i < itemsSize; i++) {
                MenuItemImpl item = visibleItems.get(i);
                if (item.isActionButton()) {
                    mActionItems.add(item);
                } else {
                    mNonActionItems.add(item);
                }
            }
        } else {
            // Nobody flagged anything, everything is a non-action item.
            // (This happens during a first pass with no action-item presenters.)
            mActionItems.clear();
            mNonActionItems.clear();
            mNonActionItems.addAll(getVisibleItems());
        }
        mIsActionItemsStale = false;
public java.util.ArrayListgetActionItems()

        flagActionItems();
        return mActionItems;
protected java.lang.StringgetActionViewStatesKey()

        return ACTION_VIEW_STATES_KEY;
public android.content.ContextgetContext()

        return mContext;
public MenuItemImplgetExpandedItem()

        return mExpandedItem;
public android.graphics.drawable.DrawablegetHeaderIcon()

        return mHeaderIcon;
public java.lang.CharSequencegetHeaderTitle()

        return mHeaderTitle;
public android.view.ViewgetHeaderView()

        return mHeaderView;
public android.view.MenuItemgetItem(int index)
{@inheritDoc}

        return mItems.get(index);
public java.util.ArrayListgetNonActionItems()

        flagActionItems();
        return mNonActionItems;
booleangetOptionalIconsVisible()

        return mOptionalIconsVisible;
private static intgetOrdering(int categoryOrder)
Returns the ordering across all items. This will grab the category from the upper bits, find out how to order the category with respect to other categories, and combine it with the lower bits.

param
categoryOrder The category order for a particular item (if it has not been or/add with a category, the default category is assumed).
return
An ordering integer that can be used to order this item across all the items (even from other categories).

        final int index = (categoryOrder & CATEGORY_MASK) >> CATEGORY_SHIFT;
        
        if (index < 0 || index >= sCategoryToOrder.length) {
            throw new IllegalArgumentException("order does not contain a valid category.");
        }
        
        return (sCategoryToOrder[index] << CATEGORY_SHIFT) | (categoryOrder & USER_MASK);
android.content.res.ResourcesgetResources()

        return mResources;
public com.android.internal.view.menu.MenuBuildergetRootMenu()
Gets the root menu (if this is a submenu, find its root menu).

return
The root menu.

        return this;
public java.util.ArrayListgetVisibleItems()

        if (!mIsVisibleItemsStale) return mVisibleItems;
        
        // Refresh the visible items
        mVisibleItems.clear();
        
        final int itemsSize = mItems.size(); 
        MenuItemImpl item;
        for (int i = 0; i < itemsSize; i++) {
            item = mItems.get(i);
            if (item.isVisible()) mVisibleItems.add(item);
        }
        
        mIsVisibleItemsStale = false;
        mIsActionItemsStale = true;
        
        return mVisibleItems;
public booleanhasVisibleItems()

        final int size = size();

        for (int i = 0; i < size; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.isVisible()) {
                return true;
            }
        }

        return false;
booleanisQwertyMode()

return
whether the menu shortcuts are in qwerty mode or not

        return mQwertyMode;
public booleanisShortcutKey(int keyCode, android.view.KeyEvent event)

        return findItemWithShortcutForKey(keyCode, event) != null;
public booleanisShortcutsVisible()

return
Whether shortcuts should be visible on menus.

        return mShortcutsVisible;
voidonItemActionRequestChanged(MenuItemImpl item)
Called by {@link MenuItemImpl} when its action request status is changed.

param
item The item that has gone through a change in action request status.

        // Notify of items being changed
        mIsActionItemsStale = true;
        onItemsChanged(true);
voidonItemVisibleChanged(MenuItemImpl item)
Called by {@link MenuItemImpl} when its visible flag is changed.

param
item The item that has gone through a visibility change.

        // Notify of items being changed
        mIsVisibleItemsStale = true;
        onItemsChanged(true);
public voidonItemsChanged(boolean structureChanged)
Called when an item is added or removed.

param
structureChanged true if the menu structure changed, false if only item properties changed. (Visibility is a structural property since it affects layout.)

        if (!mPreventDispatchingItemsChanged) {
            if (structureChanged) {
                mIsVisibleItemsStale = true;
                mIsActionItemsStale = true;
            }

            dispatchPresenterUpdate(structureChanged);
        } else {
            mItemsChangedWhileDispatchPrevented = true;
        }
public booleanperformIdentifierAction(int id, int flags)

        // Look for an item whose identifier is the id.
        return performItemAction(findItem(id), flags);
public booleanperformItemAction(android.view.MenuItem item, int flags)

        return performItemAction(item, null, flags);
public booleanperformItemAction(android.view.MenuItem item, MenuPresenter preferredPresenter, int flags)

        MenuItemImpl itemImpl = (MenuItemImpl) item;
        
        if (itemImpl == null || !itemImpl.isEnabled()) {
            return false;
        }

        boolean invoked = itemImpl.invoke();

        final ActionProvider provider = item.getActionProvider();
        final boolean providerHasSubMenu = provider != null && provider.hasSubMenu();
        if (itemImpl.hasCollapsibleActionView()) {
            invoked |= itemImpl.expandActionView();
            if (invoked) close(true);
        } else if (itemImpl.hasSubMenu() || providerHasSubMenu) {
            close(false);

            if (!itemImpl.hasSubMenu()) {
                itemImpl.setSubMenu(new SubMenuBuilder(getContext(), this, itemImpl));
            }

            final SubMenuBuilder subMenu = (SubMenuBuilder) itemImpl.getSubMenu();
            if (providerHasSubMenu) {
                provider.onPrepareSubMenu(subMenu);
            }
            invoked |= dispatchSubMenuSelected(subMenu, preferredPresenter);
            if (!invoked) close(true);
        } else {
            if ((flags & FLAG_PERFORM_NO_CLOSE) == 0) {
                close(true);
            }
        }
        
        return invoked;
public booleanperformShortcut(int keyCode, android.view.KeyEvent event, int flags)

        final MenuItemImpl item = findItemWithShortcutForKey(keyCode, event);

        boolean handled = false;
        
        if (item != null) {
            handled = performItemAction(item, flags);
        }
        
        if ((flags & FLAG_ALWAYS_PERFORM_CLOSE) != 0) {
            close(true);
        }
        
        return handled;
public voidremoveGroup(int group)

        final int i = findGroupIndex(group);

        if (i >= 0) {
            final int maxRemovable = mItems.size() - i;
            int numRemoved = 0;
            while ((numRemoved++ < maxRemovable) && (mItems.get(i).getGroupId() == group)) {
                // Don't force update for each one, this method will do it at the end
                removeItemAtInt(i, false);
            }
            
            // Notify menu views
            onItemsChanged(true);
        }
public voidremoveItem(int id)

        removeItemAtInt(findItemIndex(id), true);
public voidremoveItemAt(int index)

        removeItemAtInt(index, true);
private voidremoveItemAtInt(int index, boolean updateChildrenOnMenuViews)
Remove the item at the given index and optionally forces menu views to update.

param
index The index of the item to be removed. If this index is invalid an exception is thrown.
param
updateChildrenOnMenuViews Whether to force update on menu views. Please make sure you eventually call this after your batch of removals.

        if ((index < 0) || (index >= mItems.size())) return;

        mItems.remove(index);
        
        if (updateChildrenOnMenuViews) onItemsChanged(true);
public voidremoveMenuPresenter(MenuPresenter presenter)
Remove a presenter from this menu. That presenter will no longer receive notifications of updates to this menu's data.

param
presenter The presenter to remove

        for (WeakReference<MenuPresenter> ref : mPresenters) {
            final MenuPresenter item = ref.get();
            if (item == null || item == presenter) {
                mPresenters.remove(ref);
            }
        }
public voidrestoreActionViewStates(android.os.Bundle states)

        if (states == null) {
            return;
        }

        SparseArray<Parcelable> viewStates = states.getSparseParcelableArray(
                getActionViewStatesKey());

        final int itemCount = size();
        for (int i = 0; i < itemCount; i++) {
            final MenuItem item = getItem(i);
            final View v = item.getActionView();
            if (v != null && v.getId() != View.NO_ID) {
                v.restoreHierarchyState(viewStates);
            }
            if (item.hasSubMenu()) {
                final SubMenuBuilder subMenu = (SubMenuBuilder) item.getSubMenu();
                subMenu.restoreActionViewStates(states);
            }
        }

        final int expandedId = states.getInt(EXPANDED_ACTION_VIEW_ID);
        if (expandedId > 0) {
            MenuItem itemToExpand = findItem(expandedId);
            if (itemToExpand != null) {
                itemToExpand.expandActionView();
            }
        }
public voidrestorePresenterStates(android.os.Bundle state)

        dispatchRestoreInstanceState(state);
public voidsaveActionViewStates(android.os.Bundle outStates)

        SparseArray<Parcelable> viewStates = null;

        final int itemCount = size();
        for (int i = 0; i < itemCount; i++) {
            final MenuItem item = getItem(i);
            final View v = item.getActionView();
            if (v != null && v.getId() != View.NO_ID) {
                if (viewStates == null) {
                    viewStates = new SparseArray<Parcelable>();
                }
                v.saveHierarchyState(viewStates);
                if (item.isActionViewExpanded()) {
                    outStates.putInt(EXPANDED_ACTION_VIEW_ID, item.getItemId());
                }
            }
            if (item.hasSubMenu()) {
                final SubMenuBuilder subMenu = (SubMenuBuilder) item.getSubMenu();
                subMenu.saveActionViewStates(outStates);
            }
        }

        if (viewStates != null) {
            outStates.putSparseParcelableArray(getActionViewStatesKey(), viewStates);
        }
public voidsavePresenterStates(android.os.Bundle outState)

        dispatchSaveInstanceState(outState);
public voidsetCallback(com.android.internal.view.menu.MenuBuilder$Callback cb)

        mCallback = cb;
public voidsetCurrentMenuInfo(android.view.ContextMenu.ContextMenuInfo menuInfo)
Sets the current menu info that is set on all items added to this menu (until this is called again with different menu info, in which case that one will be added to all subsequent item additions).

param
menuInfo The extra menu information to add.

        mCurrentMenuInfo = menuInfo;
public com.android.internal.view.menu.MenuBuildersetDefaultShowAsAction(int defaultShowAsAction)

        mDefaultShowAsAction = defaultShowAsAction;
        return this;
voidsetExclusiveItemChecked(android.view.MenuItem item)

        final int group = item.getGroupId();
        
        final int N = mItems.size();
        for (int i = 0; i < N; i++) {
            MenuItemImpl curItem = mItems.get(i);
            if (curItem.getGroupId() == group) {
                if (!curItem.isExclusiveCheckable()) continue;
                if (!curItem.isCheckable()) continue;
                
                // Check the item meant to be checked, uncheck the others (that are in the group)
                curItem.setCheckedInt(curItem == item);
            }
        }
public voidsetGroupCheckable(int group, boolean checkable, boolean exclusive)

        final int N = mItems.size();
       
        for (int i = 0; i < N; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.getGroupId() == group) {
                item.setExclusiveCheckable(exclusive);
                item.setCheckable(checkable);
            }
        }
public voidsetGroupEnabled(int group, boolean enabled)

        final int N = mItems.size();

        for (int i = 0; i < N; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.getGroupId() == group) {
                item.setEnabled(enabled);
            }
        }
public voidsetGroupVisible(int group, boolean visible)

        final int N = mItems.size();

        // We handle the notification of items being changed ourselves, so we use setVisibleInt rather
        // than setVisible and at the end notify of items being changed
        
        boolean changedAtLeastOneItem = false;
        for (int i = 0; i < N; i++) {
            MenuItemImpl item = mItems.get(i);
            if (item.getGroupId() == group) {
                if (item.setVisibleInt(visible)) changedAtLeastOneItem = true;
            }
        }

        if (changedAtLeastOneItem) onItemsChanged(true);
protected com.android.internal.view.menu.MenuBuildersetHeaderIconInt(android.graphics.drawable.Drawable icon)
Sets the header's icon. This replaces the header view. Called by the builder-style methods of subclasses.

param
icon The new icon.
return
This MenuBuilder so additional setters can be called.

        setHeaderInternal(0, null, 0, icon, null);
        return this;
protected com.android.internal.view.menu.MenuBuildersetHeaderIconInt(int iconRes)
Sets the header's icon. This replaces the header view. Called by the builder-style methods of subclasses.

param
iconRes The new icon (as a resource ID).
return
This MenuBuilder so additional setters can be called.

        setHeaderInternal(0, null, iconRes, null, null);
        return this;
private voidsetHeaderInternal(int titleRes, java.lang.CharSequence title, int iconRes, android.graphics.drawable.Drawable icon, android.view.View view)

        final Resources r = getResources();

        if (view != null) {
            mHeaderView = view;
            
            // If using a custom view, then the title and icon aren't used
            mHeaderTitle = null;
            mHeaderIcon = null;
        } else {
            if (titleRes > 0) {
                mHeaderTitle = r.getText(titleRes);
            } else if (title != null) {
                mHeaderTitle = title;
            }
            
            if (iconRes > 0) {
                mHeaderIcon = getContext().getDrawable(iconRes);
            } else if (icon != null) {
                mHeaderIcon = icon;
            }
            
            // If using the title or icon, then a custom view isn't used
            mHeaderView = null;
        }
        
        // Notify of change
        onItemsChanged(false);
protected com.android.internal.view.menu.MenuBuildersetHeaderTitleInt(java.lang.CharSequence title)
Sets the header's title. This replaces the header view. Called by the builder-style methods of subclasses.

param
title The new title.
return
This MenuBuilder so additional setters can be called.

        setHeaderInternal(0, title, 0, null, null);
        return this;
protected com.android.internal.view.menu.MenuBuildersetHeaderTitleInt(int titleRes)
Sets the header's title. This replaces the header view. Called by the builder-style methods of subclasses.

param
titleRes The new title (as a resource ID).
return
This MenuBuilder so additional setters can be called.

        setHeaderInternal(titleRes, null, 0, null, null);
        return this;
protected com.android.internal.view.menu.MenuBuildersetHeaderViewInt(android.view.View view)
Sets the header's view. This replaces the title and icon. Called by the builder-style methods of subclasses.

param
view The new view.
return
This MenuBuilder so additional setters can be called.

        setHeaderInternal(0, null, 0, null, view);
        return this;
voidsetOptionalIconsVisible(boolean visible)

        mOptionalIconsVisible = visible;
public voidsetQwertyMode(boolean isQwerty)

        mQwertyMode = isQwerty;

        onItemsChanged(false);
public voidsetShortcutsVisible(boolean shortcutsVisible)
Sets whether the shortcuts should be visible on menus. Devices without hardware key input will never make shortcuts visible even if this method is passed 'true'.

param
shortcutsVisible Whether shortcuts should be visible (if true and a menu item does not have a shortcut defined, that item will still NOT show a shortcut)

        if (mShortcutsVisible == shortcutsVisible) return;

        setShortcutsVisibleInner(shortcutsVisible);
        onItemsChanged(false);
private voidsetShortcutsVisibleInner(boolean shortcutsVisible)

        mShortcutsVisible = shortcutsVisible
                && mResources.getConfiguration().keyboard != Configuration.KEYBOARD_NOKEYS
                && mResources.getBoolean(
                        com.android.internal.R.bool.config_showMenuShortcutsWhenKeyboardPresent);
public intsize()

        return mItems.size();
public voidstartDispatchingItemsChanged()

        mPreventDispatchingItemsChanged = false;

        if (mItemsChangedWhileDispatchPrevented) {
            mItemsChangedWhileDispatchPrevented = false;
            onItemsChanged(true);
        }
public voidstopDispatchingItemsChanged()
Stop dispatching item changed events to presenters until {@link #startDispatchingItemsChanged()} is called. Useful when many menu operations are going to be performed as a batch.

        if (!mPreventDispatchingItemsChanged) {
            mPreventDispatchingItemsChanged = true;
            mItemsChangedWhileDispatchPrevented = false;
        }