gnu.jpdf
Class PDFCatalog

java.lang.Object
  gnu.jpdf.PDFObject
      gnu.jpdf.PDFCatalog

All Implemented Interfaces:

java.io.Serializable

public class PDFCatalog
extends PDFObject

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

See Also:

Serialized Form

Field Summary

Fields inherited from class gnu.jpdf.PDFObject

objser, pdfDocument

Constructor Summary

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

Method Summary

protected void	setOutline(PDFOutline outline) This sets the root outline object
void	write(java.io.OutputStream os) Writes the object to the output stream.

Methods inherited from class gnu.jpdf.PDFObject

getPDFDocument, getSerialID, getType, toArray, toString, writeEnd, writeStart

Methods inherited from class java.lang.Object

clone, equals, finalize, 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

setOutline

protected void setOutline(PDFOutline outline)

This sets the root outline object

Parameters:

outline - The root outline

write

public void write(java.io.OutputStream os)
           throws java.io.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:

java.io.IOException - on error