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

Class AdapterMenuItem

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

All Implemented Interfaces:

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 AdapterMenuItem
extends Item

Allows any widget to be placed in a menu. As of 2.0, any widget can be added directly to a Menu therefore reducing the need for this class. AdapterMenuItem allows arbitrary widgets to be added to Menu and also configured as Items.

For example, when adding a ComboBox to a Menu, the Menu will be closed when a item from the combo drop down list is clicked if the combo is added directly to the Menu. To stop the menu from being closed, an AdapterMenuItem can be used so that @link Item.setHideOnClick(boolean) can be called.

Nested Class Summary

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 boolean	manageFocus
protected Widget	widget The wrapped 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
AdapterMenuItem(Widget widget) Creates a new adapter.

Method Summary

Modifier and Type	Method and Description
XElement	getElement() Gets a handle to the object's underlying DOM element.
Widget	getWidget() Returns the wrapped widget.
boolean	isAttached()
boolean	isManageFocus() Returns true if the adapter manages focus for the wrapped widget.
boolean	isNeedsIndent() Returns true if the widget will be indented.
protected void	onAttach()
void	onBrowserEvent(Event event)
protected void	onClick(NativeEvent be)
protected void	onDetach()
protected void	onDisable()
protected void	onEnable()
protected boolean	onEscape()
void	setManageFocus(boolean manageFocus) True to move focus to wrapped widget when the enter key is pressed and remove focus of wrapped widget when escape is pressed (defaults to false).
void	setNeedsIndent(boolean needsIndent) True to indent the widget to account for the icon space (defaults to true).

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

activate, addActivateHandler, addBeforeSelectionHandler, addDeactivateHandler, addSelectionHandler, deactivate, expandMenu, getAppearance, getHideOnClick, handleClick, isCanActivate, setCanActivate, setHideOnClick, shouldDeactivate

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

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disable, disableContextMenu, disableEvents, enable, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getFocusEl, getFocusSupport, 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, onFocus, onHide, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, 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

widget

protected Widget widget

The wrapped widget.

manageFocus

protected boolean manageFocus

Constructor Detail

AdapterMenuItem

public AdapterMenuItem(Widget widget)

Creates a new adapter.

Parameters:

widget - the widget to be adapted

Method Detail

getElement

public XElement getElement()

Description copied from class: Component

Gets a handle to the object's underlying DOM element. This method should not be overridden. It is non-final solely to support legacy code that depends upon overriding it. If it is overridden, the subclass implementation must not return a different element than was previously set using #setElement(com.google.gwt.dom.client.Element).

Overrides:

getElement in class Component

Returns:

the object's browser element

getWidget

public Widget getWidget()

Returns the wrapped widget.

Returns:

the widget

isAttached

public boolean isAttached()

isNeedsIndent

public boolean isNeedsIndent()

Returns true if the widget will be indented.

Returns:

true if indented

onBrowserEvent

public void onBrowserEvent(Event event)

Overrides:

onBrowserEvent in class Component

setNeedsIndent

public void setNeedsIndent(boolean needsIndent)

True to indent the widget to account for the icon space (defaults to true).

Parameters:

needsIndent - true to indent

onAttach

protected void onAttach()

Overrides:

onAttach in class Item

onClick

protected void onClick(NativeEvent be)

Overrides:

onClick in class Item

onDetach

protected void onDetach()

Overrides:

onDetach in class Component

onDisable

protected void onDisable()

Overrides:

onDisable in class Item

isManageFocus

public boolean isManageFocus()

Returns true if the adapter manages focus for the wrapped widget.

Returns:

true if focus being managed

setManageFocus

public void setManageFocus(boolean manageFocus)

True to move focus to wrapped widget when the enter key is pressed and remove focus of wrapped widget when escape is pressed (defaults to false).

Parameters:

manageFocus - true to manage focus

onEnable

protected void onEnable()

Overrides:

onEnable in class Item

onEscape

protected boolean onEscape()

Overrides:

onEscape in class Item