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

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
All Implemented Interfaces:
Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener
Direct Known Subclasses:
HeaderMenuItem, MenuItem, SeparatorMenuItem

public abstract class Item
extends Component

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


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
 
Fields inherited from class com.google.gwt.user.client.ui.UIObject
DEBUG_ID_PREFIX
 
Constructor Summary
Item()
           
 
Method Summary
 void addSelectionListener(SelectionListener<? extends MenuEvent> listener)
          Adds a selection listener.
 java.lang.String getActiveStyle()
          Returns the active style.
 boolean getHideOnClick()
          Returns the hide on click state.
 Menu getParentMenu()
          Returns the item's containing menu.
 void removeSelectionListener(SelectionListener<? extends ComponentEvent> listener)
          Removes a previously added listener.
 void setActiveStyle(java.lang.String activeStyle)
          The CSS class to use when the item becomes activated (defaults to "x-menu-item-active").
 void setHideOnClick(boolean hideOnClick)
          True to hide the containing menu after this item is clicked (defaults to true).
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addListener, addPlugin, addStyleName, addWidgetListener, clearState, disable, disableEvents, disableTextSelection, el, enable, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hide, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, onComponentEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHeight, setHideMode, setId, setIntStyleAttribute, setItemId, setPixelSize, setSize, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, setWidth, setZIndex, show, sinkEvents, swallowEvent, swallowEvent, toString, unmask
 
Methods inherited from class com.google.gwt.user.client.ui.Widget
fireEvent, getParent, isAttached
 
Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, setStylePrimaryName, setVisible, unsinkEvents
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Item

public Item()
Method Detail

addSelectionListener

public void addSelectionListener(SelectionListener<? extends MenuEvent> listener)
Adds a selection listener.

Parameters:
listener - the listener to add

getActiveStyle

public java.lang.String getActiveStyle()
Returns the active style.

Returns:
the style

getHideOnClick

public boolean getHideOnClick()
Returns the hide on click state.

Returns:
the hide on click state

getParentMenu

public Menu getParentMenu()
Returns the item's containing menu.

Returns:
the menu

removeSelectionListener

public void removeSelectionListener(SelectionListener<? extends ComponentEvent> listener)
Removes a previously added listener.

Parameters:
listener - the listener to be removed

setActiveStyle

public void setActiveStyle(java.lang.String activeStyle)
The CSS class to use when the item becomes activated (defaults to "x-menu-item-active").

Parameters:
activeStyle - the active style

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