com.sencha.gxt.widget.core.client.menu

Class Menu

java.lang.Object

Widget

com.sencha.gxt.widget.core.client.Component

com.sencha.gxt.widget.core.client.container.Container

com.sencha.gxt.widget.core.client.container.InsertContainer

com.sencha.gxt.widget.core.client.menu.Menu

All Implemented Interfaces:

AddEvent.HasAddHandlers, BeforeAddEvent.HasBeforeAddHandlers, BeforeHideEvent.HasBeforeHideHandlers, BeforeRemoveEvent.HasBeforeRemoveHandlers, BeforeShowContextMenuEvent.HasBeforeShowContextMenuHandler, BeforeShowEvent.HasBeforeShowHandlers, BlurEvent.HasBlurHandlers, ContainerHandler.HasContainerHandlers, DisableEvent.HasDisableHandlers, EnableEvent.HasEnableHandlers, FocusEvent.HasFocusHandlers, HideEvent.HasHideHandlers, MoveEvent.HasMoveHandlers, RemoveEvent.HasRemoveHandlers, ShowContextMenuEvent.HasShowContextMenuHandler, ShowEvent.HasShowHandlers, HasFocusSupport, HasItemId

Direct Known Subclasses:

ColorMenu, DateMenu, ListMenu, RangeMenu

public class Menu
extends InsertContainer

A menu widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Menu.MenuAppearance

Field Summary

Fields

Modifier and Type	Field and Description
protected Item	activeItem
protected BaseEventPreview	eventPreview
protected KeyNav	keyNav
protected Item	parentItem
protected boolean	plain
protected boolean	showSeparator

Fields inherited from class com.sencha.gxt.widget.core.client.Component

adjustSize, allowTextSelection, cacheSizes, disableContextMenu, disabled, disabledStyle, ensureVisibilityOnSizing, height, hidden, lastSize, layer, left, mask, maskMessage, monitorWindowResize, pageX, pageY, resizeHandler, shim, tabIndex, toolTip, toolTipConfig, top, width, windowResizeDelay, windowResizeTask

Constructor Summary

Constructors

Constructor and Description
Menu()
Menu(Menu.MenuAppearance appearance)

Method Summary

