Package io.jmix.flowui.action.genericfilter

Class GenericFilterAction<A extends GenericFilterAction<A>>

java.lang.Object
io.jmix.flowui.kit.action.AbstractAction
io.jmix.flowui.kit.action.BaseAction
io.jmix.flowui.action.SecuredBaseAction
io.jmix.flowui.action.genericfilter.GenericFilterAction<A>
All Implemented Interfaces:
ExecutableAction, SecuredAction, TargetAction<GenericFilter>, Action, HasShortcutCombination
Direct Known Subclasses:
AbstractGenericFilterSaveAction, GenericFilterAddConditionAction, GenericFilterClearValuesAction, GenericFilterCopyAction, GenericFilterEditAction, GenericFilterMakeDefaultAction, GenericFilterRemoveAction, GenericFilterResetAction
public abstract class GenericFilterAction<A extends GenericFilterAction<A>> extends SecuredBaseAction implements TargetAction<GenericFilter>, ExecutableAction

  • Field Details

    • target

      protected GenericFilter target

    • visibleBySpecificUiPermission

      protected boolean visibleBySpecificUiPermission

    • configurationChangeRegistration

      protected com.vaadin.flow.shared.Registration configurationChangeRegistration

    • filterComponentsChangeRegistration

      protected com.vaadin.flow.shared.Registration filterComponentsChangeRegistration

  • Constructor Details

    • GenericFilterAction

      public GenericFilterAction(String id)

  • Method Details

    • initAction

      protected void initAction()

    • getTarget

      @Nullable public GenericFilter getTarget()
      Specified by:
      getTarget in interface TargetAction<A extends GenericFilterAction<A>>

    • setTarget

      public void setTarget(@Nullable GenericFilter target)
      Specified by:
      setTarget in interface TargetAction<A extends GenericFilterAction<A>>

    • setTargetInternal

      protected void setTargetInternal(@Nullable GenericFilter target)

    • actionPerform

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

    • isApplicable

      protected boolean isApplicable()
      Overrides:
      isApplicable in class BaseAction

    • isPermitted

      protected boolean isPermitted()
      Overrides:
      isPermitted in class SecuredBaseAction

    • isVisibleByUiPermissions

      public boolean isVisibleByUiPermissions()
      Specified by:
      isVisibleByUiPermissions in interface SecuredAction
      Overrides:
      isVisibleByUiPermissions in class SecuredBaseAction

    • bindListeners

      protected void bindListeners(GenericFilter target)

    • bindFilterComponentsChangeListener

      protected void bindFilterComponentsChangeListener(GenericFilter target)

    • unbindListeners

      protected void unbindListeners()

    • unbindFilterComponentsChange

      protected void unbindFilterComponentsChange()

    • onConfigurationChanged

      protected void onConfigurationChanged(GenericFilter.ConfigurationChangeEvent event)

    • onFilterComponentsChanged

      protected void onFilterComponentsChanged(LogicalFilterComponent.FilterComponentsChangeEvent<?> event)

    • withTarget

      public A withTarget(@Nullable GenericFilter 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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      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 SecuredBaseAction
      Parameters:
      handler - listener to add or null to remove all
      Returns:
      this object

    • withEnabledByUiPermissions

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

    • withVisibleByUiPermissions

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

    • checkTarget

      protected void checkTarget()

    • getParentView

      protected View<?> getParentView()