BaseMenuPresenter.java revision 8d02deabac62c4a68a335a7b3141795466362b89
1696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell/* 2696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Copyright (C) 2011 The Android Open Source Project 3696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 4696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Licensed under the Apache License, Version 2.0 (the "License"); 5696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * you may not use this file except in compliance with the License. 6696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * You may obtain a copy of the License at 7696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 8696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * http://www.apache.org/licenses/LICENSE-2.0 9696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 10696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Unless required by applicable law or agreed to in writing, software 11696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * distributed under the License is distributed on an "AS IS" BASIS, 12696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * See the License for the specific language governing permissions and 14696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * limitations under the License. 15696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 16696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 17696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellpackage com.android.internal.view.menu; 18696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 19696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport android.content.Context; 20696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport android.view.LayoutInflater; 21696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport android.view.View; 22696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport android.view.ViewGroup; 23696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 24696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport java.util.ArrayList; 25696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 26696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell/** 27696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Base class for MenuPresenters that have a consistent container view and item 28696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * views. Behaves similarly to an AdapterView in that existing item views will 29696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * be reused if possible when items change. 30696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 31696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellpublic abstract class BaseMenuPresenter implements MenuPresenter { 32696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected Context mContext; 33696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected MenuBuilder mMenu; 34696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected LayoutInflater mInflater; 35696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell private Callback mCallback; 36696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 37696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell private int mMenuLayoutRes; 38696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell private int mItemLayoutRes; 39696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 40696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected MenuView mMenuView; 41696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 42696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 43696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Construct a new BaseMenuPresenter. 44696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 45696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param menuLayoutRes Layout resource ID for the menu container view 46696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param itemLayoutRes Layout resource ID for a single item view 47696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 48696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public BaseMenuPresenter(int menuLayoutRes, int itemLayoutRes) { 49696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mMenuLayoutRes = menuLayoutRes; 50696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mItemLayoutRes = itemLayoutRes; 51696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 52696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 53696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell @Override 54696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public void initForMenu(Context context, MenuBuilder menu) { 55696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mContext = context; 56696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mInflater = LayoutInflater.from(mContext); 57696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mMenu = menu; 58696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 59696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 60696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell @Override 61696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public MenuView getMenuView(ViewGroup root) { 62696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (mMenuView == null) { 63696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mMenuView = (MenuView) mInflater.inflate(mMenuLayoutRes, root, false); 64696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mMenuView.initialize(mMenu); 65696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell updateMenuView(true); 66696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 67696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 68696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return mMenuView; 69696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 70696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 71696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 72696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Reuses item views when it can 73696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 74696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public void updateMenuView(boolean cleared) { 75696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mMenu.flagActionItems(); 76696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell ArrayList<MenuItemImpl> visibleItems = mMenu.getVisibleItems(); 77696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell final int itemCount = visibleItems.size(); 78696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell final ViewGroup parent = (ViewGroup) mMenuView; 79696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell int childIndex = 0; 80696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell for (int i = 0; i < itemCount; i++) { 81696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell MenuItemImpl item = visibleItems.get(i); 82696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (shouldIncludeItem(childIndex, item)) { 83696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell final View convertView = parent.getChildAt(childIndex); 84696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell final View itemView = getItemView(item, convertView, parent); 85696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (itemView != convertView) { 86696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell addItemView(itemView, childIndex); 87696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 88696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell childIndex++; 89696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 90696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 91696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 92696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell // Remove leftover views. 93696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell while (childIndex < parent.getChildCount()) { 94696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (!filterLeftoverView(parent, childIndex)) { 95696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell childIndex++; 96696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 97696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 98696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 99696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 100696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 101696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Add an item view at the given index. 102696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 103696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param itemView View to add 104696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param childIndex Index within the parent to insert at 105696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 106696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected void addItemView(View itemView, int childIndex) { 10745c515b0e962ee8ffc901872bcc9f25599ea0e78Adam Powell final ViewGroup currentParent = (ViewGroup) itemView.getParent(); 10845c515b0e962ee8ffc901872bcc9f25599ea0e78Adam Powell if (currentParent != null) { 10945c515b0e962ee8ffc901872bcc9f25599ea0e78Adam Powell currentParent.removeView(itemView); 11045c515b0e962ee8ffc901872bcc9f25599ea0e78Adam Powell } 111696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell ((ViewGroup) mMenuView).addView(itemView, childIndex); 112696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 113696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 114696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 115696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Filter the child view at index and remove it if appropriate. 116696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param parent Parent to filter from 117696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param childIndex Index to filter 118696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @return true if the child view at index was removed 119696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 120696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell protected boolean filterLeftoverView(ViewGroup parent, int childIndex) { 121696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell parent.removeViewAt(childIndex); 122696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return true; 123696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 124696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 125696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public void setCallback(Callback cb) { 126696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mCallback = cb; 127696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 128696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 129696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 130696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Create a new item view that can be re-bound to other item data later. 131696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 132696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @return The new item view 133696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 134696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public MenuView.ItemView createItemView(ViewGroup parent) { 135696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return (MenuView.ItemView) mInflater.inflate(mItemLayoutRes, parent, false); 136696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 137696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 138696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 139696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Prepare an item view for use. See AdapterView for the basic idea at work here. 140696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * This may require creating a new item view, but well-behaved implementations will 141696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * re-use the view passed as convertView if present. The returned view will be populated 142696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * with data from the item parameter. 143696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 144696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param item Item to present 145696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param convertView Existing view to reuse 146696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param parent Intended parent view - use for inflation. 147696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @return View that presents the requested menu item 148696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 149696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public View getItemView(MenuItemImpl item, View convertView, ViewGroup parent) { 150696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell MenuView.ItemView itemView; 151696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (convertView instanceof MenuView.ItemView) { 152696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell itemView = (MenuView.ItemView) convertView; 153696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } else { 154696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell itemView = createItemView(parent); 155696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 156696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell bindItemView(item, itemView); 157696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return (View) itemView; 158696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 159696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 160696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 161696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Bind item data to an existing item view. 162696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 163696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param item Item to bind 164696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param itemView View to populate with item data 165696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 166696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public abstract void bindItemView(MenuItemImpl item, MenuView.ItemView itemView); 167696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 168696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell /** 169696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * Filter item by child index and item data. 170696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * 171696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param childIndex Indended presentation index of this item 172696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @param item Item to present 173696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell * @return true if this item should be included in this menu presentation; false otherwise 174696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell */ 175696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public boolean shouldIncludeItem(int childIndex, MenuItemImpl item) { 176696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return true; 177696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 178696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 179696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public void onCloseMenu(MenuBuilder menu, boolean allMenusAreClosing) { 180696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (mCallback != null) { 181696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell mCallback.onCloseMenu(menu, allMenusAreClosing); 182696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 183696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 184696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 185696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public boolean onSubMenuSelected(SubMenuBuilder menu) { 186696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell if (mCallback != null) { 187696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return mCallback.onOpenSubMenu(menu); 188696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 189696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return false; 190696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 191696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell 192696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell public boolean flagActionItems() { 193696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell return false; 194696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell } 1958d02deabac62c4a68a335a7b3141795466362b89Adam Powell 1968d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean expandItemActionView(MenuBuilder menu, MenuItemImpl item) { 1978d02deabac62c4a68a335a7b3141795466362b89Adam Powell return false; 1988d02deabac62c4a68a335a7b3141795466362b89Adam Powell } 1998d02deabac62c4a68a335a7b3141795466362b89Adam Powell 2008d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean collapseItemActionView(MenuBuilder menu, MenuItemImpl item) { 2018d02deabac62c4a68a335a7b3141795466362b89Adam Powell return false; 2028d02deabac62c4a68a335a7b3141795466362b89Adam Powell } 203696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powell} 204