Package com.storedobject.vaadin

Class MenuBar

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

com.storedobject.vaadin.MenuBarItem

com.storedobject.vaadin.MenuBar

All Implemented Interfaces:

com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasStyle, Serializable

public class MenuBar
extends MenuBarItem

This component provides the same functionality of Vaadin's MenuBar. However, it is easier to use it in your code.

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MenuBar()

Method Summary

Modifier and Type	Method	Description
MenuBarItem	addMenuItem(com.vaadin.flow.component.Component component)	Add a menu so that a sub-menu can be created under that.
MenuBarItem	addMenuItem(com.vaadin.flow.component.Component component, ClickHandler clickHandler)	Add a menu with its click-handler.
MenuBarItem	addMenuItem(String caption)	Add a menu so that a sub-menu can be created under that.
MenuBarItem	addMenuItem(String caption, ClickHandler clickHandler)	Add a menu with its click-handler.
com.vaadin.flow.component.menubar.MenuBar	getBar()	Get Vaadin's MenuBar embedded in this.
protected com.vaadin.flow.component.menubar.MenuBar	initContent()
boolean	isOpenOnHover()	Gets whether the sub menus open by clicking or hovering on the root level buttons.
void	remove(MenuBarItem... items)	Removes the given menu items from this menu bar.
void	removeAll()	Removes all menu items from this menu bar.
void	setOpenOnHover(boolean openOnHover)	Sets the event which opens the sub menus of the root level buttons.

Methods inherited from class com.storedobject.vaadin.MenuBarItem

isCheckable, isChecked, setCheckable, setChecked

Methods inherited from class com.vaadin.flow.component.Composite

getChildren, getContent, getElement

Methods inherited from class com.vaadin.flow.component.Component

addListener, findAncestor, fireEvent, from, get, getEventBus, getId, getListeners, getLocale, getParent, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, removeFromParent, scrollIntoView, scrollIntoView, set, setElement, setId, setVisible

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.vaadin.flow.component.AttachNotifier

addAttachListener

Methods inherited from interface com.vaadin.flow.component.DetachNotifier

addDetachListener

Methods inherited from interface com.vaadin.flow.component.HasStyle

addClassName, addClassNames, getClassName, getClassNames, getStyle, hasClassName, removeClassName, removeClassNames, setClassName, setClassName

Constructor Details

MenuBar

public MenuBar()

Method Details

initContent

protected com.vaadin.flow.component.menubar.MenuBar initContent()

Overrides:

initContent in class com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

addMenuItem

public MenuBarItem addMenuItem(String caption,
 ClickHandler clickHandler)

Description copied from class: MenuBarItem

Add a menu with its click-handler.

Specified by:

addMenuItem in class MenuBarItem

Parameters:

caption - Caption to display.

clickHandler - Click-handler.

Returns:

The menu that is added. This menu can not add further items because it already defines its own click handler.

addMenuItem

public MenuBarItem addMenuItem(com.vaadin.flow.component.Component component,
 ClickHandler clickHandler)

Description copied from class: MenuBarItem

Add a menu with its click-handler.

Specified by:

addMenuItem in class MenuBarItem

Parameters:

component - Component to display.

clickHandler - Click-handler.

Returns:

The menu that is added. This menu can not add further items because it already defines its own click handler.

addMenuItem

public MenuBarItem addMenuItem(String caption)

Description copied from class: MenuBarItem

Add a menu so that a sub-menu can be created under that.

Specified by:

addMenuItem in class MenuBarItem

Parameters:

caption - Caption to display.

Returns:

The menu that is added. It will be a sub-menu so that you can add further menu items under it.

addMenuItem

public MenuBarItem addMenuItem(com.vaadin.flow.component.Component component)

Description copied from class: MenuBarItem

Add a menu so that a sub-menu can be created under that.

Specified by:

addMenuItem in class MenuBarItem

Parameters:

component - Component to display.

Returns:

The menu that is added. It will be a sub-menu so that you can add further menu items under it.

remove

public void remove(MenuBarItem... items)

Removes the given menu items from this menu bar.

Specified by:

remove in class MenuBarItem

Parameters:

items - Menu items to remove.

removeAll

public void removeAll()

Removes all menu items from this menu bar.

Specified by:

removeAll in class MenuBarItem

setOpenOnHover

public void setOpenOnHover(boolean openOnHover)

Sets the event which opens the sub menus of the root level buttons.

Parameters:

openOnHover - true to make the sub menus open on hover (mouseover), false to make them openable by clicking.

isOpenOnHover

public boolean isOpenOnHover()

Gets whether the sub menus open by clicking or hovering on the root level buttons.

Returns:

true if the sub menus open by hovering on the root level buttons, false if they open by clicking.

getBar

public com.vaadin.flow.component.menubar.MenuBar getBar()

Get Vaadin's MenuBar embedded in this.

Returns:

Vaadin's menu bar. Direct manipulation of this for adding/removing components is discouraged. However, you may use it for the manipulation themes, internationalization etc.