com.adobe.acs.commons.designer

Enum PageRegion

java.lang.Object

java.lang.Enum<PageRegion>

com.adobe.acs.commons.designer.PageRegion

All Implemented Interfaces:

Serializable, Comparable<PageRegion>

@ProviderType
public enum PageRegion
extends Enum<PageRegion>

Enum representing the possible target regions for a client library within an HTML page.

Enum Constant Summary

Enum Constants

Enum Constant and Description
BODY The body section.
HEAD The head section.

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

HEAD

public static final PageRegion HEAD

The head section.

BODY

public static final PageRegion BODY

The body section.

Method Detail

values

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

Returns:

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

valueOf

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

toString

public String toString()

Overrides:

toString in class Enum<PageRegion>