Package com.vaadin.flow.component

Enum Class ModalityMode

java.lang.Object

java.lang.Enum<ModalityMode>

com.vaadin.flow.component.ModalityMode

All Implemented Interfaces:

Serializable, Comparable<ModalityMode>, Constable

public enum ModalityMode
extends Enum<ModalityMode>

Dialog modality mode.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
MODELESS	Doesn’t use modality at all.
STRICT	A visual curtain dims the background behind the dialog, trapping focus and blocking pointer events.
VISUAL	Behaves like STRICT except that request are not blocked.

Method Summary

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

MODELESS

public static final ModalityMode MODELESS

Doesn’t use modality at all. No modality curtain, focus trap, pointer event blocking, and request blocking.

STRICT

public static final ModalityMode STRICT

A visual curtain dims the background behind the dialog, trapping focus and blocking pointer events. Background components can't receive requests unless explicitly enabled via low-level APIs like DomListenerRegistration.allowInert().

VISUAL

public static final ModalityMode VISUAL

Behaves like STRICT except that request are not blocked.

Method Details

values

public static ModalityMode[] 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 ModalityMode 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