de.gurkenlabs.litiengine

Enum Valign

java.lang.Object

java.lang.Enum<Valign>

de.gurkenlabs.litiengine.Valign

All Implemented Interfaces:

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

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

The enum Valign defines a range of vertical alignments.

Enum Constant Summary

Enum Constants

Enum Constant and Description
DOWN
MIDDLE
MIDDLE_DOWN
MIDDLE_TOP
TOP

Method Summary

Modifier and Type	Method and Description
static Valign	get(java.lang.String valignString) Gets the vertical align enumeration value for the specified string.
double	getLocation(double height, double objectHeight) Gets the location for the specified object height to be vertically aligned within the bounds of the specified height.
double	getValue(double height) Gets the proportional value of this instance.
float	getValue(float height) Gets the proportional value of this instance.
int	getValue(int height) Gets the proportional value of this instance.
static Valign	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static Valign[]	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, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

DOWN

public static final Valign DOWN

MIDDLE

public static final Valign MIDDLE

TOP

public static final Valign TOP

MIDDLE_TOP

public static final Valign MIDDLE_TOP

MIDDLE_DOWN

public static final Valign MIDDLE_DOWN

Method Detail

values

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

Returns:

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

valueOf

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

get

public static Valign get(java.lang.String valignString)

Gets the vertical align enumeration value for the specified string.

Parameters:

valignString - The string representing the enum value.

Returns:

The enum value represented by the specified string or DOWN if the specified string is invalid.

getValue

public float getValue(float height)

Gets the proportional value of this instance.

Parameters:

height - The height to calculate the relative value from.

Returns:

The proportional value for the specified height.

getValue

public double getValue(double height)

Gets the proportional value of this instance.

Parameters:

height - The height to calculate the relative value from.

Returns:

The proportional value for the specified height.

getValue

public int getValue(int height)

Gets the proportional value of this instance.

Parameters:

height - The height to calculate the relative value from.

Returns:

The proportional value for the specified height.

getLocation

public double getLocation(double height,
                          double objectHeight)

Gets the location for the specified object height to be vertically aligned within the bounds of the specified height.

Parameters:

height - The height, limiting the vertical alignment.

objectHeight - The height of the object for which to calculate the vertically aligned location.

Returns:

The y-coordinate for the location of the object with the specified height.