public class

MenuBar

extends Widget
implements HasCloseHandlers<T> HasAnimation PopupListener

java.lang.Object
↳	com.google.gwt.user.client.ui.UIObject
	↳	com.google.gwt.user.client.ui.Widget
		↳	com.google.gwt.user.client.ui.MenuBar

Class Overview

A standard menu bar widget. A menu bar can contain any number of menu items, each of which can either fire a Command or open a cascaded menu bar.

CSS Style Rules

.gwt-MenuBar: the menu bar itself
.gwt-MenuBar-horizontal: dependent style applied to horizontal menu bars
.gwt-MenuBar-vertical: dependent style applied to vertical menu bars
.gwt-MenuBar .gwt-MenuItem: menu items
.gwt-MenuBar .gwt-MenuItem-selected: selected menu items
.gwt-MenuBar .gwt-MenuItemSeparator: section breaks between menu items
.gwt-MenuBar .gwt-MenuItemSeparator .menuSeparatorInner: inner component of section separators
.gwt-MenuBarPopup .menuPopupTopLeft: the top left cell
.gwt-MenuBarPopup .menuPopupTopLeftInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupTopCenter: the top center cell
.gwt-MenuBarPopup .menuPopupTopCenterInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupTopRight: the top right cell
.gwt-MenuBarPopup .menuPopupTopRightInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupMiddleLeft: the middle left cell
.gwt-MenuBarPopup .menuPopupMiddleLeftInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupMiddleCenter: the middle center cell
.gwt-MenuBarPopup .menuPopupMiddleCenterInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupMiddleRight: the middle right cell
.gwt-MenuBarPopup .menuPopupMiddleRightInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupBottomLeft: the bottom left cell
.gwt-MenuBarPopup .menuPopupBottomLeftInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupBottomCenter: the bottom center cell
.gwt-MenuBarPopup .menuPopupBottomCenterInner: the inner element of the cell
.gwt-MenuBarPopup .menuPopupBottomRight: the bottom right cell
.gwt-MenuBarPopup .menuPopupBottomRightInner: the inner element of the cell

Example

{@example com.google.gwt.examples.MenuBarExample}

Use in UiBinder Templates

MenuBar elements in UiBinder template files can have a vertical boolean attribute (which defaults to false), and may have only MenuItem elements as children. MenuItems may contain HTML and MenuBars.

For example:

 <g:MenuBar>
   <g:MenuItem>Higgledy
     <g:MenuBar vertical="true">
       <g:MenuItem>able</g:MenuItem>
       <g:MenuItem>baker</g:MenuItem>
       <g:MenuItem>charlie</g:MenuItem>
     </g:MenuBar>
   </g:MenuItem>
   <g:MenuItem>Piggledy
     <g:MenuBar vertical="true">
       <g:MenuItem>foo</g:MenuItem>
       <g:MenuItem>bar</g:MenuItem>
       <g:MenuItem>baz</g:MenuItem>
     </g:MenuBar>
   </g:MenuItem>
   <g:MenuItem><b>Pop!</b>
     <g:MenuBar vertical="true">
       <g:MenuItem>uno</g:MenuItem>
       <g:MenuItem>dos</g:MenuItem>
       <g:MenuItem>tres</g:MenuItem>
     </g:MenuBar>
   </g:MenuItem>
 </g:MenuBar>

Summary

Nested Classes
interface	MenuBar.MenuBarImages	This interface is deprecated. replaced by `MenuBar.Resources`
interface	MenuBar.Resources	A ClientBundle that contains the default resources for this widget.

[Expand]

Inherited Constants

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

Public Constructors
	MenuBar() Creates an empty horizontal menu bar.
	MenuBar(boolean vertical) Creates an empty menu bar.
	MenuBar(boolean vertical, MenuBar.MenuBarImages images) This constructor is deprecated. replaced by `MenuBar(boolean, Resources)`
	MenuBar(boolean vertical, MenuBar.Resources resources) Creates an empty menu bar that uses the specified ClientBundle for menu images.
	MenuBar(MenuBar.MenuBarImages images) This constructor is deprecated. replaced by `MenuBar(Resources)`
	MenuBar(MenuBar.Resources resources) Creates an empty horizontal menu bar that uses the specified ClientBundle for menu images.

