org.sejda.model.pdf.headerfooter

Enum NumberingStyle

java.lang.Object

java.lang.Enum<NumberingStyle>

org.sejda.model.pdf.headerfooter.NumberingStyle

All Implemented Interfaces:

Serializable, Comparable<NumberingStyle>, FriendlyNamed

public enum NumberingStyle
extends Enum<NumberingStyle>
implements FriendlyNamed

Numbering styles for footer labels.

Author:

Eduard Weissmann

Enum Constant Summary

Enum Constants

Enum Constant and Description
ARABIC
EMPTY
ROMAN

Method Summary

Methods

Modifier and Type	Method and Description
String	getFriendlyName()
abstract String	toStyledString(int number)
static NumberingStyle	valueOf(String name) Returns the enum constant of this type with the specified name.
static NumberingStyle[]	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 NumberingStyle ARABIC

EMPTY

public static final NumberingStyle EMPTY

ROMAN

public static final NumberingStyle ROMAN

Method Detail

values

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

Returns:

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

valueOf

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

toStyledString

public abstract String toStyledString(int number)

Parameters:

number -

Returns:

a string representing the given number.