Modifier and Type	Method and Description
HandlerRegistration	addBeforeSelectionHandler(<any> handler)
HandlerRegistration	addMaximizeHandler(MaximizeEvent.MaximizeHandler handler) Fires when the Menu is maximized.
HandlerRegistration	addMinimizeHandler(MinimizeEvent.MinimizeHandler handler) Fires when the Menu is minimized.
HandlerRegistration	addSelectionHandler(<any> handler)
protected void	constrainScroll(int y)
protected void	createScrollers()
protected void	deactivateActiveItem()
protected void	doAutoSize()
protected void	doPhysicalAttach(Widget child, int beforeIndex)
protected void	doPhysicalDetach(Widget child)
Menu.MenuAppearance	getAppearance() Returns the appearance object for this instance
protected XElement	getContainerTarget()
String	getDefaultAlign() Returns the default alignment.
int	getMaxHeight() Returns the max height of the menu or -1 if not set.
int	getMinWidth() Returns the menu's minimum width.
Item	getParentItem() Returns the menu's parent item.
String	getSubMenuAlign() Returns the sub menu alignment.
void	hide() Hides the menu.
void	hide(boolean deep) Hides this menu and optionally all parent menus
boolean	isConstrainViewport() Returns true if constrain to viewport is enabled.
boolean	isEnableScrolling() Returns true if vertical scrolling is enabled.
boolean	isFocusOnShow() Returns true if the menu will be focused when displayed.
boolean	isVisible()
protected void	onAfterFirstAttach() Called immediately after the first time the widget becomes attached to the browser's document only the first time.
void	onBrowserEvent(Event event)
protected void	onClick(Event ce)
protected void	onEscape(NativePreviewEvent pe)
protected void	onHide()
protected void	onKeyDown(NativeEvent evt)
protected void	onKeyEnter(NativeEvent evt)
protected void	onKeyLeft(NativeEvent evt)
protected void	onKeyRight(NativeEvent evt)
protected void	onKeyUp(NativeEvent evt)
protected void	onMouseMove(Event ce)
protected void	onMouseOut(Event ce)
protected void	onMouseOver(Event ce)
protected void	onPreviewEvent(NativePreviewEvent pe) Provides information about external events occurring in the DOM, allow the menu to decide to hide if necessary
protected void	onScroll(ClickRepeaterEvent ce)
protected void	onWidgetHide(Widget widget)
protected void	onWidgetShow(Widget widget)
protected void	onWindowResize(int width, int height)
protected void	scrollMenu(boolean top)
void	setActiveItem(Widget widget, boolean autoExpand) Sets the active item.
void	setConstrainViewport(boolean constrainViewport) Sets whether the menu should be constrained to the viewport when shown.
void	setDefaultAlign(String defaultAlign) Sets the default XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position value for this menu relative to its element of origin (defaults to "tl-bl?").
void	setEnableScrolling(boolean enableScrolling) True to enable vertical scrolling of the children in the menu (defaults to true).
void	setFocusOnShow(boolean focusOnShow) True to set the focus on the menu when it is displayed.
void	setMaxHeight(int maxHeight) Sets the max height of the menu (defaults to -1).
void	setMinWidth(int minWidth) Sets he minimum width of the menu in pixels (defaults to 120).
void	setOnHideFocusElement(Element onHideFocusElement) Sets the element that should receive focus onHide unless the onHide was triggered by focusing on a different element.
void	setSubMenuAlign(String subMenuAlign) The XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position value to use for submenus of this menu (defaults to "tl-tr-?").
void	show(Element elem, Style.AnchorAlignment alignment) Displays this menu relative to another element.
void	show(Element elem, Style.AnchorAlignment alignment, int offsetX, int offsetY) Displays this menu relative to another element.
void	show(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.
protected void	showElement() Displays the element only.
protected Item	tryActivate(int start, int step)

Methods inherited from class com.sencha.gxt.widget.core.client.container.InsertContainer

insert, insert, setElement

Methods inherited from class com.sencha.gxt.widget.core.client.container.Container

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, adjustIndex, adopt, checkIndexBoundsForInsertion, clear, disable, doAttachChildren, doDetachChildren, enable, ensureGroupingHandlerRegistration, findWidget, getChildren, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, onInsert, onRemove, orphan, remove, remove, remove

Methods inherited from class com.sencha.gxt.widget.core.client.Component

addBeforeHideHandler, addBeforeShowContextMenuHandler, addBeforeShowHandler, addBlurHandler, addDisableHandler, addEnableHandler, addFocusHandler, addHideHandler, addMoveHandler, addResizeHandler, addShowContextMenuHandler, addShowHandler, addStyleDependentName, addStyleOnOver, adjustPosition, adjustSize, applyState, assertAfterRender, assertPreRender, blur, clearSizeCache, disableContextMenu, disableEvents, enableEvents, fireCancellableEvent, fireEvent, focus, getData, getElement, getFocusEl, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getPositionEl, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideShadow, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isMonitorWindowResize, isRendered, isStateful, isVisible, mask, mask, notifyHide, notifyShow, onAttach, onBlur, onDetach, onDisable, onEnable, onFocus, onHideContextMenu, onLoad, onPosition, onResize, onRightClick, onShow, onShowContextMenu, onUnload, removeStyleDependentName, removeStyleOnOver, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setMonitorWindowResize, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setStyleDependentName, setTabIndex, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

eventPreview

protected BaseEventPreview eventPreview

keyNav

protected KeyNav keyNav

parentItem

protected Item parentItem

plain

protected boolean plain

showSeparator

protected boolean showSeparator

activeItem

protected Item activeItem

Constructor Detail

Menu

public Menu()

Menu

public Menu(Menu.MenuAppearance appearance)

Method Detail

addBeforeSelectionHandler

public HandlerRegistration addBeforeSelectionHandler(<any> handler)

addMaximizeHandler

public HandlerRegistration addMaximizeHandler(MaximizeEvent.MaximizeHandler handler)

Fires when the Menu is maximized.

Parameters:

handler - sets the MaximizeEvent.MaximizeHandler

Returns:

the HandlerRegistration.

addMinimizeHandler

public HandlerRegistration addMinimizeHandler(MinimizeEvent.MinimizeHandler handler)

Fires when the Menu is minimized.

Parameters:

handler - sets the MinimizeEvent.MinimizeHandler.

Returns:

the HandlerRegistration.

addSelectionHandler

public HandlerRegistration addSelectionHandler(<any> handler)

getAppearance

public Menu.MenuAppearance getAppearance()

Returns the appearance object for this instance

Returns:

the appearance impl used by this component

getDefaultAlign

public String getDefaultAlign()

Returns the default alignment.

Returns:

the default align

getMaxHeight

public int getMaxHeight()

Returns the max height of the menu or -1 if not set.

Returns:

the max height in pixels

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 String getSubMenuAlign()

Returns the sub menu alignment.

Returns:

the alignment

hide

public void hide()

Hides the menu.

Overrides:

hide in class Component

hide

public void hide(boolean deep)

Hides this menu and optionally all parent menus

Parameters:

deep - true to close all parent menus

isConstrainViewport

public boolean isConstrainViewport()

Returns true if constrain to viewport is enabled.

Returns:

the constrain to viewport state

isEnableScrolling

public boolean isEnableScrolling()

Returns true if vertical scrolling is enabled.

Returns:

true for scrolling

isFocusOnShow

public boolean isFocusOnShow()

Returns true if the menu will be focused when displayed.

Returns:

true if focused

isVisible

public boolean isVisible()

Overrides:

isVisible in class Component

onBrowserEvent

public void onBrowserEvent(Event event)

Overrides:

onBrowserEvent in class Component

setActiveItem

public void setActiveItem(Widget widget,
                          boolean autoExpand)

Sets the active item. The widget must be of type Item to be activated. All other types are ignored.

Parameters:

widget - the widget to set active

autoExpand - true to auto expand the item

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 constrain

setDefaultAlign

public void setDefaultAlign(String defaultAlign)

Sets the default XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, 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)

