Alignment (JavaDocs for mmm-all dev-SNAPSHOT)

java.lang.Object
- java.lang.Enum<Alignment>
- - net.sf.mmm.util.lang.api.Alignment

All Implemented Interfaces:

Serializable, Comparable<Alignment>, AttributeReadValue<String>, Datatype, SimpleDatatype<String>
```
public enum Alignment
extends Enum<Alignment>
implements SimpleDatatype<String>
```
This enum contains the available values for the alignment of an object.

Since:

3.0.0

Author:

Joerg Hohwiller (hohwille at users.sourceforge.net)

See Also:

HorizontalAlignment, VerticalAlignment

Enum Constant Summary

Enum Constants
Enum Constant and 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.

Field Summary

Fields
Modifier and Type Field and Description

private String title

private String value

Fields
Modifier and Type	Field and Description
`private String`	`title`
`private String`	`value`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and 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`.
`HorizontalAlignment`	`getHorizontalAlignment()` This method gets the horizontal part of the alignment.
`abstract Alignment`	`getMirrored()` This method gets the inverse alignment.
`Alignment`	`getPart(Orientation orientation)` This method extracts the `horizontal` or `vertical` part of this alignment.
`String`	`getValue()` This method returns the raw value of this datatype.
`VerticalAlignment`	`getVerticalAlignment()` This method gets the vertical part of the alignment.
`Direction`	`toDirection()`
`String`	`toString()` Returns the official `String` representation of this `Datatype`.
`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.
    ___ _*_ ___
  - TOP
```
public static final Alignment TOP
```
    the component will be located at the top and horizontally centered.
    _*_ ___ ___
  - BOTTOM
```
public static final Alignment BOTTOM
```
    the component will be located at the bottom and horizontally centered.
    ___ ___ _*_
  - LEFT
```
public static final Alignment LEFT
```
    the component will be located at the left and vertically centered.
    ___ *__ ___
  - RIGHT
```
public static final Alignment RIGHT
```
    the component will be located at the right and vertically centered.
    ___ __* ___
  - TOP_LEFT
```
public static final Alignment TOP_LEFT
```
    the component will be located at the right and vertically centered.
    *__ ___ ___
  - TOP_RIGHT
```
public static final Alignment TOP_RIGHT
```
    the component will be located at the right and vertically centered.
    __* ___ ___
  - BOTTOM_LEFT
```
public static final Alignment BOTTOM_LEFT
```
    the component will be located at the right and vertically centered.
    ___ ___ *__
  - BOTTOM_RIGHT
```
public static final Alignment BOTTOM_RIGHT
```
    the component will be located at the right and vertically centered.
    ___ ___ __*
- Field Detail
  - value
```
private final String value
```
  - title
```
private final String title
```
- 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()
```
    Description copied from interface: SimpleDatatype
    
    This method returns the raw value of this datatype. This will typically be a standard datatype (like String , Character, Boolean, any type of Number, any type of java.time.LocalDate, etc.).
    
    Specified by:
    
    getValue in interface AttributeReadValue<String>
    
    Specified by:
    
    getValue in interface SimpleDatatype<String>
    
    Returns:
    
    the value of this datatype.
  - toString
```
public String toString()
```
    Description copied from interface: Datatype
    
    Returns the official String representation of this Datatype. While the general contract of Object.toString() is very weak and mainly used for debugging, the contract here is very strong. The returned String has to be suitable for end-users and official output to any kind of sink.
    ATTENTION:
    This method is not supposed to do internationalization (I18N). See NlsMessage for this purpose and implement NlsObject if you want to support I18N/L10N.
    
    Specified by:
    
    toString in interface Datatype
    
    Overrides:
    
    toString in class Enum<Alignment>
    
    Returns:
    
    the official String representation to display the value of this Datatype.
  - 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.
  - getHorizontalAlignment
```
public HorizontalAlignment getHorizontalAlignment()
```
    This method gets the horizontal part of the alignment.
    
    Returns:
    
    the HorizontalAlignment.
  - getVerticalAlignment
```
public VerticalAlignment getVerticalAlignment()
```
    This method gets the vertical part of the alignment.
    
    Returns:
    
    the VerticalAlignment.
  - getPart
```
public Alignment getPart(Orientation orientation)
```
    This method extracts the horizontal or vertical part of this alignment.
    
    Parameters:
    
    orientation - is the Orientation of the requested part.
    
    Returns:
    
    getHorizontalAlignment() if orientation is Orientation.HORIZONTAL, getVerticalAlignment() 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

Enum Alignment

Enum Constant Summary

Field Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

CENTER

TOP

BOTTOM

LEFT

RIGHT

TOP_LEFT

TOP_RIGHT

BOTTOM_LEFT

BOTTOM_RIGHT

Field Detail

value

title

Method Detail

values

valueOf

getValue

toString

fromValue

getHorizontalAlignment

getVerticalAlignment

getPart

getMirrored

toDirection

fromDirection