io.jmix.ui.action.list

Class ExcludeAction<E>

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.ui.action.list.SecuredListAction

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

All Implemented Interfaces:

Action, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction

@StudioAction(target="io.jmix.ui.component.ListComponent",
              description="Excludes entities from the list. The excluded entities are not deleted.",
              availableInScreenWizard=true)
 @ActionType(value="exclude")
public class ExcludeAction<E>
extends SecuredListAction
implements Action.AdjustWhenScreenReadOnly, Action.ExecutableAction

Standard action for excluding entity instances from the list. The excluded entities are not deleted.

Should be defined for a list component (Table, DataGrid, etc.) connected to a nested data container.

The action instance can be parameterized using the nested properties XML element or programmatically in the screen controller.

Nested Class Summary

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

BaseAction.EnabledRule

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

Action.ActionPerformedEvent, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.MainTabSheetAction, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.function.Consumer<RemoveOperation.ActionCancelledEvent<E>>	actionCancelledHandler
protected java.util.function.Consumer<RemoveOperation.AfterActionPerformedEvent<E>>	afterActionPerformedHandler
protected java.lang.Boolean	confirmation
protected java.lang.String	confirmationMessage
protected java.lang.String	confirmationTitle
static java.lang.String	ID
protected RemoveOperation	removeOperation

Fields inherited from class io.jmix.ui.action.list.SecuredListAction

accessManager, constraintEntityOp, metadata

Fields inherited from class io.jmix.ui.action.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
ExcludeAction()
ExcludeAction(java.lang.String id)

Method Summary

Modifier and Type	Method and Description
void	actionPerform(Component component) Invoked by owning component to execute the action.
void	execute() Executes the action.
java.lang.Boolean	getConfirmation() Returns true/false if the confirmation flag was set by setConfirmation(Boolean) or in the screen XML.
java.lang.String	getConfirmationMessage() Returns confirmation dialog message if it was set by setConfirmationMessage(String) or in the screen XML.
java.lang.String	getConfirmationTitle() Returns confirmation dialog title if it was set by setConfirmationTitle(String) or in the screen XML.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
void	setActionCancelledHandler(java.util.function.Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler) Sets the handler to be invoked if the action was cancelled by the user.
void	setAfterActionPerformedHandler(java.util.function.Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler) Sets the handler to be invoked after excluding entities.
void	setConfirmation(java.lang.Boolean confirmation) Sets whether to ask confirmation from the user.
void	setConfirmationMessage(java.lang.String confirmationMessage) Sets confirmation dialog message.
void	setConfirmationTitle(java.lang.String confirmationTitle) Sets confirmation dialog title.
protected void	setIcons(Icons icons)
protected void	setMessages(io.jmix.core.Messages messages)
void	setRemoveOperation(RemoveOperation removeOperation)
protected void	setUiComponentProperties(UiComponentProperties componentProperties)

Methods inherited from class io.jmix.ui.action.list.SecuredListAction

getConstraintEntityOp, isApplicable, setAccessManager, setConstraintEntityOp, setMetadata

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

getTarget, setTarget, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

addActionPerformedListener, addEnabledRule, 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.AdjustWhenScreenReadOnly

isDisabledWhenScreenReadOnly

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

Field Detail

ID

public static final java.lang.String ID

See Also:

Constant Field Values

removeOperation

protected RemoveOperation removeOperation

confirmation

protected java.lang.Boolean confirmation

confirmationMessage

protected java.lang.String confirmationMessage

confirmationTitle

protected java.lang.String confirmationTitle

afterActionPerformedHandler

protected java.util.function.Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler

actionCancelledHandler

protected java.util.function.Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler

Constructor Detail

ExcludeAction

public ExcludeAction()

ExcludeAction

public ExcludeAction(java.lang.String id)

Method Detail

getConfirmation

@Nullable
public java.lang.Boolean getConfirmation()

Returns true/false if the confirmation flag was set by setConfirmation(Boolean) or in the screen XML. Otherwise returns null.

setConfirmation

@StudioPropertiesItem(defaultValue="true")
public void setConfirmation(java.lang.Boolean confirmation)

Sets whether to ask confirmation from the user.

getConfirmationMessage

@Nullable
public java.lang.String getConfirmationMessage()

Returns confirmation dialog message if it was set by setConfirmationMessage(String) or in the screen XML. Otherwise returns null.

setConfirmationMessage

@StudioPropertiesItem
public void setConfirmationMessage(java.lang.String confirmationMessage)

Sets confirmation dialog message.

getConfirmationTitle

@Nullable
public java.lang.String getConfirmationTitle()

Returns confirmation dialog title if it was set by setConfirmationTitle(String) or in the screen XML. Otherwise returns null.

setConfirmationTitle

@StudioPropertiesItem
public void setConfirmationTitle(java.lang.String confirmationTitle)

Sets confirmation dialog title.

setAfterActionPerformedHandler

public void setAfterActionPerformedHandler(java.util.function.Consumer<RemoveOperation.AfterActionPerformedEvent<E>> afterActionPerformedHandler)

Sets the handler to be invoked after excluding entities.

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petsTable.exclude", subject = "afterActionPerformedHandler")
 protected void petsTableExcludeAfterActionPerformedHandler(RemoveOperation.AfterActionPerformedEvent event) {
     System.out.println("Removed " + event.getItems());
 }
 

setActionCancelledHandler

public void setActionCancelledHandler(java.util.function.Consumer<RemoveOperation.ActionCancelledEvent<E>> actionCancelledHandler)

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

The preferred way to set the handler is using a controller method annotated with Install, e.g.:

 @Install(to = "petsTable.exclude", subject = "actionCancelledHandler")
 protected void petsTableExcludeActionCancelledHandler(RemoveOperation.ActionCancelledEvent event) {
     System.out.println("Cancelled");
 }
 

setIcons

@Autowired
protected void setIcons(Icons icons)

setMessages

@Autowired
protected void setMessages(io.jmix.core.Messages messages)

setUiComponentProperties

@Autowired
protected void setUiComponentProperties(UiComponentProperties componentProperties)

setRemoveOperation

@Autowired
public void setRemoveOperation(RemoveOperation removeOperation)

isPermitted

protected boolean isPermitted()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isPermitted in class SecuredListAction

Returns:

true if the action is enabled for the current user

actionPerform

public void actionPerform(Component component)

Description copied from interface: Action

Invoked by owning component to execute the action.

Specified by:

actionPerform in interface Action

Overrides:

actionPerform in class BaseAction

Parameters:

component - invoking component

execute

public void execute()

Executes the action.

Specified by:

execute in interface Action.ExecutableAction