Package com.vaadin.flow.component.contextmenu

Class ContextMenu

java.lang.Object

com.vaadin.flow.component.Component

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

com.vaadin.flow.component.contextmenu.ContextMenu

All Implemented Interfaces:

AttachNotifier, HasMenuItems, DetachNotifier, HasElement, HasStyle, Serializable

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

Context Menu is a component that you can attach to any component to display a context menu. The menu appears on right (default) or left click. On a touch device, a long press opens the context menu. You can use dividers to separate and group related content. Use dividers sparingly, though, to avoid creating unnecessary visual clutter.

Context Menu, like Menu Bar, supports multi-level sub-menus. You can use a hierarchical menu to organize a large set of options and group related items. Moreover, Context Menu supports checkable menu items that can be used to toggle a setting on and off. It also supports disabling menu items to show that they are unavailable. Menu items can also be customized to include more than a single line of text. You can use left-click to open Context Menu in situations where left-click does not have any other function, for example a Grid without selection support.

Best Practices:
Context Menu is used to provide shortcuts to the user. You should not use it as the only or primary means to complete a task. The primary way should be accessible elsewhere in the UI. Also note that you should use Context Menu when there is no dedicated button for opening an overlay menu, such as right-clicking a grid row. When there is a dedicated element/component, such as an overflow menu, use Menu Bar.

Author:

Vaadin Ltd.

See Also:

• Serialized Form

Nested Class Summary

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

ContextMenuBase.OpenedChangeEvent<TComponent extends ContextMenuBase<TComponent,?,?>>

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)	Creates a new menu item with the given component content and click listener and adds it to the context menu overlay.
MenuItem	addItem(String text, ComponentEventListener<ClickEvent<MenuItem>> clickListener)	Creates a new menu item with the given text content and click listener and adds it 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.
ContextMenuPosition	getPosition()	Gets position of the context menu with respect to its target.
void	setPosition(ContextMenuPosition position)	Sets position of the context menu with respect to its target.

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

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

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

addListener, findAncestor, fireEvent, from, get, 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.DetachNotifier

addDetachListener

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

getElement

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

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

Constructor Details

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 Details

addItem

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

Description copied from interface: HasMenuItems

Creates a new menu item with the given text content and click listener and adds it to the context menu overlay.

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)

addItem

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

Description copied from interface: HasMenuItems

Creates a new menu item with the given component content and click listener and adds it to the context menu overlay.

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)

getPosition

public ContextMenuPosition getPosition()

Gets position of the context menu with respect to its target.

Returns:

the position

setPosition

public void setPosition(ContextMenuPosition position)

Sets position of the context menu with respect to its target. When null is passed, resets to default behaviour of opening context menu at the location of the click.

By default, no position is set and the context menu opens at the location of the click.

Parameters:

position - the position to set

See Also:

• ContextMenuBase.setTarget(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