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

Interface BaseAction

All Superinterfaces:

Cloneable, Component, CompositeComponent

All Known Subinterfaces:

Action, Report

All Known Implementing Classes:

AbstractAction, ActionImpl, ReportImpl

public interface BaseAction
extends CompositeComponent

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static enum	BaseAction.ActionType	The action type describes of what kind the action is.
static enum	BaseAction.ButtonStyle	The style describes the styling of the action button
static enum	BaseAction.ModalSize	The size of the action modal (only for non-fullscreen custom actions)

Nested classes/interfaces inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

Component.Configuration

Method Summary

Modifier and Type	Method	Description
BaseAction.ActionType	getActionType()	Returns the action type of the action.
@Nullable Integer	getConfirmationThreshold()	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).
@Nullable String	getIcon()	The icon which should be displayed before the label.
@Nullable Integer	getMaxSelection()	Maximum number of entities that may be selected for this action.
@Nullable Integer	getMinSelection()	Minimum number of entities that need to be selected for this action.
BaseAction.ModalSize	getModalSize()
boolean	getShowConfirmation()	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".
boolean	isFullscreen()	Returns true if the action is supposed to be run as "fullscreen" action
boolean	isRunInBackgroundTask()	If `true` the action will run as background task.
boolean	usesLabelAsTextResource()

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.Component

accept, getForm, getId, getLabel, getParent, getPosition, validate

Methods inherited from interface ch.tocco.nice2.model.form.api.form2.components.CompositeComponent

findById, getChildren, getScopes, hasChildren

Method Details

getActionType

BaseAction.ActionType getActionType()

Returns the action type of the action. See BaseAction.ActionType for more information about the specific action types.

getIcon

@Nullable
@Nullable String getIcon()

The icon which should be displayed before the label. Represents font-awesome icon.

getMinSelection

@Nullable
@Nullable Integer getMinSelection()

Minimum number of entities that need to be selected for this action.

getMaxSelection

@Nullable
@Nullable Integer getMaxSelection()

Maximum number of entities that may be selected for this action.

getShowConfirmation

boolean getShowConfirmation()

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".

getConfirmationThreshold

@Nullable
@Nullable Integer getConfirmationThreshold()

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).

isRunInBackgroundTask

boolean isRunInBackgroundTask()

If `true` the action will run as background task. Makes sense, if the action may take a long time. Default is `false`.

isFullscreen

boolean isFullscreen()

Returns true if the action is supposed to be run as "fullscreen" action

getModalSize

BaseAction.ModalSize getModalSize()

Returns:

the ModalSize of the custom non-fullscreen action (default: Medium)

usesLabelAsTextResource

boolean usesLabelAsTextResource()

Returns:

true if label should be interpreted as text resource, false if it should be used as is