com.haulmont.cuba.gui.components.actions

Class RemoveAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

com.haulmont.cuba.gui.components.actions.ListAction

com.haulmont.cuba.gui.components.actions.ItemTrackingAction

com.haulmont.cuba.gui.components.actions.RemoveAction

All Implemented Interfaces:

HasBeforeActionPerformedHandler, io.jmix.ui.action.Action, io.jmix.ui.action.Action.AdjustWhenScreenReadOnly, io.jmix.ui.action.Action.HasPrimaryState, io.jmix.ui.action.Action.HasSecurityConstraint, io.jmix.ui.action.Action.HasTarget, io.jmix.ui.action.Action.SecuredAction

Direct Known Subclasses:

ExcludeAction

@Component(value="cuba_RemoveAction")
 @Scope(value="prototype")
public class RemoveAction
extends ItemTrackingAction
implements HasBeforeActionPerformedHandler, io.jmix.ui.action.Action.AdjustWhenScreenReadOnly

Standard list action to remove an entity instance.

Action's behaviour can be customized by providing arguments to constructor, setting properties, or overriding method afterRemove(Set) )}

In order to provide your own implementation globally, create a subclass and register it in web-spring.xml, for example:

 <bean id="cuba_RemoveAction" class="com.company.sample.gui.MyRemoveAction" scope="prototype"/>
 

Also, use create() static methods instead of constructors when creating the action programmatically.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	RemoveAction.AfterRemoveHandler

Nested classes/interfaces inherited from class io.jmix.ui.action.BaseAction

io.jmix.ui.action.BaseAction.EnabledRule

Nested classes/interfaces inherited from interface com.haulmont.cuba.gui.components.actions.HasBeforeActionPerformedHandler

HasBeforeActionPerformedHandler.BeforeActionPerformedHandler

Nested classes/interfaces inherited from interface io.jmix.ui.action.Action

io.jmix.ui.action.Action.ActionPerformedEvent, io.jmix.ui.action.Action.AdjustWhenScreenReadOnly, io.jmix.ui.action.Action.ExecutableAction, io.jmix.ui.action.Action.HasPrimaryState, io.jmix.ui.action.Action.HasSecurityConstraint, io.jmix.ui.action.Action.HasTarget, io.jmix.ui.action.Action.MainTabSheetAction, io.jmix.ui.action.Action.ScreenOpeningAction, io.jmix.ui.action.Action.SecuredAction, io.jmix.ui.action.Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID
protected RemoveAction.AfterRemoveHandler	afterRemoveHandler
protected boolean	autocommit
protected HasBeforeActionPerformedHandler.BeforeActionPerformedHandler	beforeActionPerformedHandler
protected boolean	confirm
protected java.lang.String	confirmationMessage
protected java.lang.String	confirmationTitle

Fields inherited from class com.haulmont.cuba.gui.components.actions.ItemTrackingAction

accessManager, applicationContext, constraintEntityOp, metadata, security

Fields inherited from class com.haulmont.cuba.gui.components.actions.ListAction

target

Fields inherited from class io.jmix.ui.action.AbstractAction

caption, description, enabled, eventHub, icon, id, owners, primary, shortcut, visible

Fields inherited from interface io.jmix.ui.action.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
RemoveAction(ListComponent target) The simplest constructor.
RemoveAction(ListComponent target, boolean autocommit) Constructor that allows to specify autocommit value.
RemoveAction(ListComponent target, boolean autocommit, java.lang.String id) Constructor that allows to specify action's identifier and autocommit value.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(io.jmix.ui.component.Component component) This method is invoked by the action owner component.
protected void	afterRemove(java.util.Set selected) Hook invoked after remove.
protected boolean	checkRemovePermission()
protected void	confirmAndRemove(java.util.Set<io.jmix.core.Entity> selected)
static RemoveAction	create(io.jmix.ui.component.ListComponent target) Creates an action with default id.
static RemoveAction	create(io.jmix.ui.component.ListComponent target, boolean autocommit) Creates an action with default id.
static RemoveAction	create(io.jmix.ui.component.ListComponent target, boolean autocommit, java.lang.String id) Creates an action with the given id.
protected void	doRemove(java.util.Set<io.jmix.core.Entity> selected, boolean autocommit)
HasBeforeActionPerformedHandler.BeforeActionPerformedHandler	getBeforeActionPerformedHandler()
java.lang.String	getConfirmationMessage() Provides confirmation dialog message.
java.lang.String	getConfirmationTitle() Provides confirmation dialog title.
boolean	isAutocommit()
boolean	isConfirm()
protected boolean	isPermitted() Check permissions for Action
protected void	remove(java.util.Set<io.jmix.core.Entity> selected)
void	setAfterRemoveHandler(RemoveAction.AfterRemoveHandler afterRemoveHandler)
void	setAutocommit(boolean autocommit)
void	setBeforeActionPerformedHandler(HasBeforeActionPerformedHandler.BeforeActionPerformedHandler handler) Sets handler that is invoked before the action is executed.
void	setConfirm(boolean confirm)
void	setConfirmationMessage(java.lang.String confirmationMessage)
void	setConfirmationTitle(java.lang.String confirmationTitle)

Methods inherited from class com.haulmont.cuba.gui.components.actions.ItemTrackingAction

getConstraintEntityOp, getConstraintOperationType, setConstraintEntityOp, setConstraintOperationType

