Package io.jmix.tabbedmode.action.tabsheet

Class TabbedViewsContainerAction<A extends TabbedViewsContainerAction<A>>

java.lang.Object
io.jmix.flowui.kit.action.AbstractAction
io.jmix.flowui.kit.action.BaseAction
io.jmix.tabbedmode.action.tabsheet.TabbedViewsContainerAction<A>
Type Parameters:
A - action type
All Implemented Interfaces:
TargetAction<TabbedViewsContainer<?>>, Action, HasShortcutCombination
Direct Known Subclasses:
AbstractCloseTabsAction
public abstract class TabbedViewsContainerAction<A extends TabbedViewsContainerAction<A>> extends BaseAction implements TargetAction<TabbedViewsContainer<?>>
Base class for actions that work with TabbedViewsContainer.

  • Field Details

  • Constructor Details

    • TabbedViewsContainerAction

      public TabbedViewsContainerAction(String id)

  • Method Details

    • initAction

      protected void initAction()

    • getTarget

      @Nullable public TabbedViewsContainer<?> getTarget()
      Specified by:
      getTarget in interface TargetAction<A extends TabbedViewsContainerAction<A>>

    • setTarget

      public void setTarget(@Nullable TabbedViewsContainer<?> target)
      Specified by:
      setTarget in interface TargetAction<A extends TabbedViewsContainerAction<A>>

    • detachListeners

      protected void detachListeners(TabbedViewsContainer<?> target)

    • attachListeners

      protected void attachListeners(TabbedViewsContainer<?> target)

    • withTarget

      public A withTarget(@Nullable TabbedViewsContainer<?> target)

    • withText

      public A withText(@Nullable String text)
      Description copied from class: BaseAction
      Sets the text property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withText in class BaseAction
      Parameters:
      text - text to set or null to remove
      Returns:
      this object

    • withEnabled

      public A withEnabled(boolean enabled)
      Description copied from class: BaseAction
      Sets the enabled property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withEnabled in class BaseAction
      Parameters:
      enabled - whether the action is currently enabled
      Returns:
      this object

    • withVisible

      public A withVisible(boolean visible)
      Description copied from class: BaseAction
      Sets the visible property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withVisible in class BaseAction
      Parameters:
      visible - whether the action is currently visible
      Returns:
      this object

    • withIcon

      public A withIcon(@Nullable com.vaadin.flow.component.icon.Icon icon)
      Description copied from class: BaseAction
      Sets the icon property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withIcon in class BaseAction
      Parameters:
      icon - icon to set or null to remove
      Returns:
      this object

    • withIcon

      public A withIcon(@Nullable com.vaadin.flow.component.icon.VaadinIcon icon)
      Description copied from class: BaseAction
      Sets the icon property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withIcon in class BaseAction
      Parameters:
      icon - icon to set or null to remove
      Returns:
      this object

    • withTitle

      public A withTitle(@Nullable String title)
      Description copied from class: BaseAction
      Sets the description property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withTitle in class BaseAction
      Parameters:
      title - description to set or null to remove
      Returns:
      this object

    • withVariant

      public A withVariant(ActionVariant actionVariant)
      Description copied from class: BaseAction
      Sets the variant property value of an action. May be used by components to initialize their appearance.
      Overrides:
      withVariant in class BaseAction
      Parameters:
      actionVariant - variant to set
      Returns:
      this object

    • withShortcutCombination

      public A withShortcutCombination(@Nullable KeyCombination shortcutCombination)
      Description copied from class: BaseAction
      Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.
      Overrides:
      withShortcutCombination in class BaseAction
      Parameters:
      shortcutCombination - key combination to set or null to remove
      Returns:
      this object

    • withHandler

      public A withHandler(@Nullable Consumer<ActionPerformedEvent> handler)
      Description copied from class: BaseAction
      Adds a listener to be notified when action is performed.
      Overrides:
      withHandler in class BaseAction
      Parameters:
      handler - listener to add or null to remove all
      Returns:
      this object

    • actionPerform

      public void actionPerform(com.vaadin.flow.component.Component trigger)
      Description copied from interface: Action
      Executes action logic.
      Specified by:
      actionPerform in interface Action
      Overrides:
      actionPerform in class BaseAction
      Parameters:
      trigger - Component that triggered this action

    • execute

      public abstract void execute(@Nullable com.vaadin.flow.component.Component trigger)

    • findTab

      @Nullable protected com.vaadin.flow.component.tabs.Tab findTab(@Nullable com.vaadin.flow.component.Component trigger)

    • isApplicable

      protected boolean isApplicable()
      Overrides:
      isApplicable in class BaseAction

    • findActionTab

      @Nullable protected com.vaadin.flow.component.tabs.Tab findActionTab()

    • checkTarget

      protected void checkTarget()