io.jmix.ui.component

Enum CloseOriginType

java.lang.Object

java.lang.Enum<CloseOriginType>

io.jmix.ui.component.CloseOriginType

All Implemented Interfaces:

Window.CloseOrigin, java.io.Serializable, java.lang.Comparable<CloseOriginType>

public enum CloseOriginType
extends java.lang.Enum<CloseOriginType>
implements Window.CloseOrigin

Describes the default ways a window was closed.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BREADCRUMBS A screen is closed by clicking on the breadcrumbs link.
CLOSE_BUTTON A screen is closed with one of the following approaches: screen's close button, TabSheet tabs' close actions (Close, Close All, Close Others).
SHORTCUT A screen is closed with UiScreenProperties.getCloseShortcut().

Method Summary

Modifier and Type	Method and Description
static CloseOriginType	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static CloseOriginType[]	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

BREADCRUMBS

public static final CloseOriginType BREADCRUMBS

A screen is closed by clicking on the breadcrumbs link.

CLOSE_BUTTON

public static final CloseOriginType CLOSE_BUTTON

A screen is closed with one of the following approaches: screen's close button, TabSheet tabs' close actions (Close, Close All, Close Others).

SHORTCUT

public static final CloseOriginType SHORTCUT

A screen is closed with UiScreenProperties.getCloseShortcut().

Method Detail

values

public static CloseOriginType[] 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 (CloseOriginType c : CloseOriginType.values())
    System.out.println(c);

Returns:

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

valueOf

public static CloseOriginType 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