Android - An Open Handset Alliance Project

android.widget
public class

android.widget.SubMenuBuilder

java.lang.Object
	android.widget.MenuBuilder		ContextMenu Menu
		android.widget.SubMenuBuilder	SubMenu

The model for a sub menu, which is an extension of the menu. Most methods are proxied to the parent menu.

Summary

Constants inherited from class android.widget.MenuBuilder

			Value
int	NUM_TYPES	The number of different menu types	4	0x00000004
int	TYPE_CONTEXT	The menu type that represents the context menu view	3	0x00000003
int	TYPE_EXPANDED	The menu type that represents the expanded menu view	1	0x00000001
int	TYPE_ICON	The menu type that represents the icon menu view	0	0x00000000
int	TYPE_SUB	The menu type that represents the sub menu view	2	0x00000002

Constants inherited from interface android.view.Menu

			Value
int	ALTERNATIVE	Category code for menu group and identifier integers that are alternative actions on the data that is currently displayed -- or/add this with your base value.	262144	0x00040000
int	APPEND_TO_GROUP	Flag for addIntentOptions(int, int, ComponentName, Intent[], Intent, int, Menu.Item[]): if set, do not automatically remove any existing menu items in the same group.	1	0x00000001
int	CATEGORY_MASK	This is the part of a menu group or identifier integer that supplies the category of the item.	-65536	0xffff0000
int	CATEGORY_SHIFT	Bit shift of the category portion of the group/identifier integer.	16	0x00000010
int	CONTAINER	Category code for menu group and identifier integers that are part of a container -- or/add this with your base value.	65536	0x00010000
int	FIRST	First value for group and identifier integers, for normal menu items that do not have a category.	1	0x00000001
int	NONE	Value to use for group and identifier integers when you don't care about them.	0	0x00000000
int	PERFORM_NO_CLOSE	Flag for performShortcut(int, KeyEvent, int): if set, do not close the menu after executing the shortcut.	1	0x00000001
int	SECONDARY	Category code for menu group and identifier integers that are user-supplied secondary (infrequently used) options -- or/add this with your base value.	196608	0x00030000
int	SELECTED_ALTERNATIVE	Category code for menu group and identifier integers that are alternative actions on the item that is currently selected -- or/add this with your base value.	327680	0x00050000
int	SYSTEM	Category code for menu group and identifier integers that are provided by the system -- or/add this with your base value.	131072	0x00020000
int	USER_MASK	This is the part of a menu group or identifier integer that the user can provide.	65535	0x0000ffff
int	USER_SHIFT	Bit shift of the user portion of the group/identifier integer.	0	0x00000000

Public Constructors

SubMenuBuilder(Context context, MenuBuilder parentMenu, MenuItemData item)

Public Methods

				Item	getItem()
					Gets the Menu.Item that represents this submenu in the parent menu.
				Menu	getParentMenu()
				boolean	isQwertyMode()
				boolean	isShortcutsShown()
				void	setQwertyMode(boolean isQwerty)
					Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).
				void	setShortcutsShown(boolean shortcutsShown)
					Sets whether the shortcuts should be shown on menus.