True to enable vertical scrolling of the children in the menu (defaults to true).

Parameters:

enableScrolling - true to for scrolling

setFocusOnShow

public void setFocusOnShow(boolean focusOnShow)

True to set the focus on the menu when it is displayed.

Parameters:

focusOnShow - true to focus

setMaxHeight

public void setMaxHeight(int maxHeight)

Sets the max height of the menu (defaults to -1). Only applies when setEnableScrolling(boolean) is set to true.

Parameters:

maxHeight - the max height

setMinWidth

public void setMinWidth(int minWidth)

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

Parameters:

minWidth - the minimum width

setOnHideFocusElement

public void setOnHideFocusElement(Element onHideFocusElement)

Sets the element that should receive focus onHide unless the onHide was triggered by focusing on a different element. This is typically set on the top-level menu rather than a sub menu

Parameters:

onHideFocusElement - the element to focus on during onHide

setSubMenuAlign

public void setSubMenuAlign(String subMenuAlign)

The XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position value to use for submenus of this menu (defaults to "tl-tr-?").

Parameters:

subMenuAlign - the sub alignment

show

public void show(Element elem,
                 Style.AnchorAlignment alignment)

Displays this menu relative to another element.

Parameters:

elem - the element to align to

alignment - the XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position to use in aligning to the element (defaults to defaultAlign)

show

public void show(Element elem,
                 Style.AnchorAlignment alignment,
                 int offsetX,
                 int offsetY)

Displays this menu relative to another element.

Parameters:

elem - the element to align to

alignment - the XElement.alignTo(Element, com.sencha.gxt.core.client.Style.AnchorAlignment, int, int) anchor position to use in aligning to the element (defaults to defaultAlign)

offsetX - X offset

offsetY - Y offset

showElement

protected void showElement()

Displays the element only.

Override this method to provide an animation when showing the menu.

 Menu menu1 = new Menu() {

show

public void show(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

constrainScroll

protected void constrainScroll(int y)

createScrollers

protected void createScrollers()

deactivateActiveItem

protected void deactivateActiveItem()

doAutoSize

protected void doAutoSize()

doPhysicalAttach

protected void doPhysicalAttach(Widget child,
                                int beforeIndex)

Overrides:

doPhysicalAttach in class Container

doPhysicalDetach

protected void doPhysicalDetach(Widget child)

Overrides:

doPhysicalDetach in class Container

getContainerTarget

protected XElement getContainerTarget()

Overrides:

getContainerTarget in class Container

onAfterFirstAttach

protected void onAfterFirstAttach()

Description copied from class: Component

Called immediately after the first time the widget becomes attached to the browser's document only the first time.

Overrides:

onAfterFirstAttach in class Component

onPreviewEvent

protected void onPreviewEvent(NativePreviewEvent pe)

Provides information about external events occurring in the DOM, allow the menu to decide to hide if necessary

onClick

protected void onClick(Event ce)

onEscape

protected void onEscape(NativePreviewEvent pe)

onHide

protected void onHide()

Overrides:

onHide in class Component

onKeyDown

protected void onKeyDown(NativeEvent evt)

onKeyEnter

protected void onKeyEnter(NativeEvent evt)

onKeyLeft

protected void onKeyLeft(NativeEvent evt)

onKeyRight

protected void onKeyRight(NativeEvent evt)

onKeyUp

protected void onKeyUp(NativeEvent evt)

onMouseMove

protected void onMouseMove(Event ce)

onMouseOut

protected void onMouseOut(Event ce)

onMouseOver

protected void onMouseOver(Event ce)

onScroll

protected void onScroll(ClickRepeaterEvent ce)

onWidgetHide

protected void onWidgetHide(Widget widget)

Overrides:

onWidgetHide in class Container

onWidgetShow

protected void onWidgetShow(Widget widget)

Overrides:

onWidgetShow in class Container

onWindowResize

protected void onWindowResize(int width,
                              int height)

Overrides:

onWindowResize in class Component

scrollMenu

protected void scrollMenu(boolean top)

tryActivate

protected Item tryActivate(int start,
                           int step)