info.magnolia.ui.api.overlay

Enum OverlayLayer.ModalityLevel

java.lang.Object

java.lang.Enum<OverlayLayer.ModalityLevel>

info.magnolia.ui.api.overlay.OverlayLayer.ModalityLevel

All Implemented Interfaces:

Serializable, Comparable<OverlayLayer.ModalityLevel>

Enclosing interface:

OverlayLayer

public static enum OverlayLayer.ModalityLevel
extends Enum<OverlayLayer.ModalityLevel>

The available levels of modality. Determines how "modal" it is - -STRONG creates a dark background that prevents clicks. -LIGHT adds a border, creates a transparent background that prevents clicks. -NON_MODAL does not prevent clicks.

Enum Constant Summary

Enum Constants

Enum Constant and Description
LIGHT
NON_MODAL
STRONG

Method Summary

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

STRONG

public static final OverlayLayer.ModalityLevel STRONG

LIGHT

public static final OverlayLayer.ModalityLevel LIGHT

NON_MODAL

public static final OverlayLayer.ModalityLevel NON_MODAL

Method Detail

values

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

Returns:

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

valueOf

public static OverlayLayer.ModalityLevel valueOf(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:

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

NullPointerException - if the argument is null

getCssClass

public String getCssClass()

getName

public String getName()