Package io.jmix.flowui.action

Class SecuredBaseAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

io.jmix.flowui.kit.action.BaseAction

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

io.jmix.flowui.action.SecuredBaseAction

All Implemented Interfaces:

SecuredAction, Action, HasShortcutCombination

Direct Known Subclasses:

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

public class SecuredBaseAction
extends ObservableBaseAction<SecuredBaseAction>
implements SecuredAction

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 boolean	enabledByUiPermissions
protected List<SecuredBaseAction.EnabledRule>	enabledRules
protected boolean	visibleByUiPermissions

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()
boolean	isEnabledByUiPermissions()
protected boolean	isPermitted()
boolean	isVisibleByUiPermissions()
void	refreshState()	Refreshes internal state of the action to initialize enabled, visible, text, icon, etc.
void	removeEnabledRule(SecuredBaseAction.EnabledRule enabledRule)	Remove enabled rule.
void	setEnabledByUiPermissions(boolean enabledByUiPermissions)
void	setVisibleByUiPermissions(boolean visibleByUiPermissions)
SecuredBaseAction	withEnabledByUiPermissions(boolean enabledByUiPermissions)
SecuredBaseAction	withIcon(com.vaadin.flow.component.icon.Icon icon)	Deprecated, for removal: This API element is subject to removal in a future version.
SecuredBaseAction	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)	Sets the icon property value of an action.
SecuredBaseAction	withVisibleByUiPermissions(boolean visibleByUiPermissions)

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

actionPerform, getUiObservationSupport, withDescription, withEnabled, withHandler, withIcon, withShortcutCombination, withText, withVariant, withVisible

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

addActionPerformedListener, isApplicable, setEnabled, setEnabledInternal, setVisible, setVisibleInternal, withTitle

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

Methods inherited from interface io.jmix.flowui.kit.action.Action

actionPerform, addPropertyChangeListener, getDescription, getIcon, getIconComponent, getId, getText, getVariant, isEnabled, isVisible, setDescription, setEnabled, setIcon, setIconComponent, setText, setVariant, setVisible

Methods inherited from interface io.jmix.flowui.kit.component.HasShortcutCombination

getShortcutCombination, setShortcutCombination

Field Details

enabledByUiPermissions

protected boolean enabledByUiPermissions

visibleByUiPermissions

protected boolean visibleByUiPermissions

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

isEnabledByUiPermissions

public boolean isEnabledByUiPermissions()

Specified by:

isEnabledByUiPermissions in interface SecuredAction

setEnabledByUiPermissions

public void setEnabledByUiPermissions(boolean enabledByUiPermissions)

Specified by:

setEnabledByUiPermissions in interface SecuredAction

isVisibleByUiPermissions

public boolean isVisibleByUiPermissions()

Specified by:

isVisibleByUiPermissions in interface SecuredAction

setVisibleByUiPermissions

public void setVisibleByUiPermissions(boolean visibleByUiPermissions)

Specified by:

setVisibleByUiPermissions in interface SecuredAction

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

withIcon

@Deprecated(since="2.8",
            forRemoval=true)
public SecuredBaseAction withIcon(@Nullable
 com.vaadin.flow.component.icon.Icon icon)

Deprecated, for removal: This API element is subject to removal in a future version.

Description copied from class: BaseAction

Sets the icon property value of an action. May be used by components to initialize their appearance.

Overrides:

withIcon in class ObservableBaseAction<SecuredBaseAction>

Parameters:

icon - icon to set or null to remove

Returns:

this object

withIcon

public SecuredBaseAction withIcon(@Nullable
 com.vaadin.flow.component.icon.VaadinIcon icon)

Description copied from class: BaseAction

Sets the icon property value of an action. May be used by components to initialize their appearance.

Overrides:

withIcon in class BaseAction

Parameters:

icon - icon to set or null to remove

Returns:

this object

withEnabledByUiPermissions

public SecuredBaseAction withEnabledByUiPermissions(boolean enabledByUiPermissions)

withVisibleByUiPermissions

public SecuredBaseAction withVisibleByUiPermissions(boolean visibleByUiPermissions)