org.axsl.pdf

Enum PdfPageLabelStyle

java.lang.Object

java.lang.Enum<PdfPageLabelStyle>

org.axsl.pdf.PdfPageLabelStyle

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PdfPageLabelStyle>

public enum PdfPageLabelStyle
extends java.lang.Enum<PdfPageLabelStyle>

Enumeration of the possible page numbering styles.

See Also:

"PDF Reference, 3rd Edition, Section 8.3.1."

Enum Constant Summary

Enum Constants

Enum Constant and Description
DECIMAL_ARABIC Decimal Arabic numerals.
LOWERCASE_LETTERS Lowercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on.
LOWERCASE_ROMAN Lowercase roman numerals.
UPPERCASE_LETTERS Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on.
UPPERCASE_ROMAN Uppercase roman numerals.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPdfName() Returns the value to write into the PDF file to designate this style.
static PdfPageLabelStyle	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PdfPageLabelStyle[]	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

DECIMAL_ARABIC

public static final PdfPageLabelStyle DECIMAL_ARABIC

Decimal Arabic numerals.

UPPERCASE_ROMAN

public static final PdfPageLabelStyle UPPERCASE_ROMAN

Uppercase roman numerals.

LOWERCASE_ROMAN

public static final PdfPageLabelStyle LOWERCASE_ROMAN

Lowercase roman numerals.

UPPERCASE_LETTERS

public static final PdfPageLabelStyle UPPERCASE_LETTERS

Uppercase letters (A to Z for the first 26 pages, AA to ZZ for the next 26, and so on.

LOWERCASE_LETTERS

public static final PdfPageLabelStyle LOWERCASE_LETTERS

Lowercase letters (a to z for the first 26 pages, aa to zz for the next 26, and so on.

Method Detail

values

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

Returns:

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

valueOf

public static PdfPageLabelStyle valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getPdfName

public java.lang.String getPdfName()

Returns the value to write into the PDF file to designate this style.

Returns:

The PDF value for this style.