Package ch.tocco.nice2.model.form.impl.form2.components

Class AbstractAction

java.lang.Object
ch.tocco.nice2.model.form.impl.form2.components.AbstractComponent
ch.tocco.nice2.model.form.impl.form2.components.AbstractCompositeComponent
ch.tocco.nice2.model.form.impl.form2.components.AbstractAction
All Implemented Interfaces:
BaseAction, Component, CompositeComponent, Cloneable
Direct Known Subclasses:
ActionImpl, ReportImpl
public abstract class AbstractAction extends AbstractCompositeComponent implements BaseAction
Abstract base class for all 'actions' that can be placed in an action menu or a column (for example a Action or a Report).

  • Field Details

    • actionType

      protected BaseAction.ActionType actionType

    • icon

      protected String icon

    • runInBackgroundTask

      protected boolean runInBackgroundTask

    • fullscreen

      protected boolean fullscreen

    • modalSize

      protected BaseAction.ModalSize modalSize

    • minSelection

      protected Integer minSelection

    • maxSelection

      protected Integer maxSelection

    • showConfirmation

      protected boolean showConfirmation

    • confirmationThreshold

      protected Integer confirmationThreshold

    • cancelConfirmation

      protected boolean cancelConfirmation

  • Constructor Details

    • AbstractAction

      public AbstractAction()

  • Method Details

    • getActionType

      public BaseAction.ActionType getActionType()
      Description copied from interface: BaseAction
      Returns the action type of the action. See BaseAction.ActionType for more information about the specific action types.
      Specified by:
      getActionType in interface BaseAction

    • setActionType

      public void setActionType(BaseAction.ActionType actionType)

    • getIcon

      @Nullable public @Nullable String getIcon()
      Description copied from interface: BaseAction
      The icon which should be displayed before the label. Represents font-awesome icon.
      Specified by:
      getIcon in interface BaseAction

    • setIcon

      public void setIcon(String icon)

    • getMinSelection

      @Nullable public @Nullable Integer getMinSelection()
      Description copied from interface: BaseAction
      Minimum number of entities that need to be selected for this action.
      Specified by:
      getMinSelection in interface BaseAction

    • setMinSelection

      public void setMinSelection(Integer minSelection)

    • getMaxSelection

      @Nullable public @Nullable Integer getMaxSelection()
      Description copied from interface: BaseAction
      Maximum number of entities that may be selected for this action.
      Specified by:
      getMaxSelection in interface BaseAction

    • setMaxSelection

      public void setMaxSelection(Integer maxSelection)

    • isRunInBackgroundTask

      public boolean isRunInBackgroundTask()
      Description copied from interface: BaseAction
      If `true` the action will run as background task. Makes sense, if the action may take a long time. Default is `false`.
      Specified by:
      isRunInBackgroundTask in interface BaseAction

    • setRunInBackgroundTask

      public void setRunInBackgroundTask(boolean runInBackgroundTask)

    • getShowConfirmation

      public boolean getShowConfirmation()
      Description copied from interface: BaseAction
      If `true` the action will show the "selection is big it may take a while" warning / confirmation in the new client if the selection size is larger than the "confirmationThreshold".
      Specified by:
      getShowConfirmation in interface BaseAction

    • setShowConfirmation

      public void setShowConfirmation(boolean showConfirmation)

    • getConfirmationThreshold

      @Nullable public @Nullable Integer getConfirmationThreshold()
      Description copied from interface: BaseAction
      This property defines from which selection size the "selection is big it may take a while" warning / confirmation is displayed in the new client (if "showConfirmation" is `false` the value of this property is ignored).
      Specified by:
      getConfirmationThreshold in interface BaseAction

    • setConfirmationThreshold

      public void setConfirmationThreshold(Integer confirmationThreshold)

    • isFullscreen

      public boolean isFullscreen()
      Description copied from interface: BaseAction
      Returns true if the action is supposed to be run as "fullscreen" action
      Specified by:
      isFullscreen in interface BaseAction

    • setFullscreen

      public void setFullscreen(boolean fullscreen)

    • getModalSize

      public BaseAction.ModalSize getModalSize()
      Specified by:
      getModalSize in interface BaseAction
      Returns:
      the ModalSize of the custom non-fullscreen action (default: Medium)

    • setModalSize

      public void setModalSize(BaseAction.ModalSize modalSize)

    • isCancelConfirmation

      public boolean isCancelConfirmation()
      Description copied from interface: BaseAction
      Returns true if a confirmation should be shown if the action is canceled
      Specified by:
      isCancelConfirmation in interface BaseAction

    • setCancelConfirmation

      public void setCancelConfirmation(boolean cancelConfirmation)

    • usesLabelAsTextResource

      public boolean usesLabelAsTextResource()
      Specified by:
      usesLabelAsTextResource in interface BaseAction
      Returns:
      true if label should be interpreted as text resource, false if it should be used as is

    • setUsesLabelAsTextResource

      public void setUsesLabelAsTextResource(boolean usesLabelAsTextResource)