Package com.storedobject.vaadin

Class MenuItem

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.HtmlComponent

com.vaadin.flow.component.HtmlContainer

com.vaadin.flow.component.html.Div

com.storedobject.vaadin.MenuItem

All Implemented Interfaces:

ApplicationMenuItem, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.ClickNotifier<com.vaadin.flow.component.html.Div>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.HasComponents, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasOrderedComponents, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, Serializable

@CssImport("./so/menu/styles.css")
public class MenuItem
extends com.vaadin.flow.component.html.Div
implements ApplicationMenuItem

Default implementation of ApplicationMenuItem and ApplicationMenuItemGroup.

Author:

Syam

See Also:

• Application
• ApplicationMenu
• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText

com.vaadin.flow.component.HasText.WhiteSpace

Constructor Summary

Constructors

Constructor	Description
MenuItem(String label, Icon icon, Runnable runnable, boolean closeable)

Method Summary

Modifier and Type	Method	Description
static ApplicationMenuItem	create(ExecutableView view, String menuLabel, Runnable menuAction)	Create a menu item for a View.
static ApplicationMenuItem	create(String menuLabel, String icon, Runnable menuAction)	Create a menu item.
static ApplicationMenuItemGroup	createGroup(String menuLabel)	Create a group menu item.
void	dehilite()	De-highlight the menu item so that it looks normal.
void	hilite()	Highlight the menu item so that it looks stand out among other menu items.
boolean	isEnabled()	Is this menu item enabled?
void	setEnabled(boolean enabled)	Enable or disable this menu item.
void	setLabel(String caption)	Set the caption for the menu item.

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

getTitle, setTitle

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

addListener, findAncestor, fireEvent, from, get, getChildren, getElement, 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.ClickNotifier

addClickListener, addClickShortcut, addDoubleClickListener, addSingleClickListener

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

addDetachListener

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

add, add, add, addComponentAsFirst, addComponentAtIndex, remove, remove, removeAll

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

getElement

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

getChildren, getComponentAt, getComponentCount, indexOf, replace

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

getHeight, getHeightUnit, getMaxHeight, getMaxWidth, getMinHeight, getMinWidth, getWidth, getWidthUnit, setHeight, setHeight, setHeightFull, setMaxHeight, setMaxHeight, setMaxWidth, setMaxWidth, setMinHeight, setMinHeight, setMinWidth, setMinWidth, setSizeFull, setSizeUndefined, setWidth, setWidth, setWidthFull

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

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

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

getText, getWhiteSpace, setText, setWhiteSpace

Constructor Details

MenuItem

public MenuItem(String label,
 Icon icon,
 Runnable runnable,
 boolean closeable)

Method Details

create

public static ApplicationMenuItem create(String menuLabel,
 String icon,
 Runnable menuAction)

Create a menu item.

Parameters:

menuLabel - Label.

icon - Icon.

menuAction - Action.

Returns:

Menu item.

create

public static ApplicationMenuItem create(ExecutableView view,
 String menuLabel,
 Runnable menuAction)

Create a menu item for a View.

Parameters:

view - View.

menuLabel - Label.

menuAction - Action.

Returns:

Menu item.

createGroup

public static ApplicationMenuItemGroup createGroup(String menuLabel)

Create a group menu item.

Parameters:

menuLabel - Label.

Returns:

Group menu item.

hilite

public void hilite()

Description copied from interface: ApplicationMenuItem

Highlight the menu item so that it looks stand out among other menu items.

Specified by:

hilite in interface ApplicationMenuItem

dehilite

public void dehilite()

Description copied from interface: ApplicationMenuItem

De-highlight the menu item so that it looks normal.

Specified by:

dehilite in interface ApplicationMenuItem

setLabel

public void setLabel(String caption)

Description copied from interface: ApplicationMenuItem

Set the caption for the menu item.

Specified by:

setLabel in interface ApplicationMenuItem

Parameters:

caption - Caption

setEnabled

public void setEnabled(boolean enabled)

Description copied from interface: ApplicationMenuItem

Enable or disable this menu item. (A disabled item should not be clickable).

Specified by:

setEnabled in interface ApplicationMenuItem

Specified by:

setEnabled in interface com.vaadin.flow.component.HasEnabled

Parameters:

enabled - Whether to enable or not.

isEnabled

public boolean isEnabled()

Description copied from interface: ApplicationMenuItem

Is this menu item enabled?

Specified by:

isEnabled in interface ApplicationMenuItem

Specified by:

isEnabled in interface com.vaadin.flow.component.HasEnabled

Returns:

True/false.