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

Class Menu

java.lang.Object

com.google.gwt.user.client.ui.UIObject

com.google.gwt.user.client.ui.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:

HasAttachHandlers, HasBeforeSelectionHandlers<Item>, HasResizeHandlers, HasSelectionHandlers<Item>, HasHandlers, EventListener, HasEnabled, HasVisibility, HasWidgets, HasWidgets.ForIsWidget, IndexedPanel, IndexedPanel.ForIsWidget, InsertPanel, InsertPanel.ForIsWidget, IsWidget, 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, Iterable<Widget>

Direct Known Subclasses:

ColorMenu, DateMenu, ListMenu, RangeMenu

public class Menu
extends InsertContainer
implements HasBeforeSelectionHandlers<Item>, HasSelectionHandlers<Item>

A menu widget.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	Menu.MenuAppearance

Nested classes/interfaces inherited from class com.google.gwt.user.client.ui.UIObject

UIObject.DebugIdImpl, UIObject.DebugIdImplEnabled

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.InsertPanel

InsertPanel.ForIsWidget

Nested classes/interfaces inherited from interface com.google.gwt.user.client.ui.HasWidgets

HasWidgets.ForIsWidget

Field Summary

Fields inherited from class com.google.gwt.user.client.ui.UIObject

DEBUG_ID_PREFIX

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
HandlerRegistration	addBeforeSelectionHandler(BeforeSelectionHandler<Item> 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(SelectionHandler<Item> handler)
Menu.MenuAppearance	getAppearance() Returns the appearance object for this instance
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()
void	onBrowserEvent(Event event)
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(com.google.gwt.dom.client.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(com.google.gwt.dom.client.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.

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

insert, insert

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

add, add, addAddHandler, addBeforeAddHandler, addBeforeRemoveHandler, addContainerHandler, addRemoveHandler, clear, disable, enable, findWidget, getItemByItemId, getWidget, getWidgetCount, getWidgetIndex, getWidgetIndex, iterator, 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, addStyleOnOver, clearSizeCache, disableEvents, enableEvents, fireEvent, focus, getData, getElement, getFocusSupport, getHideMode, getId, getItemId, getOffsetHeight, getOffsetWidth, getShadow, getShadowPosition, getStateId, getTabIndex, getToolTip, hideToolTip, isAllowTextSelection, isAutoHeight, isAutoWidth, isDeferHeight, isEnabled, isRendered, isStateful, isVisible, mask, mask, removeToolTip, setAllowTextSelection, setBorders, setBounds, setBounds, setContextMenu, setData, setDeferHeight, setEnabled, setHeight, setHeight, setHideMode, setId, setItemId, setPagePosition, setPixelSize, setPosition, setShadow, setShadowPosition, setSize, setStateful, setStateId, setTabIndex, setToolTip, setToolTip, setToolTipConfig, setVisible, setWidth, setWidth, show, sync, syncSize, unmask

Methods inherited from class com.google.gwt.user.client.ui.Widget

addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, getLayoutData, getParent, isAttached, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject

addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getOffsetHeight, getOffsetWidth, getStyleName, getStylePrimaryName, getTitle, isVisible, removeStyleDependentName, removeStyleName, setStyleDependentName, setStyleName, setStyleName, setStylePrimaryName, setTitle, setVisible, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.gwt.event.shared.HasHandlers

fireEvent

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel.ForIsWidget

add

Methods inherited from interface com.google.gwt.user.client.ui.InsertPanel

add

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel.ForIsWidget

getWidgetIndex

Methods inherited from interface com.google.gwt.user.client.ui.IndexedPanel

getWidget, getWidgetCount, getWidgetIndex, remove

Constructor Detail

Menu

public Menu()

Menu

public Menu(Menu.MenuAppearance appearance)

Method Detail

addBeforeSelectionHandler

public HandlerRegistration addBeforeSelectionHandler(BeforeSelectionHandler<Item> handler)

Specified by:

addBeforeSelectionHandler in interface HasBeforeSelectionHandlers<Item>

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(SelectionHandler<Item> handler)

Specified by:

addSelectionHandler in interface HasSelectionHandlers<Item>

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

Specified by:

isVisible in interface HasVisibility

Overrides:

isVisible in class Component

onBrowserEvent

public void onBrowserEvent(Event event)

Specified by:

onBrowserEvent in interface EventListener

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(com.google.gwt.dom.client.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(com.google.gwt.dom.client.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(com.google.gwt.dom.client.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(com.google.gwt.dom.client.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

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