com.day.cq.wcm.api

Enum AuthoringUIMode

java.lang.Object

java.lang.Enum<AuthoringUIMode>

com.day.cq.wcm.api.AuthoringUIMode

All Implemented Interfaces:

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

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

Enum Constant Summary

Enum Constants

Enum Constant and Description
CLASSIC Classic authoring UI mode
TOUCH Touch-Optimized authoring UI mode

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	REQUEST_ATTRIBUTE_NAME Name of the AuthoringUIMode request attribute

Method Summary

Modifier and Type	Method and Description
static AuthoringUIMode	fromRequest(ServletRequest request) Returns the current authoring UI mode of this request.
static AuthoringUIMode	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AuthoringUIMode[]	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

CLASSIC

public static final AuthoringUIMode CLASSIC

Classic authoring UI mode

TOUCH

public static final AuthoringUIMode TOUCH

Touch-Optimized authoring UI mode

Field Detail

REQUEST_ATTRIBUTE_NAME

public static final java.lang.String REQUEST_ATTRIBUTE_NAME

Name of the AuthoringUIMode request attribute

Method Detail

values

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

Returns:

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

valueOf

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

fromRequest

public static AuthoringUIMode fromRequest(ServletRequest request)

Returns the current authoring UI mode of this request.

Parameters:

request - Servlet request

Returns:

current authoring UI mode