Methods inherited from class android.widget.MenuBuilder

				Item	add(int group, int id, CharSequence title, Runnable callback)
					Add a new item to the menu.
				Item	add(int group, int id, CharSequence title, int iconResId)
					Add a new item to the menu.
				Item	add(int group, int id, int titleRes, int iconResId)
					Add a new item to the menu.
				Item	add(int group, int id, CharSequence title)
					Add a new item to the menu.
				Item	add(int group, int id, int title)
					Variation on add(int, int, CharSequence) that takes a string resource identifier instead of the string itself.
				Item	add(int group, int id, int title, Runnable callback)
					Variation on add(int, int, CharSequence, Runnable) that takes a string resource identifier instead of the string itself.
				int	addIntentOptions(int group, int id, ComponentName caller, Intent[] specifics, Intent intent, int flags, Item[] outSpecificItems)
					Add a group of menu items corresponding to actions that can be performed for a particular Intent.
				SubMenu	addSubMenu(int group, int id, CharSequence title)
					Add a new sub-menu to the menu.
				SubMenu	addSubMenu(int group, int id, CharSequence title, int iconRes)
					Add a new sub-menu to the menu.
				SubMenu	addSubMenu(int group, int id, int titleRes, int iconRes)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself and a resource identifier for the icon.
				SubMenu	addSubMenu(int group, int id, int titleRes, Drawable icon)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself, and a Drawable for the icon.
				SubMenu	addSubMenu(int group, int id, int title)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself.
				SubMenu	addSubMenu(int group, int id, CharSequence title, Drawable icon)
					Add a new sub-menu to the menu.
				void	clear()
					Remove all existing items from the menu, leaving it empty as if it had just been created.
				void	clearMenuViews()
					Clears the cached menu views.
				int	findGroupIndex(int group)
					Get the index of the first menu item that is in the given group.
				Item	findItem(int id)
					Return the menu item with a particular identifier.
				int	findItemIndex(int id)
					Get the index of a menu item that has the given identifier.
				Item	get(int index)
					Retrieve the menu item object at a particular index.
				View	getMenuView(int menuType, ViewGroup parent, boolean createIfNonexistent)
					Gets a menu View that contains this menu's items.
				boolean	hasShownItems()
					Return whether the menu currently has item items that are being shown.
				boolean	isShortcutKey(int keyCode, KeyEvent event)
					Is a keypress one of the defined shortcut keys for this window.
				boolean	isShortcutsShown()
				boolean	performIdentifierAction(int id, int flags)
					Execute the menu item action associated with the given menu identifier.
				boolean	performShortcut(int keyCode, KeyEvent event, int flags)
					Execute the menu item action associated with the given shortcut character.
				void	removeGroup(int group)
					Remove all items in the given group.
				void	removeItem(int id)
					Remove the item with the given identifier.
				void	removeItemAt(int index)
					Remove the item at the given index.
				void	setCallback(Callback callback)
				void	setCurrentMenuInfo(Object menuInfo)
					Sets the current menu info that is set on all items added to this menu (until this is called again with different menu info, in which case that one will be added to all subsequent item additions).
				void	setDefaultItem(int id)
					Set the item that is initially selected when the menu is displayed.
				void	setGroupCheckable(int group, boolean checkable, boolean exclusive)
					Control whether a particular group of items can show a check mark.
				void	setGroupShown(int group, boolean shown)
					Show or hide all menu items that are in the given group.
				void	setHeader(int titleRes)
					Sets the header of the context menu to the title given in `titleRes` resource identifier.
				void	setHeader(int titleRes, Drawable icon)
					Sets the header of the context menu to the title given in `titleRes` resource identifier and the icon given in `icon` Drawable.
				void	setHeader(int titleRes, int iconRes)
					Sets the header of the context menu to the title given in `titleRes` resource identifier and the icon given in `iconRes` resource id.
				void	setHeader(CharSequence title)
					Sets the header of the context menu to the title given in `title`.
				void	setHeader(View headerView)
					Sets the header of the context menu to the View given in `headerView`.
				void	setHeader(CharSequence title, int iconRes)
					Sets the header of the context menu to the title given in `title` and the icon given in `iconRes` resource id.
				void	setHeader(CharSequence title, Drawable icon)
					Sets the header of the context menu to the title given in `title` and the icon given in `icon` Drawable.
				void	setItemCheckable(int id, boolean checkable)
					Control whether a particular item with the given identifier can display a check mark.
				void	setItemChecked(int id, boolean checked)
					Show or hide the check mark for a particular menu item selected by its identifier.
				void	setItemShown(int id, boolean shown)
					Show or hide a particular menu item selected by its identifier.
				void	setQwertyMode(boolean isQwerty)
					Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).
				void	setShortcutsShown(boolean shortcutsShown)
					Sets whether the shortcuts should be shown on menus.
				int	size()
					Get the number of items in the menu.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

	Object	clone()
		Answers a new instance of the same class as the receiver, whose slots have been filled in with the values in the slots of the receiver.
	boolean	equals(Object o)
		Compares the argument to the receiver, and answers true if they represent the same object using a class specific comparison.
	void	finalize()
		Called by the virtual machine when there are no longer any (non-weak) references to the receiver.
final	Class	getClass()
		Answers the unique instance of java.lang.Class which represents the class of the receiver.
	int	hashCode()
		Answers an integer hash code for the receiver.
final	void	notify()
		Causes one thread which is `wait` ing on the receiver to be made ready to run.
final	void	notifyAll()
		Causes all threads which are `wait` ing on the receiver to be made ready to run.
	String	toString()
		Answers a string containing a concise, human-readable description of the receiver.
final	void	wait(long time, int frac)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait(long time)
		Causes the thread which sent this message to be made not ready to run either pending some change in the receiver (as indicated by `notify` or `notifyAll`) or the expiration of the timeout.
final	void	wait()
		Causes the thread which sent this message to be made not ready to run pending some change in the receiver (as indicated by `notify` or `notifyAll`).

Methods inherited from interface android.view.SubMenu

getItem, setHeader, setHeader

Methods inherited from interface android.view.ContextMenu

setHeader, setHeader, setHeader, setHeader, setHeader, setHeader, setHeader

