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 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.os.Bundle; 21696cba573e651b0e4f18a4718627c8ccecb3bda0Adam Powellimport android.util.ListScenario; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.util.SparseArray; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.Menu; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.MenuItem; 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Utility base class for creating various Menu scenarios. Configurable by the 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * number of menu items. Used @link {@link ListScenario} as a reference. 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic class MenuScenario extends Activity implements MenuItem.OnMenuItemClickListener { 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Params mParams = new Params(); 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private Menu mMenu; 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private MenuItem[] mItems; 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean[] mWasItemClicked; 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onCreate(Bundle icicle) { 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project super.onCreate(icicle); 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project dispatchInitParams(); 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private void dispatchInitParams() { 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onInitParams(mParams); 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onParamsChanged(); 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setParams(Params params) { 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mParams = params; 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project onParamsChanged(); 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void onParamsChanged() { 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mItems = new MenuItem[mParams.numItems]; 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWasItemClicked = new boolean[mParams.numItems]; 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onCreateOptionsMenu(Menu menu) { 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Safe to hold on to 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMenu = menu; 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (!mParams.shouldShowMenu) return false; 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project MenuItem item; 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < mParams.numItems; i++) { 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if ((item = onAddMenuItem(menu, i)) == null) { 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Add a default item for this position if the subclasses 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // haven't 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project CharSequence givenTitle = mParams.itemTitles.get(i); 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project item = menu.add(0, 0, 0, (givenTitle != null) ? givenTitle : ("Item " + i)); 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (item != null) { 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mItems[i] = item; 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mParams.listenForClicks) { 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project item.setOnMenuItemClickListener(this); 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project @Override 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onPrepareOptionsMenu(Menu menu) { 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Safe to hold on to 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mMenu = menu; 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mParams.shouldShowMenu; 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Override this to add an item to the menu. 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemPosition The position of the item to add (only for your 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reference). 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The item that was added to the menu, or null if nothing was 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * added. 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected MenuItem onAddMenuItem(Menu menu, int itemPosition) { 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return null; 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Override this to set the parameters for the scenario. Call through to super first. 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param params 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project protected void onInitParams(Params params) { 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Menu getMenu() { 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mMenu; 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onMenuItemClick(MenuItem item) { 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project final int position = findItemPosition(item); 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (position < 0) return false; 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project mWasItemClicked[position] = true; 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return true; 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean wasItemClicked(int position) { 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return mWasItemClicked[position]; 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Finds the position for a given Item. 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param item The item to find. 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The position, or -1 if not found. 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int findItemPosition(MenuItem item) { 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Could create reverse mapping, but optimizations aren't important (yet :P) 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project for (int i = 0; i < mParams.numItems; i++) { 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project if (mItems[i] == item) return i; 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return -1; 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public static class Params { 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Using as data structure, so no m prefix 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean shouldShowMenu = true; 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private int numItems = 10; 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private boolean listenForClicks = true; 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project private SparseArray<CharSequence> itemTitles = new SparseArray<CharSequence>(); 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setShouldShowMenu(boolean shouldShowMenu) { 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.shouldShowMenu = shouldShowMenu; 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setNumItems(int numItems) { 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.numItems = numItems; 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setListenForClicks(boolean listenForClicks) { 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project this.listenForClicks = listenForClicks; 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Params setItemTitle(int itemPos, CharSequence title) { 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project itemTitles.put(itemPos, title); 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project return this; 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 175