org.apache.fop.pdf
Class PDFRoot
java.lang.Object
|
+--org.apache.fop.pdf.PDFObject
|
+--org.apache.fop.pdf.PDFRoot
- public class PDFRoot
- extends PDFObject
class representing a Root (/Catalog) object
Field Summary |
protected PDFPages |
rootPages
the /Pages object that is root of the Pages hierarchy |
Constructor Summary |
PDFRoot(int number,
PDFPages pages)
create a Root (/Catalog) object. |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
rootPages
protected PDFPages rootPages
- the /Pages object that is root of the Pages hierarchy
PDFRoot
public PDFRoot(int number,
PDFPages pages)
- create a Root (/Catalog) object. NOTE: The PDFRoot
object must be created before the PDF document is
generated, but it is not assigned an object ID until
it is about to be written (immediately before the xref
table as part of the trsailer). (mark-fop@inomial.com)
- Parameters:
number
- the object's number
addPage
public void addPage(PDFPage page)
- add a /Page object to the root /Pages object
- Parameters:
page
- the /Page object to add
setRootPages
public void setRootPages(PDFPages pages)
- set the root /Pages object
- Parameters:
pages
- the /Pages object to set as root
setRootOutline
public void setRootOutline(PDFOutline outline)
getRootOutline
public PDFOutline getRootOutline()
toPDF
public byte[] toPDF()
throws java.lang.IllegalStateException
- represent the object as PDF.
- Returns:
- the PDF string
- Throws:
java.lang.IllegalStateException
- if the setNumber() method has
not been called.
Copyright © 1999-2002 Apache Software Foundation. All Rights Reserved.