MenuItem.java revision 51ac0e94a83cfccb5105aa14df1077729a5b4ccc
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 { 3489e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell /* 3589e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * These should be kept in sync with attrs.xml enum constants for showAsAction 3689e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell */ 3789e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell /** Never show this item as a button in an Action Bar. */ 3889e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell public static final int SHOW_AS_ACTION_NEVER = 0; 3989e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell /** Show this item as a button in an Action Bar if the system decides there is room for it. */ 4089e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell public static final int SHOW_AS_ACTION_IF_ROOM = 1; 4189e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell /** 4289e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * Always show this item as a button in an Action Bar. 4389e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * Use sparingly! If too many items are set to always show in the Action Bar it can 4489e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * crowd the Action Bar and degrade the user experience on devices with smaller screens. 4589e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * A good rule of thumb is to have no more than 2 items set to always show at a time. 4689e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell */ 4789e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell public static final int SHOW_AS_ACTION_ALWAYS = 2; 48d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell 49d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell /** 50d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell * When this item is in the action bar, always show it with a text label even if 51d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell * it also has an icon specified. 52d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell */ 53d8404b23739b135060ab9a04317a9f8b990cf8caAdam Powell public static final int SHOW_AS_ACTION_WITH_TEXT = 4; 548d02deabac62c4a68a335a7b3141795466362b89Adam Powell 558d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 568d02deabac62c4a68a335a7b3141795466362b89Adam Powell * This item's action view collapses to a normal menu item. 578d02deabac62c4a68a335a7b3141795466362b89Adam Powell * When expanded, the action view temporarily takes over 588d02deabac62c4a68a335a7b3141795466362b89Adam Powell * a larger segment of its container. 598d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 608d02deabac62c4a68a335a7b3141795466362b89Adam Powell public static final int SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW = 8; 6189e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell 629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Interface definition for a callback to be invoked when a menu item is 649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * clicked. 659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onContextItemSelected(MenuItem) 679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onOptionsItemSelected(MenuItem) 689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public interface OnMenuItemClickListener { 709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Called when a menu item has been invoked. This is the first code 729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * that is executed; if it returns true, no other callbacks will be 739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executed. 749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param item The menu item that was invoked. 769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Return true to consume this click and prevent others from 789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * executing. 799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean onMenuItemClick(MenuItem item); 819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project } 829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 848d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Interface definition for a callback to be invoked when a menu item 858d02deabac62c4a68a335a7b3141795466362b89Adam Powell * marked with {@link MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW} is 868d02deabac62c4a68a335a7b3141795466362b89Adam Powell * expanded or collapsed. 878d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 888d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see MenuItem#expandActionView() 898d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see MenuItem#collapseActionView() 908d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see MenuItem#setShowAsActionFlags(int) 918d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 928d02deabac62c4a68a335a7b3141795466362b89Adam Powell public interface OnActionExpandListener { 938d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 948d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Called when a menu item with {@link MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW} 958d02deabac62c4a68a335a7b3141795466362b89Adam Powell * is expanded. 968d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @param item Item that was expanded 978d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return true if the item should expand, false if expansion should be suppressed. 988d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 998d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean onMenuItemActionExpand(MenuItem item); 1008d02deabac62c4a68a335a7b3141795466362b89Adam Powell 1018d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 1028d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Called when a menu item with {@link MenuItem#SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW} 1038d02deabac62c4a68a335a7b3141795466362b89Adam Powell * is collapsed. 1048d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @param item Item that was collapsed 1058d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return true if the item should collapse, false if collapsing should be suppressed. 1068d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 1078d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean onMenuItemActionCollapse(MenuItem item); 1088d02deabac62c4a68a335a7b3141795466362b89Adam Powell } 1098d02deabac62c4a68a335a7b3141795466362b89Adam Powell 1108d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 1119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the identifier for this menu item. The identifier can not 1129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be changed after the menu is created. 1139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item's identifier. 1159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getItemId(); 1179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the group identifier that this menu item is part of. The group 1209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * identifier can not be changed after the menu is created. 1219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The menu item's group identifier. 1239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getGroupId(); 1259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the category and order within the category of this item. This 1289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item will be shown before all items (within its category) that have 1299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * order greater than this value. 1309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 1319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * An order integer contains the item's category (the upper bits of the 1329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * integer; set by or/add the category with the order within the 1339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * category) and the ordering of the item within that category (the 1349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * lower bits). Example categories are {@link Menu#CATEGORY_SYSTEM}, 1359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#CATEGORY_SECONDARY}, {@link Menu#CATEGORY_ALTERNATIVE}, 1369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#CATEGORY_CONTAINER}. See {@link Menu} for a full list. 1379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The order of this item. 1399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public int getOrder(); 1419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the title associated with this item. 1449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The new text to be displayed. 1469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitle(CharSequence title); 1499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the title associated with this item. 1529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 1539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Some menu types do not sufficient space to show the full title, and 1549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * instead a condensed title is preferred. See {@link Menu} for more 1559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information. 1569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The resource id of the new text to be displayed. 1589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setTitleCondensed(CharSequence) 1609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitle(int title); 1639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current title of the item. 1669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The title. 1689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getTitle(); 1709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the condensed title associated with this item. The condensed 1739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * title is used in situations where the normal title may be too long to 1749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * be displayed. 1759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param title The new text to be displayed as the condensed title. 1779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setTitleCondensed(CharSequence title); 1809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Retrieve the current condensed title of the item. If a condensed 1839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * title was never set, it will return the normal title. 1849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The condensed title, if it exists. 1869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Otherwise the normal title. 1879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public CharSequence getTitleCondensed(); 1899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 1909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 1919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the icon associated with this item. This icon will not always be 1929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shown, so the title should be sufficient in describing this item. See 1939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu} for the menu types that support icons. 1949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 1959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param icon The new icon (as a Drawable) to be displayed. 1969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 1979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 1989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIcon(Drawable icon); 1999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the icon associated with this item. This icon will not always be 2029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shown, so the title should be sufficient in describing this item. See 2039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu} for the menu types that support icons. 2049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * This method will set the resource ID of the icon which will be used to 2069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * lazily get the Drawable when this item is being shown. 2079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param iconRes The new icon (as a resource ID) to be displayed. 2099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIcon(int iconRes); 2129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Returns the icon for this item as a Drawable (getting it from resources if it hasn't been 2159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * loaded before). 2169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The icon as a Drawable. 2189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Drawable getIcon(); 2209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the Intent associated with this item. By default there is no 2239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Intent associated with a menu item. If you set one, and nothing 2249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * else handles the item, then the default behavior will be to call 2259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link android.content.Context#startActivity} with the given Intent. 2269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p>Note that setIntent() can not be used with the versions of 2289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Menu#add} that take a Runnable, because {@link Runnable#run} 2299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * does not return a value so there is no way to tell if it handled the 2309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. In this case it is assumed that the Runnable always handles 2319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the item, and the intent will never be started. 2329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #getIntent 2349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param intent The Intent to associated with the item. This Intent 2359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * object is <em>not</em> copied, so be careful not to 2369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * modify it later. 2379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setIntent(Intent intent); 2409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the Intent associated with this item. This returns a 2439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * reference to the Intent which you can change as desired to modify 2449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * what the Item is holding. 2459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setIntent 2479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Returns the last value supplied to {@link #setIntent}, or 2489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * null. 2499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public Intent getIntent(); 2519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change both the numeric and alphabetic shortcut associated with this 2549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * item. Note that the shortcut will be triggered when the key that 2559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * generates the given character is pressed alone or along with with the alt 2569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * key. Also note that case is not significant and that alphabetic shortcut 2579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * characters will be displayed in lower case. 2589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numericChar The numeric shortcut key. This is the shortcut when 2629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a numeric (e.g., 12-key) keyboard. 2639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param alphaChar The alphabetic shortcut key. This is the shortcut when 2649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a keyboard with alphabetic keys. 2659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setShortcut(char numericChar, char alphaChar); 2689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the numeric shortcut associated with this item. 2719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param numericChar The numeric shortcut key. This is the shortcut when 2759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a 12-key (numeric) keyboard. 2769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 2779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setNumericShortcut(char numericChar); 2799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the char for this menu item's numeric (12-key) shortcut. 2829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Numeric character to use as a shortcut. 2849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 2859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char getNumericShortcut(); 2869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 2879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 2889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Change the alphabetic shortcut associated with this item. The shortcut 2899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * will be triggered when the key that generates the given character is 2909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * pressed alone or along with with the alt key. Case is not significant and 2919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * shortcut characters will be displayed in lower case. Note that menu items 2929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * with the characters '\b' or '\n' as shortcuts will get triggered by the 2939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Delete key or Carriage Return key, respectively. 2949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 2959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support shortcuts. 2969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 2979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param alphaChar The alphabetic shortcut key. This is the shortcut when 2989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * using a keyboard with alphabetic keys. 2999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setAlphabeticShortcut(char alphaChar); 3029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the char for this menu item's alphabetic shortcut. 3059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return Alphabetic character to use as a shortcut. 3079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public char getAlphabeticShortcut(); 3099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether this item can display a check mark. Setting this does 3129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * not actually display a check mark (see {@link #setChecked} for that); 3139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * rather, it ensures there is room in the item in which to display a 3149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * check mark. 3159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 3169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support check marks. 3179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param checkable Set to true to allow a check mark, false to 3199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * disallow. The default is false. 3209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setChecked 3219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #isCheckable 3229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Menu#setGroupCheckable 3239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setCheckable(boolean checkable); 3269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the item can currently display a check mark. 3299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If a check mark can be displayed, returns true. 3319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setCheckable 3339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isCheckable(); 3359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Control whether this item is shown with a check mark. Note that you 3389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * must first have enabled checking with {@link #setCheckable} or else 3399066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the check mark will not appear. If this item is a member of a group that contains 3409066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * mutually-exclusive items (set via {@link Menu#setGroupCheckable(int, boolean, boolean)}, 3419066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * the other items in the group will be unchecked. 3429066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * <p> 3439066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * See {@link Menu} for the menu types that support check marks. 3449066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3459066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setCheckable 3469066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #isChecked 3479066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Menu#setGroupCheckable 3489066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param checked Set to true to display a check mark, false to hide 3499066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it. The default value is false. 3509066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3519066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3529066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setChecked(boolean checked); 3539066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3549066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3559066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return whether the item is currently displaying a check mark. 3569066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3579066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If a check mark is displayed, returns true. 3589066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3599066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see #setChecked 3609066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3619066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isChecked(); 3629066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3639066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3649066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets the visibility of the menu item. Even if a menu item is not visible, 3659066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * it may still be invoked via its shortcut (to completely disable an item, 3669066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * set it to invisible and {@link #setEnabled(boolean) disabled}). 3679066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3689066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param visible If true then the item will be visible; if false it is 3699066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * hidden. 3709066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3719066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3729066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setVisible(boolean visible); 3739066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3749066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3759066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the visibility of the menu item. 3769066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3779066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true the item is visible; else it is hidden. 3789066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3799066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isVisible(); 3809066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3819066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3829066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Sets whether the menu item is enabled. Disabling a menu item will not 3839066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * allow it to be invoked via its shortcut. The menu item will still be 3849066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * visible. 3859066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3869066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param enabled If true then the item will be invokable; if false it is 3879066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * won't be invokable. 3889066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 3899066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3909066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setEnabled(boolean enabled); 3919066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3929066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 3939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Return the enabled state of the menu item. 3949066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 3959066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true the item is enabled and hence invokable; else it is not. 3969066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 3979066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean isEnabled(); 3989066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 3999066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4009066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Check whether this item has an associated sub-menu. I.e. it is a 4019066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * sub-menu of another menu. 4029066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4039066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return If true this item has a menu; else it is a 4049066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * normal item. 4059066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4069066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public boolean hasSubMenu(); 4079066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4089066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4099066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Get the sub-menu to be invoked when this item is selected, if it has 4109066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * one. See {@link #hasSubMenu()}. 4119066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4129066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The associated menu if there is one, else null 4139066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4149066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public SubMenu getSubMenu(); 4159066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4169066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4179066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Set a custom listener for invocation of this menu item. In most 4189066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * situations, it is more efficient and easier to use 4199066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Activity#onOptionsItemSelected(MenuItem)} or 4209066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * {@link Activity#onContextItemSelected(MenuItem)}. 4219066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4229066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @param menuItemClickListener The object to receive invokations. 4239066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return This Item so additional setters can be called. 4249066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onOptionsItemSelected(MenuItem) 4259066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see Activity#onContextItemSelected(MenuItem) 4269066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4279066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public MenuItem setOnMenuItemClickListener(MenuItem.OnMenuItemClickListener menuItemClickListener); 4289066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project 4299066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project /** 4309066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * Gets the extra information linked to this menu item. This extra 4319066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * information is set by the View that added this menu item to the 4329066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * menu. 4339066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * 4349066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @see OnCreateContextMenuListener 4359066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * @return The extra information linked to the View that added this 4369066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project * menu item to the menu. This can be null. 4379066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project */ 4389066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project public ContextMenuInfo getMenuInfo(); 43989e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell 44089e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell /** 44189e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * Sets how this item should display in the presence of an Action Bar. 442759dc706ba61dda6b9eef80ecae2d590383229aeAdam Powell * The parameter actionEnum is a flag set. One of {@link #SHOW_AS_ACTION_ALWAYS}, 443759dc706ba61dda6b9eef80ecae2d590383229aeAdam Powell * {@link #SHOW_AS_ACTION_IF_ROOM}, or {@link #SHOW_AS_ACTION_NEVER} should 444759dc706ba61dda6b9eef80ecae2d590383229aeAdam Powell * be used, and you may optionally OR the value with {@link #SHOW_AS_ACTION_WITH_TEXT}. 445759dc706ba61dda6b9eef80ecae2d590383229aeAdam Powell * SHOW_AS_ACTION_WITH_TEXT requests that when the item is shown as an action, 446759dc706ba61dda6b9eef80ecae2d590383229aeAdam Powell * it should be shown with a text label. 44789e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * 44889e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * @param actionEnum How the item should display. One of 449ec66a3a9e06ae91e0b49a5e858e46fe0c91606f1Adam Powell * {@link #SHOW_AS_ACTION_ALWAYS}, {@link #SHOW_AS_ACTION_IF_ROOM}, or 450ec66a3a9e06ae91e0b49a5e858e46fe0c91606f1Adam Powell * {@link #SHOW_AS_ACTION_NEVER}. SHOW_AS_ACTION_NEVER is the default. 45189e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * 45289e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell * @see android.app.ActionBar 453cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @see #setActionView(View) 45489e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell */ 45589e0645b4157961e8c465eb9c819f965fdb453d8Adam Powell public void setShowAsAction(int actionEnum); 456cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell 457cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell /** 4588d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Sets how this item should display in the presence of an Action Bar. 4598d02deabac62c4a68a335a7b3141795466362b89Adam Powell * The parameter actionEnum is a flag set. One of {@link #SHOW_AS_ACTION_ALWAYS}, 4608d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #SHOW_AS_ACTION_IF_ROOM}, or {@link #SHOW_AS_ACTION_NEVER} should 4618d02deabac62c4a68a335a7b3141795466362b89Adam Powell * be used, and you may optionally OR the value with {@link #SHOW_AS_ACTION_WITH_TEXT}. 4628d02deabac62c4a68a335a7b3141795466362b89Adam Powell * SHOW_AS_ACTION_WITH_TEXT requests that when the item is shown as an action, 4638d02deabac62c4a68a335a7b3141795466362b89Adam Powell * it should be shown with a text label. 4648d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 4658d02deabac62c4a68a335a7b3141795466362b89Adam Powell * <p>Note: This method differs from {@link #setShowAsAction(int)} only in that it 4668d02deabac62c4a68a335a7b3141795466362b89Adam Powell * returns the current MenuItem instance for call chaining. 4678d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 4688d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @param actionEnum How the item should display. One of 4698d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #SHOW_AS_ACTION_ALWAYS}, {@link #SHOW_AS_ACTION_IF_ROOM}, or 4708d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #SHOW_AS_ACTION_NEVER}. SHOW_AS_ACTION_NEVER is the default. 4718d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 4728d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see android.app.ActionBar 4738d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see #setActionView(View) 4748d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return This MenuItem instance for call chaining. 4758d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 4768d02deabac62c4a68a335a7b3141795466362b89Adam Powell public MenuItem setShowAsActionFlags(int actionEnum); 4778d02deabac62c4a68a335a7b3141795466362b89Adam Powell 4788d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 479cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * Set an action view for this menu item. An action view will be displayed in place 480cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * of an automatically generated menu item element in the UI when this item is shown 481cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * as an action within a parent. 48251ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <p> 48351ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <strong>Note:</strong> Setting an action view overrides the action provider 48451ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * set via {@link #setActionProvider(ActionProvider)}. 48551ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * </p> 486cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * 487cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @param view View to use for presenting this item to the user. 488cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @return This Item so additional setters can be called. 489cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * 490cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @see #setShowAsAction(int) 491cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell */ 492cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell public MenuItem setActionView(View view); 493cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell 494cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell /** 4953f476b34049d062942eafcf48396f593e00bd324Adam Powell * Set an action view for this menu item. An action view will be displayed in place 4963f476b34049d062942eafcf48396f593e00bd324Adam Powell * of an automatically generated menu item element in the UI when this item is shown 4973f476b34049d062942eafcf48396f593e00bd324Adam Powell * as an action within a parent. 49851ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <p> 49951ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <strong>Note:</strong> Setting an action view overrides the action provider 50051ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * set via {@link #setActionProvider(ActionProvider)}. 50151ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * </p> 5023f476b34049d062942eafcf48396f593e00bd324Adam Powell * 5033f476b34049d062942eafcf48396f593e00bd324Adam Powell * @param resId Layout resource to use for presenting this item to the user. 5043f476b34049d062942eafcf48396f593e00bd324Adam Powell * @return This Item so additional setters can be called. 5053f476b34049d062942eafcf48396f593e00bd324Adam Powell * 5063f476b34049d062942eafcf48396f593e00bd324Adam Powell * @see #setShowAsAction(int) 5073f476b34049d062942eafcf48396f593e00bd324Adam Powell */ 5083f476b34049d062942eafcf48396f593e00bd324Adam Powell public MenuItem setActionView(int resId); 5093f476b34049d062942eafcf48396f593e00bd324Adam Powell 5103f476b34049d062942eafcf48396f593e00bd324Adam Powell /** 511cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * Returns the currently set action view for this menu item. 512cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * 513cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @return This item's action view 514cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * 515cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @see #setActionView(View) 516cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell * @see #setShowAsAction(int) 517cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell */ 518cf78b3e5101349fdddbde14b3a55140f9562ae66Adam Powell public View getActionView(); 5198d02deabac62c4a68a335a7b3141795466362b89Adam Powell 5208d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 52151ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * Sets the {@link ActionProvider} responsible for creating an action view if 52251ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * the item is placed on the action bar. The provider also provides a default 52351ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * action invoked if the item is placed in the overflow menu. 52451ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <p> 52551ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * <strong>Note:</strong> Setting an action provider overrides the action view 52651ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * set via {@link #setActionView(int)} or {@link #setActionView(View)}. 52751ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * </p> 52851ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * 52951ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @param actionProvider The action provider. 53051ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @return This Item so additional setters can be called. 53151ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * 53251ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @see ActionProvider 53351ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov */ 53451ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov public MenuItem setActionProvider(ActionProvider actionProvider); 53551ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov 53651ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov /** 53751ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * Gets the {@link ActionProvider}. 53851ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * 53951ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @return The action provider. 54051ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * 54151ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @see ActionProvider 54251ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov * @see #setActionProvider(ActionProvider) 54351ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov */ 54451ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov public ActionProvider getActionProvider(); 54551ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov 54651ac0e94a83cfccb5105aa14df1077729a5b4cccSvetoslav Ganov /** 5478d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Expand the action view associated with this menu item. 5488d02deabac62c4a68a335a7b3141795466362b89Adam Powell * The menu item must have an action view set, as well as 5498d02deabac62c4a68a335a7b3141795466362b89Adam Powell * the showAsAction flag {@link #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW}. 5508d02deabac62c4a68a335a7b3141795466362b89Adam Powell * If a listener has been set using {@link #setOnActionExpandListener(OnActionExpandListener)} 5518d02deabac62c4a68a335a7b3141795466362b89Adam Powell * it will have its {@link OnActionExpandListener#onMenuItemActionExpand(MenuItem)} 5528d02deabac62c4a68a335a7b3141795466362b89Adam Powell * method invoked. The listener may return false from this method to prevent expanding 5538d02deabac62c4a68a335a7b3141795466362b89Adam Powell * the action view. 5548d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 5558d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return true if the action view was expanded, false otherwise. 5568d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 5578d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean expandActionView(); 5588d02deabac62c4a68a335a7b3141795466362b89Adam Powell 5598d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 5608d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Collapse the action view associated with this menu item. 5618d02deabac62c4a68a335a7b3141795466362b89Adam Powell * The menu item must have an action view set, as well as the showAsAction flag 5628d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW}. If a listener has been set using 5638d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #setOnActionExpandListener(OnActionExpandListener)} it will have its 5648d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link OnActionExpandListener#onMenuItemActionCollapse(MenuItem)} method invoked. 5658d02deabac62c4a68a335a7b3141795466362b89Adam Powell * The listener may return false from this method to prevent collapsing the action view. 5668d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 5678d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return true if the action view was collapsed, false otherwise. 5688d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 5698d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean collapseActionView(); 5708d02deabac62c4a68a335a7b3141795466362b89Adam Powell 5718d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 5728d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Returns true if this menu item's action view has been expanded. 5738d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 5748d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return true if the item's action view is expanded, false otherwise. 5758d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 5768d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see #expandActionView() 5778d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see #collapseActionView() 5788d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW 5798d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @see OnActionExpandListener 5808d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 5818d02deabac62c4a68a335a7b3141795466362b89Adam Powell public boolean isActionViewExpanded(); 5828d02deabac62c4a68a335a7b3141795466362b89Adam Powell 5838d02deabac62c4a68a335a7b3141795466362b89Adam Powell /** 5848d02deabac62c4a68a335a7b3141795466362b89Adam Powell * Set an {@link OnActionExpandListener} on this menu item to be notified when 5858d02deabac62c4a68a335a7b3141795466362b89Adam Powell * the associated action view is expanded or collapsed. The menu item must 5868d02deabac62c4a68a335a7b3141795466362b89Adam Powell * be configured to expand or collapse its action view using the flag 5878d02deabac62c4a68a335a7b3141795466362b89Adam Powell * {@link #SHOW_AS_ACTION_COLLAPSE_ACTION_VIEW}. 5888d02deabac62c4a68a335a7b3141795466362b89Adam Powell * 5898d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @param listener Listener that will respond to expand/collapse events 5908d02deabac62c4a68a335a7b3141795466362b89Adam Powell * @return This menu item instance for call chaining 5918d02deabac62c4a68a335a7b3141795466362b89Adam Powell */ 5928d02deabac62c4a68a335a7b3141795466362b89Adam Powell public MenuItem setOnActionExpandListener(OnActionExpandListener listener); 5939066cfe9886ac131c34d59ed0e2d287b0e3c0087The Android Open Source Project}