com.extjs.gxt.desktop.client
Class StartMenu

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.BoxComponent
                  extended by com.extjs.gxt.ui.client.widget.Container<Component>
                      extended by com.extjs.gxt.ui.client.widget.menu.Menu
                          extended by com.extjs.gxt.desktop.client.StartMenu
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 StartMenu
extends Menu

A start menu component. Menu items can be added to the main region of the start menu, or to the "tool" area, which is located to the right.


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  El header
           
protected  El headerText
           
protected  java.lang.String heading
           
protected  java.lang.String iconStyle
           
protected  El menuBWrap
           
protected  El menuPanel
           
protected  java.util.List<Item> tools
           
protected  El toolsPanel
           
protected  int toolWidth
           
 
Fields inherited from class com.extjs.gxt.ui.client.widget.menu.Menu
activeItem, eventPreview, keyNav, parentItem, plain, showSeparator, ul
 
Fields inherited from class com.extjs.gxt.ui.client.widget.Container
attachChildren, enableLayout, layoutExecuted, layoutNeeded, layoutOnAttach, layoutOnChange
 
Fields inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustSize, cacheSizes, ensureVisibilityOnSizing, height, lastSize, layer, shim, width
 
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
StartMenu()
           
 
Method Summary
 void addTool(Item item)
          Adds a item to the "tool" area of the start menu.
 void addToolSeperator()
          Adds a separator to the "too" area.
protected  void doAttachChildren()
           
protected  void doDetachChildren()
           
 Component findItem(com.google.gwt.user.client.Element elem)
          Returns the component whose element, or child element, matches the given element.
 El getFocusEl()
           
 java.lang.String getHeading()
          Returns the start menu's heading.
 java.lang.String getIconStyle()
          Returns the menu's icon style.
 El getLayoutTarget()
          Returns the container's layout target.
 int getToolWidth()
           
protected  void onRender(com.google.gwt.user.client.Element target, int index)
          Subclasses must override and ensure setElement is called for lazy rendered components.
protected  void renderTool(Item tool)
           
 void setHeading(java.lang.String heading)
          Sets the menu's heading text.
 void setIconStyle(java.lang.String iconStyle)
          Sets the menu's icon style.
 void setToolWidth(int toolWidth)
           
 void show(com.google.gwt.user.client.Element elem, java.lang.String pos)
          Displays this menu relative to another element.
 
