Package com.vaadin.flow.component.contextmenu

Class ContextMenu

java.lang.Object

com.vaadin.flow.component.Component

com.vaadin.flow.component.contextmenu.GeneratedVaadinContextMenu<C>

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

com.vaadin.flow.component.contextmenu.ContextMenu

All Implemented Interfaces:

AttachNotifier, ClickNotifier<ContextMenu>, HasMenuItems, DetachNotifier, HasComponents, HasElement, HasEnabled, HasStyle, Serializable

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

Server-side component for <vaadin-context-menu>.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class com.vaadin.flow.component.contextmenu.GeneratedVaadinContextMenu

GeneratedVaadinContextMenu.OpenedChangeEvent<R extends GeneratedVaadinContextMenu<R>>

Field Summary

Fields inherited from class com.vaadin.flow.component.contextmenu.ContextMenuBase

EVENT_DETAIL

Constructor Summary

Constructors

Constructor	Description
ContextMenu()	Creates an empty context menu.
ContextMenu(Component target)	Creates an empty context menu with the given target component.

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(SerializableRunnable contentReset)	Creates a menu manager instance which contains logic to control the menu content.

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

add, addComponentAtIndex, addItem, addItem, addOpenedChangeListener, close, getChildren, getItems, getMenuManager, getTarget, isOpened, isOpenOnClick, onBeforeOpenMenu, remove, removeAll, setOpenOnClick, setTarget

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

getCloseOnString, getListenOnJsonObject, getOpenOnString, getSelectorString, isOpenedBoolean, open, setCloseOn, setListenOn, setOpenOn, setSelector

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

addListener, fireEvent, from, get, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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

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

addDetachListener

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

add, addComponentAsFirst

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

getElement

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

isEnabled, setEnabled

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

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

Constructor Detail

ContextMenu

public ContextMenu()

Creates an empty context menu.

ContextMenu

public ContextMenu(Component target)

Creates an empty context menu with the given target component.

Parameters:

target - the target component for this context menu

See Also:

ContextMenuBase.setTarget(Component)

Method Detail

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(SerializableRunnable contentReset)

Description copied from class: ContextMenuBase

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

Specified by:

createMenuManager in class ContextMenuBase<ContextMenu,MenuItem,SubMenu>

Parameters:

contentReset - callback to reset the menu content

Returns:

a new menu manager instance