ActionMenuPresenter.java revision 6b8c69edd210ad86eb659e06681422bb29ba2123
1/* 2 * Copyright (C) 2011 The Android Open Source Project 3 * 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 7 * 8 * http://www.apache.org/licenses/LICENSE-2.0 9 * 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. 15 */ 16 17package com.android.internal.view.menu; 18 19import android.content.Context; 20import android.content.res.Configuration; 21import android.content.res.Resources; 22import android.os.Parcel; 23import android.os.Parcelable; 24import android.util.SparseBooleanArray; 25import android.view.ActionProvider; 26import android.view.MenuItem; 27import android.view.MotionEvent; 28import android.view.SoundEffectConstants; 29import android.view.View; 30import android.view.ViewConfiguration; 31import android.view.View.MeasureSpec; 32import android.view.accessibility.AccessibilityNodeInfo; 33import android.view.ViewGroup; 34import android.widget.ImageButton; 35import android.widget.ListPopupWindow; 36import android.widget.ListPopupWindow.ForwardingListener; 37 38import com.android.internal.view.ActionBarPolicy; 39import com.android.internal.view.menu.ActionMenuView.ActionMenuChildView; 40 41import java.util.ArrayList; 42 43/** 44 * MenuPresenter for building action menus as seen in the action bar and action modes. 45 */ 46public class ActionMenuPresenter extends BaseMenuPresenter 47 implements ActionProvider.SubUiVisibilityListener { 48 private static final String TAG = "ActionMenuPresenter"; 49 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; 60 61 private int mMinCellSize; 62 63 // Group IDs that have been added as actions - used temporarily, allocated here for reuse. 64 private final SparseBooleanArray mActionButtonGroups = new SparseBooleanArray(); 65 66 private View mScrapActionButtonView; 67 68 private OverflowPopup mOverflowPopup; 69 private ActionButtonSubmenu mActionButtonPopup; 70 71 private OpenOverflowRunnable mPostedOpenRunnable; 72 73 final PopupPresenterCallback mPopupPresenterCallback = new PopupPresenterCallback(); 74 int mOpenSubMenuId; 75 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); 79 } 80 81 @Override 82 public void initForMenu(Context context, MenuBuilder menu) { 83 super.initForMenu(context, menu); 84 85 final Resources res = context.getResources(); 86 87 final ActionBarPolicy abp = ActionBarPolicy.get(context); 88 if (!mReserveOverflowSet) { 89 mReserveOverflow = abp.showsOverflowMenuButton(); 90 } 91 92 if (!mWidthLimitSet) { 93 mWidthLimit = abp.getEmbeddedMenuWidthLimit(); 94 } 95 96 // Measure for initial configuration 97 if (!mMaxItemsSet) { 98 mMaxItems = abp.getMaxActionButtons(); 99 } 100 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); 107 } 108 width -= mOverflowButton.getMeasuredWidth(); 109 } else { 110 mOverflowButton = null; 111 } 112 113 mActionItemWidthLimit = width; 114 115 mMinCellSize = (int) (ActionMenuView.MIN_CELL_SIZE * res.getDisplayMetrics().density); 116 117 // Drop a scrap view as it may no longer reflect the proper context/config. 118 mScrapActionButtonView = null; 119 } 120 121 public void onConfigurationChanged(Configuration newConfig) { 122 if (!mMaxItemsSet) { 123 mMaxItems = mContext.getResources().getInteger( 124 com.android.internal.R.integer.max_action_buttons); 125 } 126 if (mMenu != null) { 127 mMenu.onItemsChanged(true); 128 } 129 } 130 131 public void setWidthLimit(int width, boolean strict) { 132 mWidthLimit = width; 133 mStrictWidthLimit = strict; 134 mWidthLimitSet = true; 135 } 136 137 public void setReserveOverflow(boolean reserveOverflow) { 138 mReserveOverflow = reserveOverflow; 139 mReserveOverflowSet = true; 140 } 141 142 public void setItemLimit(int itemCount) { 143 mMaxItems = itemCount; 144 mMaxItemsSet = true; 145 } 146 147 public void setExpandedActionViewsExclusive(boolean isExclusive) { 148 mExpandedActionViewsExclusive = isExclusive; 149 } 150 151 @Override 152 public MenuView getMenuView(ViewGroup root) { 153 MenuView result = super.getMenuView(root); 154 ((ActionMenuView) result).setPresenter(this); 155 return result; 156 } 157 158 @Override 159 public View getItemView(MenuItemImpl item, View convertView, ViewGroup parent) { 160 View actionView = item.getActionView(); 161 if (actionView == null || item.hasCollapsibleActionView()) { 162 if (!(convertView instanceof ActionMenuItemView)) { 163 convertView = null; 164 } 165 actionView = super.getItemView(item, convertView, parent); 166 } 167 actionView.setVisibility(item.isActionViewExpanded() ? View.GONE : View.VISIBLE); 168 169 final ActionMenuView menuParent = (ActionMenuView) parent; 170 final ViewGroup.LayoutParams lp = actionView.getLayoutParams(); 171 if (!menuParent.checkLayoutParams(lp)) { 172 actionView.setLayoutParams(menuParent.generateLayoutParams(lp)); 173 } 174 return actionView; 175 } 176 177 @Override 178 public void bindItemView(MenuItemImpl item, MenuView.ItemView itemView) { 179 itemView.initialize(item, 0); 180 181 final ActionMenuView menuView = (ActionMenuView) mMenuView; 182 ActionMenuItemView actionItemView = (ActionMenuItemView) itemView; 183 actionItemView.setItemInvoker(menuView); 184 } 185 186 @Override 187 public boolean shouldIncludeItem(int childIndex, MenuItemImpl item) { 188 return item.isActionButton(); 189 } 190 191 @Override 192 public void updateMenuView(boolean cleared) { 193 super.updateMenuView(cleared); 194 195 if (mMenu != null) { 196 final ArrayList<MenuItemImpl> actionItems = mMenu.getActionItems(); 197 final int count = actionItems.size(); 198 for (int i = 0; i < count; i++) { 199 final ActionProvider provider = actionItems.get(i).getActionProvider(); 200 if (provider != null) { 201 provider.setSubUiVisibilityListener(this); 202 } 203 } 204 } 205 206 final ArrayList<MenuItemImpl> nonActionItems = mMenu != null ? 207 mMenu.getNonActionItems() : null; 208 209 boolean hasOverflow = false; 210 if (mReserveOverflow && nonActionItems != null) { 211 final int count = nonActionItems.size(); 212 if (count == 1) { 213 hasOverflow = !nonActionItems.get(0).isActionViewExpanded(); 214 } else { 215 hasOverflow = count > 0; 216 } 217 } 218 219 if (hasOverflow) { 220 if (mOverflowButton == null) { 221 mOverflowButton = new OverflowMenuButton(mSystemContext); 222 } 223 ViewGroup parent = (ViewGroup) mOverflowButton.getParent(); 224 if (parent != mMenuView) { 225 if (parent != null) { 226 parent.removeView(mOverflowButton); 227 } 228 ActionMenuView menuView = (ActionMenuView) mMenuView; 229 menuView.addView(mOverflowButton, menuView.generateOverflowButtonLayoutParams()); 230 } 231 } else if (mOverflowButton != null && mOverflowButton.getParent() == mMenuView) { 232 ((ViewGroup) mMenuView).removeView(mOverflowButton); 233 } 234 235 ((ActionMenuView) mMenuView).setOverflowReserved(mReserveOverflow); 236 } 237 238 @Override 239 public boolean filterLeftoverView(ViewGroup parent, int childIndex) { 240 if (parent.getChildAt(childIndex) == mOverflowButton) return false; 241 return super.filterLeftoverView(parent, childIndex); 242 } 243 244 public boolean onSubMenuSelected(SubMenuBuilder subMenu) { 245 if (!subMenu.hasVisibleItems()) return false; 246 247 SubMenuBuilder topSubMenu = subMenu; 248 while (topSubMenu.getParentMenu() != mMenu) { 249 topSubMenu = (SubMenuBuilder) topSubMenu.getParentMenu(); 250 } 251 View anchor = findViewForItem(topSubMenu.getItem()); 252 if (anchor == null) { 253 if (mOverflowButton == null) return false; 254 anchor = mOverflowButton; 255 } 256 257 mOpenSubMenuId = subMenu.getItem().getItemId(); 258 mActionButtonPopup = new ActionButtonSubmenu(mContext, subMenu); 259 mActionButtonPopup.setAnchorView(anchor); 260 mActionButtonPopup.show(); 261 super.onSubMenuSelected(subMenu); 262 return true; 263 } 264 265 private View findViewForItem(MenuItem item) { 266 final ViewGroup parent = (ViewGroup) mMenuView; 267 if (parent == null) return null; 268 269 final int count = parent.getChildCount(); 270 for (int i = 0; i < count; i++) { 271 final View child = parent.getChildAt(i); 272 if (child instanceof MenuView.ItemView && 273 ((MenuView.ItemView) child).getItemData() == item) { 274 return child; 275 } 276 } 277 return null; 278 } 279 280 /** 281 * Display the overflow menu if one is present. 282 * @return true if the overflow menu was shown, false otherwise. 283 */ 284 public boolean showOverflowMenu() { 285 if (mReserveOverflow && !isOverflowMenuShowing() && mMenu != null && mMenuView != null && 286 mPostedOpenRunnable == null && !mMenu.getNonActionItems().isEmpty()) { 287 OverflowPopup popup = new OverflowPopup(mContext, mMenu, mOverflowButton, true); 288 mPostedOpenRunnable = new OpenOverflowRunnable(popup); 289 // Post this for later; we might still need a layout for the anchor to be right. 290 ((View) mMenuView).post(mPostedOpenRunnable); 291 292 // ActionMenuPresenter uses null as a callback argument here 293 // to indicate overflow is opening. 294 super.onSubMenuSelected(null); 295 296 return true; 297 } 298 return false; 299 } 300 301 /** 302 * Hide the overflow menu if it is currently showing. 303 * 304 * @return true if the overflow menu was hidden, false otherwise. 305 */ 306 public boolean hideOverflowMenu() { 307 if (mPostedOpenRunnable != null && mMenuView != null) { 308 ((View) mMenuView).removeCallbacks(mPostedOpenRunnable); 309 mPostedOpenRunnable = null; 310 return true; 311 } 312 313 MenuPopupHelper popup = mOverflowPopup; 314 if (popup != null) { 315 popup.dismiss(); 316 return true; 317 } 318 return false; 319 } 320 321 /** 322 * Dismiss all popup menus - overflow and submenus. 323 * @return true if popups were dismissed, false otherwise. (This can be because none were open.) 324 */ 325 public boolean dismissPopupMenus() { 326 boolean result = hideOverflowMenu(); 327 result |= hideSubMenus(); 328 return result; 329 } 330 331 /** 332 * Dismiss all submenu popups. 333 * 334 * @return true if popups were dismissed, false otherwise. (This can be because none were open.) 335 */ 336 public boolean hideSubMenus() { 337 if (mActionButtonPopup != null) { 338 mActionButtonPopup.dismiss(); 339 return true; 340 } 341 return false; 342 } 343 344 /** 345 * @return true if the overflow menu is currently showing 346 */ 347 public boolean isOverflowMenuShowing() { 348 return mOverflowPopup != null && mOverflowPopup.isShowing(); 349 } 350 351 /** 352 * @return true if space has been reserved in the action menu for an overflow item. 353 */ 354 public boolean isOverflowReserved() { 355 return mReserveOverflow; 356 } 357 358 public boolean flagActionItems() { 359 final ArrayList<MenuItemImpl> visibleItems = mMenu.getVisibleItems(); 360 final int itemsSize = visibleItems.size(); 361 int maxActions = mMaxItems; 362 int widthLimit = mActionItemWidthLimit; 363 final int querySpec = MeasureSpec.makeMeasureSpec(0, MeasureSpec.UNSPECIFIED); 364 final ViewGroup parent = (ViewGroup) mMenuView; 365 366 int requiredItems = 0; 367 int requestedItems = 0; 368 int firstActionWidth = 0; 369 boolean hasOverflow = false; 370 for (int i = 0; i < itemsSize; i++) { 371 MenuItemImpl item = visibleItems.get(i); 372 if (item.requiresActionButton()) { 373 requiredItems++; 374 } else if (item.requestsActionButton()) { 375 requestedItems++; 376 } else { 377 hasOverflow = true; 378 } 379 if (mExpandedActionViewsExclusive && item.isActionViewExpanded()) { 380 // Overflow everything if we have an expanded action view and we're 381 // space constrained. 382 maxActions = 0; 383 } 384 } 385 386 // Reserve a spot for the overflow item if needed. 387 if (mReserveOverflow && 388 (hasOverflow || requiredItems + requestedItems > maxActions)) { 389 maxActions--; 390 } 391 maxActions -= requiredItems; 392 393 final SparseBooleanArray seenGroups = mActionButtonGroups; 394 seenGroups.clear(); 395 396 int cellSize = 0; 397 int cellsRemaining = 0; 398 if (mStrictWidthLimit) { 399 cellsRemaining = widthLimit / mMinCellSize; 400 final int cellSizeRemaining = widthLimit % mMinCellSize; 401 cellSize = mMinCellSize + cellSizeRemaining / cellsRemaining; 402 } 403 404 // Flag as many more requested items as will fit. 405 for (int i = 0; i < itemsSize; i++) { 406 MenuItemImpl item = visibleItems.get(i); 407 408 if (item.requiresActionButton()) { 409 View v = getItemView(item, mScrapActionButtonView, parent); 410 if (mScrapActionButtonView == null) { 411 mScrapActionButtonView = v; 412 } 413 if (mStrictWidthLimit) { 414 cellsRemaining -= ActionMenuView.measureChildForCells(v, 415 cellSize, cellsRemaining, querySpec, 0); 416 } else { 417 v.measure(querySpec, querySpec); 418 } 419 final int measuredWidth = v.getMeasuredWidth(); 420 widthLimit -= measuredWidth; 421 if (firstActionWidth == 0) { 422 firstActionWidth = measuredWidth; 423 } 424 final int groupId = item.getGroupId(); 425 if (groupId != 0) { 426 seenGroups.put(groupId, true); 427 } 428 item.setIsActionButton(true); 429 } else if (item.requestsActionButton()) { 430 // Items in a group with other items that already have an action slot 431 // can break the max actions rule, but not the width limit. 432 final int groupId = item.getGroupId(); 433 final boolean inGroup = seenGroups.get(groupId); 434 boolean isAction = (maxActions > 0 || inGroup) && widthLimit > 0 && 435 (!mStrictWidthLimit || cellsRemaining > 0); 436 437 if (isAction) { 438 View v = getItemView(item, mScrapActionButtonView, parent); 439 if (mScrapActionButtonView == null) { 440 mScrapActionButtonView = v; 441 } 442 if (mStrictWidthLimit) { 443 final int cells = ActionMenuView.measureChildForCells(v, 444 cellSize, cellsRemaining, querySpec, 0); 445 cellsRemaining -= cells; 446 if (cells == 0) { 447 isAction = false; 448 } 449 } else { 450 v.measure(querySpec, querySpec); 451 } 452 final int measuredWidth = v.getMeasuredWidth(); 453 widthLimit -= measuredWidth; 454 if (firstActionWidth == 0) { 455 firstActionWidth = measuredWidth; 456 } 457 458 if (mStrictWidthLimit) { 459 isAction &= widthLimit >= 0; 460 } else { 461 // Did this push the entire first item past the limit? 462 isAction &= widthLimit + firstActionWidth > 0; 463 } 464 } 465 466 if (isAction && groupId != 0) { 467 seenGroups.put(groupId, true); 468 } else if (inGroup) { 469 // We broke the width limit. Demote the whole group, they all overflow now. 470 seenGroups.put(groupId, false); 471 for (int j = 0; j < i; j++) { 472 MenuItemImpl areYouMyGroupie = visibleItems.get(j); 473 if (areYouMyGroupie.getGroupId() == groupId) { 474 // Give back the action slot 475 if (areYouMyGroupie.isActionButton()) maxActions++; 476 areYouMyGroupie.setIsActionButton(false); 477 } 478 } 479 } 480 481 if (isAction) maxActions--; 482 483 item.setIsActionButton(isAction); 484 } else { 485 // Neither requires nor requests an action button. 486 item.setIsActionButton(false); 487 } 488 } 489 return true; 490 } 491 492 @Override 493 public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) { 494 dismissPopupMenus(); 495 super.onCloseMenu(menu, allMenusAreClosing); 496 } 497 498 @Override 499 public Parcelable onSaveInstanceState() { 500 SavedState state = new SavedState(); 501 state.openSubMenuId = mOpenSubMenuId; 502 return state; 503 } 504 505 @Override 506 public void onRestoreInstanceState(Parcelable state) { 507 SavedState saved = (SavedState) state; 508 if (saved.openSubMenuId > 0) { 509 MenuItem item = mMenu.findItem(saved.openSubMenuId); 510 if (item != null) { 511 SubMenuBuilder subMenu = (SubMenuBuilder) item.getSubMenu(); 512 onSubMenuSelected(subMenu); 513 } 514 } 515 } 516 517 @Override 518 public void onSubUiVisibilityChanged(boolean isVisible) { 519 if (isVisible) { 520 // Not a submenu, but treat it like one. 521 super.onSubMenuSelected(null); 522 } else { 523 mMenu.close(false); 524 } 525 } 526 527 private static class SavedState implements Parcelable { 528 public int openSubMenuId; 529 530 SavedState() { 531 } 532 533 SavedState(Parcel in) { 534 openSubMenuId = in.readInt(); 535 } 536 537 @Override 538 public int describeContents() { 539 return 0; 540 } 541 542 @Override 543 public void writeToParcel(Parcel dest, int flags) { 544 dest.writeInt(openSubMenuId); 545 } 546 547 public static final Parcelable.Creator<SavedState> CREATOR 548 = new Parcelable.Creator<SavedState>() { 549 public SavedState createFromParcel(Parcel in) { 550 return new SavedState(in); 551 } 552 553 public SavedState[] newArray(int size) { 554 return new SavedState[size]; 555 } 556 }; 557 } 558 559 private class OverflowMenuButton extends ImageButton implements ActionMenuChildView { 560 public OverflowMenuButton(Context context) { 561 super(context, null, com.android.internal.R.attr.actionOverflowButtonStyle); 562 563 setClickable(true); 564 setFocusable(true); 565 setVisibility(VISIBLE); 566 setEnabled(true); 567 568 setOnTouchListener(new ForwardingListener(this) { 569 @Override 570 public ListPopupWindow getPopup() { 571 if (mOverflowPopup == null) { 572 return null; 573 } 574 575 return mOverflowPopup.getPopup(); 576 } 577 578 @Override 579 public boolean onForwardingStarted() { 580 showOverflowMenu(); 581 return true; 582 } 583 584 @Override 585 public boolean onForwardingStopped() { 586 // Displaying the popup occurs asynchronously, so wait for 587 // the runnable to finish before deciding whether to stop 588 // forwarding. 589 if (mPostedOpenRunnable != null) { 590 return false; 591 } 592 593 hideOverflowMenu(); 594 return true; 595 } 596 }); 597 } 598 599 @Override 600 public boolean performClick() { 601 if (super.performClick()) { 602 return true; 603 } 604 605 playSoundEffect(SoundEffectConstants.CLICK); 606 showOverflowMenu(); 607 return true; 608 } 609 610 @Override 611 public boolean needsDividerBefore() { 612 return false; 613 } 614 615 @Override 616 public boolean needsDividerAfter() { 617 return false; 618 } 619 620 @Override 621 protected void onMeasure(int widthMeasureSpec, int heightMeasureSpec) { 622 if (MeasureSpec.getMode(heightMeasureSpec) == MeasureSpec.AT_MOST) { 623 // Fill available height 624 heightMeasureSpec = MeasureSpec.makeMeasureSpec( 625 MeasureSpec.getSize(heightMeasureSpec), MeasureSpec.EXACTLY); 626 } 627 super.onMeasure(widthMeasureSpec, heightMeasureSpec); 628 } 629 630 @Override 631 public void onInitializeAccessibilityNodeInfo(AccessibilityNodeInfo info) { 632 super.onInitializeAccessibilityNodeInfo(info); 633 info.setCanOpenPopup(true); 634 } 635 } 636 637 private class OverflowPopup extends MenuPopupHelper { 638 public OverflowPopup(Context context, MenuBuilder menu, View anchorView, 639 boolean overflowOnly) { 640 super(context, menu, anchorView, overflowOnly); 641 setCallback(mPopupPresenterCallback); 642 } 643 644 @Override 645 public void onDismiss() { 646 super.onDismiss(); 647 mMenu.close(); 648 mOverflowPopup = null; 649 } 650 } 651 652 private class ActionButtonSubmenu extends MenuPopupHelper { 653 private SubMenuBuilder mSubMenu; 654 655 public ActionButtonSubmenu(Context context, SubMenuBuilder subMenu) { 656 super(context, subMenu); 657 mSubMenu = subMenu; 658 659 MenuItemImpl item = (MenuItemImpl) subMenu.getItem(); 660 if (!item.isActionButton()) { 661 // Give a reasonable anchor to nested submenus. 662 setAnchorView(mOverflowButton == null ? (View) mMenuView : mOverflowButton); 663 } 664 665 setCallback(mPopupPresenterCallback); 666 667 boolean preserveIconSpacing = false; 668 final int count = subMenu.size(); 669 for (int i = 0; i < count; i++) { 670 MenuItem childItem = subMenu.getItem(i); 671 if (childItem.isVisible() && childItem.getIcon() != null) { 672 preserveIconSpacing = true; 673 break; 674 } 675 } 676 setForceShowIcon(preserveIconSpacing); 677 } 678 679 @Override 680 public void onDismiss() { 681 super.onDismiss(); 682 mActionButtonPopup = null; 683 mOpenSubMenuId = 0; 684 } 685 } 686 687 private class PopupPresenterCallback implements MenuPresenter.Callback { 688 689 @Override 690 public boolean onOpenSubMenu(MenuBuilder subMenu) { 691 if (subMenu == null) return false; 692 693 mOpenSubMenuId = ((SubMenuBuilder) subMenu).getItem().getItemId(); 694 return false; 695 } 696 697 @Override 698 public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) { 699 if (menu instanceof SubMenuBuilder) { 700 ((SubMenuBuilder) menu).getRootMenu().close(false); 701 } 702 } 703 } 704 705 private class OpenOverflowRunnable implements Runnable { 706 private OverflowPopup mPopup; 707 708 public OpenOverflowRunnable(OverflowPopup popup) { 709 mPopup = popup; 710 } 711 712 public void run() { 713 mMenu.changeMenuMode(); 714 final View menuView = (View) mMenuView; 715 if (menuView != null && menuView.getWindowToken() != null && mPopup.tryShow()) { 716 mOverflowPopup = mPopup; 717 } 718 mPostedOpenRunnable = null; 719 } 720 } 721} 722