com.vaadin.flow.component.grid.contextmenu.GridMenuItem API 23.1.17 | Vaadin

You're viewing an older version of Vaadin JavaDoc. Please see version 24.7.0 for the latest.

com.vaadin.flow.component.grid.contextmenu.

java.lang.Object
- com.vaadin.flow.component.Component
- - com.vaadin.flow.component.contextmenu.MenuItemBase<GridContextMenu<T>,GridMenuItem<T>,GridSubMenu<T>>
  - - com.vaadin.flow.component.grid.contextmenu.GridMenuItem<T>

All Implemented Interfaces:

AttachNotifier, DetachNotifier, HasComponents, HasElement, HasEnabled, HasText, Serializable
```
public class GridMenuItem<T>
extends MenuItemBase<GridContextMenu<T>,GridMenuItem<T>,GridSubMenu<T>>
```
Item component used inside GridContextMenu and GridSubMenu. This component can be created and added to a menu overlay with HasGridMenuItems.addItem(String, ComponentEventListener) and similar methods.

Author:

Vaadin Ltd.

See Also:

Serialized Form

Nested Class Summary
- Nested classes/interfaces inherited from interface com.vaadin.flow.component.HasText
  HasText.WhiteSpace

Constructor Summary

Constructors
Constructor	Description
`GridMenuItem(GridContextMenu<T> contextMenu, SerializableRunnable contentReset)`	Creates a new instance using the context menu and its reset callback.

Method Summary

All Methods
Modifier and Type	Method	Description
`Registration`	`addMenuItemClickListener(ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>> clickListener)`	Adds the given click listener for this menu item.
`protected GridSubMenu<T>`	`createSubMenu()`

Methods inherited from class com.vaadin.flow.component.contextmenu.MenuItemBase
addThemeNames, executeJsWhenAttached, getContextMenu, getSubMenu, hasThemeName, isCheckable, isChecked, isParentItem, removeThemeNames, setCheckable, setChecked

Methods inherited from class com.vaadin.flow.component.Component
addListener, fireEvent, from, get, getChildren, getElement, getEventBus, getId, getLocale, getParent, getTranslation, getTranslation, getTranslation, getUI, hasListener, isAttached, isTemplateMapped, isVisible, onAttach, onDetach, onEnabledStateChanged, 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.HasComponents
add, add, addComponentAsFirst, addComponentAtIndex, remove, removeAll

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.HasText
getText, getWhiteSpace, setText, setWhiteSpace

- Constructor Detail
  - GridMenuItem
```
public GridMenuItem(GridContextMenu<T> contextMenu,
                    SerializableRunnable contentReset)
```
    Creates a new instance using the context menu and its reset callback.
    
    Parameters:
    
    contextMenu - the context menu, not null
    
    contentReset - the callback to reset the context menu, not null
- Method Detail
  - addMenuItemClickListener
```
public Registration addMenuItemClickListener(ComponentEventListener<GridContextMenu.GridContextMenuItemClickEvent<T>> clickListener)
```
    Adds the given click listener for this menu item. The fired GridContextMenu.GridContextMenuItemClickEvent contains information of which item inside the Grid was targeted when the context menu was opened.
    
    Parameters:
    
    clickListener - the click listener to add
    
    Returns:
    
    a handle for removing the listener
  - createSubMenu
```
protected GridSubMenu<T> createSubMenu()
```
    Specified by:
    
    createSubMenu in class MenuItemBase<GridContextMenu<T>,GridMenuItem<T>,GridSubMenu<T>>