org.sejda.model

Enum VerticalAlign

java.lang.Object

java.lang.Enum<VerticalAlign>

org.sejda.model.VerticalAlign

All Implemented Interfaces:

Serializable, Comparable<VerticalAlign>, FriendlyNamed

public enum VerticalAlign
extends Enum<VerticalAlign>
implements FriendlyNamed

Possible vertical alignments

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
BOTTOM
TOP

Method Summary

Modifier and Type	Method and Description
String	getFriendlyName()
abstract float	position(float pageHeight, float margin, float fontSize)
static VerticalAlign	valueOf(String name) Returns the enum constant of this type with the specified name.
static VerticalAlign[]	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

TOP

public static final VerticalAlign TOP

BOTTOM

public static final VerticalAlign BOTTOM

Method Detail

values

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

Returns:

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

valueOf

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

getFriendlyName

public String getFriendlyName()

Specified by:

getFriendlyName in interface FriendlyNamed

Returns:

the friendly name of the entity, to be usually used as a representation for an user.

position

public abstract float position(float pageHeight,
                               float margin,
                               float fontSize)

Parameters:

pageHeight -

margin -

Returns:

the vertical position of a text in a page of the given height