Package org.apache.fop.pdf

Class PDFPageLabels

java.lang.Object

org.apache.fop.pdf.PDFObject

org.apache.fop.pdf.PDFDictionary

org.apache.fop.pdf.PDFNumberTreeNode

org.apache.fop.pdf.PDFPageLabels

All Implemented Interfaces:

CompressedObject, PDFWritable

public class PDFPageLabels
extends PDFNumberTreeNode

Class representing a PDF /PageLabels dictionary.

Field Summary

Fields

Modifier and Type	Field	Description
private static int	DECIMAL
private int	lastPageLabelType
private int	lastPageNumber
private java.lang.String	lastZeroPaddingPrefix
private static int	LOWER_ALPHA
private static int	LOWER_ROMAN
private static java.util.regex.Pattern	MATCH_DECIMAL
private static java.util.regex.Pattern	MATCH_LETTER
private static java.util.regex.Pattern	MATCH_ROMAN
private static int	PREFIX
private static PDFName	S_DECIMAL
private static PDFName	S_LOWER_ALPHA
private static PDFName	S_LOWER_ROMAN
private static PDFName	S_UPPER_ALPHA
private static PDFName	S_UPPER_ROMAN
private static int	UPPER_ALPHA
private static int	UPPER_ROMAN

Fields inherited from class org.apache.fop.pdf.PDFDictionary

entries, order

Fields inherited from class org.apache.fop.pdf.PDFObject

log

Constructor Summary

Constructors

Constructor	Description
PDFPageLabels()	Create the /PageLabels dictionary

Method Summary

Modifier and Type	Method	Description
void	addPageLabel(int index, java.lang.String pageLabel)	Adds a new entry, if necessary, to the /PageLabels dictionary.
private int	alphabeticToArabic(char c)
private int	romanToArabic(java.lang.String roman)

Methods inherited from class org.apache.fop.pdf.PDFNumberTreeNode

addToNums, getKids, getLowerLimit, getNums, getUpperLimit, setKids, setLowerLimit, setNums, setUpperLimit

Methods inherited from class org.apache.fop.pdf.PDFDictionary

containsKey, get, getChildren, getChildren, keySet, output, put, put, remove, writeDictionary

Methods inherited from class org.apache.fop.pdf.PDFObject

contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, supportsObjectStream, toPDF, toPDFString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DECIMAL

private static final int DECIMAL

See Also:

Constant Field Values

LOWER_ALPHA

private static final int LOWER_ALPHA

See Also:

Constant Field Values

UPPER_ALPHA

private static final int UPPER_ALPHA

See Also:

Constant Field Values

LOWER_ROMAN

private static final int LOWER_ROMAN

See Also:

Constant Field Values

UPPER_ROMAN

private static final int UPPER_ROMAN

See Also:

Constant Field Values

PREFIX

private static final int PREFIX

See Also:

Constant Field Values

S_DECIMAL

private static final PDFName S_DECIMAL

S_UPPER_ROMAN

private static final PDFName S_UPPER_ROMAN

S_LOWER_ROMAN

private static final PDFName S_LOWER_ROMAN

S_UPPER_ALPHA

private static final PDFName S_UPPER_ALPHA

S_LOWER_ALPHA

private static final PDFName S_LOWER_ALPHA

MATCH_DECIMAL

private static final java.util.regex.Pattern MATCH_DECIMAL

MATCH_ROMAN

private static final java.util.regex.Pattern MATCH_ROMAN

MATCH_LETTER

private static final java.util.regex.Pattern MATCH_LETTER

lastPageLabelType

private int lastPageLabelType

lastPageNumber

private int lastPageNumber

lastZeroPaddingPrefix

private java.lang.String lastZeroPaddingPrefix

Constructor Detail

PDFPageLabels

public PDFPageLabels()

Create the /PageLabels dictionary

Method Detail

addPageLabel

public void addPageLabel(int index,
                         java.lang.String pageLabel)

Adds a new entry, if necessary, to the /PageLabels dictionary.

Parameters:

index - the page index (0 for page 1)

pageLabel - the page number as a string

romanToArabic

private int romanToArabic(java.lang.String roman)

alphabeticToArabic

private int alphabeticToArabic(char c)