Package com.lowagie.text.alignment

Enum VerticalAlignment

java.lang.Object

java.lang.Enum<VerticalAlignment>

com.lowagie.text.alignment.VerticalAlignment

All Implemented Interfaces:

Serializable, Comparable<VerticalAlignment>

public enum VerticalAlignment
extends Enum<VerticalAlignment>

Represents a possible vertical alignment modes for document elements that can be aligned vertically.

Since:

1.2.7

Author:

noavarice

See Also:

WithVerticalAlignment

Enum Constant Summary

Enum Constants

Enum Constant	Description
BASELINE
BOTTOM
CENTER
TOP
UNDEFINED

Method Summary

Modifier and Type	Method	Description
int	getId()
static Optional<VerticalAlignment>	of(int id)	Constructs VerticalAlignment instance from passed unique alignment id.
static VerticalAlignment	valueOf(String name)	Returns the enum constant of this type with the specified name.
static VerticalAlignment[]	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

UNDEFINED

public static final VerticalAlignment UNDEFINED

TOP

public static final VerticalAlignment TOP

CENTER

public static final VerticalAlignment CENTER

BOTTOM

public static final VerticalAlignment BOTTOM

BASELINE

public static final VerticalAlignment BASELINE

Method Detail

values

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

Returns:

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

valueOf

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

getId

public int getId()

of

public static Optional<VerticalAlignment> of(int id)

Constructs VerticalAlignment instance from passed unique alignment id.

Parameters:

id - Alignment unique ID

Returns:

Optional containing alignment instance. If id is not recognized, Optional.empty() will be returned

See Also:

Element.ALIGN_UNDEFINED, Element.ALIGN_TOP, Element.ALIGN_MIDDLE, Element.ALIGN_BOTTOM, Element.ALIGN_BASELINE