Package be.gaudry.model.disposition

Enum Class ETextLocation

java.lang.Object

java.lang.Enum<ETextLocation>

be.gaudry.model.disposition.ETextLocation

All Implemented Interfaces:

Serializable, Comparable<ETextLocation>, Constable

public enum ETextLocation
extends Enum<ETextLocation>

Possibles locations into a page document. Provided by the broldev.core.model project.

Since:

1.0 Jul 2, 2008, broldev.core.model 0.0.1-SNAPSHOT dependency

Version:

1.1 Feb 12 2009

Author:

Steph GAUDRY

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
FOOTER	Footer of the document
HEADER	Header of the document
NONE	No placement (not add to document, not displayed)

Method Summary

Modifier and Type	Method	Description
static ETextLocation	fromInt(int key)
int	getValue()	The value is a numeric representation of this ETextLocation, independent of the Enum.ordinal() information.
String	toString()	Returns a localized representation of an ETextPosition, or the name of this enum constant (as contained in the declaration) if an error occurs when trying to use the language resource file.
static ETextLocation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ETextLocation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NONE

public static final ETextLocation NONE

No placement (not add to document, not displayed)

HEADER

public static final ETextLocation HEADER

Header of the document

FOOTER

public static final ETextLocation FOOTER

Footer of the document

Method Details

values

public static ETextLocation[] values()

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

Returns:

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

valueOf

public static ETextLocation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getValue

public int getValue()

The value is a numeric representation of this ETextLocation, independent of the Enum.ordinal() information.

Returns:

the value

toString

public String toString()

Returns a localized representation of an ETextPosition, or the name of this enum constant (as contained in the declaration) if an error occurs when trying to use the language resource file.

Overrides:

toString in class Enum<ETextLocation>

Since:

1.1 use localization

See Also:

LanguageHelper

fromInt

public static ETextLocation fromInt(int key)

Parameters:

key - numeric representation of the ETextLocation,value given by the getValue() method.

Returns:

the matching ETextLocation, or HEADER in case of wrong parameter