com.sencha.gxt.widget.core.client.menu

Class MenuItem

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.menu.Item

com.sencha.gxt.widget.core.client.menu.MenuItem

All Implemented Interfaces:

HasGestureRecognizers, ActivateEvent.HasActivateHandlers<Item>, BeforeHideEvent.HasBeforeHideHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, DeactivateEvent.HasDeactivateHandlers<Item>, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasIcon, HasItemId

Direct Known Subclasses:

CheckMenuItem

public class MenuItem
extends Item
implements HasIcon

A base class for all menu items that require menu-related functionality (like sub-menus) and are not static display items. Item extends the base functionality of Item by adding menu-specific activation and click handling.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MenuItem.MenuItemAppearance

Nested classes/interfaces inherited from class com.sencha.gxt.widget.core.client.menu.Item

Item.ItemAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected SafeHtml	html
protected ImageResource	icon
protected Menu	subMenu
protected Widget	widget

Fields inherited from class com.sencha.gxt.widget.core.client.menu.Item

canActivate, hideOnClick

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
MenuItem() Creates a new item.
MenuItem(MenuItem.MenuItemAppearance menuItemAppearance) Creates a menu item with the given appearances.
MenuItem(SafeHtml html) Creates a new item with the given html.
MenuItem(SafeHtml html, <any> handler) Creates a new item with the given html and selection handler.
MenuItem(SafeHtml html, ImageResource icon) Creates a new item with the given html and icon.
MenuItem(String text, <any> handler) Creates a new item with the given text and selection handler.
MenuItem(String text, ImageResource icon) Creates a new item with the given text and icon.

Method Summary

Modifier and Type	Method and Description
protected void	activate(boolean autoExpand)
protected void	deactivate()
protected void	doAttachChildren()
protected void	doDetachChildren()
void	expandMenu() Expands the item's sub menu.
protected void	expandMenu(boolean autoActivate)
MenuItem.MenuItemAppearance	getAppearance()
String	getHTML() Returns the item's html.
ImageResource	getIcon() Returns the item's icon style.
SafeHtml	getSafeHtml() Returns the item's html.
Menu	getSubMenu() Returns the item's sub menu.
String	getText() Returns the item's text.
protected void	handleClick(NativeEvent be)
boolean	hasSubMenu() Returns true if this has a sub menu.
void	setHTML(SafeHtml html) Sets the item's html.
void	setIcon(ImageResource icon) Sets the icon.
void	setSubMenu(Menu menu) Sets the item's sub menu.
void	setText(String text) Sets the item's text.
void	setWidget(Widget widget)
protected boolean	shouldDeactivate(NativeEvent ce)

Methods inherited from class com.sencha.gxt.widget.core.client.menu.Item

addActivateHandler, addBeforeSelectionHandler, addDeactivateHandler, addSelectionHandler, getHideOnClick, isCanActivate, isHideOnClick, onAttach, onClick, onDisable, onEnable, onEscape, setCanActivate, setHideOnClick

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addGestureRecognizer, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getGestureRecognizer, getGestureRecognizerCount, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hide, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, notifyHide, notifyShow, onAfterFirstAttach, onBlur, onBrowserEvent, onDetach, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onTouch, onUnload, onWindowResize, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

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

Field Detail

icon

protected ImageResource icon

subMenu

protected Menu subMenu

html

protected SafeHtml html

widget

protected Widget widget

Constructor Detail

MenuItem

public MenuItem()

Creates a new item.

MenuItem

public MenuItem(MenuItem.MenuItemAppearance menuItemAppearance)

Creates a menu item with the given appearances.

Parameters:

menuItemAppearance - the menu item appearance

MenuItem

public MenuItem(SafeHtml html)

Creates a new item with the given html.

Parameters:

html - the item's html

MenuItem

public MenuItem(SafeHtml html,
                ImageResource icon)

Creates a new item with the given html and icon.

Parameters:

html - the item's html

icon - the item's icon

MenuItem

public MenuItem(String text,
                ImageResource icon)

Creates a new item with the given text and icon.

Parameters:

text - the item's text

icon - the item's icon

MenuItem

public MenuItem(SafeHtml html,
                <any> handler)

Creates a new item with the given html and selection handler.

Parameters:

html - the item html

handler - the selection handler

MenuItem

public MenuItem(String text,
                <any> handler)

Creates a new item with the given text and selection handler.

Parameters:

text - the item text

handler - the selection handler

Method Detail

expandMenu

public void expandMenu()

Expands the item's sub menu.

getAppearance

public MenuItem.MenuItemAppearance getAppearance()

Overrides:

getAppearance in class Item

getText

public String getText()

Returns the item's text. If text was set that contained reserved html characters, the return value will be html escaped. If html was set instead, the return value will be html.

Returns:

the text or html, depending on what was set

See Also:

getHTML()

setText

public void setText(String text)

Sets the item's text. Text that contains reserved html characters will be escaped.

Parameters:

text - the text

getSafeHtml

public SafeHtml getSafeHtml()

Returns the item's html.

Returns:

the html

getHTML

public String getHTML()

Returns the item's html.

Returns:

the html

setHTML

public void setHTML(SafeHtml html)

Sets the item's html.

Parameters:

html - the html

getIcon

public ImageResource getIcon()

Returns the item's icon style.

Specified by:

getIcon in interface HasIcon

Returns:

the icon style

setIcon

public void setIcon(ImageResource icon)

Description copied from interface: HasIcon

Sets the icon.

Specified by:

setIcon in interface HasIcon

Parameters:

icon - the icon

getSubMenu

public Menu getSubMenu()

Returns the item's sub menu.

Returns:

the sub menu

hasSubMenu

public boolean hasSubMenu()

Returns true if this has a sub menu.

Returns:

true if there is a sub menu

setSubMenu

public void setSubMenu(Menu menu)

Sets the item's sub menu.

Parameters:

menu - the sub menu

setWidget

public void setWidget(Widget widget)

activate

protected void activate(boolean autoExpand)

Overrides:

activate in class Item

deactivate

protected void deactivate()

Overrides:

deactivate in class Item

doAttachChildren

protected void doAttachChildren()

doDetachChildren

protected void doDetachChildren()

expandMenu

protected void expandMenu(boolean autoActivate)

Overrides:

expandMenu in class Item

handleClick

protected void handleClick(NativeEvent be)

Overrides:

handleClick in class Item

shouldDeactivate

protected boolean shouldDeactivate(NativeEvent ce)

Overrides:

shouldDeactivate in class Item