MenuBar (vaadin-all 8.6.1 API)

java.lang.Object
- com.google.gwt.user.client.ui.UIObject
- - com.google.gwt.user.client.ui.Widget
  - - com.vaadin.client.ui.menubar.MenuBar

All Implemented Interfaces:

com.google.gwt.event.logical.shared.HasAttachHandlers, com.google.gwt.event.shared.HasHandlers, com.google.gwt.user.client.EventListener, com.google.gwt.user.client.ui.HasVisibility, com.google.gwt.user.client.ui.IsWidget, com.google.gwt.user.client.ui.PopupListener

Direct Known Subclasses:

VComboBox.SuggestionMenu

Deprecated.
```
@Deprecated
public class MenuBar
extends com.google.gwt.user.client.ui.Widget
implements com.google.gwt.user.client.ui.PopupListener
```
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 .gwt-MenuItem { menu items }
- .gwt-MenuBar .gwt-MenuItem-selected { selected menu items }
Example

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

Constructors
Constructor and Description

MenuBar()
Deprecated.

Creates an empty horizontal menu bar.

MenuBar(boolean vertical)
Deprecated.

Creates an empty menu bar.

Constructors
Constructor and Description
`MenuBar()` Deprecated. Creates an empty horizontal menu bar.
`MenuBar(boolean vertical)` Deprecated. Creates an empty menu bar.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`void`	`addItem(MenuItem item)` Deprecated. Adds a menu item to the bar.
`MenuItem`	`addItem(String text, boolean asHTML, com.google.gwt.user.client.Command cmd)` Deprecated. 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)` Deprecated. Adds a menu item to the bar, that will open the specified menu when it is selected.
`MenuItem`	`addItem(String text, com.google.gwt.user.client.Command cmd)` Deprecated. Adds a menu item to the bar, that will fire the given command when it is selected.
`MenuItem`	`addItem(String text, MenuBar popup)` Deprecated. Adds a menu item to the bar, that will open the specified menu when it is selected.
`void`	`clearItems()` Deprecated. Removes all menu items from this menu bar.
`protected void`	`doItemAction(MenuItem item, boolean fireCommand)` Deprecated.
`boolean`	`getAutoOpen()` Deprecated. Gets whether this menu bar's child menus will open when the mouse is moved over it.
`MenuItem`	`getFirstItem()` Deprecated. Gets the first item from the menu or null if no items.
`List<MenuItem>`	`getItems()` Deprecated. Returns a list containing the `MenuItem` objects in the menu bar.
`MenuItem`	`getLastItem()` Deprecated. Gest the last item from the menu or null if no items.
`protected int`	`getPreferredHeight()` Deprecated. Gets the preferred height of the menu.
`int`	`getSelectedIndex()` Deprecated. Gets the index of the selected item.
`MenuItem`	`getSelectedItem()` Deprecated. Returns the `MenuItem` that is currently selected (highlighted) by the user.
`boolean`	`isScrollActive()` Deprecated. Gets whether the scroll is activate for this menu.
`void`	`onBrowserEvent(com.google.gwt.user.client.Event event)` Deprecated.
`protected void`	`onDetach()` Deprecated.
`void`	`onPopupClosed(com.google.gwt.user.client.ui.PopupPanel sender, boolean autoClosed)` Deprecated.
`void`	`removeItem(MenuItem item)` Deprecated. Removes the specified menu item from the bar.
`void`	`scrollSelectionIntoView()` Deprecated. Scroll the selected item into view.
`void`	`selectItem(MenuItem item)` Deprecated.
`void`	`setAutoOpen(boolean autoOpen)` Deprecated. Sets whether this menu bar's child menus will open when the mouse is moved over it.
`void`	`setScrollEnabled(boolean enabled)` Deprecated. Sets the menu scroll enabled or disabled.

Methods inherited from class com.google.gwt.user.client.ui.Widget
addAttachHandler, addBitlessDomHandler, addDomHandler, addHandler, asWidget, asWidgetOrNull, createHandlerManager, delegateEvent, doAttachChildren, doDetachChildren, fireEvent, getHandlerCount, getLayoutData, getParent, isAttached, isOrWasAttached, onAttach, onLoad, onUnload, removeFromParent, setLayoutData, sinkEvents, unsinkEvents

Methods inherited from class com.google.gwt.user.client.ui.UIObject
addStyleDependentName, addStyleName, ensureDebugId, ensureDebugId, ensureDebugId, getAbsoluteLeft, getAbsoluteTop, getElement, getOffsetHeight, getOffsetWidth, getStyleElement, getStyleName, getStyleName, getStylePrimaryName, getStylePrimaryName, getTitle, isVisible, isVisible, onEnsureDebugId, removeStyleDependentName, removeStyleName, resolvePotentialElement, setElement, setElement, setHeight, setPixelSize, setSize, setStyleDependentName, setStyleName, setStyleName, setStyleName, setStyleName, setStylePrimaryName, setStylePrimaryName, setTitle, setVisible, setVisible, setWidth, sinkBitlessEvent, toString

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - MenuBar
```
public MenuBar()
```
    Deprecated.
    
    Creates an empty horizontal menu bar.
  - MenuBar
```
public MenuBar(boolean vertical)
```
    Deprecated.
    
    Creates an empty menu bar.
    
    Parameters:
    
    vertical - true to orient the menu bar vertically
- Method Detail
  - addItem
```
public void addItem(MenuItem item)
```
    Deprecated.
    
    Adds a menu item to the bar.
    
    Parameters:
    
    item - the item to be added
  - addItem
```
public MenuItem addItem(String text,
                        boolean asHTML,
                        com.google.gwt.user.client.Command cmd)