Methods inherited from interface android.view.Menu

				Item	add(int group, int id, CharSequence title, Runnable callback)
					Add a new item to the menu.
				Item	add(int group, int id, CharSequence title, int iconRes)
					Add a new item to the menu.
				Item	add(int group, int id, int titleRes, int iconRes)
					Add a new item to the menu.
				Item	add(int group, int id, CharSequence title)
					Add a new item to the menu.
				Item	add(int group, int id, int titleRes)
					Variation on add(int, int, CharSequence) that takes a string resource identifier instead of the string itself.
				Item	add(int group, int id, int titleRes, Runnable callback)
					Variation on add(int, int, CharSequence, Runnable) that takes a string resource identifier instead of the string itself.
				int	addIntentOptions(int group, int id, ComponentName caller, Intent[] specifics, Intent intent, int flags, Item[] outSpecificItems)
					Add a group of menu items corresponding to actions that can be performed for a particular Intent.
				SubMenu	addSubMenu(int group, int id, CharSequence title)
					Add a new sub-menu to the menu.
				SubMenu	addSubMenu(int group, int id, CharSequence title, int iconRes)
					Add a new sub-menu to the menu.
				SubMenu	addSubMenu(int group, int id, int titleRes, int iconRes)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself and a resource identifier for the icon.
				SubMenu	addSubMenu(int group, int id, int titleRes, Drawable icon)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself, and a Drawable for the icon.
				SubMenu	addSubMenu(int group, int id, int titleRes)
					Variation on addSubMenu(int, int, CharSequence) that takes a string resource identifier for the title instead of the string itself.
				SubMenu	addSubMenu(int group, int id, CharSequence title, Drawable icon)
					Add a new sub-menu to the menu.
				void	clear()
					Remove all existing items from the menu, leaving it empty as if it had just been created.
				int	findGroupIndex(int group)
					Get the index of the first menu item that is in the given group.
				Item	findItem(int id)
					Return the menu item with a particular identifier.
				int	findItemIndex(int id)
					Get the index of a menu item that has the given identifier.
				Item	get(int index)
					Retrieve the menu item object at a particular index.
				boolean	hasShownItems()
					Return whether the menu currently has item items that are being shown.
				boolean	isShortcutKey(int keyCode, KeyEvent event)
					Is a keypress one of the defined shortcut keys for this window.
				boolean	performIdentifierAction(int id, int flags)
					Execute the menu item action associated with the given menu identifier.
				boolean	performShortcut(int keyCode, KeyEvent event, int flags)
					Execute the menu item action associated with the given shortcut character.
				void	removeGroup(int group)
					Remove all items in the given group.
				void	removeItem(int id)
					Remove the item with the given identifier.
				void	removeItemAt(int index)
					Remove the item at the given index.
				void	setDefaultItem(int id)
					Set the item that is initially selected when the menu is displayed.
				void	setGroupCheckable(int group, boolean checkable, boolean exclusive)
					Control whether a particular group of items can show a check mark.
				void	setGroupShown(int group, boolean shown)
					Show or hide all menu items that are in the given group.
				void	setItemCheckable(int id, boolean checkable)
					Control whether a particular item with the given identifier can display a check mark.
				void	setItemChecked(int id, boolean checked)
					Show or hide the check mark for a particular menu item selected by its identifier.
				void	setItemShown(int id, boolean shown)
					Show or hide a particular menu item selected by its identifier.
				void	setQwertyMode(boolean isQwerty)
					Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).
				int	size()
					Get the number of items in the menu.

Details

Public Constructors

public SubMenuBuilder(Context context, MenuBuilder parentMenu, MenuItemData item)

Public Methods

public Item getItem()

Gets the Menu.Item that represents this submenu in the parent menu. Use this for setting additional item attributes.

public Menu getParentMenu()

public boolean isQwertyMode()

public boolean isShortcutsShown()

public void setQwertyMode(boolean isQwerty)

Control whether the menu should be running in qwerty mode (alphabetic shortcuts) or 12-key mode (numeric shortcuts).

public void setShortcutsShown(boolean shortcutsShown)

Sets whether the shortcuts should be shown on menus.

Parameters

shortcutsShown	Whether shortcuts should be shown (if true and a menu item does not have a shortcut defined, that item will still NOT show a shortcut)

Android - An Open Handset Alliance Project

Documentation

Goodies

android.widget.SubMenuBuilder

Summary

Constants inherited from class android.widget.MenuBuilder

Constants inherited from interface android.view.Menu

Public Constructors

Public Methods

Methods inherited from class android.widget.MenuBuilder

Methods inherited from class java.lang.Object

Methods inherited from interface android.view.SubMenu

Methods inherited from interface android.view.ContextMenu

Methods inherited from interface android.view.Menu

Details

Public Constructors

public SubMenuBuilder(Context context, MenuBuilder parentMenu, MenuItemData item)

Public Methods

public Item getItem()

public Menu getParentMenu()

public boolean isQwertyMode()

public boolean isShortcutsShown()

public void setQwertyMode(boolean isQwerty)

public void setShortcutsShown(boolean shortcutsShown)

Parameters


e.g. "intent" or "activity"