Package be.gaudry.model.disposition

Enum Class EPageOrientation

java.lang.Object

java.lang.Enum<EPageOrientation>

be.gaudry.model.disposition.EPageOrientation

All Implemented Interfaces:

Serializable, Comparable<EPageOrientation>, Constable

public enum EPageOrientation
extends Enum<EPageOrientation>

Possibles page orientations. 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
LANDSCAPE	Horizontal layout
PORTRAIT	Vertical layout

Method Summary

Modifier and Type	Method	Description
static EPageOrientation	fromInt(int key)
int	getValue()	The value is a numeric representation of this EPageOrientation, independent of the Enum.ordinal() information.
String	toString()	Returns a localized representation of an EPageOrientation, 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 EPageOrientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EPageOrientation[]	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

LANDSCAPE

public static final EPageOrientation LANDSCAPE

Horizontal layout

PORTRAIT

public static final EPageOrientation PORTRAIT

Vertical layout

Method Details

values

public static EPageOrientation[] 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 EPageOrientation 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 EPageOrientation, independent of the Enum.ordinal() information.

Returns:

the value

toString

public String toString()

Returns a localized representation of an EPageOrientation, 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<EPageOrientation>

Since:

1.1 use localization

See Also:

LanguageHelper

fromInt

public static EPageOrientation fromInt(int key)

Parameters:

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

Returns:

the matching EPageOrientation, or PORTRAIT in case of wrong parameter