com.google.gwt.user.client.ui
Class MenuItem

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

All Implemented Interfaces:

HasHTML, HasText

public class MenuItem

extends UIObject

implements HasHTML

A widget that can be placed in a MenuBar. Menu items can either fire a Command when they are clicked, or open a cascading sub-menu.

Field Summary

Fields inherited from class java.lang.Object

typeId, typeName

Constructor Summary

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.

Method Summary

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.
void	setCommand(Command cmd) Sets the command associated with this item.
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.

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleName, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleName, isVisible, isVisible, removeStyleName, setElement, setHeight, setPixelSize, setSize, setStyleName, setStyleName, setVisible, setVisible, setWidth, sinkEvents, toString, unsinkEvents

Methods inherited from class java.lang.Object

equals, finalize, hashCode

Constructor Detail

MenuItem

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

MenuItem

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

MenuItem

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

MenuItem

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

Method Detail

getCommand

public Command getCommand()

Gets the command associated with this item.

Returns:

this item's command, or null if none exists

getHTML

public String getHTML()

Description copied from interface: HasHTML

Gets this object's contents as HTML.

Specified by:

getHTML in interface HasHTML

Returns:

the object's HTML

getParentMenu

public MenuBar getParentMenu()

Gets the menu that contains this item.

Returns:

the parent menu, or null if none exists.

getSubMenu

public MenuBar getSubMenu()

Gets the sub-menu associated with this item.

Returns:

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

getText

public String getText()

Description copied from interface: HasText

Gets this object's text.

Specified by:

getText in interface HasText

Returns:

the object's text

setCommand

public void setCommand(Command cmd)

Sets the command associated with this item.

Parameters:

cmd - the command to be associated with this item

setHTML

public void setHTML(String html)

Description copied from interface: HasHTML

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 HasText.setText(java.lang.String) whenever possible.

Specified by:

setHTML in interface HasHTML

Parameters:

html - the object's new HTML

setSubMenu

public void setSubMenu(MenuBar subMenu)

Sets the sub-menu associated with this item.

Parameters:

subMenu - this item's new sub-menu

setText

public void setText(String text)

Description copied from interface: HasText

Sets this object's text.

Specified by:

setText in interface HasText