Package org.refcodes.textual

Enum HorizAlignTextMode

java.lang.Object

java.lang.Enum<HorizAlignTextMode>

org.refcodes.textual.HorizAlignTextMode

All Implemented Interfaces:

Serializable, Comparable<HorizAlignTextMode>

public enum HorizAlignTextMode
extends Enum<HorizAlignTextMode>

The HorizAlignTextMode specifies for according algorithms on how a line is to be aligned.

Enum Constant Summary

Enum Constants

Enum Constant	Description
BLOCK	Block mode, extends the line's spaces round robin with additional spaces till the width is reached.
CENTER	Center alignment relative to the required width.
LEFT	Left alignment according to the required width.
RIGHT	Right alignment according to the required width.

Method Summary

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

LEFT

public static final HorizAlignTextMode LEFT

Left alignment according to the required width.

CENTER

public static final HorizAlignTextMode CENTER

Center alignment relative to the required width.

RIGHT

public static final HorizAlignTextMode RIGHT

Right alignment according to the required width.

BLOCK

public static final HorizAlignTextMode BLOCK

Block mode, extends the line's spaces round robin with additional spaces till the width is reached.

Method Detail

values

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

Returns:

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

valueOf

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