org.foray.pdf.object
Class PDFPageLabel

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFPageLabel

public class PDFPageLabel
extends PDFObject

A PDF PageLabel Dictionary. See PDF Reference, 3rd Edition, Section 8.3.1.

Field Summary

Fields inherited from class org.foray.pdf.object.PDFObject

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFPageLabel(PDFDocument doc, org.axsl.pdf.PdfPageLabelStyle style, CharSequence labelPrefix, int startingNumber)
Create a PDFPageLabel object.

Method Summary

String

toPDF() Generates the PDF text necessary to represent the object, returning it as a String.

Methods inherited from class org.foray.pdf.object.PDFObject

bufferToByteArray, byteArrayToStream, getCharsPerLine, getGeneration, getLogger, getNumber, getPDFDocument, output, pdfID, pdfReference, setNumber, stringToByteArray

Methods inherited from class java.lang.Object

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

Constructor Detail

PDFPageLabel

public PDFPageLabel(PDFDocument doc,
                    org.axsl.pdf.PdfPageLabelStyle style,
                    CharSequence labelPrefix,
                    int startingNumber)

Create a PDFPageLabel object.

Parameters:

doc - The parent PDF document.

style - The numbering style to be used for the numeric portion of each page label. If null is passed, there will be no numeric portion in the page label.

labelPrefix - The (optional) label prefix for page labels in this range. If null is passed, there will be no label prefix in the page label.

startingNumber - The (optional) value of the numeric portion for the first page label in the range. Subsequent pages will be numbered sequentially from this value.

Method Detail

toPDF

public String toPDF()

Description copied from class: PDFObject

Generates the PDF text necessary to represent the object, returning it as a String.

Returns:

The PDF text necessary to represent the object.