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

java.lang.Object
  com.google.gwt.user.client.ui.UIObject
      com.google.gwt.user.client.ui.Widget
          com.extjs.gxt.ui.client.widget.Component
              com.extjs.gxt.ui.client.widget.BoxComponent
                  com.extjs.gxt.ui.client.widget.Container<Component>
                      com.extjs.gxt.ui.client.widget.menu.Menu

All Implemented Interfaces:

Observable, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener

Direct Known Subclasses:

ColorMenu, DateMenu, StartMenu

public class Menu
extends Container<Component>

A menu component.

Events:

BeforeShow : MenuEvent(container)

Fires before this menu is displayed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• container : this

Show : MenuEvent(container)

Fires after this menu is displayed.

• container : this

BeforeHide : MenuEvent(container)

Fired before the menu is hidden. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• container : this

Hide : MenuEvent(container)

Fires after this menu is hidden.

• container : this

BeforeAdd : MenuEvent(container, item, index)

Fires before a item is added or inserted. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• container : this
• item : the item being added
• index : the index at which the item will be added

BeforeRemove : MenuEvent(container, item)

Fires before a item is removed. Listeners can cancel the action by calling BaseEvent.setCancelled(boolean).

• container : this
• item : the item being removed

Add : MenuEvent(container, item, index)

Fires after a item has been added or inserted.

• container : this
• item : the item that was added
• index : the index at which the item will be added

Remove : MenuEvent(container, item)

Fires after a item has been removed.

• container : this
• item : the item being removed

Inherited Events:

BoxComponent Move

BoxComponent Resize

Component Enable

Component Disable

Component BeforeHide

Component Hide

Component BeforeShow

Component Show

Component Attach

Component Detach

Component BeforeRender

Component Render

Component BrowserEvent

Component BeforeStateRestore

Component StateRestore

Component BeforeStateSave

Component SaveState

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

Menu()
Creates a new menu.

Method Summary

boolean	add(Component item) Adds a item to the menu.
java.lang.String	getDefaultAlign() Returns the default alignment.
El	getLayoutTarget() Returns the container's layout target.
int	getMaxHeight()
int	getMinWidth() Returns the menu's minimum width.
Item	getParentItem() Returns the menu's parent item.
java.lang.String	getSubMenuAlign() Returns the sub menu alignment.
void	hide() Hides the menu.
Menu	hide(boolean deep) Hides this menu and optionally all parent menus
boolean	insert(Component item, int index) Inserts an item into the menu.
boolean	isConstrainViewport() Returns true if constrain to viewport is enabled.
boolean	isEnableScrolling()
boolean	isFocusOnShow()
boolean	isVisible() Returns true if the component is visible.
void	onComponentEvent(ComponentEvent ce) Any events a component receives will be forwarded to this method.
boolean	remove(Component item) Removes a item from the menu.
void	setConstrainViewport(boolean constrainViewport) Sets whether the menu should be constrained to the viewport when shown.
void	setDefaultAlign(java.lang.String defaultAlign) Sets the default El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?").
void	setEnableScrolling(boolean enableScrolling)
void	setFocusOnShow(boolean focusOnShow)
void	setMaxHeight(int maxHeight)
void	setMinWidth(int minWidth) Sets he minimum width of the menu in pixels (defaults to 120).
void	setSubMenuAlign(java.lang.String subMenuAlign) The El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) anchor position value to use for submenus of this menu (defaults to "tl-tr-?").
void	show(com.google.gwt.user.client.Element elem, java.lang.String pos) Displays this menu relative to another element.
void	show(com.google.gwt.user.client.Element elem, java.lang.String pos, int[] offsets) Displays this menu relative to another element.
void	show(com.google.gwt.user.client.ui.Widget widget) Displays this menu relative to the widget using the default alignment.
void	showAt(int x, int y) Displays this menu at a specific xy position.

Methods inherited from class com.extjs.gxt.ui.client.widget.Container

disable, enable, findItem, 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

Menu

public Menu()

Creates a new menu.

Method Detail

add

public boolean add(Component item)

Adds a item to the menu.

Parameters:

item - the new item

getDefaultAlign

public java.lang.String getDefaultAlign()

Returns the default alignment.

Returns:

the default align

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 Container<Component>

Returns:

the layout target

getMaxHeight

public int getMaxHeight()

getMinWidth

public int getMinWidth()

Returns the menu's minimum width.

Returns:

the width

getParentItem

public Item getParentItem()

Returns the menu's parent item.

Returns:

the parent item

getSubMenuAlign

public java.lang.String getSubMenuAlign()

Returns the sub menu alignment.

Returns:

the alignment

hide

public void hide()

Hides the menu.

Overrides:

hide in class Component

hide

public Menu hide(boolean deep)

Hides this menu and optionally all parent menus

Parameters:

deep - true to close all parent menus

Returns:

this

insert

public boolean insert(Component item,
                      int index)

Inserts an item into the menu.

Parameters:

item - the item to insert

index - the insert location

isConstrainViewport

public boolean isConstrainViewport()

Returns true if constrain to viewport is enabled.

Returns:

the constrain to viewport state

isEnableScrolling

public boolean isEnableScrolling()

isFocusOnShow

public boolean isFocusOnShow()

isVisible

public boolean isVisible()

Description copied from class: Component

Returns true if the component is visible.

Overrides:

isVisible in class Component

onComponentEvent

public void onComponentEvent(ComponentEvent ce)

Description copied from class: Component

Any events a component receives will be forwarded to this method. Subclasses should override as needed. The Component.onBrowserEvent(com.google.gwt.user.client.Event) method should not be overridden or modified.

Overrides:

onComponentEvent in class Component

Parameters:

ce - the base event

remove

public boolean remove(Component item)

Removes a item from the menu.

Parameters:

item - the menu to remove

Returns:

true if the item was removed

setConstrainViewport

public void setConstrainViewport(boolean constrainViewport)

Sets whether the menu should be constrained to the viewport when shown. Only applies when using showAt(int, int).

Parameters:

constrainViewport - true to contrain

setDefaultAlign

public void setDefaultAlign(java.lang.String defaultAlign)

Sets the default El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?").

Parameters:

defaultAlign - the default align

setEnableScrolling

public void setEnableScrolling(boolean enableScrolling)

setFocusOnShow

public void setFocusOnShow(boolean focusOnShow)

setMaxHeight

public void setMaxHeight(int maxHeight)

setMinWidth

public void setMinWidth(int minWidth)

Sets he minimum width of the menu in pixels (defaults to 120).

Parameters:

minWidth - the min width

setSubMenuAlign

public void setSubMenuAlign(java.lang.String subMenuAlign)

The El.alignTo(com.google.gwt.user.client.Element, java.lang.String, int[]) anchor position value to use for submenus of this menu (defaults to "tl-tr-?").

Parameters:

subMenuAlign - the sub alignment

show

public void show(com.google.gwt.user.client.Element elem,
                 java.lang.String pos)

Displays this menu relative to another element.

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)

show

public void show(com.google.gwt.user.client.Element elem,
                 java.lang.String pos,
                 int[] offsets)

Displays this menu relative to another element.

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)

offsets - the menu align offsets

show

public void show(com.google.gwt.user.client.ui.Widget widget)

Displays this menu relative to the widget using the default alignment.

Parameters:

widget - the align widget

showAt

public void showAt(int x,
                   int y)

Displays this menu at a specific xy position.

Parameters:

x - the x coordinate

y - the y coordinate