io.jmix.ui.screen

Enum OpenMode

java.lang.Object

java.lang.Enum<OpenMode>

io.jmix.ui.screen.OpenMode

All Implemented Interfaces:

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

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

Standard launch modes of Screens.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DIALOG Open a screen as modal dialog.
NEW_TAB Open a screen in new tab of the main window.
NEW_WINDOW In Desktop Client open a screen in new main window, in Web Client the same as new NEW_TAB
ROOT In Web Client opens a screen as main
THIS_TAB Open a screen on top of the current tab screens stack.

Method Summary

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

NEW_TAB

public static final OpenMode NEW_TAB

Open a screen in new tab of the main window.
In Web Client with AppWindow.Mode.SINGLE the new screen replaces current screen.

THIS_TAB

public static final OpenMode THIS_TAB

Open a screen on top of the current tab screens stack.

DIALOG

public static final OpenMode DIALOG

Open a screen as modal dialog.

NEW_WINDOW

public static final OpenMode NEW_WINDOW

In Desktop Client open a screen in new main window, in Web Client the same as new NEW_TAB

ROOT

public static final OpenMode ROOT

In Web Client opens a screen as main

Method Detail

values

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

Returns:

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

valueOf

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