```
    Deprecated.
    
    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
  - addItem
```
public MenuItem addItem(String text,
                        boolean asHTML,
                        MenuBar popup)
```
    Deprecated.
    
    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
  - addItem
```
public MenuItem addItem(String text,
                        com.google.gwt.user.client.Command cmd)
```
    Deprecated.
    
    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
  - addItem
```
public MenuItem addItem(String text,
                        MenuBar popup)
```
    Deprecated.
    
    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
  - clearItems
```
public void clearItems()
```
    Deprecated.
    
    Removes all menu items from this menu bar.
  - getAutoOpen
```
public boolean getAutoOpen()
```
    Deprecated.
    
    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
  - onBrowserEvent
```
public void onBrowserEvent(com.google.gwt.user.client.Event event)
```
    Deprecated.
    
    Specified by:
    
    onBrowserEvent in interface com.google.gwt.user.client.EventListener
    
    Overrides:
    
    onBrowserEvent in class com.google.gwt.user.client.ui.Widget
  - onPopupClosed
```
public void onPopupClosed(com.google.gwt.user.client.ui.PopupPanel sender,
                          boolean autoClosed)
```
    Deprecated.
    
    Specified by:
    
    onPopupClosed in interface com.google.gwt.user.client.ui.PopupListener
  - removeItem
```
public void removeItem(MenuItem item)
```
    Deprecated.
    
    Removes the specified menu item from the bar.
    
    Parameters:
    
    item - the item to be removed
  - setAutoOpen
```
public void setAutoOpen(boolean autoOpen)
```
    Deprecated.
    
    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
  - getItems
```
public List<MenuItem> getItems()
```
    Deprecated.
    
    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
  - getSelectedItem
```
public MenuItem getSelectedItem()
```
    Deprecated.
    
    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
  - getFirstItem
```
public MenuItem getFirstItem()
```
    Deprecated.
    
    Gets the first item from the menu or null if no items.
    
    Returns:
    
    the first item from the menu or null if no items.
    
    Since:
    
    7.2.6
  - getLastItem
```
public MenuItem getLastItem()
```
    Deprecated.
    
    Gest the last item from the menu or null if no items.
    
    Returns:
    
    the last item from the menu or null if no items.
    
    Since:
    
    7.2.6
  - getSelectedIndex
```
public int getSelectedIndex()
```
    Deprecated.
    
    Gets the index of the selected item.
    
    Returns:
    
    the index of the selected item.
    
    Since:
    
    7.2.6
  - onDetach
```
protected void onDetach()
```
    Deprecated.
    
    Overrides:
    
    onDetach in class com.google.gwt.user.client.ui.Widget
  - doItemAction
```
protected void doItemAction(MenuItem item,
                            boolean fireCommand)
```
    Deprecated.
  - selectItem
```
public void selectItem(MenuItem item)
```
    Deprecated.
  - scrollSelectionIntoView
```
public void scrollSelectionIntoView()
```
    Deprecated.
    
    Scroll the selected item into view.
    
    Since:
    
    7.2.6
  - setScrollEnabled
```
public void setScrollEnabled(boolean enabled)
```
    Deprecated.
    
    Sets the menu scroll enabled or disabled.
    
    Parameters:
    
    enabled - the enabled state of the scroll.
    
    Since:
    
    7.2.6
  - isScrollActive
```
public boolean isScrollActive()
```
    Deprecated.
    
    Gets whether the scroll is activate for this menu.
    
    Returns:
    
    true if the scroll is active, otherwise false.
    
    Since:
    
    7.2.6
  - getPreferredHeight
```
protected int getPreferredHeight()
```
    Deprecated.
    
    Gets the preferred height of the menu.
    
    Since:
    
    7.2.6

Class MenuBar

CSS Style Rules

Example

Nested Class Summary

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

Field Summary

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

Constructor Summary

Method Summary

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

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

Methods inherited from class java.lang.Object

Constructor Detail

MenuBar

MenuBar

Method Detail

addItem

addItem

addItem

addItem

addItem

clearItems

getAutoOpen

onBrowserEvent

onPopupClosed

removeItem

setAutoOpen

getItems

getSelectedItem

getFirstItem

getLastItem

getSelectedIndex

onDetach

doItemAction

selectItem

scrollSelectionIntoView

setScrollEnabled

isScrollActive

getPreferredHeight