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.shared.HasHandlers, com.google.gwt.user.client.EventListener

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
 
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 seperator to the "too" area.
 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.
 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 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, getDefaultAlign, getMaxHeight, getMinWidth, getParentItem, getSubMenuAlign, hide, hide, insert, isConstrainViewport, isEnableScrolling, isFocusOnShow, isVisible, onComponentEvent, remove, setConstrainViewport, setDefaultAlign, setEnableScrolling, setFocusOnShow, setMaxHeight, setMinWidth, setSubMenuAlign, show, show, showAt
 
Methods inherited from class com.extjs.gxt.ui.client.widget.Container
disable, enable, getItem, getItemByItemId, getItemCount, getItems, getWidget, indexOf, iterator, removeAll, scrollIntoView
 
Methods inherited from class com.extjs.gxt.ui.client.widget.BoxComponent
getBounds, getHeight, getHeight, getPosition, getShadow, getShadowOffset, getShadowPosition, getSize, getWidth, getWidth, isAutoHeight, isAutoWidth, isDeferHeight, isShim, 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
addListener, addPlugin, addStyleName, addWidgetListener, clearState, disableEvents, disableTextSelection, el, enableEvents, fireEvent, fireEvent, fireEvent, fly, focus, getBaseStyle, getBorders, getContextMenu, getData, getElement, getHideMode, getId, getItemId, getListeners, getModel, getState, getStateId, getToolTip, hasListeners, hasListeners, hideToolTip, isDisabledEvents, isEnabled, isRendered, isStateful, mask, mask, mask, onBrowserEvent, recalculate, removeAllListeners, removeFromParent, removeListener, removeStyleName, removeSwallow, removeToolTip, removeWidgetListener, render, render, repaint, saveState, setBorders, setContextMenu, setData, setElement, setEnabled, setHideMode, setId, setIntStyleAttribute, setItemId, setStateful, setStateId, setStyleAttribute, setStyleName, setTitle, setToolTip, setToolTip, setVisible, 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

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 seperator to the "too" area.


getFocusEl

public El getFocusEl()

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

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

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)

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