Package io.jmix.flowui.action

Class SecuredBaseAction<A extends SecuredBaseAction<A>>

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction<A>

io.jmix.flowui.action.ObservableBaseAction<A>

io.jmix.flowui.action.SecuredBaseAction<A>

All Implemented Interfaces:

Action, HasShortcutCombination

Direct Known Subclasses:

DialogAction, DynamicLocalizedMessageEditAction, FragmentAction, GenericFilterAction, ListDataComponentAction, PickerAction, UserMenuAction, ViewAction

public class SecuredBaseAction<A extends SecuredBaseAction<A>>
extends ObservableBaseAction<A>

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	SecuredBaseAction.EnabledRule	Callback interface which is invoked by the action to determine its enabled state.

Field Summary

Fields

Modifier and Type	Field	Description
protected List<SecuredBaseAction.EnabledRule>	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
SecuredBaseAction(String id)

Method Summary

Modifier and Type	Method	Description
void	addEnabledRule(SecuredBaseAction.EnabledRule enabledRule)	Add new enabled rule for the action.
protected boolean	isEnabledByRule()
protected boolean	isPermitted()
void	refreshState()	Refreshes internal state of the action to initialize enabled, visible, text, icon, etc.
void	removeEnabledRule(SecuredBaseAction.EnabledRule enabledRule)	Remove enabled rule.

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

actionPerform, getUiObservationSupport

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

addActionPerformedListener, isApplicable, 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

Field Details

enabledRules

protected List<SecuredBaseAction.EnabledRule> enabledRules

Constructor Details

SecuredBaseAction

public SecuredBaseAction(String id)

Method Details

refreshState

public void refreshState()

Description copied from interface: Action

Refreshes internal state of the action to initialize enabled, visible, text, icon, etc. properties depending on programmatically set values and user permissions set at runtime.

For example, this method is called by visual components holding actions when they are bound to data. At this moment the action can find out what entity it is connected to and change its state according to the user permissions.

Specified by:

refreshState in interface Action

Overrides:

refreshState in class BaseAction<A extends SecuredBaseAction<A>>

isPermitted

protected boolean isPermitted()

isEnabledByRule

protected boolean isEnabledByRule()

addEnabledRule

public void addEnabledRule(SecuredBaseAction.EnabledRule enabledRule)

Add new enabled rule for the action.

Parameters:

enabledRule - boolean rule for the action enabled state

removeEnabledRule

public void removeEnabledRule(SecuredBaseAction.EnabledRule enabledRule)

Remove enabled rule.

Parameters:

enabledRule - boolean rule for the action enabled state