Package io.jmix.ui.action.screen

Class EditorCommitAction<T>

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<EditorCommitAction<T>,StandardEditor<T>>

io.jmix.ui.action.screen.EditorCommitAction<T>

All Implemented Interfaces:

Action, Action.AdjustWhenScreenReadOnly, Action.ExecutableAction, Action.HasPrimaryState, Action.OperationResultAction, Action.ScreenAction<StandardEditor<T>>, Action.SecuredAction

@StudioAction(target="io.jmix.ui.screen.Screen",
              description="Commits changes in the editor screen")
@ActionType("editor_commit")
public class EditorCommitAction<T>
extends OperationResultScreenAction<EditorCommitAction<T>,StandardEditor<T>>
implements Action.AdjustWhenScreenReadOnly

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

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

Method Summary

Modifier and Type	Method	Description
void	execute()	Executes the Action
protected boolean	isApplicable()	Callback method which is invoked by the action to determine its enabled state.
void	setIcons(Icons icons)
void	setMessages(Messages messages)

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, 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

Methods inherited from interface io.jmix.ui.action.Action.AdjustWhenScreenReadOnly

isDisabledWhenScreenReadOnly

Field Details

ID

public static final String ID

See Also:

• Constant Field Values

Constructor Details

EditorCommitAction

public EditorCommitAction()

EditorCommitAction

public EditorCommitAction(String id)

Method Details

setIcons

@Autowired
public void setIcons(Icons icons)

setMessages

@Autowired
public void setMessages(Messages messages)

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<EditorCommitAction<T>,StandardEditor<T>>

isApplicable

protected boolean isApplicable()

Description copied from class: BaseAction

Callback method which is invoked by the action to determine its enabled state.

Overrides:

isApplicable in class AbstractScreenAction<EditorCommitAction<T>,StandardEditor<T>>

Returns:

true if the action is enabled for the current context, e.g. there is a selected row in a table