com.day.cq.wcm.api.components

Enum DialogMode

java.lang.Object

java.lang.Enum<DialogMode>

com.day.cq.wcm.api.components.DialogMode

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<DialogMode>, JSONString

public enum DialogMode
extends java.lang.Enum<DialogMode>
implements JSONString

Defines the mode of dialog where "floating" means that the dialog floats above the page and "inline" means that the dialog is inlined in the page. "auto" uses some UI metrics to define the mode of the dialog.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO automatic mode detection
FLOATING floating dialog mode
INLINE inline dialog mode

Method Summary

Modifier and Type	Method and Description
java.lang.String	toJSONString() The toJSONString method allows a class to produce its own JSON serialization.
static DialogMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static DialogMode[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

AUTO

public static final DialogMode AUTO

automatic mode detection

FLOATING

public static final DialogMode FLOATING

floating dialog mode

INLINE

public static final DialogMode INLINE

inline dialog mode

Method Detail

values

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

Returns:

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

valueOf

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

toJSONString

public java.lang.String toJSONString()

The toJSONString method allows a class to produce its own JSON serialization.

Specified by:

toJSONString in interface JSONString

Returns:

A strictly syntactically correct JSON text.