Package com.storedobject.vaadin

Class MenuBarItem

java.lang.Object

com.vaadin.flow.component.Component

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

com.storedobject.vaadin.MenuBarItem

All Implemented Interfaces:

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

Direct Known Subclasses:

MenuBar

public abstract class MenuBarItem
extends com.vaadin.flow.component.Composite<com.vaadin.flow.component.Component>

Represents a "menu bar item" or its "sub-menu".

Author:

Syam

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
MenuBarItem()

Method Summary

Modifier and Type	Method	Description
abstract MenuBarItem	addMenuItem(com.vaadin.flow.component.Component component)	Add a menu so that a sub-menu can be created under that.
abstract MenuBarItem	addMenuItem(com.vaadin.flow.component.Component component, ClickHandler clickHandler)	Add a menu with its click-handler.
abstract MenuBarItem	addMenuItem(String caption)	Add a menu so that a sub-menu can be created under that.
abstract MenuBarItem	addMenuItem(String caption, ClickHandler clickHandler)	Add a menu with its click-handler.
boolean	isCheckable()	Gets whether this item toggles a checkmark icon when clicked.
boolean	isChecked()	Gets the checked state of this item.
abstract void	remove(MenuBarItem... items)	Removes the given menu items from this.
abstract void	removeAll()	Removes all menu items from this.
void	setCheckable(boolean checkable)	Sets the checkable state of this menu item.
void	setChecked(boolean checked)	Sets the checked state of this item.

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

getChildren, getContent, getElement, initContent

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

MenuBarItem

public MenuBarItem()

Method Details

addMenuItem

public abstract MenuBarItem addMenuItem(String caption,
 ClickHandler clickHandler)

Add a menu with its click-handler.

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 abstract MenuBarItem addMenuItem(com.vaadin.flow.component.Component component,
 ClickHandler clickHandler)

Add a menu with its click-handler.

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 abstract MenuBarItem addMenuItem(String caption)

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

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 abstract MenuBarItem addMenuItem(com.vaadin.flow.component.Component component)

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

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 abstract void remove(MenuBarItem... items)

Removes the given menu items from this.

Parameters:

items - Menu items to remove.

removeAll

public abstract void removeAll()

Removes all menu items from this.

setCheckable

public void setCheckable(boolean checkable)

Sets the checkable state of this menu item. A checkable item toggles a checkmark icon when clicked. Changes in the checked state can be handled in the item's click handler with isChecked(). Setting a checked item un-checkable also makes it un-checked.

Parameters:

checkable - true to enable toggling the checked-state of this menu item by clicking, false to disable it.

isCheckable

public boolean isCheckable()

Gets whether this item toggles a checkmark icon when clicked.

Returns:

the checkable state of the item.

setChecked

public void setChecked(boolean checked)

Sets the checked state of this item. A checked item displays a checkmark icon next to it. The checked state is also toggled by clicking the item.

Parameters:

checked - true to check this item, false to un-check it.

isChecked

public boolean isChecked()

Gets the checked state of this item. The item can be checked and un-checked with setChecked(boolean) or by clicking it when it is checkable. A checked item displays a checkmark icon inside it.

Returns:

true if the item is checked, false otherwise.