Package com.storedobject.vaadin

Interface ApplicationMenuItem

All Superinterfaces:

com.vaadin.flow.component.HasElement, Serializable

All Known Subinterfaces:

ApplicationMenuItemGroup

All Known Implementing Classes:

MenuItem

public interface ApplicationMenuItem
extends com.vaadin.flow.component.HasElement

Application menu item definition. Only 3 methods are defined for the Application to interact with it. However, it should be "clickable" and should keep an associated Runnable to run as a response to the click event or some keyboard event. At a minimum a text label should be supported but a typical implementation should support a label and an icon. Also, it may support a "closable" attribute (by having a "close" icon) for those items with an associated View.

Author:

Syam

Method Summary

Modifier and Type	Method	Description
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.
default boolean	isEnabled()	Is this menu item enabled?
default void	setEnabled(boolean enabled)	Enable or disable this menu item.
void	setLabel(String caption)	Set the caption for the menu item.

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

getElement

Method Details

hilite

void hilite()

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

dehilite

void dehilite()

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

setLabel

void setLabel(String caption)

Set the caption for the menu item.

Parameters:

caption - Caption

setEnabled

default void setEnabled(boolean enabled)

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

Parameters:

enabled - Whether to enable or not.

isEnabled

default boolean isEnabled()

Is this menu item enabled?

Returns:

True/false.