io.jmix.ui.screen

Class StandardCloseAction

java.lang.Object

io.jmix.ui.screen.StandardCloseAction

All Implemented Interfaces:

ChangeTrackerCloseAction, CloseAction

public class StandardCloseAction
extends java.lang.Object
implements CloseAction, ChangeTrackerCloseAction

A close action implementation used in the base screens provided by the framework: Screen, StandardEditor, StandardLookup.

If its isCheckForUnsavedChanges() flag is set to true, the screen checks if it contains unsaved changes and asks the user whether to commit or discard them.

Constructor Summary

Constructors

Constructor and Description
StandardCloseAction(java.lang.String actionId) Constructs the close action with the given id and checkForUnsavedChanges flag set to true.
StandardCloseAction(java.lang.String actionId, boolean checkForUnsavedChanges) Constructs the close action with the given id and isCheckForUnsavedChanges() flag.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getActionId() An identifier of the close action to distinguish it from other actions of the same type.
boolean	isCheckForUnsavedChanges()
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

StandardCloseAction

public StandardCloseAction(java.lang.String actionId)

Constructs the close action with the given id and checkForUnsavedChanges flag set to true.

Parameters:

actionId - an identifier of the close action to distinguish it from other actions of the same type

StandardCloseAction

public StandardCloseAction(java.lang.String actionId,
                           boolean checkForUnsavedChanges)

Constructs the close action with the given id and isCheckForUnsavedChanges() flag.

Parameters:

actionId - an identifier of the close action to distinguish it from other actions of the same type

checkForUnsavedChanges - indicates whether the screen using this action should check for unsaved changes

Method Detail

getActionId

public java.lang.String getActionId()

An identifier of the close action to distinguish it from other actions of the same type.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

isCheckForUnsavedChanges

public boolean isCheckForUnsavedChanges()

Specified by:

isCheckForUnsavedChanges in interface ChangeTrackerCloseAction

Returns:

true if the screen using this action should prevent close if there are unsaved changes