org.sejda.model

Enum HorizontalAlign

java.lang.Object

java.lang.Enum<HorizontalAlign>

org.sejda.model.HorizontalAlign

All Implemented Interfaces:

Serializable, Comparable<HorizontalAlign>, FriendlyNamed

public enum HorizontalAlign
extends Enum<HorizontalAlign>
implements FriendlyNamed

Possible horizontal alignments.

Author:

Andrea Vacondio

Enum Constant Summary

Enum Constants

Enum Constant and Description
CENTER
LEFT
RIGHT

Method Summary

Methods

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

CENTER

public static final HorizontalAlign CENTER

RIGHT

public static final HorizontalAlign RIGHT

LEFT

public static final HorizontalAlign LEFT

Method Detail

values

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

Returns:

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

valueOf

public static HorizontalAlign 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 pageWidth,
             float stringWidth,
             float margin)

Parameters:

pageWidth - page width in pts

stringWidth - width of the text we are positioning in pts

margin - margin to use. Relevant only in non central alignment.

Returns:

the horizontal position of a label with the given width in a page of the given width