Package io.jmix.flowui.action.list

Class ExcludeAction<E>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

io.jmix.flowui.action.SecuredBaseAction

io.jmix.flowui.action.list.ListDataComponentAction<A,E>

io.jmix.flowui.action.list.SecuredListDataComponentAction<ExcludeAction<E>,E>

io.jmix.flowui.action.list.ExcludeAction<E>

All Implemented Interfaces:

AdjustWhenViewReadOnly, ExecutableAction, SecuredAction, SecurityConstraintAction, TargetAction<ListDataComponent<E>>, Action, HasShortcutCombination

@ActionType("list_exclude")
public class ExcludeAction<E>
extends SecuredListDataComponentAction<ExcludeAction<E>,E>
implements AdjustWhenViewReadOnly

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

Modifier and Type	Field	Description
protected Consumer<RemoveOperation.ActionCancelledEvent<E>>	actionCancelledHandler
protected Consumer<RemoveOperation.AfterActionPerformedEvent<E>>	afterActionPerformedHandler
protected boolean	confirmation
protected String	confirmationHeader
protected String	confirmationText
static final String	ID
protected RemoveOperation	removeOperation

Fields inherited from class io.jmix.flowui.action.list.SecuredListDataComponentAction

accessManager, applicationContext, constraintEntityOp, metadata

Fields inherited from class io.jmix.flowui.action.list.ListDataComponentAction

selectionListenerRegistration, target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

enabledByUiPermissions, enabledRules, visibleByUiPermissions

Fields inherited from class io.jmix.flowui.kit.action.BaseAction

enabledExplicitly, visibleExplicitly

Fields inherited from class io.jmix.flowui.kit.action.AbstractAction

description, enabled, eventBus, icon, id, shortcutCombination, text, variant, visible

Fields inherited from interface io.jmix.flowui.kit.action.Action

PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT_COMBINATION, PROP_TEXT, PROP_VARIANT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor	Description
ExcludeAction()
ExcludeAction(String id)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkExcludePermission()
void	execute()	Executes the Action
String	getConfirmationHeader()	Returns confirmation dialog header if it was set by setConfirmationHeader(String) or in the view XML.
String	getConfirmationText()	Returns confirmation dialog text if it was set by setConfirmationText(String) or in the view XML.
protected void	initAction()
boolean	isConfirmation()
protected boolean	isPermitted()
void	setActionCancelledHandler(Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)	Sets the handler to be invoked if the action was cancelled by the user.
void	setAfterActionPerformedHandler(Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)	Sets the handler to be invoked after removing entities.
void	setConfirmation(boolean confirmation)	Sets whether to ask confirmation from the user.
void	setConfirmationHeader(String confirmationHeader)	Sets confirmation dialog header.
void	setConfirmationText(String confirmationText)	Sets confirmation dialog text.
protected void	setMessages(Messages messages)
void	setRemoveOperation(RemoveOperation removeOperation)
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
ExcludeAction<E>	withAfterActionCancelledHandler(Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)
ExcludeAction<E>	withAfterActionPerformedHandler(Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)
ExcludeAction<E>	withConfirmation(boolean confirmation)
ExcludeAction<E>	withConfirmationHeader(String confirmationHeader)
ExcludeAction<E>	withConfirmationText(String confirmationText)

Methods inherited from class io.jmix.flowui.action.list.SecuredListDataComponentAction

getConstraintEntityOp, isApplicable, setAccessManager, setApplicationContext, setConstraintEntityOp, setMetadata, withConstraintEntityOp

Methods inherited from class io.jmix.flowui.action.list.ListDataComponentAction

actionPerform, attachSelectionListener, checkTarget, checkTargetItems, getTarget, onSelectionChange, setTarget, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withIcon, withShortcutCombination, withTarget, withText, withTitle, withVariant, withVisible, withVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.action.SecuredBaseAction

addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabledByUiPermissions, setVisibleByUiPermissions

Methods inherited from class io.jmix.flowui.kit.action.BaseAction

addActionPerformedListener, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription

Methods inherited from class io.jmix.flowui.kit.action.AbstractAction

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setShortcutCombination, setText, setVariant

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.jmix.flowui.kit.action.Action

actionPerform, addPropertyChangeListener, getDescription, getIcon, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.action.AdjustWhenViewReadOnly

isDisabledWhenViewReadOnly

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

removeOperation

protected RemoveOperation removeOperation

confirmation

protected boolean confirmation

confirmationText

protected String confirmationText

confirmationHeader

protected String confirmationHeader

afterActionPerformedHandler

protected Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler

actionCancelledHandler

protected Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler

Constructor Details

ExcludeAction

public ExcludeAction()

ExcludeAction

public ExcludeAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

initAction in class ListDataComponentAction<ExcludeAction<E>,E>

setMessages

@Autowired
protected void setMessages(Messages messages)

setRemoveOperation

@Autowired
public void setRemoveOperation(RemoveOperation removeOperation)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties uiComponentProperties)

isConfirmation

public boolean isConfirmation()

Returns:

whether to ask confirmation from the user

setConfirmation

public void setConfirmation(boolean confirmation)

Sets whether to ask confirmation from the user.

getConfirmationText

@Nullable
public String getConfirmationText()

Returns confirmation dialog text if it was set by setConfirmationText(String) or in the view XML. Otherwise, returns null.

setConfirmationText

public void setConfirmationText(@Nullable
 String confirmationText)

Sets confirmation dialog text.

getConfirmationHeader

@Nullable
public String getConfirmationHeader()

Returns confirmation dialog header if it was set by setConfirmationHeader(String) or in the view XML. Otherwise, returns null.

setConfirmationHeader

public void setConfirmationHeader(@Nullable
 String confirmationHeader)

Sets confirmation dialog header.

setAfterActionPerformedHandler

public void setAfterActionPerformedHandler(@Nullable
 Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)

Sets the handler to be invoked after removing entities.

setActionCancelledHandler

public void setActionCancelledHandler(@Nullable
 Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)

Sets the handler to be invoked if the action was cancelled by the user.

isPermitted

protected boolean isPermitted()

Overrides:

isPermitted in class SecuredListDataComponentAction<ExcludeAction<E>,E>

checkExcludePermission

protected boolean checkExcludePermission()

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

withConfirmation

public ExcludeAction<E> withConfirmation(boolean confirmation)

withConfirmationText

public ExcludeAction<E> withConfirmationText(@Nullable
 String confirmationText)

withConfirmationHeader

public ExcludeAction<E> withConfirmationHeader(@Nullable
 String confirmationHeader)

withAfterActionPerformedHandler

public ExcludeAction<E> withAfterActionPerformedHandler(@Nullable
 Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)

withAfterActionCancelledHandler

public ExcludeAction<E> withAfterActionCancelledHandler(@Nullable
 Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)