rst.pdfbox.layout.text

Enum SpaceUnit

java.lang.Object

java.lang.Enum<SpaceUnit>

rst.pdfbox.layout.text.SpaceUnit

All Implemented Interfaces:

Serializable, Comparable<SpaceUnit>

public enum SpaceUnit
extends Enum<SpaceUnit>

Unit to specify space, currently only em and pt.

Enum Constant Summary

Enum Constants

Enum Constant and Description
em The average character width of the associated font.
pt Measuring in points.

Method Summary

Modifier and Type	Method and Description
float	toPt(float size, FontDescriptor fontDescriptor) Converts the given unit to pt.
static SpaceUnit	valueOf(String name) Returns the enum constant of this type with the specified name.
static SpaceUnit[]	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

em

public static final SpaceUnit em

The average character width of the associated font.

pt

public static final SpaceUnit pt

Measuring in points.

Method Detail

values

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

Returns:

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

valueOf

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

toPt

public float toPt(float size,
                  FontDescriptor fontDescriptor)
           throws IOException

Converts the given unit to pt.

Parameters:

size - the size with respect to the unit.

fontDescriptor - the font/size to use.

Returns:

the size in pt.

Throws:

IOException - by pdfbox