Enum Class StandardOutcome

java.lang.Object
java.lang.Enum<StandardOutcome>
io.jmix.flowui.screen.StandardOutcome
All Implemented Interfaces:
Serializable, Comparable<StandardOutcome>, Constable

public enum StandardOutcome extends 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). method to determine how the screen was closed.

See Also:
  • Enum Constant Details

    • 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 Details

    • values

      public static StandardOutcome[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static StandardOutcome valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null
    • getCloseAction

      public CloseAction getCloseAction()