Package com.vaadin.flow.component.contextmenu

Interface HasMenuItems

All Superinterfaces:

Serializable

All Known Implementing Classes:

ContextMenu, MenuBar, SubMenu

public interface HasMenuItems
extends Serializable

A common interface for components that can have MenuItems with click listeners inside them.

Author:

Vaadin Ltd.

See Also:

ContextMenu, SubMenu

Method Summary

Modifier and Type	Method	Description
MenuItem	addItem(Component component, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Adds a new item component with the given component and click listener to the context menu overlay.
MenuItem	addItem(String text, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Adds a new item component with the given text content and click listener to the context menu overlay.

Method Detail

addItem

MenuItem addItem(String text,
                 ComponentEventListener<ClickEvent<MenuItem>> clickListener)

Adds a new item component with the given text content and click listener to the context menu overlay.

This is a convenience method for the use case where you have a list of highlightable MenuItems inside the overlay. If you want to configure the contents of the overlay without wrapping them inside MenuItems, or if you just want to add some non-highlightable components between the items, use the ContextMenuBase.add(Component...) method.

Parameters:

text - the text content for the new item

clickListener - the handler for clicking the new item, can be null to not add listener

Returns:

the added MenuItem component

See Also:

addItem(Component, ComponentEventListener), ContextMenuBase.add(Component...), SubMenuBase.add(Component...)

addItem

MenuItem addItem(Component component,
                 ComponentEventListener<ClickEvent<MenuItem>> clickListener)

Adds a new item component with the given component and click listener to the context menu overlay.

This is a convenience method for the use case where you have a list of highlightable MenuItems inside the overlay. If you want to configure the contents of the overlay without wrapping them inside MenuItems, or if you just want to add some non-highlightable components between the items, use the ContextMenuBase.add(Component...) method.

Parameters:

component - the component inside the new item

clickListener - the handler for clicking the new item, can be null to not add listener

Returns:

the added MenuItem component

See Also:

addItem(String, ComponentEventListener), ContextMenuBase.add(Component...), SubMenuBase.add(Component...)