com.softwarefx
Enum StringAlignment

java.lang.Object
  java.lang.Enum<StringAlignment>
      com.softwarefx.StringAlignment

All Implemented Interfaces:

Serializable, Comparable<StringAlignment>

public enum StringAlignment
extends Enum<StringAlignment>

The StringAlignment type specifies how a string is aligned in reference to the bounding rectangle. A bounding rectangle is used to define the area in which the text displays.

Enum Constant Summary

CENTER
Specifies that alignment is centered between origin and extent (width) of the formatting rectangle.

FAR
Specifies that alignment is to the far extent (right side) of the formatting rectangle.

NEAR
Specifies that alignment is towards the origin of the bounding rectangle.

Method Summary

static EnumSet<StringAlignment>	getEnumSetValue(int value) Returns a EnumSet that represents the given numeric value.
static StringAlignment	getEnumValue(int value) Returns a Enum Item that represents the given numeric value.
static int	getUnderlyingValue(EnumSet<StringAlignment> value) Returns a numeric value that represents the given EnumSet or Enum item.
static int	getUnderlyingValue(StringAlignment value) Returns a numeric value that represents the given EnumSet or Enum item.
static StringAlignment	valueOf(String name) Returns the enum constant of this type with the specified name.
static StringAlignment[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FAR

public static final StringAlignment FAR

Specifies that alignment is to the far extent (right side) of the formatting rectangle.

NEAR

public static final StringAlignment NEAR

Specifies that alignment is towards the origin of the bounding rectangle. May be used for alignment of characters along the line or for alignment of lines within the rectangle. For a right to left bounding rectangle, the origin is at the upper right.

CENTER

public static final StringAlignment CENTER

Specifies that alignment is centered between origin and extent (width) of the formatting rectangle.

Method Detail

values

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

Returns:

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

valueOf

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

getEnumSetValue

public static EnumSet<StringAlignment> getEnumSetValue(int value)

Returns a EnumSet that represents the given numeric value.

Parameters:

value - numeric representation of the Enumset.

getEnumValue

public static StringAlignment getEnumValue(int value)

Returns a Enum Item that represents the given numeric value.

Parameters:

value - numeric representation of the Enum item.

getUnderlyingValue

public static int getUnderlyingValue(StringAlignment value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.

getUnderlyingValue

public static int getUnderlyingValue(EnumSet<StringAlignment> value)

Returns a numeric value that represents the given EnumSet or Enum item.

Parameters:

value - A Enum Item or EnumSet.