io.jmix.ui.action.list

Class SecuredListAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.ListAction

io.jmix.ui.action.list.SecuredListAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.HasSecurityConstraint, Action.HasTarget, Action.SecuredAction

Direct Known Subclasses:

BulkEditAction, EditAction, ExcludeAction, ItemTrackingAction, RelatedAction, RemoveAction, ViewAction

public abstract class SecuredListAction
extends ListAction
implements Action.HasSecurityConstraint

Action that changes its enabled property depending on a selected item in a bound ListComponent.

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 io.jmix.core.AccessManager	accessManager
protected io.jmix.core.security.EntityOp	constraintEntityOp
protected io.jmix.core.Metadata	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

Modifier	Constructor and Description
protected	SecuredListAction(java.lang.String id)
	SecuredListAction(java.lang.String id, java.lang.String shortcut)

Method Summary

Modifier and Type	Method and Description
io.jmix.core.security.EntityOp	getConstraintEntityOp()
protected boolean	isApplicable() Callback method which is invoked by the action to determine its enabled state.
protected boolean	isPermitted() Callback method which is invoked by the action to determine its enabled state.
protected void	setAccessManager(io.jmix.core.AccessManager accessManager)
void	setConstraintEntityOp(io.jmix.core.security.EntityOp entityOp)
protected void	setMetadata(io.jmix.core.Metadata metadata)

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

actionPerform, 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

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

Field Detail

constraintEntityOp

protected io.jmix.core.security.EntityOp constraintEntityOp

accessManager

protected io.jmix.core.AccessManager accessManager

metadata

protected io.jmix.core.Metadata metadata

Constructor Detail

SecuredListAction

protected SecuredListAction(java.lang.String id)

SecuredListAction

public SecuredListAction(java.lang.String id,
                         @Nullable
                         java.lang.String shortcut)

Method Detail

setAccessManager

@Autowired
protected void setAccessManager(io.jmix.core.AccessManager accessManager)

setMetadata

@Autowired
protected void setMetadata(io.jmix.core.Metadata metadata)

isApplicable

protected boolean isApplicable()

Description copied from class: BaseAction

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

Overrides:

isApplicable in class BaseAction

Returns:

true if the action is enabled for the current context, e.g. there is a selected row in a table

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 BaseAction

Returns:

true if the action is enabled for the current user

setConstraintEntityOp

public void setConstraintEntityOp(@Nullable
                                  io.jmix.core.security.EntityOp entityOp)

Specified by:

setConstraintEntityOp in interface Action.HasSecurityConstraint

getConstraintEntityOp

@Nullable
public io.jmix.core.security.EntityOp getConstraintEntityOp()

Specified by:

getConstraintEntityOp in interface Action.HasSecurityConstraint