com.day.cq.wcm.api.components

Enum EditLayout

java.lang.Object

java.lang.Enum<EditLayout>

com.day.cq.wcm.api.components.EditLayout

All Implemented Interfaces:

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

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

Defines the layout of the "editing" where "rollover" means that there is a rollover edit capability on the component and "edit bar" means that there is a edit bar.

Enum Constant Summary

Enum Constants

Enum Constant and Description
AUTO automatic detection
EDITBAR edit bar
NONE no explicit edit controls; will be provided externally by the page/other parent component
ROLLOVER rollover editing type

Method Summary

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

ROLLOVER

public static final EditLayout ROLLOVER

rollover editing type

EDITBAR

public static final EditLayout EDITBAR

edit bar

AUTO

public static final EditLayout AUTO

automatic detection

NONE

public static final EditLayout NONE

no explicit edit controls; will be provided externally by the page/other parent component

Since:

5.4

Method Detail

values

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

Returns:

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

valueOf

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

getXtype

public java.lang.String getXtype()

Returns the xtype

Returns:

the xtype