Package com.vaadin.flow.component.contextmenu

Class SubMenu

java.lang.Object

com.vaadin.flow.component.contextmenu.SubMenuBase<ContextMenu,MenuItem,SubMenu>

com.vaadin.flow.component.contextmenu.SubMenu

All Implemented Interfaces:

HasMenuItems, Serializable

public class SubMenu
extends SubMenuBase<ContextMenu,MenuItem,SubMenu>
implements HasMenuItems

API that allows adding content into the sub menus of a ContextMenu to create hierarchical menus. Get it by calling MenuItemBase.getSubMenu() on the item component that should open the sub menu. Sub menu will be rendered only if content has been added inside it.

Author:

Vaadin Ltd.

See Also:

• Serialized Form

Constructor Summary

Constructors

Constructor	Description
SubMenu(MenuItem parentMenuItem, SerializableRunnable contentReset)

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.
protected MenuManager<ContextMenu,MenuItem,SubMenu>	createMenuManager()	Creates a (sub) menu manager instance which contains logic to control the (sub) menu content.

Methods inherited from class com.vaadin.flow.component.contextmenu.SubMenuBase

add, addComponentAtIndex, addItem, addItem, getChildren, getItems, getMenuManager, getParentMenuItem, remove, removeAll

Methods inherited from class java.lang.Object

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

Constructor Details

SubMenu

public SubMenu(MenuItem parentMenuItem,
 SerializableRunnable contentReset)

Method Details

addItem

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

Description copied from interface: HasMenuItems

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.

Specified by:

addItem in interface HasMenuItems

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:

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

addItem

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

Description copied from interface: HasMenuItems

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.

Specified by:

addItem in interface HasMenuItems

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:

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

createMenuManager

protected MenuManager<ContextMenu,MenuItem,SubMenu> createMenuManager()

Description copied from class: SubMenuBase

Creates a (sub) menu manager instance which contains logic to control the (sub) menu content.

Specified by:

createMenuManager in class SubMenuBase<ContextMenu,MenuItem,SubMenu>

Returns:

a new menu manager instance