com.extjs.gxt.ui.client.widget.menu
Class AdapterMenuItem

java.lang.Object
  extended by com.google.gwt.user.client.ui.UIObject
      extended by com.google.gwt.user.client.ui.Widget
          extended by com.extjs.gxt.ui.client.widget.Component
              extended by com.extjs.gxt.ui.client.widget.menu.Item
                  extended by com.extjs.gxt.ui.client.widget.menu.AdapterMenuItem
All Implemented Interfaces:
Observable, com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.IsWidget

public class AdapterMenuItem
extends Item

Allows any widget to be placed in a menu. As of 2.0, any component 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.google.gwt.user.client.ui.UIObject
com.google.gwt.user.client.ui.UIObject.DebugIdImpl, com.google.gwt.user.client.ui.UIObject.DebugIdImplEnabled
 
Field Summary
protected  boolean manageFocus
           
protected  com.google.gwt.user.client.ui.Widget widget
          The wrapped widget.
 
Fields inherited from class com.extjs.gxt.ui.client.widget.menu.Item
canActivate, hideOnClick, parentMenu
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Component
afterRender, attachables, baseStyle, disabled, disabledStyle, disableTextSelection, dummy, focusable, hidden, mask, maskMessage, maskMessageStyleName, monitorWindowResize, rendered, resizeHandler, setElementRender, stateId, swallowEvents, toolTip, windowResizeDelay, windowResizeTask
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
AdapterMenuItem(com.google.gwt.user.client.ui.Widget widget)
          Creates a new adapter.
 
Method Summary
 com.google.gwt.user.client.Element getElement()
           
 com.google.gwt.user.client.ui.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(com.google.gwt.user.client.Event event)
          Components delegate event handling to Component.onComponentEvent(ComponentEvent).
protected  void onClick(ComponentEvent be)
           
protected  void onDetach()
           
protected  void onDisable()
           
protected  void onEnable()
           
protected  boolean onEscape()
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
 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.extjs.gxt.ui.client.widget.menu.Item
activate, addSelectionListener, deactivate, expandMenu, getActiveStyle, getHideOnClick, getParentMenu, handleClick, isCanActivate, removeSelectionListener, setActiveStyle, setCanActivate, setHideOnClick, shouldDeactivate
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, afterRender, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createComponentEvent, createObservable, createStyles, disable, disableContextMenu, disableEvents, disableTextSelection, doAttachChildren, doDetachChildren, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hide, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, isVisible, mask, mask, mask, notifyHide, notifyShow, onComponentEvent, onDetachHelper, onEnsureDebugId, onHide, onHideContextMenu, onLoad, onRightClick, onShow, onShowContextMenu, onWindowResize, previewEvent, recalculate, removeAllListeners, removeAttachagle, removeFromParent, removeListener, removeStyleName, removeStyleOnOver, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setAriaRole, setAriaState, setAriaSupport, setBorders, setContextMenu, setData, setEl, setElement, setElement, setEnabled, setFiresEvents, setHeight, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setPixelSize, setSize, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, setWidth, setWindowResizeDelay, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unframe, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, fireEvent, getHandlerCount, getLayoutData, getParent, isOrWasAttached, onUnload, setLayoutData
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, isVisible, removeStyleDependentName, setElement, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setVisible, sinkBitlessEvent, unsinkEvents
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

widget

protected com.google.gwt.user.client.ui.Widget widget
The wrapped widget.


manageFocus

protected boolean manageFocus
Constructor Detail

AdapterMenuItem

public AdapterMenuItem(com.google.gwt.user.client.ui.Widget widget)
Creates a new adapter.

Parameters:
widget - the widget to be adapted
Method Detail

getElement

public com.google.gwt.user.client.Element getElement()
Overrides:
getElement in class Component

getWidget

public com.google.gwt.user.client.ui.Widget getWidget()
Returns the wrapped widget.

Returns:
the widget

isAttached

public boolean isAttached()
Overrides:
isAttached in class com.google.gwt.user.client.ui.Widget

isNeedsIndent

public boolean isNeedsIndent()
Returns true if the widget will be indented.

Returns:
true if indented

onBrowserEvent

public void onBrowserEvent(com.google.gwt.user.client.Event event)
Description copied from class: Component
Components delegate event handling to Component.onComponentEvent(ComponentEvent). Subclasses should not override.

Specified by:
onBrowserEvent in interface com.google.gwt.user.client.EventListener
Overrides:
onBrowserEvent in class Component
Parameters:
event - the dom event

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 Component

onClick

protected void onClick(ComponentEvent 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

onRender

protected void onRender(com.google.gwt.user.client.Element target,
                        int index)
Description copied from class: Component
Subclasses must override and ensure setElement is called for lazy rendered components.

Overrides:
onRender in class Component
Parameters:
target - the target element
index - the insert location