MenuItem.java revision 9066cfe9886ac131c34d59ed0e2d287b0e3c0087
19066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/* 29066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Copyright (C) 2008 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 199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.app.Activity; 209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.content.Intent; 219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.graphics.drawable.Drawable; 229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.ContextMenu.ContextMenuInfo; 239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectimport android.view.View.OnCreateContextMenuListener; 249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project/** 269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface for direct access to a previously created menu item. 279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * An Item is returned by calling one of the {@link android.view.Menu#add} 299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * methods. 309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * For a feature set of specific menu types, see {@link Menu}. 329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Projectpublic interface MenuItem { 349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface definition for a callback to be invoked when a menu item is 369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clicked. 379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onContextItemSelected(MenuItem) 399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onOptionsItemSelected(MenuItem) 409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnMenuItemClickListener { 429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a menu item has been invoked. This is the first code 449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that is executed; if it returns true, no other callbacks will be 459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executed. 469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param item The menu item that was invoked. 489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Return true to consume this click and prevent others from 509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executing. 519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onMenuItemClick(MenuItem item); 539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the identifier for this menu item. The identifier can not 579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be changed after the menu is created. 589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item's identifier. 609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getItemId(); 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the group identifier that this menu item is part of. The group 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * identifier can not be changed after the menu is created. 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item's group identifier. 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getGroupId(); 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the category and order within the category of this item. This 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item will be shown before all items (within its category) that have 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * order greater than this value. 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * An order integer contains the item's category (the upper bits of the 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * integer; set by or/add the category with the order within the 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * category) and the ordering of the item within that category (the 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * lower bits). Example categories are {@link Menu#CATEGORY_SYSTEM}, 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#CATEGORY_SECONDARY}, {@link Menu#CATEGORY_ALTERNATIVE}, 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#CATEGORY_CONTAINER}. See {@link Menu} for a full list. 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The order of this item. 849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getOrder(); 869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the title associated with this item. 899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The new text to be displayed. 919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitle(CharSequence title); 949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the title associated with this item. 979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Some menu types do not sufficient space to show the full title, and 999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instead a condensed title is preferred. See {@link Menu} for more 1009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information. 1019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The resource id of the new text to be displayed. 1039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setTitleCondensed(CharSequence) 1059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitle(int title); 1089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current title of the item. 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The title. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getTitle(); 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the condensed title associated with this item. The condensed 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * title is used in situations where the normal title may be too long to 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be displayed. 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The new text to be displayed as the condensed title. 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitleCondensed(CharSequence title); 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current condensed title of the item. If a condensed 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * title was never set, it will return the normal title. 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The condensed title, if it exists. 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Otherwise the normal title. 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getTitleCondensed(); 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the icon associated with this item. This icon will not always be 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shown, so the title should be sufficient in describing this item. See 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu} for the menu types that support icons. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param icon The new icon (as a Drawable) to be displayed. 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIcon(Drawable icon); 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the icon associated with this item. This icon will not always be 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shown, so the title should be sufficient in describing this item. See 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu} for the menu types that support icons. 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method will set the resource ID of the icon which will be used to 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * lazily get the Drawable when this item is being shown. 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param iconRes The new icon (as a resource ID) to be displayed. 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIcon(int iconRes); 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the icon for this item as a Drawable (getting it from resources if it hasn't been 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * loaded before). 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The icon as a Drawable. 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Drawable getIcon(); 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the Intent associated with this item. By default there is no 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent associated with a menu item. If you set one, and nothing 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * else handles the item, then the default behavior will be to call 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Context#startActivity} with the given Intent. 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note that setIntent() can not be used with the versions of 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#add} that take a Runnable, because {@link Runnable#run} 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * does not return a value so there is no way to tell if it handled the 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. In this case it is assumed that the Runnable always handles 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the item, and the intent will never be started. 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getIntent 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The Intent to associated with the item. This Intent 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * object is <em>not</em> copied, so be careful not to 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * modify it later. 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIntent(Intent intent); 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the Intent associated with this item. This returns a 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reference to the Intent which you can change as desired to modify 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * what the Item is holding. 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setIntent 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns the last value supplied to {@link #setIntent}, or 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * null. 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Intent getIntent(); 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change both the numeric and alphabetic shortcut associated with this 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. Note that the shortcut will be triggered when the key that 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * generates the given character is pressed alone or along with with the alt 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * key. Also note that case is not significant and that alphabetic shortcut 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * characters will be displayed in lower case. 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numericChar The numeric shortcut key. This is the shortcut when 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a numeric (e.g., 12-key) keyboard. 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param alphaChar The alphabetic shortcut key. This is the shortcut when 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a keyboard with alphabetic keys. 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setShortcut(char numericChar, char alphaChar); 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the numeric shortcut associated with this item. 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numericChar The numeric shortcut key. This is the shortcut when 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a 12-key (numeric) keyboard. 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setNumericShortcut(char numericChar); 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the char for this menu item's numeric (12-key) shortcut. 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Numeric character to use as a shortcut. 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char getNumericShortcut(); 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the alphabetic shortcut associated with this item. The shortcut 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be triggered when the key that generates the given character is 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * pressed alone or along with with the alt key. Case is not significant and 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shortcut characters will be displayed in lower case. Note that menu items 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with the characters '\b' or '\n' as shortcuts will get triggered by the 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Delete key or Carriage Return key, respectively. 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param alphaChar The alphabetic shortcut key. This is the shortcut when 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a keyboard with alphabetic keys. 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setAlphabeticShortcut(char alphaChar); 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the char for this menu item's alphabetic shortcut. 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Alphabetic character to use as a shortcut. 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char getAlphabeticShortcut(); 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether this item can display a check mark. Setting this does 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not actually display a check mark (see {@link #setChecked} for that); 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * rather, it ensures there is room in the item in which to display a 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * check mark. 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support check marks. 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param checkable Set to true to allow a check mark, false to 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * disallow. The default is false. 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setChecked 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #isCheckable 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Menu#setGroupCheckable 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setCheckable(boolean checkable); 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the item can currently display a check mark. 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If a check mark can be displayed, returns true. 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setCheckable 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isCheckable(); 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether this item is shown with a check mark. Note that you 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * must first have enabled checking with {@link #setCheckable} or else 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the check mark will not appear. If this item is a member of a group that contains 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mutually-exclusive items (set via {@link Menu#setGroupCheckable(int, boolean, boolean)}, 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the other items in the group will be unchecked. 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support check marks. 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setCheckable 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #isChecked 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Menu#setGroupCheckable 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param checked Set to true to display a check mark, false to hide 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it. The default value is false. 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setChecked(boolean checked); 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the item is currently displaying a check mark. 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If a check mark is displayed, returns true. 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setChecked 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isChecked(); 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the visibility of the menu item. Even if a menu item is not visible, 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it may still be invoked via its shortcut (to completely disable an item, 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * set it to invisible and {@link #setEnabled(boolean) disabled}). 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param visible If true then the item will be visible; if false it is 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * hidden. 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setVisible(boolean visible); 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the visibility of the menu item. 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true the item is visible; else it is hidden. 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isVisible(); 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether the menu item is enabled. Disabling a menu item will not 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * allow it to be invoked via its shortcut. The menu item will still be 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * visible. 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param enabled If true then the item will be invokable; if false it is 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * won't be invokable. 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setEnabled(boolean enabled); 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the enabled state of the menu item. 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true the item is enabled and hence invokable; else it is not. 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isEnabled(); 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check whether this item has an associated sub-menu. I.e. it is a 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sub-menu of another menu. 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true this item has a menu; else it is a 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * normal item. 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasSubMenu(); 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the sub-menu to be invoked when this item is selected, if it has 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one. See {@link #hasSubMenu()}. 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The associated menu if there is one, else null 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SubMenu getSubMenu(); 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set a custom listener for invocation of this menu item. In most 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * situations, it is more efficient and easier to use 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Activity#onOptionsItemSelected(MenuItem)} or 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Activity#onContextItemSelected(MenuItem)}. 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param menuItemClickListener The object to receive invokations. 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onOptionsItemSelected(MenuItem) 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onContextItemSelected(MenuItem) 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setOnMenuItemClickListener(MenuItem.OnMenuItemClickListener menuItemClickListener); 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the extra information linked to this menu item. This extra 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information is set by the View that added this menu item to the 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * menu. 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see OnCreateContextMenuListener 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The extra information linked to the View that added this 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * menu item to the menu. This can be null. 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public ContextMenuInfo getMenuInfo(); 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}