Methods inherited from class com.extjs.gxt.ui.client.widget.menu.Menu
add, afterRender, constrainScroll, createComponentEvent, createContainerEvent, createScrollers, deactiveActiveItem, doAutoSize, getDefaultAlign, getMaxHeight, getMinWidth, getParentItem, getSubMenuAlign, hide, hide, insert, isConstrainViewport, isEnableScrolling, isFocusOnShow, isVisible, onAutoHide, onClick, onComponentEvent, onDetach, onEscape, onHide, onInsert, onKeyDown, onKeyUp, onLayoutExcecuted, onMouseMove, onMouseOut, onMouseOver, onRemove, onScroll, onScrollerIn, onScrollerOut, onWindowResize, remove, scrollMenu, setActiveItem, setConstrainViewport, setDefaultAlign, setEnableScrolling, setFocusOnShow, setMaxHeight, setMinWidth, setSubMenuAlign, show, show, showAt, tryActivate
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
adjustIndex, adopt, disable, doLayout, doLayout, enable, getItem, getItemByItemId, getItemCount, getItems, getLayout, getWidget, indexOf, isLayoutNeeded, iterator, layout, layout, notifyHide, notifyShow, onAfterLayout, onAttach, onBeforeLayoutExcecuted, orphan, remove, removeAll, removeAll, scrollIntoView, setLayout, setLayoutNeeded, setLayoutOnChange, wrapWidget
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
adjustPosition, adjustSize, getBounds, getHeight, getHeight, getPosition, getPositionEl, getResizeEl, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, hideShadow, hideShim, hideUnders, isAutoHeight, isAutoWidth, isDeferHeight, isShim, onPosition, onResize, onShow, onUnload, setAutoHeight, setAutoWidth, setBounds, setBounds, setDeferHeight, setHeight, setHeight, setPagePosition, setPagePosition, setPixelSize, setPosition, setShadow, setShadowOffset, setShadowPosition, setShim, setSize, setSize, setWidth, setWidth, sync, syncSize
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Component
addAttachable, addListener, addPlugin, addStyleName, addStyleOnOver, addWidgetListener, applyState, assertAfterRender, assertPreRender, beforeRender, blur, clearState, createObservable, createStyles, disableContextMenu, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, frame, getAriaSupport, getBaseStyle, getBorders, getContextMenu, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getListeners, getModel, getObservable, getPlugins, getState, getStateId, getTabIndex, getTitle, getToolTip, getWindowResizeDelay, hasListeners, hasListeners, hideToolTip, initState, isDisabledEvents, isDisableTextSelection, isEnabled, isMasked, isMonitorWindowResize, isRendered, isStateful, isVisible, mask, mask, mask, onBrowserEvent, onDetachHelper, onDisable, onEnable, onEnsureDebugId, onHideContextMenu, onLoad, onRightClick, onShowContextMenu, 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, setHideMode, setId, setIntStyleAttribute, setItemId, setModel, setMonitorWindowResize, setParent, setStateful, setStateId, setStyleAttribute, setStyleName, setTabIndex, setTitle, setToolTip, setToolTip, setVisible, 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, isAttached, isOrWasAttached, 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

header

protected El header

headerText

protected El headerText

menuBWrap

protected El menuBWrap

menuPanel

protected El menuPanel

toolsPanel

protected El toolsPanel

heading

protected java.lang.String heading

iconStyle

protected java.lang.String iconStyle

tools

protected java.util.List<Item> tools

toolWidth

protected int toolWidth
Constructor Detail

StartMenu

public StartMenu()
Method Detail

addTool

public void addTool(Item item)
Adds a item to the "tool" area of the start menu.

Parameters:
item - the item to add

addToolSeperator

public void addToolSeperator()
Adds a separator to the "too" area.


findItem

public Component findItem(com.google.gwt.user.client.Element elem)
Description copied from class: Container
Returns the component whose element, or child element, matches the given element.

Overrides:
findItem in class Container<Component>
Parameters:
elem - the element
Returns:
the matching component or null if no match

getFocusEl

public El getFocusEl()
Overrides:
getFocusEl in class Component

getHeading

public java.lang.String getHeading()
Returns the start menu's heading.

Returns:
the heading

getIconStyle

public java.lang.String getIconStyle()
Returns the menu's icon style.

Returns:
the icon style

getLayoutTarget

public El getLayoutTarget()
Description copied from class: Container
Returns the container's layout target. Only applies to container's with layouts.

Overrides:
getLayoutTarget in class Menu
Returns:
the layout target

getToolWidth

public int getToolWidth()

setHeading

public void setHeading(java.lang.String heading)
Sets the menu's heading text.

Parameters:
heading - the heading

setIconStyle

public void setIconStyle(java.lang.String iconStyle)
Sets the menu's icon style.

Parameters:
iconStyle - the icon style

setToolWidth

public void setToolWidth(int toolWidth)

show

public void show(com.google.gwt.user.client.Element elem,
                 java.lang.String pos)
Description copied from class: Menu
Displays this menu relative to another element.

Overrides:
show in class Menu
Parameters:
elem - the element to align to
pos - the El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) anchor position to use in aligning to the element (defaults to defaultAlign)

doAttachChildren

protected void doAttachChildren()
Overrides:
doAttachChildren in class Container<Component>

doDetachChildren

protected void doDetachChildren()
Overrides:
doDetachChildren in class Container<Component>

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 Menu
Parameters:
target - the target element
index - the insert location

renderTool

protected void renderTool(Item tool)