de.erichseifert.gral.graphics

Enum Location

java.lang.Object

java.lang.Enum<Location>

de.erichseifert.gral.graphics.Location

All Implemented Interfaces:

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

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

Indicates the location of components.

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER Central location.
EAST Eastern location.
NORTH Northern location.
NORTH_EAST North-eastern location.
NORTH_WEST North-western location.
SOUTH Southern location.
SOUTH_EAST South-eastern location.
SOUTH_WEST South-western location.
WEST Western location.

Method Summary

Modifier and Type	Method and Description
double	getAlignmentH() Returns the horizontal alignment as a double value.
double	getAlignmentV() Returns the vertical alignment as a double value.
static Location	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Location[]	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

CENTER

public static final Location CENTER

Central location.

NORTH

public static final Location NORTH

Northern location.

NORTH_EAST

public static final Location NORTH_EAST

North-eastern location.

EAST

public static final Location EAST

Eastern location.

SOUTH_EAST

public static final Location SOUTH_EAST

South-eastern location.

SOUTH

public static final Location SOUTH

Southern location.

SOUTH_WEST

public static final Location SOUTH_WEST

South-western location.

WEST

public static final Location WEST

Western location.

NORTH_WEST

public static final Location NORTH_WEST

North-western location.

Method Detail

values

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

Returns:

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

valueOf

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

getAlignmentH

public double getAlignmentH()

Returns the horizontal alignment as a double value.

Returns:

horizontal alignment

getAlignmentV

public double getAlignmentV()

Returns the vertical alignment as a double value.

Returns:

vertical alignment