g4p_controls

Enum GAlign

java.lang.Object

java.lang.Enum<GAlign>

g4p_controls.GAlign

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<GAlign>

public enum GAlign
extends java.lang.Enum<GAlign>

This class provides an enumeration that is used to control the alignment of text and images.
It also defines the constants for the position of the icon relative to the text.

Author:

Peter Lager

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM
CENTER
EAST
INVALID
JUSTIFY
LEFT
MIDDLE
NORTH
RIGHT
SOUTH
TOP
WEST

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDesc() Returns the textual verbose description of this alignment.
static GAlign	getFromText(java.lang.String textID) Get an alignment based from its textual ID.
java.lang.String	getTextID() Returns the textual ID of with this alignment.
boolean	isHorzAlign() Is this a horizontal alignment constant?
boolean	isPosAlign() Is this an icon position constant?
boolean	isVertAlign() Is this a vertical alignment constant?
java.lang.String	toString() Returns a full description
static GAlign	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static GAlign[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

INVALID

public static final GAlign INVALID

LEFT

public static final GAlign LEFT

CENTER

public static final GAlign CENTER

RIGHT

public static final GAlign RIGHT

JUSTIFY

public static final GAlign JUSTIFY

TOP

public static final GAlign TOP

MIDDLE

public static final GAlign MIDDLE

BOTTOM

public static final GAlign BOTTOM

SOUTH

public static final GAlign SOUTH

NORTH

public static final GAlign NORTH

WEST

public static final GAlign WEST

EAST

public static final GAlign EAST

Method Detail

values

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

Returns:

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

valueOf

public static GAlign valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getFromText

public static GAlign getFromText(java.lang.String textID)

Get an alignment based from its textual ID.

Parameters:

textID - the text ID to search for

Returns:

the alignment or INVALID if not found

getTextID

public java.lang.String getTextID()

Returns the textual ID of with this alignment.

getDesc

public java.lang.String getDesc()

Returns the textual verbose description of this alignment.
e.g. "Right align text"

isHorzAlign

public boolean isHorzAlign()

Is this a horizontal alignment constant?

isVertAlign

public boolean isVertAlign()

Is this a vertical alignment constant?

isPosAlign

public boolean isPosAlign()

Is this an icon position constant?

toString

public java.lang.String toString()

Returns a full description

Overrides:

toString in class java.lang.Enum<GAlign>