org.mpxj.mpp

Enum TimescaleAlignment

java.lang.Object

java.lang.Enum<TimescaleAlignment>

org.mpxj.mpp.TimescaleAlignment

All Implemented Interfaces:

Serializable, Comparable<TimescaleAlignment>, MpxjEnum

public enum TimescaleAlignment
extends Enum<TimescaleAlignment>
implements MpxjEnum

Class representing the label alignment on a Gantt chart timescale.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER
LEFT
RIGHT

Method Summary

Modifier and Type	Method and Description
static TimescaleAlignment	getInstance(int type) Retrieve an instance of the enum based on its int value.
static TimescaleAlignment	getInstance(Number type) Retrieve an instance of the enum based on its int value.
String	getName() Retrieve the name of this alignment.
int	getValue() Accessor method used to retrieve the numeric representation of the enum.
String	toString() Generate a string representation of this instance.
static TimescaleAlignment	valueOf(String name) Returns the enum constant of this type with the specified name.
static TimescaleAlignment[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

LEFT

public static final TimescaleAlignment LEFT

CENTER

public static final TimescaleAlignment CENTER

RIGHT

public static final TimescaleAlignment RIGHT

Method Detail

values

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

Returns:

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

valueOf

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

getInstance

public static TimescaleAlignment getInstance(int type)

Retrieve an instance of the enum based on its int value.

Parameters:

type - int type

Returns:

enum instance

getInstance

public static TimescaleAlignment getInstance(Number type)

Retrieve an instance of the enum based on its int value.

Parameters:

type - int type

Returns:

enum instance

getValue

public int getValue()

Accessor method used to retrieve the numeric representation of the enum.

Specified by:

getValue in interface MpxjEnum

Returns:

int representation of the enum

getName

public String getName()

Retrieve the name of this alignment. Note that this is not localised.

Returns:

name of this alignment type

toString

public String toString()

Generate a string representation of this instance.

Overrides:

toString in class Enum<TimescaleAlignment>

Returns:

string representation of this instance