Public Methods
HandlerRegistration	addCloseHandler(CloseHandler<PopupPanel> handler)
MenuItem	addItem(MenuItem item) Adds a menu item to the bar.
MenuItem	addItem(SafeHtml html, MenuBar popup) Adds a menu item to the bar, that will open the specified menu when it is selected.
MenuItem	addItem(String text, MenuBar popup) Adds a menu item to the bar, that will open the specified menu when it is selected.
MenuItem	addItem(SafeHtml html, Command cmd) Adds a menu item to the bar containing SafeHtml, that will fire the given command when it is selected.
MenuItem	addItem(String text, boolean asHTML, Command cmd) Adds a menu item to the bar, that will fire the given command when it is selected.
MenuItem	addItem(String text, boolean asHTML, MenuBar popup) Adds a menu item to the bar, that will open the specified menu when it is selected.
MenuItem	addItem(String text, Command cmd) Adds a menu item to the bar, that will fire the given command when it is selected.
MenuItemSeparator	addSeparator() Adds a thin line to the `MenuBar` to separate sections of `MenuItem`s.
MenuItemSeparator	addSeparator(MenuItemSeparator separator) Adds a thin line to the `MenuBar` to separate sections of `MenuItem`s.
void	clearItems() Removes all menu items from this menu bar.
void	closeAllChildren(boolean focus) Closes this menu and all child menu popups.
void	focus() Give this MenuBar focus.
boolean	getAutoOpen() Gets whether this menu bar's child menus will open when the mouse is moved over it.
int	getItemIndex(MenuItem item) Get the index of a `MenuItem`.
int	getSeparatorIndex(MenuItemSeparator item) Get the index of a `MenuItemSeparator`.
MenuItem	insertItem(MenuItem item, int beforeIndex) Adds a menu item to the bar at a specific index.
MenuItemSeparator	insertSeparator(MenuItemSeparator separator, int beforeIndex) Adds a thin line to the `MenuBar` to separate sections of `MenuItem`s at the specified index.
MenuItemSeparator	insertSeparator(int beforeIndex) Adds a thin line to the `MenuBar` to separate sections of `MenuItem`s at the specified index.
boolean	isAnimationEnabled() Returns true if animations are enabled, false if not.
boolean	isFocusOnHoverEnabled() Check whether or not this widget will steal keyboard focus when the mouse hovers over it.
void	moveSelectionDown() Moves the menu selection down to the next item.
void	moveSelectionUp() Moves the menu selection up to the previous item.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onPopupClosed(PopupPanel sender, boolean autoClosed) This method is deprecated. Use `addCloseHandler(CloseHandler)` instead
void	removeItem(MenuItem item) Removes the specified menu item from the bar.
void	removeSeparator(MenuItemSeparator separator) Removes the specified `MenuItemSeparator` from the bar.
void	selectItem(MenuItem item) Select the given MenuItem, which must be a direct child of this MenuBar.
void	setAnimationEnabled(boolean enable) Enable or disable animations.
void	setAutoOpen(boolean autoOpen) Sets whether this menu bar's child menus will open when the mouse is moved over it.
void	setFocusOnHoverEnabled(boolean enabled) Enable or disable auto focus when the mouse hovers over the MenuBar.

Protected Methods
List<MenuItem>	getItems() Returns a list containing the `MenuItem` objects in the menu bar.
MenuItem	getSelectedItem() Returns the `MenuItem` that is currently selected (highlighted) by the user.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onEnsureDebugId(String baseID) Affected Elements: -item# = the `MenuItem` at the specified index.

[Expand]

Inherited Methods

From class com.google.gwt.user.client.ui.Widget

