Package io.jmix.flowui.action.list

Class RemoveAction<E>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction<RemoveAction<E>>

io.jmix.flowui.action.ObservableBaseAction<RemoveAction<E>>

io.jmix.flowui.action.SecuredBaseAction<RemoveAction<E>>

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

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

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

All Implemented Interfaces:

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

@ActionType("list_remove")
public class RemoveAction<E>
extends SecuredListDataComponentAction<RemoveAction<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 Consumer<RemoveOperation.BeforeActionPerformedEvent<E>>	beforeActionPerformedHandler
protected boolean	confirmation
protected String	confirmationHeader
protected String	confirmationText
protected Consumer<Collection<E>>	delegate
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

enabledRules

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

uiObservationSupport

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
RemoveAction()
RemoveAction(String id)

Method Summary

Modifier and Type	Method	Description
protected boolean	checkRemovePermission()
void	execute()	Executes the action.
@Nullable String	getConfirmationHeader()	Returns confirmation dialog header if it was set by setConfirmationHeader(String) or in the view XML.
@Nullable 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(@Nullable Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)	Sets the handler to be invoked if the action was cancelled by the user.
void	setAfterActionPerformedHandler(@Nullable Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)	Sets the handler to be invoked after removing entities.
void	setBeforeActionPerformedHandler(@Nullable Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler)	Sets the handler to be invoked before removing entities.
void	setConfirmation(boolean confirmation)	Sets whether to ask confirmation from the user.
void	setConfirmationHeader(@Nullable String confirmationHeader)	Sets confirmation dialog header.
void	setConfirmationText(@Nullable String confirmationText)	Sets confirmation dialog text.
void	setDelegate(@Nullable Consumer<Collection<E>> delegate)	Sets the delegate to be invoked instead of DataManager to remove the entities from a storage.
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setRemoveOperation(RemoveOperation removeOperation)
protected void	setUiComponentProperties(UiComponentProperties uiComponentProperties)
RemoveAction<E>	withAfterActionCancelledHandler(@Nullable Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)
RemoveAction<E>	withAfterActionPerformedHandler(@Nullable Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)
RemoveAction<E>	withBeforeActionPerformedHandler(@Nullable Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler)
RemoveAction<E>	withConfirmation(boolean confirmation)
RemoveAction<E>	withConfirmationHeader(@Nullable String confirmationHeader)
RemoveAction<E>	withConfirmationText(@Nullable 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, withTarget

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

addEnabledRule, isEnabledByRule, refreshState, removeEnabledRule

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

getUiObservationSupport

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

addActionPerformedListener, self, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withDescription, withEnabled, withHandler, withIcon, withShortcutCombination, withText, withVariant, withVisible

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

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getIconComponent, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, setIconComponent, 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, getIconComponent, getId, getText, getVariant, isEnabled, isVisible, refreshState, setDescription, setEnabled, setIcon, setIconComponent, 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

beforeActionPerformedHandler

protected Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler

afterActionPerformedHandler

protected Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler

actionCancelledHandler

protected Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler

delegate

protected Consumer<Collection<E>> delegate

Constructor Details

RemoveAction

public RemoveAction()

RemoveAction

public RemoveAction(String id)

Method Details

initAction

protected void initAction()

Overrides:

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

setMessages

@Autowired
protected void setMessages(Messages messages)

setIcons

@Autowired
protected void setIcons(Icons icons)

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

public @Nullable 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

public @Nullable 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.

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(@Nullable Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler)

Sets the handler to be invoked before removing entities.

Parameters:

beforeActionPerformedHandler - handler to be set

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.

setDelegate

public void setDelegate(@Nullable Consumer<Collection<E>> delegate)

Sets the delegate to be invoked instead of DataManager to remove the entities from a storage.

isPermitted

protected boolean isPermitted()

Overrides:

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

checkRemovePermission

protected boolean checkRemovePermission()

execute

public void execute()

Executes the action.

Specified by:

execute in interface ExecutableAction

withConfirmation

public RemoveAction<E> withConfirmation(boolean confirmation)

withConfirmationText

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

withConfirmationHeader

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

withBeforeActionPerformedHandler

public RemoveAction<E> withBeforeActionPerformedHandler(@Nullable Consumer<RemoveOperation.BeforeActionPerformedEvent<E>> beforeActionPerformedHandler)

withAfterActionPerformedHandler

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

withAfterActionCancelledHandler

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