org.sejda.model.pdf.label
Enum PdfLabelNumberingStyle

java.lang.Object
  java.lang.Enum<PdfLabelNumberingStyle>
      org.sejda.model.pdf.label.PdfLabelNumberingStyle

All Implemented Interfaces:

Serializable, Comparable<PdfLabelNumberingStyle>, FriendlyNamed

public enum PdfLabelNumberingStyle
extends Enum<PdfLabelNumberingStyle>
implements FriendlyNamed

Possible values for a numbering style to be used for page labels.
Pdf reference 1.7, TABLE 8.10 Entries in a page label dictionary

Author:

Andrea Vacondio

Enum Constant Summary

ARABIC

EMPTY

LOWERCASE_LETTERS

LOWERCASE_ROMANS

UPPERCASE_LETTERS

UPPERCASE_ROMANS

Method Summary

String	getFriendlyName()
static PdfLabelNumberingStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static PdfLabelNumberingStyle[]	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

ARABIC

public static final PdfLabelNumberingStyle ARABIC

UPPERCASE_ROMANS

public static final PdfLabelNumberingStyle UPPERCASE_ROMANS

LOWERCASE_ROMANS

public static final PdfLabelNumberingStyle LOWERCASE_ROMANS

UPPERCASE_LETTERS

public static final PdfLabelNumberingStyle UPPERCASE_LETTERS

LOWERCASE_LETTERS

public static final PdfLabelNumberingStyle LOWERCASE_LETTERS

EMPTY

public static final PdfLabelNumberingStyle EMPTY

Method Detail

values

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

Returns:

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

valueOf

public static PdfLabelNumberingStyle 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.