HandlerRegistration	addAttachHandler(AttachEvent.Handler handler) Adds an `AttachEvent` handler.
final <H extends EventHandler> HandlerRegistration	addDomHandler(H handler, Type<H> type) Adds a native event handler to the widget and sinks the corresponding native event.
final <H extends EventHandler> HandlerRegistration	addHandler(H handler, Type<H> type) Adds this handler to the widget.
Widget	asWidget() Returns the `Widget` aspect of the receiver.
static Widget	asWidgetOrNull(IsWidget w) This convenience method makes a null-safe call to `asWidget()`.
HandlerManager	createHandlerManager() Creates the `HandlerManager` used by this Widget.
void	delegateEvent(Widget target, GwtEvent<?> event) Fires an event on a child widget.
void	doAttachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onAttach()` for each of its child widgets.
void	doDetachChildren() If a widget contains one or more child widgets that are not in the logical widget hierarchy (the child is physically connected only on the DOM level), it must override this method and call `onDetach()` for each of its child widgets.
void	fireEvent(GwtEvent<?> event) Fires the given event to the handlers listening to the event's type.
int	getHandlerCount(Type<?> type) Gets the number of handlers listening to the event type.
Object	getLayoutData() Gets the panel-defined layout data associated with this widget.
Widget	getParent() Gets this widget's parent panel.
boolean	isAttached() Determines whether this widget is currently attached to the browser's document (i.e., there is an unbroken chain of widgets between this widget and the underlying browser document).
final boolean	isOrWasAttached() Has this widget ever been attached?
void	onAttach() This method is called when a widget is attached to the browser's document.
void	onBrowserEvent(Event event) Fired whenever a browser event is received.
void	onDetach() This method is called when a widget is detached from the browser's document.
void	onLoad() This method is called immediately after a widget becomes attached to the browser's document.
void	onUnload() This method is called immediately before a widget will be detached from the browser's document.
void	removeFromParent() Removes this widget from its parent widget, if one exists.
void	setLayoutData(Object layoutData) Sets the panel-defined layout data associated with this widget.
void	sinkEvents(int eventBitsToAdd) Overridden to defer the call to super.sinkEvents until the first time this widget is attached to the dom, as a performance enhancement.

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

void	addStyleDependentName(String styleSuffix) Adds a dependent style name by specifying the style name's suffix.
void	addStyleName(String style) Adds a secondary or dependent style name to this object.
static void	ensureDebugId(Element elem, String baseID, String id) Set the debug id of a specific element.
final void	ensureDebugId(String id) Ensure that the main `Element` for this `UIObject` has an ID property set, which allows it to integrate with third-party libraries and test tools.
static void	ensureDebugId(Element elem, String id) Ensure that elem has an ID property set, which allows it to integrate with third-party libraries and test tools.
int	getAbsoluteLeft() Gets the object's absolute left position in pixels, as measured from the browser window's client area.
int	getAbsoluteTop() Gets the object's absolute top position in pixels, as measured from the browser window's client area.
Element	getElement() Gets a handle to the object's underlying DOM element.
int	getOffsetHeight() Gets the object's offset height in pixels.
int	getOffsetWidth() Gets the object's offset width in pixels.
Element	getStyleElement() Template method that returns the element to which style names will be applied.
String	getStyleName() Gets all of the object's style names, as a space-separated list.
static String	getStyleName(Element elem) Gets all of the element's style names, as a space-separated list.
String	getStylePrimaryName() Gets the primary style name associated with the object.
static String	getStylePrimaryName(Element elem) Gets the element's primary style name.
String	getTitle() Gets the title associated with this object.
boolean	isVisible() Determines whether or not this object is visible.
static boolean	isVisible(Element elem)
void	onEnsureDebugId(String baseID) Called when the user sets the id using the `ensureDebugId(String)` method.
void	removeStyleDependentName(String styleSuffix) Removes a dependent style name by specifying the style name's suffix.
void	removeStyleName(String style) Removes a style name.
final void	setElement(Element elem) Sets this object's browser element.
void	setElement(Element elem) Sets this object's browser element.
void	setHeight(String height) Sets the object's height.
void	setPixelSize(int width, int height) Sets the object's size, in pixels, not including decorations such as border, margin, and padding.
void	setSize(String width, String height) Sets the object's size.
void	setStyleDependentName(String styleSuffix, boolean add) Adds or removes a dependent style name by specifying the style name's suffix.
static void	setStyleName(Element elem, String styleName) Clears all of the element's style names and sets it to the given style.
static void	setStyleName(Element elem, String style, boolean add) This convenience method adds or removes a style name for a given element.
void	setStyleName(String style) Clears all of the object's style names and sets it to the given style.
void	setStyleName(String style, boolean add) Adds or removes a style name.
void	setStylePrimaryName(String style) Sets the object's primary style name and updates all dependent style names.
static void	setStylePrimaryName(Element elem, String style) Sets the element's primary style name and updates all dependent style names.
void	setTitle(String title) Sets the title associated with this object.
void	setVisible(boolean visible) Sets whether this object is visible.
static void	setVisible(Element elem, boolean visible)
void	setWidth(String width) Sets the object's width.
void	sinkEvents(int eventBitsToAdd) Adds a set of events to be sunk by this object.
String	toString() This method is overridden so that any object can be viewed in the debugger as an HTML snippet.
void	unsinkEvents(int eventBitsToRemove) Removes a set of events from this object's event list.

From class java.lang.Object

From interface com.google.gwt.event.logical.shared.HasAttachHandlers

From interface com.google.gwt.event.logical.shared.HasCloseHandlers

From interface com.google.gwt.event.shared.HasHandlers

From interface com.google.gwt.user.client.EventListener

From interface com.google.gwt.user.client.ui.HasAnimation

From interface com.google.gwt.user.client.ui.IsWidget

From interface com.google.gwt.user.client.ui.PopupListener

Public Constructors

public MenuBar ()

Creates an empty horizontal menu bar.

public MenuBar (boolean vertical)

Creates an empty menu bar.

Parameters

vertical	`true` to orient the menu bar vertically

public MenuBar (boolean vertical, MenuBar.MenuBarImages images)

This constructor is deprecated.
replaced by MenuBar(boolean, Resources)

Creates an empty menu bar that uses the specified image bundle for menu images.

Parameters

vertical	`true` to orient the menu bar vertically
images	a bundle that provides images for this menu

public MenuBar (boolean vertical, MenuBar.Resources resources)

Creates an empty menu bar that uses the specified ClientBundle for menu images.

Parameters

vertical	`true` to orient the menu bar vertically
resources	a bundle that provides images for this menu

public MenuBar (MenuBar.MenuBarImages images)

This constructor is deprecated.
replaced by MenuBar(Resources)

Creates an empty horizontal menu bar that uses the specified image bundle for menu images.

Parameters

images	a bundle that provides images for this menu

public MenuBar (MenuBar.Resources resources)

Creates an empty horizontal menu bar that uses the specified ClientBundle for menu images.

Parameters

resources	a bundle that provides images for this menu

Public Methods

public HandlerRegistration addCloseHandler (CloseHandler<PopupPanel> handler)

public MenuItem addItem (MenuItem item)

Adds a menu item to the bar.

Parameters

item	the item to be added

Returns

the MenuItem object

public MenuItem addItem (SafeHtml html, MenuBar popup)

Adds a menu item to the bar, that will open the specified menu when it is selected.

Parameters

html	the item's html text
popup	the menu to be cascaded from it

Returns

the MenuItem object created

public MenuItem addItem (String text, MenuBar popup)

Adds a menu item to the bar, that will open the specified menu when it is selected.

Parameters

text	the item's text
popup	the menu to be cascaded from it

Returns

the MenuItem object created

public MenuItem addItem (SafeHtml html, Command cmd)

Adds a menu item to the bar containing SafeHtml, that will fire the given command when it is selected.

Parameters

html	the item's html text
cmd	the command to be fired

Returns

the MenuItem object created

public MenuItem addItem (String text, boolean asHTML, Command cmd)

Adds a menu item to the bar, that will fire the given command when it is selected.

Parameters

text	the item's text
asHTML	`true` to treat the specified text as html
cmd	the command to be fired

Returns

the MenuItem object created

public MenuItem addItem (String text, boolean asHTML, MenuBar popup)

Adds a menu item to the bar, that will open the specified menu when it is selected.

Parameters

text	the item's text
asHTML	`true` to treat the specified text as html
popup	the menu to be cascaded from it

Returns

the MenuItem object created

public MenuItem addItem (String text, Command cmd)

Adds a menu item to the bar, that will fire the given command when it is selected.

Parameters

text	the item's text
cmd	the command to be fired

Returns

the MenuItem object created

public MenuItemSeparator addSeparator ()

Adds a thin line to the MenuBar to separate sections of MenuItems.

Returns

the MenuItemSeparator object created

public MenuItemSeparator addSeparator (MenuItemSeparator separator)

Adds a thin line to the MenuBar to separate sections of MenuItems.

Parameters

separator	the `MenuItemSeparator` to be added

Returns

the MenuItemSeparator object

public void clearItems ()

Removes all menu items from this menu bar.

public void closeAllChildren (boolean focus)

Closes this menu and all child menu popups.

Parameters

focus	true to move focus to the parent

public void focus ()

Give this MenuBar focus.

public boolean getAutoOpen ()

Gets whether this menu bar's child menus will open when the mouse is moved over it.

Returns

true if child menus will auto-open

public int getItemIndex (MenuItem item)

Get the index of a MenuItem.

Returns

the index of the item, or -1 if it is not contained by this MenuBar

public int getSeparatorIndex (MenuItemSeparator item)

Get the index of a MenuItemSeparator.

Returns

the index of the separator, or -1 if it is not contained by this MenuBar

public MenuItem insertItem (MenuItem item, int beforeIndex)

Adds a menu item to the bar at a specific index.

Parameters

item	the item to be inserted
beforeIndex	the index where the item should be inserted

Returns

the MenuItem object

Throws

IndexOutOfBoundsException	if `beforeIndex` is out of range

public MenuItemSeparator insertSeparator (MenuItemSeparator separator, int beforeIndex)

Adds a thin line to the MenuBar to separate sections of MenuItems at the specified index.

Parameters

separator	the `MenuItemSeparator` to be inserted
beforeIndex	the index where the separator should be inserted

Returns

the MenuItemSeparator object

Throws

IndexOutOfBoundsException	if `beforeIndex` is out of range

public MenuItemSeparator insertSeparator (int beforeIndex)

Adds a thin line to the MenuBar to separate sections of MenuItems at the specified index.

Parameters

beforeIndex	the index where the separator should be inserted

Returns

the MenuItemSeparator object

Throws

IndexOutOfBoundsException	if `beforeIndex` is out of range

public boolean isAnimationEnabled ()

Returns true if animations are enabled, false if not.

public boolean isFocusOnHoverEnabled ()

Check whether or not this widget will steal keyboard focus when the mouse hovers over it.

Returns

true if enabled, false if disabled

public void moveSelectionDown ()

Moves the menu selection down to the next item. If there is no selection, selects the first item. If there are no items at all, does nothing.

public void moveSelectionUp ()

Moves the menu selection up to the previous item. If there is no selection, selects the first item. If there are no items at all, does nothing.

public void onBrowserEvent (Event event)

Fired whenever a browser event is received.

Parameters

event	the event received

public void onPopupClosed (PopupPanel sender, boolean autoClosed)

This method is deprecated.
Use addCloseHandler(CloseHandler) instead

Closes the menu bar.

Parameters

sender	popup being closed.
autoClosed	`true` if the popup was automatically closed; `false` if it was closed programmatically.

public void removeItem (MenuItem item)

Removes the specified menu item from the bar.

Parameters

item	the item to be removed

public void removeSeparator (MenuItemSeparator separator)

Removes the specified MenuItemSeparator from the bar.

Parameters

separator	the separator to be removed

public void selectItem (MenuItem item)

Select the given MenuItem, which must be a direct child of this MenuBar.

Parameters

item	the MenuItem to select, or null to clear selection

public void setAnimationEnabled (boolean enable)

Enable or disable animations.

Parameters

enable	true to enable, false to disable

public void setAutoOpen (boolean autoOpen)

Sets whether this menu bar's child menus will open when the mouse is moved over it.

Parameters

autoOpen	`true` to cause child menus to auto-open

public void setFocusOnHoverEnabled (boolean enabled)

Enable or disable auto focus when the mouse hovers over the MenuBar. This allows the MenuBar to respond to keyboard events without the user having to click on it, but it will steal focus from other elements on the page. Enabled by default.

Parameters

enabled	true to enable, false to disable

Protected Methods

protected List<MenuItem> getItems ()

Returns a list containing the MenuItem objects in the menu bar. If there are no items in the menu bar, then an empty List object will be returned.

Returns

a list containing the MenuItem objects in the menu bar

protected MenuItem getSelectedItem ()

Returns the MenuItem that is currently selected (highlighted) by the user. If none of the items in the menu are currently selected, then null will be returned.

Returns

the MenuItem that is currently selected, or null if no items are currently selected

protected void onDetach ()

This method is called when a widget is detached from the browser's document. To receive notification before a Widget is removed from the document, override the onUnload() method or use addAttachHandler(AttachEvent.Handler).

It is strongly recommended that you override onUnload() or doDetachChildren() instead of this method to avoid inconsistencies between logical and physical attachment states.

Subclasses that override this method must call super.onDetach() to ensure that the Widget has been detached from the underlying Element. Failure to do so will result in application memory leaks due to circular references between DOM Elements and JavaScript objects.

protected void onEnsureDebugId (String baseID)

Affected Elements:

-item# = the MenuItem at the specified index.

Parameters

baseID	the base ID used by the main element

Interfaces

Classes

Annotations

Enums

Exceptions

MenuBar

Class Overview

CSS Style Rules

Example

Use in UiBinder Templates

Summary

Public Constructors

public MenuBar ()

public MenuBar (boolean vertical)

Parameters

public MenuBar (boolean vertical, MenuBar.MenuBarImages images)

Parameters

public MenuBar (boolean vertical, MenuBar.Resources resources)

Parameters

public MenuBar (MenuBar.MenuBarImages images)

Parameters

public MenuBar (MenuBar.Resources resources)

Parameters

Public Methods

public HandlerRegistration addCloseHandler (CloseHandler<PopupPanel> handler)

public MenuItem addItem (MenuItem item)

Parameters

Returns

public MenuItem addItem (SafeHtml html, MenuBar popup)

Parameters

Returns

public MenuItem addItem (String text, MenuBar popup)

Parameters

Returns

public MenuItem addItem (SafeHtml html, Command cmd)

Parameters

Returns

public MenuItem addItem (String text, boolean asHTML, Command cmd)

Parameters

Returns

public MenuItem addItem (String text, boolean asHTML, MenuBar popup)

Parameters

Returns

public MenuItem addItem (String text, Command cmd)

Parameters

Returns

public MenuItemSeparator addSeparator ()

Returns

public MenuItemSeparator addSeparator (MenuItemSeparator separator)

Parameters

Returns

public void clearItems ()

public void closeAllChildren (boolean focus)

Parameters

public void focus ()

public boolean getAutoOpen ()

Returns

public int getItemIndex (MenuItem item)

Returns

public int getSeparatorIndex (MenuItemSeparator item)

Returns

public MenuItem insertItem (MenuItem item, int beforeIndex)

Parameters

Returns

Throws

public MenuItemSeparator insertSeparator (MenuItemSeparator separator, int beforeIndex)

Parameters

Returns

Throws

public MenuItemSeparator insertSeparator (int beforeIndex)

Parameters

Returns

Throws

public boolean isAnimationEnabled ()

public boolean isFocusOnHoverEnabled ()

Returns

public void moveSelectionDown ()

public void moveSelectionUp ()

public void onBrowserEvent (Event event)

Parameters