2 * Copyright (C) 2011 The Android Open Source Project
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
8 * http://www.apache.org/licenses/LICENSE-2.0
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
17 package com.android.internal.view.menu;
19 import android.content.Context;
20 import android.content.res.Configuration;
21 import android.content.res.Resources;
22 import android.os.Parcel;
23 import android.os.Parcelable;
24 import android.util.SparseBooleanArray;
25 import android.view.ActionProvider;
26 import android.view.MenuItem;
27 import android.view.MotionEvent;
28 import android.view.SoundEffectConstants;
29 import android.view.View;
30 import android.view.ViewConfiguration;
31 import android.view.View.MeasureSpec;
32 import android.view.accessibility.AccessibilityNodeInfo;
33 import android.view.ViewGroup;
34 import android.widget.ImageButton;
35 import android.widget.ListPopupWindow;
36 import android.widget.ListPopupWindow.ForwardingListener;
38 import com.android.internal.view.ActionBarPolicy;
39 import com.android.internal.view.menu.ActionMenuView.ActionMenuChildView;
41 import java.util.ArrayList;
44 * MenuPresenter for building action menus as seen in the action bar and action modes.
46 public class ActionMenuPresenter extends BaseMenuPresenter
47 implements ActionProvider.SubUiVisibilityListener {
48 private static final String TAG = "ActionMenuPresenter";
50 private View mOverflowButton;
51 private boolean mReserveOverflow;
52 private boolean mReserveOverflowSet;
53 private int mWidthLimit;
54 private int mActionItemWidthLimit;
55 private int mMaxItems;
56 private boolean mMaxItemsSet;
57 private boolean mStrictWidthLimit;
58 private boolean mWidthLimitSet;
59 private boolean mExpandedActionViewsExclusive;
61 private int mMinCellSize;
63 // Group IDs that have been added as actions - used temporarily, allocated here for reuse.
64 private final SparseBooleanArray mActionButtonGroups = new SparseBooleanArray();
66 private View mScrapActionButtonView;
68 private OverflowPopup mOverflowPopup;
69 private ActionButtonSubmenu mActionButtonPopup;
71 private OpenOverflowRunnable mPostedOpenRunnable;
73 final PopupPresenterCallback mPopupPresenterCallback = new PopupPresenterCallback();
76 public ActionMenuPresenter(Context context) {
77 super(context, com.android.internal.R.layout.action_menu_layout,
78 com.android.internal.R.layout.action_menu_item_layout);
82 public void initForMenu(Context context, MenuBuilder menu) {
83 super.initForMenu(context, menu);
85 final Resources res = context.getResources();
87 final ActionBarPolicy abp = ActionBarPolicy.get(context);
88 if (!mReserveOverflowSet) {
89 mReserveOverflow = abp.showsOverflowMenuButton();
92 if (!mWidthLimitSet) {
93 mWidthLimit = abp.getEmbeddedMenuWidthLimit();
96 // Measure for initial configuration
98 mMaxItems = abp.getMaxActionButtons();
101 int width = mWidthLimit;
102 if (mReserveOverflow) {
103 if (mOverflowButton == null) {
104 mOverflowButton = new OverflowMenuButton(mSystemContext);
105 final int spec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED);
106 mOverflowButton.measure(spec, spec);
108 width -= mOverflowButton.getMeasuredWidth();
110 mOverflowButton = null;
113 mActionItemWidthLimit = width;
115 mMinCellSize = (int) (ActionMenuView.MIN_CELL_SIZE * res.getDisplayMetrics().density);
117 // Drop a scrap view as it may no longer reflect the proper context/config.
118 mScrapActionButtonView = null;
121 public void onConfigurationChanged(Configuration newConfig) {
123 mMaxItems = mContext.getResources().getInteger(
124 com.android.internal.R.integer.max_action_buttons);
127 mMenu.onItemsChanged(true);
131 public void setWidthLimit(int width, boolean strict) {
133 mStrictWidthLimit = strict;
134 mWidthLimitSet = true;
137 public void setReserveOverflow(boolean reserveOverflow) {
138 mReserveOverflow = reserveOverflow;
139 mReserveOverflowSet = true;
142 public void setItemLimit(int itemCount) {
143 mMaxItems = itemCount;
147 public void setExpandedActionViewsExclusive(boolean isExclusive) {
148 mExpandedActionViewsExclusive = isExclusive;
152 public MenuView getMenuView(ViewGroup root) {
153 MenuView result = super.getMenuView(root);
154 ((ActionMenuView) result).setPresenter(this);
159 public View getItemView(final MenuItemImpl item, View convertView, ViewGroup parent) {
160 View actionView = item.getActionView();
161 if (actionView == null || item.hasCollapsibleActionView()) {
162 if (!(convertView instanceof ActionMenuItemView)) {
165 actionView = super.getItemView(item, convertView, parent);
167 actionView.setVisibility(item.isActionViewExpanded() ? View.GONE : View.VISIBLE);
169 if (item.hasSubMenu()) {
170 actionView.setOnTouchListener(new ForwardingListener(actionView) {
172 public ListPopupWindow getPopup() {
173 return mActionButtonPopup != null ? mActionButtonPopup.getPopup() : null;
177 protected boolean onForwardingStarted() {
178 return onSubMenuSelected((SubMenuBuilder) item.getSubMenu());
182 protected boolean onForwardingStopped() {
183 return dismissPopupMenus();
187 actionView.setOnTouchListener(null);
190 final ActionMenuView menuParent = (ActionMenuView) parent;
191 final ViewGroup.LayoutParams lp = actionView.getLayoutParams();
192 if (!menuParent.checkLayoutParams(lp)) {
193 actionView.setLayoutParams(menuParent.generateLayoutParams(lp));
199 public void bindItemView(MenuItemImpl item, MenuView.ItemView itemView) {
200 itemView.initialize(item, 0);
202 final ActionMenuView menuView = (ActionMenuView) mMenuView;
203 ActionMenuItemView actionItemView = (ActionMenuItemView) itemView;
204 actionItemView.setItemInvoker(menuView);
208 public boolean shouldIncludeItem(int childIndex, MenuItemImpl item) {
209 return item.isActionButton();
213 public void updateMenuView(boolean cleared) {
214 super.updateMenuView(cleared);
217 final ArrayList<MenuItemImpl> actionItems = mMenu.getActionItems();
218 final int count = actionItems.size();
219 for (int i = 0; i < count; i++) {
220 final ActionProvider provider = actionItems.get(i).getActionProvider();
221 if (provider != null) {
222 provider.setSubUiVisibilityListener(this);
227 final ArrayList<MenuItemImpl> nonActionItems = mMenu != null ?
228 mMenu.getNonActionItems() : null;
230 boolean hasOverflow = false;
231 if (mReserveOverflow && nonActionItems != null) {
232 final int count = nonActionItems.size();
234 hasOverflow = !nonActionItems.get(0).isActionViewExpanded();
236 hasOverflow = count > 0;
241 if (mOverflowButton == null) {
242 mOverflowButton = new OverflowMenuButton(mSystemContext);
244 ViewGroup parent = (ViewGroup) mOverflowButton.getParent();
245 if (parent != mMenuView) {
246 if (parent != null) {
247 parent.removeView(mOverflowButton);
249 ActionMenuView menuView = (ActionMenuView) mMenuView;
250 menuView.addView(mOverflowButton, menuView.generateOverflowButtonLayoutParams());
252 } else if (mOverflowButton != null && mOverflowButton.getParent() == mMenuView) {
253 ((ViewGroup) mMenuView).removeView(mOverflowButton);
256 ((ActionMenuView) mMenuView).setOverflowReserved(mReserveOverflow);
260 public boolean filterLeftoverView(ViewGroup parent, int childIndex) {
261 if (parent.getChildAt(childIndex) == mOverflowButton) return false;
262 return super.filterLeftoverView(parent, childIndex);
265 public boolean onSubMenuSelected(SubMenuBuilder subMenu) {
266 if (!subMenu.hasVisibleItems()) return false;
268 SubMenuBuilder topSubMenu = subMenu;
269 while (topSubMenu.getParentMenu() != mMenu) {
270 topSubMenu = (SubMenuBuilder) topSubMenu.getParentMenu();
272 View anchor = findViewForItem(topSubMenu.getItem());
273 if (anchor == null) {
274 if (mOverflowButton == null) return false;
275 anchor = mOverflowButton;
278 mOpenSubMenuId = subMenu.getItem().getItemId();
279 mActionButtonPopup = new ActionButtonSubmenu(mContext, subMenu);
280 mActionButtonPopup.setAnchorView(anchor);
281 mActionButtonPopup.show();
282 super.onSubMenuSelected(subMenu);
286 private View findViewForItem(MenuItem item) {
287 final ViewGroup parent = (ViewGroup) mMenuView;
288 if (parent == null) return null;
290 final int count = parent.getChildCount();
291 for (int i = 0; i < count; i++) {
292 final View child = parent.getChildAt(i);
293 if (child instanceof MenuView.ItemView &&
294 ((MenuView.ItemView) child).getItemData() == item) {
302 * Display the overflow menu if one is present.
303 * @return true if the overflow menu was shown, false otherwise.
305 public boolean showOverflowMenu() {
306 if (mReserveOverflow && !isOverflowMenuShowing() && mMenu != null && mMenuView != null &&
307 mPostedOpenRunnable == null && !mMenu.getNonActionItems().isEmpty()) {
308 OverflowPopup popup = new OverflowPopup(mContext, mMenu, mOverflowButton, true);
309 mPostedOpenRunnable = new OpenOverflowRunnable(popup);
310 // Post this for later; we might still need a layout for the anchor to be right.
311 ((View) mMenuView).post(mPostedOpenRunnable);
313 // ActionMenuPresenter uses null as a callback argument here
314 // to indicate overflow is opening.
315 super.onSubMenuSelected(null);
323 * Hide the overflow menu if it is currently showing.
325 * @return true if the overflow menu was hidden, false otherwise.
327 public boolean hideOverflowMenu() {
328 if (mPostedOpenRunnable != null && mMenuView != null) {
329 ((View) mMenuView).removeCallbacks(mPostedOpenRunnable);
330 mPostedOpenRunnable = null;
334 MenuPopupHelper popup = mOverflowPopup;
343 * Dismiss all popup menus - overflow and submenus.
344 * @return true if popups were dismissed, false otherwise. (This can be because none were open.)
346 public boolean dismissPopupMenus() {
347 boolean result = hideOverflowMenu();
348 result |= hideSubMenus();
353 * Dismiss all submenu popups.
355 * @return true if popups were dismissed, false otherwise. (This can be because none were open.)
357 public boolean hideSubMenus() {
358 if (mActionButtonPopup != null) {
359 mActionButtonPopup.dismiss();
366 * @return true if the overflow menu is currently showing
368 public boolean isOverflowMenuShowing() {
369 return mOverflowPopup != null && mOverflowPopup.isShowing();
372 public boolean isOverflowMenuShowPending() {
373 return mPostedOpenRunnable != null || isOverflowMenuShowing();
377 * @return true if space has been reserved in the action menu for an overflow item.
379 public boolean isOverflowReserved() {
380 return mReserveOverflow;
383 public boolean flagActionItems() {
384 final ArrayList<MenuItemImpl> visibleItems = mMenu.getVisibleItems();
385 final int itemsSize = visibleItems.size();
386 int maxActions = mMaxItems;
387 int widthLimit = mActionItemWidthLimit;
388 final int querySpec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED);
389 final ViewGroup parent = (ViewGroup) mMenuView;
391 int requiredItems = 0;
392 int requestedItems = 0;
393 int firstActionWidth = 0;
394 boolean hasOverflow = false;
395 for (int i = 0; i < itemsSize; i++) {
396 MenuItemImpl item = visibleItems.get(i);
397 if (item.requiresActionButton()) {
399 } else if (item.requestsActionButton()) {
404 if (mExpandedActionViewsExclusive && item.isActionViewExpanded()) {
405 // Overflow everything if we have an expanded action view and we're
406 // space constrained.
411 // Reserve a spot for the overflow item if needed.
412 if (mReserveOverflow &&
413 (hasOverflow || requiredItems + requestedItems > maxActions)) {
416 maxActions -= requiredItems;
418 final SparseBooleanArray seenGroups = mActionButtonGroups;
422 int cellsRemaining = 0;
423 if (mStrictWidthLimit) {
424 cellsRemaining = widthLimit / mMinCellSize;
425 final int cellSizeRemaining = widthLimit % mMinCellSize;
426 cellSize = mMinCellSize + cellSizeRemaining / cellsRemaining;
429 // Flag as many more requested items as will fit.
430 for (int i = 0; i < itemsSize; i++) {
431 MenuItemImpl item = visibleItems.get(i);
433 if (item.requiresActionButton()) {
434 View v = getItemView(item, mScrapActionButtonView, parent);
435 if (mScrapActionButtonView == null) {
436 mScrapActionButtonView = v;
438 if (mStrictWidthLimit) {
439 cellsRemaining -= ActionMenuView.measureChildForCells(v,
440 cellSize, cellsRemaining, querySpec, 0);
442 v.measure(querySpec, querySpec);
444 final int measuredWidth = v.getMeasuredWidth();
445 widthLimit -= measuredWidth;
446 if (firstActionWidth == 0) {
447 firstActionWidth = measuredWidth;
449 final int groupId = item.getGroupId();
451 seenGroups.put(groupId, true);
453 item.setIsActionButton(true);
454 } else if (item.requestsActionButton()) {
455 // Items in a group with other items that already have an action slot
456 // can break the max actions rule, but not the width limit.
457 final int groupId = item.getGroupId();
458 final boolean inGroup = seenGroups.get(groupId);
459 boolean isAction = (maxActions > 0 || inGroup) && widthLimit > 0 &&
460 (!mStrictWidthLimit || cellsRemaining > 0);
463 View v = getItemView(item, mScrapActionButtonView, parent);
464 if (mScrapActionButtonView == null) {
465 mScrapActionButtonView = v;
467 if (mStrictWidthLimit) {
468 final int cells = ActionMenuView.measureChildForCells(v,
469 cellSize, cellsRemaining, querySpec, 0);
470 cellsRemaining -= cells;
475 v.measure(querySpec, querySpec);
477 final int measuredWidth = v.getMeasuredWidth();
478 widthLimit -= measuredWidth;
479 if (firstActionWidth == 0) {
480 firstActionWidth = measuredWidth;
483 if (mStrictWidthLimit) {
484 isAction &= widthLimit >= 0;
486 // Did this push the entire first item past the limit?
487 isAction &= widthLimit + firstActionWidth > 0;
491 if (isAction && groupId != 0) {
492 seenGroups.put(groupId, true);
493 } else if (inGroup) {
494 // We broke the width limit. Demote the whole group, they all overflow now.
495 seenGroups.put(groupId, false);
496 for (int j = 0; j < i; j++) {
497 MenuItemImpl areYouMyGroupie = visibleItems.get(j);
498 if (areYouMyGroupie.getGroupId() == groupId) {
499 // Give back the action slot
500 if (areYouMyGroupie.isActionButton()) maxActions++;
501 areYouMyGroupie.setIsActionButton(false);
506 if (isAction) maxActions--;
508 item.setIsActionButton(isAction);
510 // Neither requires nor requests an action button.
511 item.setIsActionButton(false);
518 public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) {
520 super.onCloseMenu(menu, allMenusAreClosing);
524 public Parcelable onSaveInstanceState() {
525 SavedState state = new SavedState();
526 state.openSubMenuId = mOpenSubMenuId;
531 public void onRestoreInstanceState(Parcelable state) {
532 SavedState saved = (SavedState) state;
533 if (saved.openSubMenuId > 0) {
534 MenuItem item = mMenu.findItem(saved.openSubMenuId);
536 SubMenuBuilder subMenu = (SubMenuBuilder) item.getSubMenu();
537 onSubMenuSelected(subMenu);
543 public void onSubUiVisibilityChanged(boolean isVisible) {
545 // Not a submenu, but treat it like one.
546 super.onSubMenuSelected(null);
552 private static class SavedState implements Parcelable {
553 public int openSubMenuId;
558 SavedState(Parcel in) {
559 openSubMenuId = in.readInt();
563 public int describeContents() {
568 public void writeToParcel(Parcel dest, int flags) {
569 dest.writeInt(openSubMenuId);
572 public static final Parcelable.Creator<SavedState> CREATOR
573 = new Parcelable.Creator<SavedState>() {
574 public SavedState createFromParcel(Parcel in) {
575 return new SavedState(in);
578 public SavedState[] newArray(int size) {
579 return new SavedState[size];
584 private class OverflowMenuButton extends ImageButton implements ActionMenuChildView {
585 public OverflowMenuButton(Context context) {
586 super(context, null, com.android.internal.R.attr.actionOverflowButtonStyle);
590 setVisibility(VISIBLE);
593 setOnTouchListener(new ForwardingListener(this) {
595 public ListPopupWindow getPopup() {
596 if (mOverflowPopup == null) {
600 return mOverflowPopup.getPopup();
604 public boolean onForwardingStarted() {
610 public boolean onForwardingStopped() {
611 // Displaying the popup occurs asynchronously, so wait for
612 // the runnable to finish before deciding whether to stop
614 if (mPostedOpenRunnable != null) {
625 public boolean performClick() {
626 if (super.performClick()) {
630 playSoundEffect(SoundEffectConstants.CLICK);
636 public boolean needsDividerBefore() {
641 public boolean needsDividerAfter() {
646 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) {
647 if (MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.AT_MOST) {
648 // Fill available height
649 heightMeasureSpec = MeasureSpec.makeMeasureSpec(
650 MeasureSpec.getSize(heightMeasureSpec), MeasureSpec.EXACTLY);
652 super.onMeasure(widthMeasureSpec, heightMeasureSpec);
656 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) {
657 super.onInitializeAccessibilityNodeInfo(info);
658 info.setCanOpenPopup(true);
662 private class OverflowPopup extends MenuPopupHelper {
663 public OverflowPopup(Context context, MenuBuilder menu, View anchorView,
664 boolean overflowOnly) {
665 super(context, menu, anchorView, overflowOnly);
666 setCallback(mPopupPresenterCallback);
670 public void onDismiss() {
673 mOverflowPopup = null;
677 private class ActionButtonSubmenu extends MenuPopupHelper {
678 private SubMenuBuilder mSubMenu;
680 public ActionButtonSubmenu(Context context, SubMenuBuilder subMenu) {
681 super(context, subMenu);
684 MenuItemImpl item = (MenuItemImpl) subMenu.getItem();
685 if (!item.isActionButton()) {
686 // Give a reasonable anchor to nested submenus.
687 setAnchorView(mOverflowButton == null ? (View) mMenuView : mOverflowButton);
690 setCallback(mPopupPresenterCallback);
692 boolean preserveIconSpacing = false;
693 final int count = subMenu.size();
694 for (int i = 0; i < count; i++) {
695 MenuItem childItem = subMenu.getItem(i);
696 if (childItem.isVisible() && childItem.getIcon() != null) {
697 preserveIconSpacing = true;
701 setForceShowIcon(preserveIconSpacing);
705 public void onDismiss() {
707 mActionButtonPopup = null;
712 private class PopupPresenterCallback implements MenuPresenter.Callback {
715 public boolean onOpenSubMenu(MenuBuilder subMenu) {
716 if (subMenu == null) return false;
718 mOpenSubMenuId = ((SubMenuBuilder) subMenu).getItem().getItemId();
723 public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) {
724 if (menu instanceof SubMenuBuilder) {
725 ((SubMenuBuilder) menu).getRootMenu().close(false);
730 private class OpenOverflowRunnable implements Runnable {
731 private OverflowPopup mPopup;
733 public OpenOverflowRunnable(OverflowPopup popup) {
738 mMenu.changeMenuMode();
739 final View menuView = (View) mMenuView;
740 if (menuView != null && menuView.getWindowToken() != null && mPopup.tryShow()) {
741 mOverflowPopup = mPopup;
743 mPostedOpenRunnable = null;