Methods inherited from class com.haulmont.cuba.gui.components.actions.ListAction

getTarget, setTarget

Methods inherited from class io.jmix.ui.action.ListAction

withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class io.jmix.ui.action.BaseAction

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal

Methods inherited from class io.jmix.ui.action.AbstractAction

addOwner, addPropertyChangeListener, firePropertyChange, getCaption, getDescription, getEventHub, getIcon, getId, getOwner, getOwners, getShortcutCombination, hasSubscriptions, isEnabled, isPrimary, isVisible, removeOwner, removePropertyChangeListener, setCaption, setDescription, setIcon, setPrimary, setShortcut, setShortcutCombination

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.jmix.ui.action.Action

addOwner, addPropertyChangeListener, getCaption, getDescription, getIcon, getId, getOwner, getOwners, getShortcutCombination, isEnabled, isVisible, refreshState, removeOwner, removePropertyChangeListener, setCaption, setDescription, setEnabled, setIcon, setShortcut, setShortcutCombination, setVisible

Methods inherited from interface io.jmix.ui.action.Action.AdjustWhenScreenReadOnly

isDisabledWhenScreenReadOnly

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

autocommit

protected boolean autocommit

confirm

protected boolean confirm

confirmationMessage

protected java.lang.String confirmationMessage

confirmationTitle

protected java.lang.String confirmationTitle

afterRemoveHandler

protected RemoveAction.AfterRemoveHandler afterRemoveHandler

beforeActionPerformedHandler

protected HasBeforeActionPerformedHandler.BeforeActionPerformedHandler beforeActionPerformedHandler

Constructor Detail

RemoveAction

public RemoveAction(ListComponent target)

The simplest constructor. The action has default name and autocommit=true.

Parameters:

target - component containing this action

RemoveAction

public RemoveAction(ListComponent target,
                    boolean autocommit)

Constructor that allows to specify autocommit value. The action has default name.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

RemoveAction

public RemoveAction(ListComponent target,
                    boolean autocommit,
                    java.lang.String id)

Constructor that allows to specify action's identifier and autocommit value.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

id - action's identifier

Method Detail

create

public static RemoveAction create(io.jmix.ui.component.ListComponent target)

Creates an action with default id. Autocommit is set to true.

Parameters:

target - component containing this action

create

public static RemoveAction create(io.jmix.ui.component.ListComponent target,
                                  boolean autocommit)

Creates an action with default id.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

create

public static RemoveAction create(io.jmix.ui.component.ListComponent target,
                                  boolean autocommit,
                                  java.lang.String id)

Creates an action with the given id.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

id - action's identifier

isPermitted

protected boolean isPermitted()

Check permissions for Action

Overrides:

isPermitted in class ItemTrackingAction

checkRemovePermission

protected boolean checkRemovePermission()

actionPerform

public void actionPerform(io.jmix.ui.component.Component component)

This method is invoked by the action owner component.

Specified by:

actionPerform in interface io.jmix.ui.action.Action

Overrides:

actionPerform in class io.jmix.ui.action.BaseAction

Parameters:

component - component invoking the action

confirmAndRemove

protected void confirmAndRemove(java.util.Set<io.jmix.core.Entity> selected)

remove

protected void remove(java.util.Set<io.jmix.core.Entity> selected)

isAutocommit

public boolean isAutocommit()

Returns:

whether to commit datasource immediately after deletion

setAutocommit

public void setAutocommit(boolean autocommit)

Parameters:

autocommit - whether to commit datasource immediately after deletion

isConfirm

public boolean isConfirm()

Returns:

whether to show the confirmation dialog to user

setConfirm

public void setConfirm(boolean confirm)

Parameters:

confirm - whether to show the confirmation dialog to user

getConfirmationMessage

public java.lang.String getConfirmationMessage()

Provides confirmation dialog message.

Returns:

localized message

setConfirmationMessage

public void setConfirmationMessage(java.lang.String confirmationMessage)

Parameters:

confirmationMessage - confirmation dialog message

getConfirmationTitle

public java.lang.String getConfirmationTitle()

Provides confirmation dialog title.

Returns:

localized title

setConfirmationTitle

public void setConfirmationTitle(java.lang.String confirmationTitle)

Parameters:

confirmationTitle - confirmation dialog title.

doRemove

protected void doRemove(java.util.Set<io.jmix.core.Entity> selected,
                        boolean autocommit)

afterRemove

protected void afterRemove(java.util.Set selected)

Hook invoked after remove.

Parameters:

selected - set of removed instances

setAfterRemoveHandler

public void setAfterRemoveHandler(RemoveAction.AfterRemoveHandler afterRemoveHandler)

Parameters:

afterRemoveHandler - handler that is invoked after remove

getBeforeActionPerformedHandler

public HasBeforeActionPerformedHandler.BeforeActionPerformedHandler getBeforeActionPerformedHandler()

Specified by:

getBeforeActionPerformedHandler in interface HasBeforeActionPerformedHandler

Returns:

before action performed handler

setBeforeActionPerformedHandler

public void setBeforeActionPerformedHandler(HasBeforeActionPerformedHandler.BeforeActionPerformedHandler handler)

Description copied from interface: HasBeforeActionPerformedHandler

Sets handler that is invoked before the action is executed.

Specified by:

setBeforeActionPerformedHandler in interface HasBeforeActionPerformedHandler

Parameters:

handler - handler to set