io.jmix.ui.screen

Enum StandardOutcome

java.lang.Object

java.lang.Enum<StandardOutcome>

io.jmix.ui.screen.StandardOutcome

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<StandardOutcome>

public enum StandardOutcome
extends java.lang.Enum<StandardOutcome>

A possible outcome of screens extending StandardEditor and StandardLookup.

Constants of this enum can be used instead of CloseAction instances in Screen.close(StandardOutcome) method to initiate closing and in Screen.AfterCloseEvent.closedWith(StandardOutcome), AfterScreenCloseEvent.closedWith(StandardOutcome). method to determine how the screen was closed.

See Also:

CLOSE, COMMIT, DISCARD, SELECT

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLOSE The screen is closed without an explicit commit.
COMMIT The screen is closed after an explicit commit.
DISCARD The screen is closed without an explicit commit and it did not notify the user about unsaved changes.
SELECT The screen is closed after the user selected an item in the lookup component.

Method Summary

Modifier and Type	Method and Description
CloseAction	getCloseAction()
static StandardOutcome	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static StandardOutcome[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CLOSE

public static final StandardOutcome CLOSE

The screen is closed without an explicit commit. However, the screen notifies the user if there are unsaved changes.

COMMIT

public static final StandardOutcome COMMIT

The screen is closed after an explicit commit. If the screen still contains unsaved changes, the user is notified about it.

DISCARD

public static final StandardOutcome DISCARD

The screen is closed without an explicit commit and it did not notify the user about unsaved changes.

SELECT

public static final StandardOutcome SELECT

The screen is closed after the user selected an item in the lookup component.

Method Detail

values

public static StandardOutcome[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (StandardOutcome c : StandardOutcome.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static StandardOutcome valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getCloseAction

public CloseAction getCloseAction()