Package io.jmix.flowui.view
Class StandardCloseAction
java.lang.Object
io.jmix.flowui.view.StandardCloseAction
- All Implemented Interfaces:
ChangeTrackerCloseAction
,CloseAction
- Direct Known Subclasses:
NavigateCloseAction
A close action implementation used in the base views provided by the framework:
View
,
StandardDetailView
, StandardListView
.
If its isCheckForUnsavedChanges()
flag is set to true, the view checks if it contains unsaved changes and asks the
user whether to save or discard them.
-
Field Summary
-
Constructor Summary
ConstructorDescriptionStandardCloseAction
(String actionId) Constructs the close action with the given id andcheckForUnsavedChanges
flag set to true.StandardCloseAction
(String actionId, boolean checkForUnsavedChanges) Constructs the close action with the given id andisCheckForUnsavedChanges()
flag. -
Method Summary
Modifier and TypeMethodDescriptionAn identifier of the close action to distinguish it from other actions of the same type.boolean
toString()
-
Field Details
-
actionId
-
checkForUnsavedChanges
protected final boolean checkForUnsavedChanges
-
-
Constructor Details
-
StandardCloseAction
Constructs the close action with the given id andcheckForUnsavedChanges
flag set to true.- Parameters:
actionId
- an identifier of the close action to distinguish it from other actions of the same type
-
StandardCloseAction
Constructs the close action with the given id andisCheckForUnsavedChanges()
flag.- Parameters:
actionId
- an identifier of the close action to distinguish it from other actions of the same typecheckForUnsavedChanges
- indicates whether the view using this action should check for unsaved changes
-
-
Method Details
-
getActionId
An identifier of the close action to distinguish it from other actions of the same type. -
toString
-
isCheckForUnsavedChanges
public boolean isCheckForUnsavedChanges()- Specified by:
isCheckForUnsavedChanges
in interfaceChangeTrackerCloseAction
- Returns:
- true if the view using this action should prevent close if there are unsaved changes
-