org.ametys.web.renderingcontext

Enum RenderingContext

java.lang.Object

java.lang.Enum<RenderingContext>

org.ametys.web.renderingcontext.RenderingContext

All Implemented Interfaces:

Serializable, Comparable<RenderingContext>

public enum RenderingContext
extends Enum<RenderingContext>

CMS current rendering context. It determines URLs, paths, ...

Enum Constant Summary

Enum Constants

Enum Constant and Description
BACK Back-office context
FRONT Front-office context
PREVIEW Preview context

Method Summary

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

BACK

public static final RenderingContext BACK

Back-office context

FRONT

public static final RenderingContext FRONT

Front-office context

PREVIEW

public static final RenderingContext PREVIEW

Preview context

Method Detail

values

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

Returns:

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

valueOf

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