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

Class HeaderMenuItem

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.HeaderMenuItem

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, HasItemId

public class HeaderMenuItem
extends Item

A menu item for headings. Typically, places as the first item in a Menu.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	HeaderMenuItem.HeaderMenuItemAppearance

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

Item.ItemAppearance

Field Summary

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
HeaderMenuItem()
HeaderMenuItem(HeaderMenuItem.HeaderMenuItemAppearance appearance) Creates a new header menu item.
HeaderMenuItem(SafeHtml html)
HeaderMenuItem(SafeHtml html, HeaderMenuItem.HeaderMenuItemAppearance appearance)
HeaderMenuItem(String text)
HeaderMenuItem(String text, HeaderMenuItem.HeaderMenuItemAppearance appearance) Creates a new header menu item.

Method Summary

Modifier and Type	Method and Description
String	getHTML() Returns the item's html.
SafeHtml	getSafeHtml() Returns the item's html.
String	getText() Returns the item's text.
void	setHTML(SafeHtml html) Sets the item's html.
void	setText(String text) Sets the item's text.

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

activate, addActivateHandler, addBeforeSelectionHandler, addDeactivateHandler, addSelectionHandler, deactivate, expandMenu, getAppearance, getHideOnClick, handleClick, isCanActivate, isHideOnClick, onAttach, onClick, onDisable, onEnable, onEscape, setCanActivate, setHideOnClick, shouldDeactivate

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

Constructor Detail

HeaderMenuItem

public HeaderMenuItem(HeaderMenuItem.HeaderMenuItemAppearance appearance)

Creates a new header menu item.

Parameters:

appearance - the appearance to be used

HeaderMenuItem

public HeaderMenuItem()

HeaderMenuItem

public HeaderMenuItem(String text,
                      HeaderMenuItem.HeaderMenuItemAppearance appearance)

Creates a new header menu item.

Parameters:

text - the text

appearance - the appearance to be used

HeaderMenuItem

public HeaderMenuItem(SafeHtml html,
                      HeaderMenuItem.HeaderMenuItemAppearance appearance)

HeaderMenuItem

public HeaderMenuItem(String text)

HeaderMenuItem

public HeaderMenuItem(SafeHtml html)

Method Detail

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