Package io.jmix.flowui.kit.component.dropdownbutton

Class AbstractDropdownButton

java.lang.Object
com.vaadin.flow.component.Component
com.vaadin.flow.component.Composite<JmixMenuBar>
io.jmix.flowui.kit.component.dropdownbutton.AbstractDropdownButton
All Implemented Interfaces:
com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.BlurNotifier<AbstractDropdownButton>, com.vaadin.flow.component.DetachNotifier, com.vaadin.flow.component.Focusable<AbstractDropdownButton>, com.vaadin.flow.component.FocusNotifier<AbstractDropdownButton>, com.vaadin.flow.component.HasElement, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.HasText, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.shared.HasOverlayClassName, DropdownButtonComponent, HasSubParts, HasTitle, Serializable
Direct Known Subclasses:
ComboButton, DropdownButton
public abstract class AbstractDropdownButton extends com.vaadin.flow.component.Composite<JmixMenuBar> implements DropdownButtonComponent, com.vaadin.flow.component.AttachNotifier, com.vaadin.flow.component.DetachNotifier, HasTitle, com.vaadin.flow.component.HasSize, com.vaadin.flow.component.HasTheme, com.vaadin.flow.component.HasEnabled, com.vaadin.flow.component.HasStyle, com.vaadin.flow.component.shared.HasOverlayClassName, com.vaadin.flow.component.HasText, com.vaadin.flow.component.Focusable<AbstractDropdownButton>
An abstract base class for dropdown button components, providing functionality for managing dropdown items, icons, styles, and various component behaviors. It serves as a customizable foundation for components such as dropdown buttons and combo buttons.
See Also:

  • Field Details

  • Constructor Details

    • AbstractDropdownButton

      public AbstractDropdownButton()

  • Method Details

    • getDropdownItem

      protected abstract JmixMenuItem getDropdownItem()

    • addItem

      public DropdownButtonItem addItem(String id, Action action)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier and action.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the identifier for the dropdown item
      action - the action to associate with the dropdown item
      Returns:
      the created dropdown item

    • addItem

      public DropdownButtonItem addItem(String id, Action action, int index)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, action, and index.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the identifier for the dropdown item
      action - the action to associate with the dropdown item
      index - the position at which the dropdown item will be added
      Returns:
      the created dropdown item

    • addItem

      public DropdownButtonItem addItem(String id, String text)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier and text.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the identifier for the dropdown item
      text - the text to display for the dropdown item
      Returns:
      the created dropdown item

    • addItem

      public DropdownButtonItem addItem(String id, String text, int index)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, text, and index.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the identifier for the dropdown item
      text - the text to display for the dropdown item
      index - the position at which the dropdown item will be added
      Returns:
      the created dropdown item

    • addItem

      public DropdownButtonItem addItem(String id, String text, Consumer<DropdownButtonItem.ClickEvent> componentEventListener)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, text, and a click event listener.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      text - the text displayed for the dropdown item
      componentEventListener - the listener to handle click events for the dropdown item
      Returns:
      the created dropdown item instance

    • addItem

      public DropdownButtonItem addItem(String id, String text, Consumer<DropdownButtonItem.ClickEvent> componentEventListener, int index)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, text, click event listener, and position index.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      text - the text to display for the dropdown item
      componentEventListener - the listener to handle click events for the dropdown item
      index - the position at which the dropdown item will be added
      Returns:
      the created dropdown item instance

    • addItem

      public DropdownButtonItem addItem(String id, com.vaadin.flow.component.Component component)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier and component content.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      component - the component to be used as content for the dropdown item
      Returns:
      the created dropdown item instance

    • addItem

      public DropdownButtonItem addItem(String id, com.vaadin.flow.component.Component component, int index)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, component content, and position index.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      component - the component to be used as content for the dropdown item
      index - the position at which the dropdown item will be added
      Returns:
      the created dropdown item instance

    • addItem

      public DropdownButtonItem addItem(String id, com.vaadin.flow.component.Component component, Consumer<DropdownButtonItem.ClickEvent> componentEventListener)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, content component, and a click event listener.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      component - the component to be used as content for the dropdown item
      componentEventListener - the listener to handle click events for the dropdown item
      Returns:
      the created dropdown item instance

    • addItem

      public DropdownButtonItem addItem(String id, com.vaadin.flow.component.Component component, Consumer<DropdownButtonItem.ClickEvent> componentEventListener, int index)
      Description copied from interface: DropdownButtonComponent
      Adds a new dropdown item with the specified identifier, component content, click event listener, and position index.
      Specified by:
      addItem in interface DropdownButtonComponent
      Parameters:
      id - the unique identifier for the dropdown item
      component - the component to be used as content for the dropdown item
      componentEventListener - the listener to handle click events for the dropdown item
      index - the position at which the dropdown item will be added
      Returns:
      the created dropdown item instance

    • createComponentMenuItem

      protected com.vaadin.flow.component.contextmenu.MenuItem createComponentMenuItem(String id, com.vaadin.flow.component.Component content, int index)

    • createTextMenuItem

      protected com.vaadin.flow.component.contextmenu.MenuItem createTextMenuItem(String id, String text, int index)

    • addItemInternal

      protected void addItemInternal(AbstractDropdownButton.HasMenuItem item, int index)

    • getItem

      @Nullable public DropdownButtonItem getItem(String itemId)
      Description copied from interface: DropdownButtonComponent
      Returns the dropdown item with the specified identifier.
      Specified by:
      getItem in interface DropdownButtonComponent
      Parameters:
      itemId - the unique identifier of the dropdown item to retrieve
      Returns:
      the item with the given identifier, or null if no item with the specified ID is found

    • getItems

      public List<DropdownButtonItem> getItems()
      Description copied from interface: DropdownButtonComponent
      Returns a list of all items currently present in the dropdown button component.
      Specified by:
      getItems in interface DropdownButtonComponent
      Returns:
      a list of DropdownButtonItem instances representing all items in the dropdown.

    • remove

      public void remove(String itemId)
      Description copied from interface: DropdownButtonComponent
      Removes the specified item identified by the given item ID.
      Specified by:
      remove in interface DropdownButtonComponent
      Parameters:
      itemId - the unique identifier of the item to be removed

    • remove

      public void remove(DropdownButtonItem item)
      Description copied from interface: DropdownButtonComponent
      Removes the specified item from the collection or list.
      Specified by:
      remove in interface DropdownButtonComponent
      Parameters:
      item - the item to be removed

    • remove

      public void remove(DropdownButtonItem... items)
      Description copied from interface: DropdownButtonComponent
      Removes the specified items from the dropdown button's list of items.
      Specified by:
      remove in interface DropdownButtonComponent
      Parameters:
      items - the items to be removed from the dropdown button. Each item represents a DropdownButtonItem object to be excluded from the list.

    • removeAll

      public void removeAll()
      Description copied from interface: DropdownButtonComponent
      Removes all items from the dropdown button component.
      Specified by:
      removeAll in interface DropdownButtonComponent

    • addSeparator

      public void addSeparator()
      Description copied from interface: DropdownButtonComponent
      Adds a visual separator to the dropdown menu. Separators are used to group related items visually.
      Specified by:
      addSeparator in interface DropdownButtonComponent

    • addSeparatorAtIndex

      public void addSeparatorAtIndex(int index)
      Description copied from interface: DropdownButtonComponent
      Adds a visual separator at the specified index in the dropdown menu. Separators are used to visually group related items within the menu.
      Specified by:
      addSeparatorAtIndex in interface DropdownButtonComponent
      Parameters:
      index - the position at which the separator will be added. The index must be a non-negative integer less than or equal to the current number of items.

    • addAttachListener

      public com.vaadin.flow.shared.Registration addAttachListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.AttachEvent> listener)
      Specified by:
      addAttachListener in interface com.vaadin.flow.component.AttachNotifier

    • isAttached

      public boolean isAttached()
      Overrides:
      isAttached in class com.vaadin.flow.component.Component

    • addDetachListener

      public com.vaadin.flow.shared.Registration addDetachListener(com.vaadin.flow.component.ComponentEventListener<com.vaadin.flow.component.DetachEvent> listener)
      Specified by:
      addDetachListener in interface com.vaadin.flow.component.DetachNotifier

    • getIcon

      @Nullable public com.vaadin.flow.component.icon.Icon getIcon()
      Description copied from interface: DropdownButtonComponent
      Returns the icon associated with the dropdown button item, if present.
      Specified by:
      getIcon in interface DropdownButtonComponent
      Returns:
      the icon of the dropdown button item, or null if no icon is set

    • setClassName

      public void setClassName(String className)
      Specified by:
      setClassName in interface com.vaadin.flow.component.HasStyle

    • setClassName

      public void setClassName(String className, boolean set)
      Specified by:
      setClassName in interface com.vaadin.flow.component.HasStyle

    • getClassName

      public String getClassName()
      Specified by:
      getClassName in interface com.vaadin.flow.component.HasStyle

    • addClassName

      public void addClassName(String className)
      Specified by:
      addClassName in interface com.vaadin.flow.component.HasStyle

    • removeClassName

      public boolean removeClassName(String className)
      Specified by:
      removeClassName in interface com.vaadin.flow.component.HasStyle

    • getClassNames

      public com.vaadin.flow.dom.ClassList getClassNames()
      Specified by:
      getClassNames in interface com.vaadin.flow.component.HasStyle

    • addClassNames

      public void addClassNames(String... classNames)
      Specified by:
      addClassNames in interface com.vaadin.flow.component.HasStyle

    • removeClassNames

      public void removeClassNames(String... classNames)
      Specified by:
      removeClassNames in interface com.vaadin.flow.component.HasStyle

    • hasClassName

      public boolean hasClassName(String className)
      Specified by:
      hasClassName in interface com.vaadin.flow.component.HasStyle

    • getOverlayClassName

      public String getOverlayClassName()
      Specified by:
      getOverlayClassName in interface com.vaadin.flow.component.shared.HasOverlayClassName

    • setOverlayClassName

      public void setOverlayClassName(String overlayClassName)
      Specified by:
      setOverlayClassName in interface com.vaadin.flow.component.shared.HasOverlayClassName

    • setThemeName

      public void setThemeName(String themeName)
      Specified by:
      setThemeName in interface com.vaadin.flow.component.HasTheme

    • setThemeName

      public void setThemeName(String themeName, boolean set)
      Specified by:
      setThemeName in interface com.vaadin.flow.component.HasTheme

    • getThemeName

      public String getThemeName()
      Specified by:
      getThemeName in interface com.vaadin.flow.component.HasTheme

    • addThemeName

      public void addThemeName(String themeName)
      Specified by:
      addThemeName in interface com.vaadin.flow.component.HasTheme

    • removeThemeName

      public boolean removeThemeName(String themeName)
      Specified by:
      removeThemeName in interface com.vaadin.flow.component.HasTheme

    • hasThemeName

      public boolean hasThemeName(String themeName)
      Specified by:
      hasThemeName in interface com.vaadin.flow.component.HasTheme

    • getThemeNames

      public com.vaadin.flow.dom.ThemeList getThemeNames()
      Specified by:
      getThemeNames in interface com.vaadin.flow.component.HasTheme

    • addThemeNames

      public void addThemeNames(String... themeNames)
      Specified by:
      addThemeNames in interface com.vaadin.flow.component.HasTheme

    • removeThemeNames

      public void removeThemeNames(String... themeNames)
      Specified by:
      removeThemeNames in interface com.vaadin.flow.component.HasTheme

    • setOpenOnHover

      public void setOpenOnHover(boolean openOnHover)
      Description copied from interface: DropdownButtonComponent
      Configures whether the dropdown menu opens when the user hovers over the button.
      Specified by:
      setOpenOnHover in interface DropdownButtonComponent
      Parameters:
      openOnHover - if true, the dropdown menu will open on hover; if false, it will only open on click

    • isOpenOnHover

      public boolean isOpenOnHover()
      Description copied from interface: DropdownButtonComponent
      Determines whether the dropdown menu is configured to open when the user hovers over the component.
      Specified by:
      isOpenOnHover in interface DropdownButtonComponent
      Returns:
      true if the dropdown opens on hover, false otherwise

    • setEnabled

      public void setEnabled(boolean enabled)
      Specified by:
      setEnabled in interface com.vaadin.flow.component.HasEnabled

    • isEnabled

      public boolean isEnabled()
      Specified by:
      isEnabled in interface com.vaadin.flow.component.HasEnabled

    • setTabIndex

      public void setTabIndex(int tabIndex)
      Specified by:
      setTabIndex in interface com.vaadin.flow.component.Focusable<AbstractDropdownButton>

    • getTabIndex

      public int getTabIndex()
      Specified by:
      getTabIndex in interface com.vaadin.flow.component.Focusable<AbstractDropdownButton>

    • focus

      public void focus()
      Specified by:
      focus in interface com.vaadin.flow.component.Focusable<AbstractDropdownButton>

    • blur

      public void blur()
      Specified by:
      blur in interface com.vaadin.flow.component.Focusable<AbstractDropdownButton>

    • addFocusShortcut

      public com.vaadin.flow.component.ShortcutRegistration addFocusShortcut(com.vaadin.flow.component.Key key, com.vaadin.flow.component.KeyModifier... keyModifiers)
      Specified by:
      addFocusShortcut in interface com.vaadin.flow.component.Focusable<AbstractDropdownButton>

    • setWidth

      public void setWidth(String width)
      Specified by:
      setWidth in interface com.vaadin.flow.component.HasSize

    • setWidth

      public void setWidth(float width, com.vaadin.flow.component.Unit unit)
      Specified by:
      setWidth in interface com.vaadin.flow.component.HasSize

    • setMinWidth

      public void setMinWidth(String minWidth)
      Specified by:
      setMinWidth in interface com.vaadin.flow.component.HasSize

    • setMinWidth

      public void setMinWidth(float minWidth, com.vaadin.flow.component.Unit unit)
      Specified by:
      setMinWidth in interface com.vaadin.flow.component.HasSize

    • setMaxWidth

      public void setMaxWidth(String maxWidth)
      Specified by:
      setMaxWidth in interface com.vaadin.flow.component.HasSize

    • setMaxWidth

      public void setMaxWidth(float maxWidth, com.vaadin.flow.component.Unit unit)
      Specified by:
      setMaxWidth in interface com.vaadin.flow.component.HasSize

    • getWidth

      public String getWidth()
      Specified by:
      getWidth in interface com.vaadin.flow.component.HasSize

    • getMinWidth

      public String getMinWidth()
      Specified by:
      getMinWidth in interface com.vaadin.flow.component.HasSize

    • getMaxWidth

      public String getMaxWidth()
      Specified by:
      getMaxWidth in interface com.vaadin.flow.component.HasSize

    • getWidthUnit

      public Optional<com.vaadin.flow.component.Unit> getWidthUnit()
      Specified by:
      getWidthUnit in interface com.vaadin.flow.component.HasSize

    • setHeight

      public void setHeight(String height)
      Specified by:
      setHeight in interface com.vaadin.flow.component.HasSize

    • setHeight

      public void setHeight(float height, com.vaadin.flow.component.Unit unit)
      Specified by:
      setHeight in interface com.vaadin.flow.component.HasSize

    • setMinHeight

      public void setMinHeight(String minHeight)
      Specified by:
      setMinHeight in interface com.vaadin.flow.component.HasSize

    • setMinHeight

      public void setMinHeight(float minHeight, com.vaadin.flow.component.Unit unit)
      Specified by:
      setMinHeight in interface com.vaadin.flow.component.HasSize

    • setMaxHeight

      public void setMaxHeight(String maxHeight)
      Specified by:
      setMaxHeight in interface com.vaadin.flow.component.HasSize

    • setMaxHeight

      public void setMaxHeight(float maxHeight, com.vaadin.flow.component.Unit unit)
      Specified by:
      setMaxHeight in interface com.vaadin.flow.component.HasSize

    • getHeight

      public String getHeight()
      Specified by:
      getHeight in interface com.vaadin.flow.component.HasSize

    • getMinHeight

      public String getMinHeight()
      Specified by:
      getMinHeight in interface com.vaadin.flow.component.HasSize

    • getMaxHeight

      public String getMaxHeight()
      Specified by:
      getMaxHeight in interface com.vaadin.flow.component.HasSize

    • getHeightUnit

      public Optional<com.vaadin.flow.component.Unit> getHeightUnit()
      Specified by:
      getHeightUnit in interface com.vaadin.flow.component.HasSize

    • setSizeFull

      public void setSizeFull()
      Specified by:
      setSizeFull in interface com.vaadin.flow.component.HasSize

    • setWidthFull

      public void setWidthFull()
      Specified by:
      setWidthFull in interface com.vaadin.flow.component.HasSize

    • setHeightFull

      public void setHeightFull()
      Specified by:
      setHeightFull in interface com.vaadin.flow.component.HasSize

    • setSizeUndefined

      public void setSizeUndefined()
      Specified by:
      setSizeUndefined in interface com.vaadin.flow.component.HasSize