Package io.jmix.ui.action.screen

Class ScreenCloseAction

java.lang.Object

io.jmix.ui.action.AbstractAction

io.jmix.ui.action.BaseAction

io.jmix.ui.action.AbstractScreenAction<A,S>

io.jmix.ui.action.screen.OperationResultScreenAction<ScreenCloseAction,Screen>

io.jmix.ui.action.screen.ScreenCloseAction

All Implemented Interfaces:

Action, Action.ExecutableAction, Action.HasPrimaryState, Action.OperationResultAction, Action.ScreenAction<Screen>, Action.SecuredAction

@StudioAction(target="io.jmix.ui.screen.Screen",
              description="Closes the screen")
@ActionType("screen_close")
public class ScreenCloseAction
extends OperationResultScreenAction<ScreenCloseAction,Screen>

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.OperationResultAction, Action.ScreenAction<S extends Screen>, Action.ScreenOpeningAction, Action.SecuredAction, Action.Status

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ID
protected StandardOutcome	outcome

Fields inherited from class io.jmix.ui.action.screen.OperationResultScreenAction

failHandler, nextStepSupplier, operationResult, successHandler

Fields inherited from class io.jmix.ui.action.AbstractScreenAction

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

Constructor	Description
ScreenCloseAction()
ScreenCloseAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
void	setIcons(Icons icons)
void	setMessages(Messages messages)
void	setOutcome(StandardOutcome outcome)
ScreenCloseAction	withOutcome(StandardOutcome outcome)

Methods inherited from class io.jmix.ui.action.screen.OperationResultScreenAction

getOperationResult, setFailHandler, setNextStepSupplier, setSuccessHandler, withFailHandler, withNextStepSupplier, withSuccessHandler

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

actionPerform, checkTarget, getTarget, initAction, isApplicable, setTarget, withCaption, withDescription, withEnabled, withEnabledByUiPermissions, withHandler, withIcon, withPrimary, withShortcut, withTarget, withVisible, withVisibleByUiPermissions

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

addActionPerformedListener, addEnabledRule, isEnabledByRule, isEnabledByUiPermissions, isPermitted, 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 Details

ID

public static final String ID

See Also:

• Constant Field Values

outcome

protected StandardOutcome outcome

Constructor Details

ScreenCloseAction

public ScreenCloseAction()

ScreenCloseAction

public ScreenCloseAction(String id)

Method Details

setIcons

@Autowired
public void setIcons(Icons icons)

setMessages

@Autowired
public void setMessages(Messages messages)

setOutcome

public void setOutcome(StandardOutcome outcome)

withOutcome

public ScreenCloseAction withOutcome(StandardOutcome outcome)

execute

public void execute()

Description copied from interface: Action.ExecutableAction

Executes the Action

Specified by:

execute in interface Action.ExecutableAction

Overrides:

execute in class OperationResultScreenAction<ScreenCloseAction,Screen>