Package io.jmix.flowui.action

Class DialogAction

java.lang.Object
io.jmix.flowui.kit.action.AbstractAction
io.jmix.flowui.kit.action.BaseAction
io.jmix.flowui.action.SecuredBaseAction
io.jmix.flowui.action.DialogAction
All Implemented Interfaces:
SecuredAction, Action, HasShortcutCombination
public class DialogAction extends SecuredBaseAction

  • Field Details

  • Constructor Details

  • Method Details

    • getType

      public DialogAction.Type getType()

    • withText

      public DialogAction 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 SecuredBaseAction
      Parameters:
      text - text to set or null to remove
      Returns:
      this object

    • withEnabled

      public DialogAction 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 SecuredBaseAction
      Parameters:
      enabled - whether the action is currently enabled
      Returns:
      this object

    • withVisible

      public DialogAction 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 SecuredBaseAction
      Parameters:
      visible - whether the action is currently visible
      Returns:
      this object

    • withIcon

      public DialogAction 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 SecuredBaseAction
      Parameters:
      icon - icon to set or null to remove
      Returns:
      this object

    • withIcon

      public DialogAction 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 SecuredBaseAction
      Parameters:
      icon - icon to set or null to remove
      Returns:
      this object

    • withTitle

      public DialogAction 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 SecuredBaseAction
      Parameters:
      title - description to set or null to remove
      Returns:
      this object

    • withVariant

      public DialogAction 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 SecuredBaseAction
      Parameters:
      actionVariant - variant to set
      Returns:
      this object

    • withShortcutCombination

      public DialogAction 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 SecuredBaseAction
      Parameters:
      shortcutCombination - key combination to set or null to remove
      Returns:
      this object

    • withHandler

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

    • withEnabledByUiPermissions

      public DialogAction withEnabledByUiPermissions(boolean enabledByUiPermissions)
      Overrides:
      withEnabledByUiPermissions in class SecuredBaseAction

    • withVisibleByUiPermissions

      public DialogAction withVisibleByUiPermissions(boolean visibleByUiPermissions)
      Overrides:
      withVisibleByUiPermissions in class SecuredBaseAction