Module com.semanticcms.core.servlet

Package com.semanticcms.core.servlet

Enum ComponentPosition

java.lang.Object

java.lang.Enum<ComponentPosition>

com.semanticcms.core.servlet.ComponentPosition

All Implemented Interfaces:

Serializable, Comparable<ComponentPosition>

public enum ComponentPosition
extends Enum<ComponentPosition>

The set of allowed component locations.

See Also:

• Script.Position

Enum Constant Summary

Enum Constants

Enum Constant	Description
BODY_END	Components called just before the body closing tag.
BODY_START	Components called just after the body opening tag.
HEAD_END	Components called just before the head closing tag.
HEAD_START	Components called just after the head opening tag.

Method Summary

Modifier and Type	Method	Description
Script.Position	getScriptPosition()	Gets the related script position.
static ComponentPosition	valueOf(String name)	Returns the enum constant of this type with the specified name.
static ComponentPosition[]	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 Details

HEAD_START

public static final ComponentPosition HEAD_START

Components called just after the head opening tag. These components are called in the order registered.

These are after any scripts in Script.Position.HEAD_START.

HEAD_END

public static final ComponentPosition HEAD_END

Components called just before the head closing tag. These components are called in the reverse order registered.

These are before any scripts in Script.Position.HEAD_END.

BODY_START

public static final ComponentPosition BODY_START

Components called just after the body opening tag. These components are called in the order registered.

These are after any scripts in Script.Position.BODY_START.

BODY_END

public static final ComponentPosition BODY_END

Components called just before the body closing tag. These components are called in the reverse order registered.

These are before any scripts in Script.Position.BODY_END.

Method Details

values

public static ComponentPosition[] values()

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

Returns:

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

valueOf

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

getScriptPosition

public Script.Position getScriptPosition()

Gets the related script position.