com.haulmont.cuba.gui.components.actions

Class ExcludeAction

java.lang.Object

com.haulmont.cuba.gui.components.AbstractAction

com.haulmont.cuba.gui.components.actions.BaseAction

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

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

com.haulmont.cuba.gui.components.actions.ExcludeAction

All Implemented Interfaces:

Action, Action.HasBeforeActionPerformedHandler, Action.HasSecurityConstraint, Action.HasTarget, Action.UiPermissionAware

@Component(value="cuba_ExcludeAction")
 @Scope(value="prototype")
public class ExcludeAction
extends RemoveAction

The RemoveAction variant that excludes instances from the list, but doesn't delete them from DB.

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

 <bean id="cuba_ExcludeAction" class="com.company.sample.gui.MyExcludeAction" scope="prototype"/>
 

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

Nested Class Summary

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.components.actions.RemoveAction

RemoveAction.AfterRemoveHandler

Nested classes/interfaces inherited from class com.haulmont.cuba.gui.components.actions.BaseAction

BaseAction.EnabledRule

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

Action.ActionPerformedEvent, Action.BeforeActionPerformedHandler, Action.HasBeforeActionPerformedHandler, Action.HasOpenType, Action.HasSecurityConstraint, Action.HasTarget, Action.Status, Action.UiPermissionAware

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ACTION_ID

Fields inherited from interface com.haulmont.cuba.gui.components.Action

PROP_CAPTION, PROP_DESCRIPTION, PROP_ENABLED, PROP_ICON, PROP_SHORTCUT, PROP_VISIBLE

Constructor Summary

Constructors

Constructor and Description
ExcludeAction(ListComponent target) The simplest constructor.
ExcludeAction(ListComponent target, boolean autocommit, boolean confirm) Constructor that allows to specify autocommit and confirm value.
ExcludeAction(ListComponent target, boolean autocommit, boolean confirm, java.lang.String id) Constructor that allows to specify all parameters.

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) This method is invoked by the action owner component.
static ExcludeAction	create(ListComponent target) Creates an action with default id.
static ExcludeAction	create(ListComponent target, boolean autocommit, boolean confirm) Creates an action with default id.
static ExcludeAction	create(ListComponent target, boolean autocommit, boolean confirm, java.lang.String id) Creates an action with the given id.

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

create, create, getBeforeActionPerformedHandler, getConfirmationMessage, getConfirmationTitle, isAutocommit, isConfirm, setAfterRemoveHandler, setAutocommit, setBeforeActionPerformedHandler, setConfirm, setConfirmationMessage, setConfirmationTitle

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

getConstraintCode, getConstraintOperationType, setConstraintCode, setConstraintOperationType

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

addEnabledRule, getTarget, isEnabledByUiPermissions, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setTarget, setVisible, setVisibleByUiPermissions, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

Methods inherited from class com.haulmont.cuba.gui.components.AbstractAction

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.haulmont.cuba.gui.components.Action

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

Field Detail

ACTION_ID

public static final java.lang.String ACTION_ID

Constructor Detail

ExcludeAction

public ExcludeAction(ListComponent target)

The simplest constructor. Autocommit and Confirm properties are set to false, the action has default name.

Parameters:

target - component containing this action

ExcludeAction

public ExcludeAction(ListComponent target,
                     boolean autocommit,
                     boolean confirm)

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

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

confirm - whether to show the confirmation dialog to user

ExcludeAction

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

Constructor that allows to specify all parameters.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

confirm - whether to show the confirmation dialog to user

id - action's name

Method Detail

create

public static ExcludeAction create(ListComponent target)

Creates an action with default id. Autocommit and Confirm properties are set to false.

Parameters:

target - component containing this action

create

public static ExcludeAction create(ListComponent target,
                                   boolean autocommit,
                                   boolean confirm)

Creates an action with default id.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

confirm - whether to show the confirmation dialog to user

create

public static ExcludeAction create(ListComponent target,
                                   boolean autocommit,
                                   boolean confirm,
                                   java.lang.String id)

Creates an action with the given id.

Parameters:

target - component containing this action

autocommit - whether to commit datasource immediately

confirm - whether to show the confirmation dialog to user

id - action's name

actionPerform

public void actionPerform(Component component)

Description copied from class: RemoveAction

This method is invoked by the action owner component.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class RemoveAction

Parameters:

component - component invoking the action