19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2006 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 179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpackage android.view; 189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 197b9c912f536925ac6ec43935d6e97506851b33d6Tor Norbyeimport android.annotation.StringRes; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.ComponentName; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface for managing the items in a menu. 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * By default, every Activity supports an options menu of actions or options. 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * You can add items to this menu and handle clicks on your additions. The 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * easiest way of adding menu items is inflating an XML file into the 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu} via {@link MenuInflater}. The easiest way of attaching code to 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clicks is via {@link Activity#onOptionsItemSelected(MenuItem)} and 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Activity#onContextItemSelected(MenuItem)}. 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Different menu types support different features: 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <ol> 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Context menus</b>: Do not support item shortcuts and item icons. 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Options menus</b>: The <b>icon menus</b> do not support item check 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * marks and only show the item's 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link MenuItem#setTitleCondensed(CharSequence) condensed title}. The 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <b>expanded menus</b> (only available if six or more menu items are visible, 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reached via the 'More' item in the icon menu) do not show item icons, and 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item check marks are discouraged. 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <li><b>Sub menus</b>: Do not support item icons, or nested sub menus. 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * </ol> 45558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * 46558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * <div class="special reference"> 47558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * <h3>Developer Guides</h3> 48558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * <p>For more information about creating menus, read the 49558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * <a href="{@docRoot}guide/topics/ui/menus.html">Menus</a> developer guide.</p> 50558459fe85f56f29a6ed6a4d0adb4a0bd6665884Joe Fernandez * </div> 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface Menu { 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is the part of an order integer that the user can provide. 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int USER_MASK = 0x0000ffff; 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Bit shift of the user portion of the order integer. 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int USER_SHIFT = 0; 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This is the part of an order integer that supplies the category of the 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_MASK = 0xffff0000; 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Bit shift of the category portion of the order integer. 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @hide 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_SHIFT = 16; 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 78e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal * A mask of all supported modifiers for MenuItem's keyboard shortcuts 79e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal */ 80e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal static final int SUPPORTED_MODIFIERS_MASK = KeyEvent.META_META_ON | KeyEvent.META_CTRL_ON 81e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal | KeyEvent.META_ALT_ON | KeyEvent.META_SHIFT_ON | KeyEvent.META_SYM_ON 82e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal | KeyEvent.META_FUNCTION_ON; 83e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal 84e631e32a1a771a36267af3f8af8b64e9365bc19ePeeyush Agarwal /** 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Value to use for group and item identifier integers when you don't care 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * about them. 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int NONE = 0; 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * First value for group and item identifier integers. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int FIRST = 1; 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // Implementation note: Keep these CATEGORY_* in sync with the category enum 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project // in attrs.xml 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Category code for the order integer for items/groups that are part of a 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * container -- or/add this with your base value. 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_CONTAINER = 0x00010000; 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Category code for the order integer for items/groups that are provided by 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the system -- or/add this with your base value. 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_SYSTEM = 0x00020000; 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Category code for the order integer for items/groups that are 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * user-supplied secondary (infrequently used) options -- or/add this with 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * your base value. 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_SECONDARY = 0x00030000; 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Category code for the order integer for items/groups that are 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * alternative actions on the data that is currently displayed -- or/add 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this with your base value. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int CATEGORY_ALTERNATIVE = 0x00040000; 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #addIntentOptions}: if set, do not automatically remove 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * any existing menu items in the same group. 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int FLAG_APPEND_TO_GROUP = 0x0001; 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #performShortcut}: if set, do not close the menu after 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executing the shortcut. 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int FLAG_PERFORM_NO_CLOSE = 0x0001; 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Flag for {@link #performShortcut(int, KeyEvent, int)}: if set, always 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * close the menu after executing the shortcut. Closing the menu also resets 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the prepared state. 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project static final int FLAG_ALWAYS_PERFORM_CLOSE = 0x0002; 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new item to the menu. This item displays the given title for its 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * label. 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The text to display for the item. 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added menu item. 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem add(CharSequence title); 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new item to the menu. This item displays the given title for its 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * label. 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param titleRes Resource identifier of title string. 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added menu item. 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1597b9c912f536925ac6ec43935d6e97506851b33d6Tor Norbye public MenuItem add(@StringRes int titleRes); 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new item to the menu. This item displays the given title for its 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * label. 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group identifier that this item should be part of. 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This can be used to define groups of items for batch state 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changes. Normally use {@link #NONE} if an item should not be in a 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * group. 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemId Unique item ID. Use {@link #NONE} if you do not need a 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unique ID. 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for the item. Use {@link #NONE} if you do not care 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * about the order. See {@link MenuItem#getOrder()}. 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The text to display for the item. 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added menu item. 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem add(int groupId, int itemId, int order, CharSequence title); 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Variation on {@link #add(int, int, int, CharSequence)} that takes a 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * string resource identifier instead of the string itself. 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group identifier that this item should be part of. 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This can also be used to define groups of items for batch state 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changes. Normally use {@link #NONE} if an item should not be in a 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * group. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemId Unique item ID. Use {@link #NONE} if you do not need a 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unique ID. 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for the item. Use {@link #NONE} if you do not care 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * about the order. See {@link MenuItem#getOrder()}. 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param titleRes Resource identifier of title string. 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added menu item. 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1937b9c912f536925ac6ec43935d6e97506851b33d6Tor Norbye public MenuItem add(int groupId, int itemId, int order, @StringRes int titleRes); 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new sub-menu to the menu. This item displays the given title for 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its label. To modify other attributes on the submenu's menu item, use 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SubMenu#getItem()}. 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The text to display for the item. 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added sub-menu 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SubMenu addSubMenu(final CharSequence title); 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new sub-menu to the menu. This item displays the given title for 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * its label. To modify other attributes on the submenu's menu item, use 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link SubMenu#getItem()}. 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param titleRes Resource identifier of title string. 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added sub-menu 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2137b9c912f536925ac6ec43935d6e97506851b33d6Tor Norbye SubMenu addSubMenu(@StringRes final int titleRes); 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a new sub-menu to the menu. This item displays the given 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>title</var> for its label. To modify other attributes on the 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * submenu's menu item, use {@link SubMenu#getItem()}. 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project *<p> 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Note that you can only have one level of sub-menus, i.e. you cannnot add 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a subMenu to a subMenu: An {@link UnsupportedOperationException} will be 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * thrown if you try. 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group identifier that this item should be part of. 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This can also be used to define groups of items for batch state 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changes. Normally use {@link #NONE} if an item should not be in a 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * group. 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemId Unique item ID. Use {@link #NONE} if you do not need a 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unique ID. 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for the item. Use {@link #NONE} if you do not care 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * about the order. See {@link MenuItem#getOrder()}. 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The text to display for the item. 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added sub-menu 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project SubMenu addSubMenu(final int groupId, final int itemId, int order, final CharSequence title); 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Variation on {@link #addSubMenu(int, int, int, CharSequence)} that takes 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a string resource identifier for the title instead of the string itself. 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group identifier that this item should be part of. 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This can also be used to define groups of items for batch state 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changes. Normally use {@link #NONE} if an item should not be in a group. 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemId Unique item ID. Use {@link #NONE} if you do not need a unique ID. 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for the item. Use {@link #NONE} if you do not care about the 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * order. See {@link MenuItem#getOrder()}. 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param titleRes Resource identifier of title string. 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The newly added sub-menu 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2507b9c912f536925ac6ec43935d6e97506851b33d6Tor Norbye SubMenu addSubMenu(int groupId, int itemId, int order, @StringRes int titleRes); 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Add a group of menu items corresponding to actions that can be performed 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for a particular Intent. The Intent is most often configured with a null 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * action, the data that the current activity is working with, and includes 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * either the {@link Intent#CATEGORY_ALTERNATIVE} or 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Intent#CATEGORY_SELECTED_ALTERNATIVE} to find activities that have 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * said they would like to be included as optional action. You can, however, 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * use any Intent you want. 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link android.content.pm.PackageManager#queryIntentActivityOptions} 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * for more * details on the <var>caller</var>, <var>specifics</var>, and 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <var>intent</var> arguments. The list returned by that function is used 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * to populate the resulting menu items. 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * All of the menu items of possible options for the intent will be added 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with the given group and id. You can use the group to control ordering of 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the items in relation to other items in the menu. Normally this function 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will automatically remove any existing items in the menu in the same 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * group and place a divider above and below the added items; this behavior 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * can be modified with the <var>flags</var> parameter. For each of the 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * generated items {@link MenuItem#setIntent} is called to associate the 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * appropriate Intent with the item; this means the activity will 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * automatically be started for you without having to do anything else. 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group identifier that the items should be part of. 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This can also be used to define groups of items for batch state 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * changes. Normally use {@link #NONE} if the items should not be in 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * a group. 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param itemId Unique item ID. Use {@link #NONE} if you do not need a 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * unique ID. 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param order The order for the items. Use {@link #NONE} if you do not 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * care about the order. See {@link MenuItem#getOrder()}. 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param caller The current activity component name as defined by 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * queryIntentActivityOptions(). 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param specifics Specific items to place first as defined by 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * queryIntentActivityOptions(). 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent Intent describing the kinds of items to populate in the 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * list as defined by queryIntentActivityOptions(). 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags Additional options controlling how the items are added. 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param outSpecificItems Optional array in which to place the menu items 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that were generated for each of the <var>specifics</var> that were 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * requested. Entries may be null if no activity was found for that 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * specific action. 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The number of menu items that were added. 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #FLAG_APPEND_TO_GROUP 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuItem#setIntent 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see android.content.pm.PackageManager#queryIntentActivityOptions 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int addIntentOptions(int groupId, int itemId, int order, 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project ComponentName caller, Intent[] specifics, 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project Intent intent, int flags, MenuItem[] outSpecificItems); 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove the item with the given identifier. 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param id The item to be removed. If there is no item with this 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * identifier, nothing happens. 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void removeItem(int id); 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove all items in the given group. 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param groupId The group to be removed. If there are no items in this 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * group, nothing happens. 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void removeGroup(int groupId); 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Remove all existing items from the menu, leaving it empty as if it had 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * just been created. 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void clear(); 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether a particular group of items can show a check mark. This 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * is similar to calling {@link MenuItem#setCheckable} on all of the menu items 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with the given group identifier, but in addition you can control whether 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this group contains a mutually-exclusive set items. This should be called 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * after the items of the group have been added to the menu. 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param group The group of items to operate on. 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param checkable Set to true to allow a check mark, false to 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * disallow. The default is false. 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param exclusive If set to true, only one item in this group can be 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * checked at a time; checking an item will automatically 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * uncheck all others in the group. If set to false, each 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item can be checked independently of the others. 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuItem#setCheckable 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuItem#setChecked 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setGroupCheckable(int group, boolean checkable, boolean exclusive); 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Show or hide all menu items that are in the given group. 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param group The group of items to operate on. 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param visible If true the items are visible, else they are hidden. 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuItem#setVisible 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setGroupVisible(int group, boolean visible); 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Enable or disable all menu items that are in the given group. 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param group The group of items to operate on. 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param enabled If true the items will be enabled, else they will be disabled. 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see MenuItem#setEnabled 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setGroupEnabled(int group, boolean enabled); 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the menu currently has item items that are visible. 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return True if there is one or more item visible, 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * else false. 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasVisibleItems(); 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the menu item with a particular identifier. 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param id The identifier to find. 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item object, or null if there is no item with 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * this identifier. 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem findItem(int id); 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the number of items in the menu. Note that this will change any 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * times items are added or removed from the menu. 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The item count. 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int size(); 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the menu item at the given index. 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param index The index of the menu item to return. 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item. 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @exception IndexOutOfBoundsException 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * when {@code index < 0 || >= size()} 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem getItem(int index); 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Closes the menu, if open. 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void close(); 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Execute the menu item action associated with the given shortcut 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * character. 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param keyCode The keycode of the shortcut key. 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param event Key event message. 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags Additional option flags or 0. 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If the given shortcut exists and is shown, returns 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * true; else returns false. 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #FLAG_PERFORM_NO_CLOSE 4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean performShortcut(int keyCode, KeyEvent event, int flags); 4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Is a keypress one of the defined shortcut keys for this window. 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param keyCode the key code from {@link KeyEvent} to check. 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param event the {@link KeyEvent} to use to help check. 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project boolean isShortcutKey(int keyCode, KeyEvent event); 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Execute the menu item action associated with the given menu identifier. 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param id Identifier associated with the menu item. 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param flags Additional option flags or 0. 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If the given identifier exists and is shown, returns 4399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * true; else returns false. 4409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #FLAG_PERFORM_NO_CLOSE 4429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean performIdentifierAction(int id, int flags); 4449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether the menu should be running in qwerty mode (alphabetic 4489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shortcuts) or 12-key mode (numeric shortcuts). 4499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param isQwerty If true the menu will use alphabetic shortcuts; else it 4519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will use numeric shortcuts. 4529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public void setQwertyMode(boolean isQwerty); 4549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project} 4559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 456