19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2007 The Android Open Source Project 39066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 49066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Licensed under the Apache License, Version 2.0 (the "License"); 59066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * you may not use this file except in compliance with the License. 69066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You may obtain a copy of the License at 79066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 89066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * http://www.apache.org/licenses/LICENSE-2.0 99066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Unless required by applicable law or agreed to in writing, software 119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * distributed under the License is distributed on an "AS IS" BASIS, 129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See the License for the specific language governing permissions and 149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * limitations under the License. 159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 171d3165f10b12165f02b7015ac1a817c5f60e6399Neal Nguyenpackage android.view.menu; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 191d3165f10b12165f02b7015ac1a817c5f60e6399Neal Nguyenimport android.util.ListScenario; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport com.android.internal.view.menu.MenuBuilder; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport com.android.internal.view.menu.MenuBuilder.MenuAdapter; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.SparseArray; 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.Menu; 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.MenuItem; 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.View; 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Utility base class for creating various Menu scenarios. Configurable by the 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * number of menu items. Used @link {@link ListScenario} as a reference. 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class MenuScenario extends Activity implements MenuItem.OnMenuItemClickListener { 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Params mParams = new Params(); 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Menu mMenu; 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private MenuItem[] mItems; 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean[] mWasItemClicked; 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private MenuAdapter[] mMenuAdapters = new MenuAdapter[MenuBuilder.NUM_TYPES]; 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onCreate(Bundle icicle) { 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.onCreate(icicle); 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dispatchInitParams(); 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void dispatchInitParams() { 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onInitParams(mParams); 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onParamsChanged(); 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setParams(Params params) { 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mParams = params; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onParamsChanged(); 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onParamsChanged() { 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mItems = new MenuItem[mParams.numItems]; 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWasItemClicked = new boolean[mParams.numItems]; 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onCreateOptionsMenu(Menu menu) { 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Safe to hold on to 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMenu = menu; 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mParams.shouldShowMenu) return false; 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MenuItem item; 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < mParams.numItems; i++) { 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((item = onAddMenuItem(menu, i)) == null) { 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Add a default item for this position if the subclasses 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // haven't 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CharSequence givenTitle = mParams.itemTitles.get(i); 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project item = menu.add(0, 0, 0, (givenTitle != null) ? givenTitle : ("Item " + i)); 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (item != null) { 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mItems[i] = item; 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mParams.listenForClicks) { 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project item.setOnMenuItemClickListener(this); 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onPrepareOptionsMenu(Menu menu) { 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Safe to hold on to 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMenu = menu; 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mParams.shouldShowMenu; 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Override this to add an item to the menu. 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemPosition The position of the item to add (only for your 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reference). 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The item that was added to the menu, or null if nothing was 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * added. 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected MenuItem onAddMenuItem(Menu menu, int itemPosition) { 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Override this to set the parameters for the scenario. Call through to super first. 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param params 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onInitParams(Params params) { 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Menu getMenu() { 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMenu; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onMenuItemClick(MenuItem item) { 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int position = findItemPosition(item); 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (position < 0) return false; 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWasItemClicked[position] = true; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean wasItemClicked(int position) { 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mWasItemClicked[position]; 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Finds the position for a given Item. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param item The item to find. 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The position, or -1 if not found. 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int findItemPosition(MenuItem item) { 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Could create reverse mapping, but optimizations aren't important (yet :P) 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < mParams.numItems; i++) { 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mItems[i] == item) return i; 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return -1; 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuBuilder#getMenuAdapter(int) 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuAdapter getMenuAdapter(int menuType) { 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mMenuAdapters[menuType] == null) { 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMenuAdapters[menuType] = ((MenuBuilder) mMenu).getMenuAdapter(menuType); 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMenuAdapters[menuType]; 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets a menu view. Call this after you're sure it has been shown, 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * otherwise it may not have the proper layout_* attributes set. 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param menuType The type of menu. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The MenuView for that type. 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public View getMenuView(int menuType) { 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return ((MenuBuilder) mMenu).getMenuView(menuType, null); 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the menu item view for a given position. 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param menuType The type of menu. 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param position The position of the item. 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item view for the given item in the given menu type. 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public View getItemView(int menuType, int position) { 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return getMenuAdapter(menuType).getView(position, null, null); 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static class Params { 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Using as data structure, so no m prefix 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean shouldShowMenu = true; 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int numItems = 10; 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean listenForClicks = true; 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private SparseArray<CharSequence> itemTitles = new SparseArray<CharSequence>(); 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setShouldShowMenu(boolean shouldShowMenu) { 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.shouldShowMenu = shouldShowMenu; 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setNumItems(int numItems) { 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.numItems = numItems; 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setListenForClicks(boolean listenForClicks) { 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.listenForClicks = listenForClicks; 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setItemTitle(int itemPos, CharSequence title) { 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project itemTitles.put(itemPos, title); 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 213