com.sas.visuals
Class Placement

com.sas.visuals.Placement

public final class Placement

An Enumeration class. Use the static final variables as enumeration values: discrete named values from a set of 12 values. Note there are no public constructors, so the final static variables listed below will be the only instances of the class.

See Also:

Enum

Nested Class Summary

Nested classes/interfaces inherited from class com.sas.util.Enum

com.sas.util.Enum.Editor

Field Summary

static Placement	BOTTOM Place at the bottom
static Placement	BOTTOM_LEFT Place on the bottom left side
static Placement	BOTTOM_RIGHT Place on the bottom right side
static int	count Number of enumerations.
static Placement	LEFTSIDE_BOTTOM Place on the left side, near the bottom
static Placement	LEFTSIDE_CENTER Place on the leftside, center
static Placement	LEFTSIDE_TOP Place on the left side, near the top
static Placement	RIGHTSIDE_BOTTOM Place on the right side, near the bottom
static Placement	RIGHTSIDE_CENTER Place on the rightside, center
static Placement	RIGHTSIDE_TOP Place on the right side, near the top
static Placement	TOP Place at the top
static Placement	TOP_LEFT Place on the top left side
static Placement	TOP_RIGHT Place on the top right side

Fields inherited from class com.sas.util.Enum

next

Method Summary

static Placement	get(int index) Return the enum corresponding to an index, or ordinal position.
static Placement	get(java.lang.String name) Return the enum corresponding to an enum name
static Placement	getEnum(int value) Return the enum containing a specified value
static Placement	getFirst() Get the first enum in the sequence.
int	getIndex() Return the ordinal position of an enum.
Placement	getNext() Return the next Placement in the sequence
com.sas.util.Enum	getNextEnum() Return the next Placement in the sequence
static Placement	read(java.io.ObjectInputStream is) Deserialization support.
void	write(java.io.ObjectOutputStream os) Serialization support. write a Placement to an ObjectOutputStream.

Methods inherited from class com.sas.util.Enum

get, get, getAt, getAt, getEnum, getEnums, getIndex, getValue, setValue, toString, toString

Field Detail

count

public static final int count

Number of enumerations.

See Also:

Constant Field Values

RIGHTSIDE_CENTER

public static final Placement RIGHTSIDE_CENTER

Place on the rightside, center

LEFTSIDE_CENTER

public static final Placement LEFTSIDE_CENTER

Place on the leftside, center

BOTTOM_RIGHT

public static final Placement BOTTOM_RIGHT

Place on the bottom right side

BOTTOM_LEFT

public static final Placement BOTTOM_LEFT

Place on the bottom left side

TOP_RIGHT

public static final Placement TOP_RIGHT

Place on the top right side

TOP_LEFT

public static final Placement TOP_LEFT

Place on the top left side

RIGHTSIDE_BOTTOM

public static final Placement RIGHTSIDE_BOTTOM

Place on the right side, near the bottom

RIGHTSIDE_TOP

public static final Placement RIGHTSIDE_TOP

Place on the right side, near the top

LEFTSIDE_BOTTOM

public static final Placement LEFTSIDE_BOTTOM

Place on the left side, near the bottom

LEFTSIDE_TOP

public static final Placement LEFTSIDE_TOP

Place on the left side, near the top

BOTTOM

public static final Placement BOTTOM

Place at the bottom

TOP

public static final Placement TOP

Place at the top

Method Detail

getNext

public Placement getNext()

Return the next Placement in the sequence

Returns:

the next Placement in the sequence

getNextEnum

public com.sas.util.Enum getNextEnum()

Return the next Placement in the sequence

Specified by:

getNextEnum in class com.sas.util.Enum

Returns:

the next Placement in the sequence

getIndex

public int getIndex()

Return the ordinal position of an enum. The ordinal position is it's position relative to the others; this is a value from 0 to 12_1

Specified by:

getIndex in class com.sas.util.Enum

Returns:

int

get

public static Placement get(int index)

Return the enum corresponding to an index, or ordinal position.

Parameters:

index - The relative position [0,12_1]

Returns:

Placement

getEnum

public static Placement getEnum(int value)

Return the enum containing a specified value

Parameters:

value - A value of a Placement to find.

Returns:

Placement

get

public static Placement get(java.lang.String name)

Return the enum corresponding to an enum name

Parameters:

name - The enumeration name to find

Returns:

Placement, null if no such enumeration

write

public void write(java.io.ObjectOutputStream os)
           throws java.io.IOException

Serialization support. write a Placement to an ObjectOutputStream. Use this method to serialize a Placement held in an instance variable if you want to make the holding object Serializable. Enum objects are not Serializable because they are immutable singletons. (The benefit of enums is there is only one of each value.)

Parameters:

os - an Object Output Stream.

Throws:

java.io.IOException

read

public static Placement read(java.io.ObjectInputStream is)
                      throws java.io.IOException

Deserialization support. Read a Placement from an ObjectInputStream. Note that Placement objects are not serializable; this prevents creation of multiple objects with the same value and/or name. Call this from your class' private readObject method if your class is Serializable and keeps Placement objects; the Placement instance variable in your class should be transient.

Parameters:

is - the ObjectInputStream

Throws:

java.io.IOException

getFirst

public static Placement getFirst()

Get the first enum in the sequence.

Returns:

the next Enum, or null if this is the last in the sequence.