Package io.jmix.ui.component.mainwindow.impl

Class SubstituteUserAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.component.mainwindow.impl.SubstituteUserAction

All Implemented Interfaces:

Action, Action.HasPrimaryState, Action.SecuredAction

public class SubstituteUserAction
extends BaseAction

Makes UI-specific preparations to user substitution and performs it using UserSubstitutionManager Checks if there are screens that have unsaved changes and shows dialog window with options:

1. Discard changes (and close all windows, cleanups background tasks, then performs substitution and recreates main window)
2. Cancel (invokes all cancelActions)

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	Description
protected List<Consumer<org.springframework.security.core.userdetails.UserDetails>>	cancelActions
protected Icons	icons
static final String	ID
protected Messages	messages
protected org.springframework.security.core.userdetails.UserDetails	newSubstitutedUser
protected org.springframework.security.core.userdetails.UserDetails	prevSubstitutedUser
protected UserSubstitutionManager	substitutionManager

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	Description
SubstituteUserAction(org.springframework.security.core.userdetails.UserDetails newSubstitutedUser, org.springframework.security.core.userdetails.UserDetails oldSubstitutedUser, Messages messages, Icons icons, UserSubstitutionManager substitutionManager)

Method Summary

Modifier and Type	Method	Description
void	actionPerform(Component component)	Invoked by owning component to execute the action.
protected void	cancel()
protected void	doSubstituteUser(AppUI currentUI)
SubstituteUserAction	withCancelAction(Consumer<org.springframework.security.core.userdetails.UserDetails> cancelStep)

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

addActionPerformedListener, addEnabledRule, isApplicable, isEnabledByRule, isEnabledByUiPermissions, isPermitted, isVisibleByUiPermissions, refreshState, removeEnabledRule, setEnabled, setEnabledByUiPermissions, setEnabledInternal, setVisible, setVisibleByUiPermissions, setVisibleInternal, withCaption, withDescription, withHandler, withIcon, withPrimary, withShortcut

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

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

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

cancelActions

protected List<Consumer<org.springframework.security.core.userdetails.UserDetails>> cancelActions

newSubstitutedUser

protected org.springframework.security.core.userdetails.UserDetails newSubstitutedUser

prevSubstitutedUser

protected org.springframework.security.core.userdetails.UserDetails prevSubstitutedUser

messages

protected Messages messages

icons

protected Icons icons

substitutionManager

protected UserSubstitutionManager substitutionManager

Constructor Details

SubstituteUserAction

public SubstituteUserAction(org.springframework.security.core.userdetails.UserDetails newSubstitutedUser,
 org.springframework.security.core.userdetails.UserDetails oldSubstitutedUser,
 Messages messages,
 Icons icons,
 UserSubstitutionManager substitutionManager)

Method Details

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

doSubstituteUser

protected void doSubstituteUser(AppUI currentUI)

cancel

protected void cancel()

withCancelAction

public SubstituteUserAction withCancelAction(Consumer<org.springframework.security.core.userdetails.UserDetails> cancelStep)