public class

MenuItem

extends UIObject
implements HasSafeHtml HasEnabled HasHTML

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.MenuItem

Class Overview

An entry in a MenuBar. Menu items can either fire a Command when they are clicked, or open a cascading sub-menu. Each menu item is assigned a unique DOM id in order to support ARIA. See Accessibility for more information.

Summary

[Expand]

Inherited Constants

From class com.google.gwt.user.client.ui.UIObject

Public Constructors
	MenuItem(SafeHtml html) Constructs a new menu item that fires a command when it is selected.
	MenuItem(SafeHtml html, Command cmd) Constructs a new menu item that fires a command when it is selected.
	MenuItem(SafeHtml html, MenuBar subMenu) Constructs a new menu item that cascades to a sub-menu when it is selected.
	MenuItem(String text, boolean asHTML, Command cmd) Constructs a new menu item that fires a command when it is selected.
	MenuItem(String text, boolean asHTML, MenuBar subMenu) Constructs a new menu item that cascades to a sub-menu when it is selected.
	MenuItem(String text, Command cmd) Constructs a new menu item that fires a command when it is selected.
	MenuItem(String text, MenuBar subMenu) Constructs a new menu item that cascades to a sub-menu when it is selected.

Public Methods
Command	getCommand() Gets the command associated with this item.
String	getHTML() Gets this object's contents as HTML.
MenuBar	getParentMenu() Gets the menu that contains this item.
MenuBar	getSubMenu() Gets the sub-menu associated with this item.
String	getText() Gets this object's text.
boolean	isEnabled() Returns true if the widget is enabled, false if not.
void	setCommand(Command cmd) Sets the command associated with this item.
void	setEnabled(boolean enabled) Sets whether this widget is enabled.
void	setHTML(SafeHtml html) Sets this object's contents via known-safe HTML.
void	setHTML(String html) Sets this object's contents via HTML.
void	setSubMenu(MenuBar subMenu) Sets the sub-menu associated with this item.
void	setText(String text) Sets this object's text.

Protected Methods
void	onEnsureDebugId(String baseID) Also sets the Debug IDs of MenuItems in the submenu of this `MenuItem` if a submenu exists.
void	setSelectionStyle(boolean selected)

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.UIObject

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.safehtml.client.HasSafeHtml

From interface com.google.gwt.user.client.ui.HasEnabled

From interface com.google.gwt.user.client.ui.HasHTML

From interface com.google.gwt.user.client.ui.HasText

Public Constructors

public MenuItem (SafeHtml html)

Constructs a new menu item that fires a command when it is selected.

Parameters

html	the item's html text

public MenuItem (SafeHtml html, Command cmd)

Constructs a new menu item that fires a command when it is selected.

Parameters

html	the item's text
cmd	the command to be fired when it is selected

public MenuItem (SafeHtml html, MenuBar subMenu)

Constructs a new menu item that cascades to a sub-menu when it is selected.

Parameters

html	the item's text
subMenu	the sub-menu to be displayed when it is selected

public MenuItem (String text, boolean asHTML, Command cmd)

Constructs a new menu item that fires a command when it is selected.

Parameters

text	the item's text
asHTML	`true` to treat the specified text as html
cmd	the command to be fired when it is selected

public MenuItem (String text, boolean asHTML, MenuBar subMenu)

Constructs a new menu item that cascades to a sub-menu when it is selected.

Parameters

text	the item's text
asHTML	`true` to treat the specified text as html
subMenu	the sub-menu to be displayed when it is selected

public MenuItem (String text, Command cmd)

Constructs a new menu item that fires a command when it is selected.

Parameters

text	the item's text
cmd	the command to be fired when it is selected

public MenuItem (String text, MenuBar subMenu)

Constructs a new menu item that cascades to a sub-menu when it is selected.

Parameters

text	the item's text
subMenu	the sub-menu to be displayed when it is selected

Public Methods

public Command getCommand ()

Gets the command associated with this item.

Returns

this item's command, or null if none exists

public String getHTML ()

Gets this object's contents as HTML.

Returns

the object's HTML

public MenuBar getParentMenu ()

Gets the menu that contains this item.

Returns

the parent menu, or null if none exists.

public MenuBar getSubMenu ()

Gets the sub-menu associated with this item.

Returns

this item's sub-menu, or null if none exists

public String getText ()

Gets this object's text.

Returns

the object's text

public boolean isEnabled ()

Returns true if the widget is enabled, false if not.

public void setCommand (Command cmd)

Sets the command associated with this item.

Parameters

cmd	the command to be associated with this item

public void setEnabled (boolean enabled)

Sets whether this widget is enabled.

Parameters

enabled	`true` to enable the widget, `false` to disable it

public void setHTML (SafeHtml html)

Sets this object's contents via known-safe HTML.

The object will behave exactly the same as when a widget's setHTML(String) method is invoked; however the SafeHtml passed to this method observes the contract that it can be used in an HTML context without causing unsafe script execution. Thus, unlike setHTML(String), using this method cannot result in Cross-Site Scripting security vulnerabilities.

Parameters

html	the object's new HTML, represented as a `SafeHtml` object

public void setHTML (String html)

Sets this object's contents via HTML. Use care when setting an object's HTML; it is an easy way to expose script-based security problems. Consider using setText(String) whenever possible.

Parameters

html	the object's new HTML

public void setSubMenu (MenuBar subMenu)

Sets the sub-menu associated with this item.

Parameters

subMenu	this item's new sub-menu

public void setText (String text)

Sets this object's text.

Parameters

text	the object's new text

Protected Methods

protected void onEnsureDebugId (String baseID)

Also sets the Debug IDs of MenuItems in the submenu of this MenuItem if a submenu exists.

Parameters

baseID	the base ID used by the main element

Interfaces

Classes

Annotations

Enums

Exceptions

MenuItem

Class Overview

Summary

Public Constructors

public MenuItem (SafeHtml html)

Parameters

public MenuItem (SafeHtml html, Command cmd)

Parameters

public MenuItem (SafeHtml html, MenuBar subMenu)

Parameters

public MenuItem (String text, boolean asHTML, Command cmd)

Parameters

public MenuItem (String text, boolean asHTML, MenuBar subMenu)

Parameters

public MenuItem (String text, Command cmd)

Parameters

public MenuItem (String text, MenuBar subMenu)

Parameters

Public Methods

public Command getCommand ()

Returns

public String getHTML ()

Returns

public MenuBar getParentMenu ()

Returns

public MenuBar getSubMenu ()

Returns

public String getText ()

Returns

public boolean isEnabled ()

public void setCommand (Command cmd)

Parameters

public void setEnabled (boolean enabled)

Parameters

public void setHTML (SafeHtml html)

Parameters

public void setHTML (String html)

Parameters

public void setSubMenu (MenuBar subMenu)

Parameters

public void setText (String text)

Parameters

Protected Methods

protected void onEnsureDebugId (String baseID)

Parameters

See Also

protected void setSelectionStyle (boolean selected)