Package com.github.tadukoo.view.constants

Enum Class Orientation

java.lang.Object

java.lang.Enum<Orientation>

com.github.tadukoo.view.constants.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, Constable

public enum Orientation
extends Enum<Orientation>

Represents the way to orient an object in relation to given coordinates.

Version:

0.1-Alpha-SNAPSHOT

Author:

Logan Ferree (Tadukoo)

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Orientation.Horizontal	Enum used for how to align horizontally
static enum	Orientation.Vertical	Enum used for how to align vertically

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM_CENTER	Align the object to the bottom, centered horizontally
BOTTOM_LEFT	Align the object to the bottom left
BOTTOM_RIGHT	Align the object to the bottom right
CENTER	Center the object (horizontally and vertically) on the specified coordinate
LEFT_CENTER	Left align the object, centered vertically
RIGHT_CENTER	Right align the object, centered vertically
TOP_CENTER	Align the object to the top, centered horizontally
TOP_LEFT	Align the object to the top left
TOP_RIGHT	Align the object to the top right

Field Summary

Fields

Modifier and Type	Field	Description
private final Orientation.Horizontal	hor	The horizontal alignment to be used
private final Orientation.Vertical	ver	The vertical alignment to be used

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Orientation(Orientation.Vertical ver, Orientation.Horizontal hor)

Method Summary

Modifier and Type	Method	Description
Orientation.Horizontal	horizontal()
static Orientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Orientation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
Orientation.Vertical	vertical()

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TOP_CENTER

public static final Orientation TOP_CENTER

Align the object to the top, centered horizontally

LEFT_CENTER

public static final Orientation LEFT_CENTER

Left align the object, centered vertically

CENTER

public static final Orientation CENTER

Center the object (horizontally and vertically) on the specified coordinate

RIGHT_CENTER

public static final Orientation RIGHT_CENTER

Right align the object, centered vertically

BOTTOM_CENTER

public static final Orientation BOTTOM_CENTER

Align the object to the bottom, centered horizontally

TOP_LEFT

public static final Orientation TOP_LEFT

Align the object to the top left

TOP_RIGHT

public static final Orientation TOP_RIGHT

Align the object to the top right

BOTTOM_LEFT

public static final Orientation BOTTOM_LEFT

Align the object to the bottom left

BOTTOM_RIGHT

public static final Orientation BOTTOM_RIGHT

Align the object to the bottom right

Field Details

ver

private final Orientation.Vertical ver

The vertical alignment to be used

hor

private final Orientation.Horizontal hor

The horizontal alignment to be used

Constructor Details

Orientation

private Orientation(Orientation.Vertical ver,
 Orientation.Horizontal hor)

Parameters:

ver - How to align vertically

hor - How to align horizontally

Method Details

values

public static Orientation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static Orientation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

vertical

public Orientation.Vertical vertical()

Returns:

The vertical alignment to be used

horizontal

public Orientation.Horizontal horizontal()

Returns:

The horizontal alignment to be used