Package io.jmix.flowui.action.view

Class ViewCloseAction

java.lang.Object

io.jmix.flowui.kit.action.AbstractAction

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

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

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

io.jmix.flowui.action.view.ViewAction<ViewCloseAction,View<?>>

io.jmix.flowui.action.view.OperationResultViewAction<ViewCloseAction,View<?>>

io.jmix.flowui.action.view.ViewCloseAction

All Implemented Interfaces:

ExecutableAction, OperationResultAction, TargetAction<View<?>>, Action, HasShortcutCombination

@ActionType("view_close")
public class ViewCloseAction
extends OperationResultViewAction<ViewCloseAction,View<?>>

Nested Class Summary

Nested classes/interfaces inherited from class io.jmix.flowui.action.SecuredBaseAction

SecuredBaseAction.EnabledRule

Field Summary

Fields

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

Fields inherited from class io.jmix.flowui.action.view.OperationResultViewAction

failHandler, nextStepSupplier, operationResult, successHandler

Fields inherited from class io.jmix.flowui.action.view.ViewAction

target

Fields inherited from class io.jmix.flowui.action.SecuredBaseAction

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
ViewCloseAction()
ViewCloseAction(String id)

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
protected void	setIcons(Icons icons)
protected void	setMessages(Messages messages)
void	setOutcome(StandardOutcome outcome)
void	setShortcutCombination(@Nullable KeyCombination shortcutCombination)	Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.
protected void	setUiViewProperties(UiViewProperties viewProperties)
ViewCloseAction	withOutcome(StandardOutcome outcome)

Methods inherited from class io.jmix.flowui.action.view.OperationResultViewAction

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

Methods inherited from class io.jmix.flowui.action.view.ViewAction

actionPerform, checkTarget, getTarget, initAction, isApplicable, setTarget, withTarget

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

addEnabledRule, isEnabledByRule, isPermitted, refreshState, removeEnabledRule

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

getUiObservationSupport

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

addActionPerformedListener, 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, 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, refreshState, setDescription, setEnabled, setIcon, setIconComponent, setText, setVariant, setVisible

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

getShortcutCombination

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

outcome

protected StandardOutcome outcome

Constructor Details

ViewCloseAction

public ViewCloseAction()

ViewCloseAction

public ViewCloseAction(String id)

Method Details

setMessages

@Autowired
protected void setMessages(Messages messages)

setIcons

@Autowired
protected void setIcons(Icons icons)

setUiViewProperties

@Autowired
protected void setUiViewProperties(UiViewProperties viewProperties)

setShortcutCombination

public void setShortcutCombination(@Nullable KeyCombination shortcutCombination)

Description copied from interface: HasShortcutCombination

Sets object that stores information about keys, modifiers and additional settings that describe shortcut combinations.

Specified by:

setShortcutCombination in interface HasShortcutCombination

Overrides:

setShortcutCombination in class AbstractAction

Parameters:

shortcutCombination - key combination to set or null to remove

setOutcome

public void setOutcome(StandardOutcome outcome)

withOutcome

public ViewCloseAction withOutcome(StandardOutcome outcome)

execute

public void execute()

Description copied from interface: ExecutableAction

Executes the Action

Specified by:

execute in interface ExecutableAction

Overrides:

execute in class OperationResultViewAction<ViewCloseAction,View<?>>