SubMenuBase (Vaadin Platform (vaadin-platform-javadoc) 14.12.5 API)

java.lang.Object
- com.vaadin.flow.component.contextmenu.SubMenuBase<C,I,S>

Type Parameters:

C - the context-menu type

I - the menu-item type

S - the sub menu type

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

GridSubMenu, SubMenu
```
public abstract class SubMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>
extends Object
implements Serializable
```
Base class for sub-menus in ContextMenuBase extensions. Classes extending this should provide API for adding items and handling events related to them. For basic example, see SubMenu.

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor and Description

SubMenuBase(I parentMenuItem)

Constructors
Constructor and Description
`SubMenuBase(I parentMenuItem)`

Method Summary

All Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`add(Component... components)` Adds the given components into the sub menu overlay.
`void`	`addComponentAtIndex(int index, Component component)` Adds the given component into the sub menu overlay at the given index.
`I`	`addItem(Component component)` Adds a new item component with the given component to the sub menu overlay.
`I`	`addItem(String text)` Adds a new item component with the given text content to the sub menu overlay.
`protected abstract MenuManager<C,I,S>`	`createMenuManager()` Creates a (sub) menu manager instance which contains logic to control the (sub) menu content.
`Stream<Component>`	`getChildren()` Gets the child components of this sub menu.
`List<I>`	`getItems()` Gets the items added to this sub menu (the children of this component that are instances of `MenuItem`).
`protected MenuManager<C,I,S>`	`getMenuManager()` Gets a (sub) menu manager.
`I`	`getParentMenuItem()` Gets the menu item component that opens this sub menu overlay.
`void`	`remove(Component... components)` Removes the given components from the sub menu overlay.
`void`	`removeAll()` Removes all components inside the sub menu overlay.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - SubMenuBase
```
public SubMenuBase(I parentMenuItem)
```
- Method Detail
  - addItem
```
public I addItem(String text)
```
    Adds a new item component with the given text content to the sub 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 add(Component...) method.
    
    Parameters:
    
    text - the text content for the created menu item
    
    Returns:
    
    the created menu item
    
    See Also:
    
    add(Component...)
  - addItem
```
public I addItem(Component component)
```
    Adds a new item component with the given component to the sub 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 add(Component...) method.
    
    Parameters:
    
    component - the component to add to the created menu item
    
    Returns:
    
    the created menu item
    
    See Also:
    
    add(Component...)
  - add
```
public void add(Component... components)
```
    Adds the given components into the sub menu overlay.
    For the common use case of having a list of high-lightable items inside the overlay, you can use the addItem(String) convenience methods instead.
    The added elements will be inserted into an overlay that is attached into the <body>.
    
    Parameters:
    
    components - the components to add
    
    See Also:
    
    HasMenuItems.addItem(String, ComponentEventListener), HasMenuItems.addItem(Component, ComponentEventListener)
  - remove
```
public void remove(Component... components)
```
    Removes the given components from the sub menu overlay.
    
    Parameters:
    
    components - the components to remove
    
    See Also:
    
    add(Component...)
  - removeAll
```
public void removeAll()
```
    Removes all components inside the sub menu overlay.
    
    See Also:
    
    add(Component...)
  - addComponentAtIndex
```
public void addComponentAtIndex(int index,
                                Component component)
```
    Adds the given component into the sub menu overlay at the given index.
    The added elements will be inserted into an overlay that is attached into the <body>.
    
    Parameters:
    
    index - the index, where the component will be added
    
    component - the component to add
    
    See Also:
    
    add(Component...)
  - getChildren
```
public Stream<Component> getChildren()
```
    Gets the child components of this sub menu. This includes components added with add(Component...) and the MenuItem components created with addItem(String) and its overload methods. This doesn't include the components added to the main context menu or any other sub menus it may have.
    
    Returns:
    
    the child components of this sub menu
  - getItems
```
public List<I> getItems()
```
    Gets the items added to this sub menu (the children of this component that are instances of MenuItem).
    
    Returns:
    
    the MenuItem components in this sub menu
    
    See Also:
    
    addItem(String), getChildren()
  - getParentMenuItem
```
public I getParentMenuItem()
```
    Gets the menu item component that opens this sub menu overlay.
    
    Returns:
    
    the parent menu item of this sub menu
  - getMenuManager
```
protected MenuManager<C,I,S> getMenuManager()
```
    Gets a (sub) menu manager.
    
    Returns:
  - createMenuManager
```
protected abstract MenuManager<C,I,S> createMenuManager()
```
    Creates a (sub) menu manager instance which contains logic to control the (sub) menu content.
    
    Returns:
    
    a new menu manager instance

Class SubMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

SubMenuBase

Method Detail

addItem

addItem

add

remove

removeAll

addComponentAtIndex

getChildren

getItems

getParentMenuItem

getMenuManager

createMenuManager