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.SecuredBaseAction

All Implemented Interfaces:

SecuredAction, Action, HasShortcutCombination

Direct Known Subclasses:

DialogAction, GenericFilterAction, ListDataComponentAction, PickerAction, ViewAction

public class SecuredBaseAction
extends BaseAction
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.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()
void	removeEnabledRule(SecuredBaseAction.EnabledRule enabledRule)	Remove enabled rule.
void	setEnabledByUiPermissions(boolean enabledByUiPermissions)
void	setVisibleByUiPermissions(boolean visibleByUiPermissions)
SecuredBaseAction	withEnabled(boolean enabled)
SecuredBaseAction	withEnabledByUiPermissions(boolean enabledByUiPermissions)
SecuredBaseAction	withHandler(Consumer<ActionPerformedEvent> handler)
SecuredBaseAction	withIcon(com.vaadin.flow.component.icon.Icon icon)
SecuredBaseAction	withIcon(com.vaadin.flow.component.icon.VaadinIcon icon)
SecuredBaseAction	withShortcutCombination(KeyCombination shortcutCombination)
SecuredBaseAction	withText(String text)
SecuredBaseAction	withTitle(String title)
SecuredBaseAction	withVariant(ActionVariant actionVariant)
SecuredBaseAction	withVisible(boolean visible)
SecuredBaseAction	withVisibleByUiPermissions(boolean visibleByUiPermissions)

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

actionPerform, addActionPerformedListener, isApplicable, setEnabled, setEnabledInternal, setVisible, setVisibleInternal

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

addPropertyChangeListener, firePropertyChange, getDescription, getEventBus, getIcon, getId, getShortcutCombination, getText, getVariant, hasListener, isEnabled, isVisible, setDescription, setIcon, 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, getId, getText, getVariant, isEnabled, isVisible, setDescription, setEnabled, setIcon, 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()

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

withText

public SecuredBaseAction withText(@Nullable
 String text)

Overrides:

withText in class BaseAction

withEnabled

public SecuredBaseAction withEnabled(boolean enabled)

Overrides:

withEnabled in class BaseAction

withVisible

public SecuredBaseAction withVisible(boolean visible)

Overrides:

withVisible in class BaseAction

withIcon

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

Overrides:

withIcon in class BaseAction

withIcon

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

Overrides:

withIcon in class BaseAction

withTitle

public SecuredBaseAction withTitle(@Nullable
 String title)

Overrides:

withTitle in class BaseAction

withVariant

public SecuredBaseAction withVariant(ActionVariant actionVariant)

Overrides:

withVariant in class BaseAction

withShortcutCombination

public SecuredBaseAction withShortcutCombination(@Nullable
 KeyCombination shortcutCombination)

Overrides:

withShortcutCombination in class BaseAction

withHandler

public SecuredBaseAction withHandler(@Nullable
 Consumer<ActionPerformedEvent> handler)

Overrides:

withHandler in class BaseAction

withEnabledByUiPermissions

public SecuredBaseAction withEnabledByUiPermissions(boolean enabledByUiPermissions)

withVisibleByUiPermissions

public SecuredBaseAction withVisibleByUiPermissions(boolean visibleByUiPermissions)