org.foray.pdf.object
Class PDFOutline

java.lang.Object
  org.foray.pdf.object.PDFObject
      org.foray.pdf.object.PDFOutlineParent
          org.foray.pdf.object.PDFOutline

All Implemented Interfaces:

org.axsl.pdf.PdfOutlineParent

public class PDFOutline
extends PDFOutlineParent

An Outline dictionary in PDF. See PDF Reference 3rd Edition, Section 8.2.2.

Field Summary

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

EOL, MSG_EOL, XREF_EOL

Constructor Summary

PDFOutline(PDFDocument doc)
Constructor.

Method Summary

protected int	count() Returns the total number of open items at all levels of the outline.
protected String	toPDF() Generates the PDF text necessary to represent the object, returning it as a String.

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

addChild, createPdfOutlineItem, getChildren, getFirst, getLast

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

PDFOutline

public PDFOutline(PDFDocument doc)

Constructor.

Parameters:

doc - The parent PDF document.

Method Detail

count

protected int count()

Returns the total number of open items at all levels of the outline.

Specified by:

count in class PDFOutlineParent

Returns:

The total number of open items at all levels of the outline.

See Also:

"PDF Reference, 3rd Edition, Table 8.3.3"

toPDF

protected 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.