gnu.apdf

Class PDFCatalog

java.lang.Object

gnu.apdf.PDFObject

gnu.apdf.PDFCatalog

All Implemented Interfaces:

Serializable

public class PDFCatalog
extends PDFObject

This class implements the PDF Catalog, also known as the root node

Author:

Peter T. Mount, Eric Z. Beard, ericzbeard@hotmail.com

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
PDFCatalog(PDFPageList pdfPageList, int pagemode) This constructs a PDF Catalog object

Method Summary

Modifier and Type	Method and Description
void	write(OutputStream os) Writes the object to the output stream.

Methods inherited from class gnu.apdf.PDFObject

getGeneration, getName, getPDFDocument, getSerialID, getType, setName, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

PDFCatalog

public PDFCatalog(PDFPageList pdfPageList,
                  int pagemode)

This constructs a PDF Catalog object

Parameters:

pdfPageList - The PDFPageList object that's the root of the documents page tree

pagemode - How the document should appear when opened. Allowed values are USENONE, USEOUTLINES, USETHUMBS or FULLSCREEN.

Method Detail

write

public void write(OutputStream os)
           throws IOException

Description copied from class: PDFObject

Writes the object to the output stream. This method must be overidden.

Note: It should not write any other objects, even if they are it's Kids, as they will be written by the calling routine.

Specified by:

write in class PDFObject

Parameters:

os - OutputStream to send the object to

Throws:

IOException - on error