Package com.vaadin.flow.component.contextmenu

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

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.contextmenu.ContextMenuBase<C,I,S>
Type Parameters:
C - the context-menu type
I - the menu-item type
S - the sub menu type
All Implemented Interfaces:
AttachNotifier, DetachNotifier, HasElement, HasStyle, Serializable
Direct Known Subclasses:
ContextMenu, GridContextMenu
@Tag("vaadin-context-menu") @NpmPackage(value="@vaadin/context-menu", version="25.0.0-beta1") @JsModule("@vaadin/context-menu/src/vaadin-context-menu.js") @JsModule("./flow-component-renderer.js") @JsModule("./contextMenuConnector.js") @JsModule("./contextMenuTargetConnector.js") public abstract class ContextMenuBase<C extends ContextMenuBase<C,I,S>,I extends MenuItemBase<C,I,S>,S extends SubMenuBase<C,I,S>> extends Component implements HasStyle
Base functionality for server-side components based on <vaadin-context-menu>. Classes extending this should provide API for adding items and handling events related to them. For basic example, see ContextMenu.
Author:
Vaadin Ltd.
See Also:

  • Field Details

  • Constructor Details

    • ContextMenuBase

      public ContextMenuBase()
      Creates an empty context menu.

  • Method Details

    • setTarget

      public void setTarget(Component target)
      Sets the target component for this context menu.

      By default, the context menu can be opened with a right click or a long touch on the target component.

      Parameters:
      target - the target component for this context menu, can be null to remove the target

    • getTarget

      public Component getTarget()
      Gets the target component of this context menu, or null if it doesn't have a target.
      Returns:
      the target component of this context menu
      See Also:

    • setOpenOnClick

      public void setOpenOnClick(boolean openOnClick)
      Determines the way for opening the context menu.

      By default, the context menu can be opened with a right click or a long touch on the target component.

      Parameters:
      openOnClick - if true, the context menu can be opened with left click only. Otherwise the context menu follows the default behavior.

    • isOpenOnClick

      public boolean isOpenOnClick()
      Gets whether the context menu can be opened via left click.

      By default, this will return false and context menu can be opened with a right click or a long touch on the target component.

      Returns:
      true if the context menu can be opened with left click only. Otherwise the context menu follows the default behavior.

    • close

      public void close()
      Closes this context menu if it is currently open.

    • addItem

      public I addItem(String text)
      Creates a new menu item with the given text content and adds it to the context menu.
      Parameters:
      text - the text content for the created menu item
      Returns:
      the created menu item

    • addItem

      public I addItem(Component component)
      Creates a new menu item with the given component content and adds it to the context menu.
      Parameters:
      component - the component to add to the created menu item
      Returns:
      the created menu item

    • addComponent

      public void addComponent(Component... components)
      Adds the given components to the context menu.

      For the common use case of having a list of high-lightable items inside the menu, use addItem(String) and its overload methods instead.

      Parameters:
      components - the components to add
      See Also:

    • addComponent

      public void addComponent(Collection<Component> components)
      Adds the given components to the context menu.

      For the common use case of having a list of high-lightable items inside the menu, use addItem(String) and its overload methods instead.

      Parameters:
      components - the components to add
      See Also:

    • remove

      public void remove(Component... components)
      Removes the given components from the context menu.
      Parameters:
      components - the components to remove

    • removeAll

      public void removeAll()
      Removes all the child components. This also removes all the items added with addItem(String) and its overload methods.

    • addComponentAtIndex

      public void addComponentAtIndex(int index, Component component)
      Adds the given component to the context menu at the given index.

      For the common use case of having a list of high-lightable items inside the menu, use addItem(String) and its overload methods instead.

      Parameters:
      index - the index, where the component will be added
      component - the component to add

    • addComponentAsFirst

      public void addComponentAsFirst(Component component)
      Adds the given component as the first child to the context menu.

      For the common use case of having a list of high-lightable items inside the menu, use addItem(String) and its overload methods instead.

      Parameters:
      component - the component to add

    • addSeparator

      public void addSeparator()
      Adds a separator between items.

    • getChildren

      public Stream<Component> getChildren()
      Gets the child components of this component. This includes components added with addComponent(Component...) and the MenuItem components created with addItem(String) and its overload methods. This doesn't include the components added to the sub menus of this context menu.
      Overrides:
      getChildren in class Component
      Returns:
      the child components of this component
      See Also:

    • getItems

      public List<I> getItems()
      Gets the items added to this component (the children of this component that are instances of MenuItem). This doesn't include the components added to the sub menus of this context menu.
      Returns:
      the MenuItem components in this context menu
      See Also:

    • isOpened

      @Synchronize(property="opened", value="opened-changed") public boolean isOpened()
      Gets the open state from the context menu.

      This property is synchronized automatically from client side when an opened-changed event happens.

      Returns:
      the opened property from the context menu

    • addOpenedChangeListener

      public Registration addOpenedChangeListener(ComponentEventListener<ContextMenuBase.OpenedChangeEvent<C>> listener)
      Adds a listener for the opened-changed events fired by the web component.
      Parameters:
      listener - the listener to add
      Returns:
      a Registration for removing the event listener

    • getMenuManager

      protected MenuManager<C,I,S> getMenuManager()
      Gets the menu manager.
      Returns:
      the menu manager

    • createMenuManager

      protected abstract MenuManager<C,I,S> createMenuManager(SerializableRunnable contentReset)
      Creates a menu manager instance which contains logic to control the menu content.
      Parameters:
      contentReset - callback to reset the menu content
      Returns:
      a new menu manager instance

    • onBeforeOpenMenu

      protected boolean onBeforeOpenMenu(tools.jackson.databind.node.ObjectNode eventDetail)
      Decides whether to open the menu when the beforeOpenHandler(DomEvent) is processed, sub-classes can easily override it and perform additional operations in this phase.

      The event details are completely specified by the target component that is in charge of defining the data it sends to the server. Based on this information, this method enables for dynamically modifying the contents of the context menu. Furthermore, this method's return value specifies if the context menu will be opened.

      Parameters:
      eventDetail - the client side event details provided by the target component.
      Returns:
      true if the context menu should be opened, false otherwise.