Package org.apache.fop.traits

Class Direction

java.lang.Object

org.apache.fop.traits.TraitEnum

org.apache.fop.traits.Direction

All Implemented Interfaces:

java.io.Serializable

public final class Direction
extends TraitEnum

Enumeration class for direction traits, namely {inline,block}-progression-direction and shift-direction.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static Direction	BT	direction: bottom-to-top
private static java.lang.String[]	DIRECTION_NAMES
private static int[]	DIRECTION_VALUES
private static Direction[]	DIRECTIONS
static Direction	LR	direction: left-to-right
static Direction	RL	direction: right-to-left
private static long	serialVersionUID
static Direction	TB	direction: top-to-bottom

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Direction(int index)

Method Summary

Modifier and Type	Method	Description
boolean	isHorizontal()	Determine if direction is horizontal or not.
boolean	isVertical()	Determine if direction is vertical or not.
private java.lang.Object	readResolve()
java.lang.String	toString()
static Direction	valueOf(int enumValue)	Returns the enumeration/singleton object based on its name.
static Direction	valueOf(java.lang.String name)	Returns the enumeration/singleton object based on its name.

Methods inherited from class org.apache.fop.traits.TraitEnum

getEnumValue, getName

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

DIRECTION_NAMES

private static final java.lang.String[] DIRECTION_NAMES

DIRECTION_VALUES

private static final int[] DIRECTION_VALUES

LR

public static final Direction LR

direction: left-to-right

RL

public static final Direction RL

direction: right-to-left

TB

public static final Direction TB

direction: top-to-bottom

BT

public static final Direction BT

direction: bottom-to-top

DIRECTIONS

private static final Direction[] DIRECTIONS

Constructor Detail

Direction

private Direction(int index)

Method Detail

isVertical

public boolean isVertical()

Determine if direction is vertical or not.

Returns:

true if vertical

isHorizontal

public boolean isHorizontal()

Determine if direction is horizontal or not.

Returns:

true if horizontal

valueOf

public static Direction valueOf(java.lang.String name)

Returns the enumeration/singleton object based on its name.

Parameters:

name - the name of the enumeration value

Returns:

the enumeration object

valueOf

public static Direction valueOf(int enumValue)

Returns the enumeration/singleton object based on its name.

Parameters:

enumValue - the enumeration value

Returns:

the enumeration object

readResolve

private java.lang.Object readResolve()
                              throws java.io.ObjectStreamException

Throws:

java.io.ObjectStreamException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object