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

Class Item

java.lang.Object

Widget

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

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

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

Direct Known Subclasses:

AdapterMenuItem, HeaderMenuItem, MenuItem, SeparatorMenuItem

public abstract class Item
extends Component
implements ActivateEvent.HasActivateHandlers<Item>, DeactivateEvent.HasDeactivateHandlers<Item>

The base class for all items that render into menus. BaseItem provides default rendering, activated state management.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Item.ItemAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected boolean	canActivate True if this item can be visually activated (defaults to false).
protected boolean	hideOnClick True to hide the containing menu after this item is clicked (defaults to true).

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
Item(Item.ItemAppearance appearance)

Method Summary

Modifier and Type	Method and Description
protected void	activate(boolean autoExpand)
HandlerRegistration	addActivateHandler(ActivateEvent.ActivateHandler<Item> handler) Adds a ActivateEvent handler.
HandlerRegistration	addBeforeSelectionHandler(<any> handler)
HandlerRegistration	addDeactivateHandler(DeactivateEvent.DeactivateHandler<Item> handler) Adds a DeactivateEvent handler.
HandlerRegistration	addSelectionHandler(<any> handler)
protected void	deactivate()
protected void	expandMenu(boolean autoActivate)
Item.ItemAppearance	getAppearance()
boolean	getHideOnClick() Returns the hide on click state.
protected void	handleClick(NativeEvent be)
boolean	isCanActivate() Returns true if the widget can be activated.
boolean	isHideOnClick() Return true if the widget can be hidden on click
protected void	onAttach()
protected void	onClick(NativeEvent be)
protected void	onDisable()
protected void	onEnable()
protected boolean	onEscape()
void	setCanActivate(boolean canActivate) Sets whether the item can be activated (defaults to false).
void	setHideOnClick(boolean hideOnClick) True to hide the containing menu after this item is clicked (defaults to true).
protected boolean	shouldDeactivate(NativeEvent ce)

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

canActivate

protected boolean canActivate

True if this item can be visually activated (defaults to false).

hideOnClick

protected boolean hideOnClick

True to hide the containing menu after this item is clicked (defaults to true).

Constructor Detail

Item

public Item(Item.ItemAppearance appearance)

Method Detail

addActivateHandler

public HandlerRegistration addActivateHandler(ActivateEvent.ActivateHandler<Item> handler)

Description copied from interface: ActivateEvent.HasActivateHandlers

Adds a ActivateEvent handler.

Specified by:

addActivateHandler in interface ActivateEvent.HasActivateHandlers<Item>

Parameters:

handler - the handler

Returns:

the registration for the event

addDeactivateHandler

public HandlerRegistration addDeactivateHandler(DeactivateEvent.DeactivateHandler<Item> handler)

Description copied from interface: DeactivateEvent.HasDeactivateHandlers

Adds a DeactivateEvent handler.

Specified by:

addDeactivateHandler in interface DeactivateEvent.HasDeactivateHandlers<Item>

Parameters:

handler - the handler

Returns:

the registration for the event

addSelectionHandler

public HandlerRegistration addSelectionHandler(<any> handler)

addBeforeSelectionHandler

public HandlerRegistration addBeforeSelectionHandler(<any> handler)

getAppearance

public Item.ItemAppearance getAppearance()

getHideOnClick

public boolean getHideOnClick()

Returns the hide on click state.

Returns:

the hide on click state

isCanActivate

public boolean isCanActivate()

Returns true if the widget can be activated.

Returns:

true if can be activated

isHideOnClick

public boolean isHideOnClick()

Return true if the widget can be hidden on click

Returns:

true if the widget can be hidden

setCanActivate

public void setCanActivate(boolean canActivate)

Sets whether the item can be activated (defaults to false).

Parameters:

canActivate - true to activate

setHideOnClick

public void setHideOnClick(boolean hideOnClick)

True to hide the containing menu after this item is clicked (defaults to true).

Parameters:

hideOnClick - true to hide, otherwise false

activate

protected void activate(boolean autoExpand)

deactivate

protected void deactivate()

expandMenu

protected void expandMenu(boolean autoActivate)

handleClick

protected void handleClick(NativeEvent be)

onClick

protected void onClick(NativeEvent be)

onDisable

protected void onDisable()

Overrides:

onDisable in class Component

onAttach

protected void onAttach()

Overrides:

onAttach in class Component

onEnable

protected void onEnable()

Overrides:

onEnable in class Component

onEscape

protected boolean onEscape()

shouldDeactivate

protected boolean shouldDeactivate(NativeEvent ce)