Module io.github.mmm.base

Package io.github.mmm.base.placement

Enum Alignment

java.lang.Object

java.lang.Enum<Alignment>

io.github.mmm.base.placement.Alignment

All Implemented Interfaces:

Serializable, Comparable<Alignment>

public enum Alignment
extends Enum<Alignment>

This enum contains the available values for the alignment of an object.

See Also:

HorizontalAlignment, VerticalAlignment

Enum Constant Summary

Enum Constants

Enum Constant	Description
BOTTOM	the component will be located at the bottom and horizontally centered.
BOTTOM_LEFT	the component will be located at the right and vertically centered.
BOTTOM_RIGHT	the component will be located at the right and vertically centered.
CENTER	the component will be horizontally and vertically centered.
LEFT	the component will be located at the left and vertically centered.
RIGHT	the component will be located at the right and vertically centered.
TOP	the component will be located at the top and horizontally centered.
TOP_LEFT	the component will be located at the right and vertically centered.
TOP_RIGHT	the component will be located at the right and vertically centered.

Method Summary

Modifier and Type	Method	Description
static Alignment	fromDirection(Direction direction)	This is the inverse operation for toDirection().
static Alignment	fromValue(String value)	This method gets the Alignment with the given value.
abstract Alignment	getMirrored()	This method gets the inverse alignment.
String	getValue()
Alignment	toAlignment(Orientation orientation)	This method extracts the horizontal or vertical part of this alignment.
Direction	toDirection()
HorizontalAlignment	toHorizontalAlignment()	This method gets the horizontal part of the alignment.
String	toString()
VerticalAlignment	toVerticalAlignment()	This method gets the vertical part of the alignment.
static Alignment	valueOf(String name)	Returns the enum constant of this type with the specified name.
static Alignment[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

CENTER

public static final Alignment CENTER

the component will be horizontally and vertically centered.
...
.X.
...


TOP

public static final Alignment TOP

the component will be located at the top and horizontally centered.
.X.
...
...


BOTTOM

public static final Alignment BOTTOM

the component will be located at the bottom and horizontally centered.
...
...
.X.


LEFT

public static final Alignment LEFT

the component will be located at the left and vertically centered.
...
X..
...


RIGHT

public static final Alignment RIGHT

the component will be located at the right and vertically centered.
...
..X
...


TOP_LEFT

public static final Alignment TOP_LEFT

the component will be located at the right and vertically centered.
X..
...
...


TOP_RIGHT

public static final Alignment TOP_RIGHT

the component will be located at the right and vertically centered.
..X
...
...


BOTTOM_LEFT

public static final Alignment BOTTOM_LEFT

the component will be located at the right and vertically centered.
...
...
X..


BOTTOM_RIGHT

public static final Alignment BOTTOM_RIGHT

the component will be located at the right and vertically centered.
...
...
..X


Method Detail

values

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

Returns:

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

valueOf

public static Alignment valueOf(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:

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

NullPointerException - if the argument is null

getValue

public String getValue()

Returns:

the ascii symbol.

toString

public String toString()

Overrides:

toString in class Enum<Alignment>

fromValue

public static Alignment fromValue(String value)

This method gets the Alignment with the given value.

Parameters:

value - is the value of the requested Alignment.

Returns:

the requested Alignment.

toHorizontalAlignment

public HorizontalAlignment toHorizontalAlignment()

This method gets the horizontal part of the alignment.

Returns:

the HorizontalAlignment.

toVerticalAlignment

public VerticalAlignment toVerticalAlignment()

This method gets the vertical part of the alignment.

Returns:

the VerticalAlignment.

toAlignment

public Alignment toAlignment(Orientation orientation)

This method extracts the horizontal or vertical part of this alignment.

Parameters:

orientation - is the Orientation of the requested part.

Returns:

the Alignment from toHorizontalAlignment() if orientation is Orientation.HORIZONTAL, or toVerticalAlignment() otherwise.

getMirrored

public abstract Alignment getMirrored()

This method gets the inverse alignment.

Returns:

the inverse alignment. E.g. BOTTOM_RIGHT for TOP_LEFT. Returns itself if CENTER.

toDirection

public Direction toDirection()

Returns:

the corresponding Direction or null for CENTER.

Since:

4.0.0

fromDirection

public static Alignment fromDirection(Direction direction)

This is the inverse operation for toDirection().

Parameters:

direction - is the Direction. May be null for CENTER.

Returns:

the corresponding Alignment.

Since:

4.0.0