org.apache.fop.pdf
Class PDFPages
java.lang.Object
|
+--org.apache.fop.pdf.PDFObject
|
+--org.apache.fop.pdf.PDFPages
- public class PDFPages
- extends PDFObject
class representing a /Pages object.
A /Pages object is an ordered collection of pages (/Page objects)
(Actually, /Pages can contain further /Pages as well but this
implementation doesn't allow this)
Field Summary |
protected int |
count
the number of /Page objects |
protected java.util.List |
kids
the /Page objects |
Constructor Summary |
PDFPages(int objnum)
create a /Pages object. |
Methods inherited from class org.apache.fop.pdf.PDFObject |
encode, encodeString, encodeText, formatDateTime, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, output, referencePDF, setDocument, setObjectNumber, toPDF |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
kids
protected java.util.List kids
- the /Page objects
count
protected int count
- the number of /Page objects
PDFPages
public PDFPages(int objnum)
- create a /Pages object. NOTE: The PDFPages
object must be created before the PDF document is
generated, but it is not written to the stream immediately.
It must also be allocated an object ID (so that the kids
can refer to the parent) so that the XRef table needs to
be updated before this object is written.
- Parameters:
objnum
- the object's number
addPage
public void addPage(PDFPage page)
- add a /Page object.
- Parameters:
page
- the PDFPage to add.
notifyKidRegistered
public void notifyKidRegistered(PDFPage page)
- Use this method to notify the PDFPages object that a child page
- Parameters:
page
- the child page
getCount
public int getCount()
- get the count of /Page objects
- Returns:
- the number of pages
incrementCount
public void incrementCount()
- increment the count of /Page objects
toPDFString
public java.lang.String toPDFString()
- Description copied from class:
PDFObject
- This method returns a String representation of the PDF object. The result
is normally converted/encoded to a byte array by toPDF(). Only use
this method to implement the serialization if the object can be fully
represented as text. If the PDF representation of the object contains
binary content use toPDF() or output(OutputStream) instead.
- Overrides:
toPDFString
in class PDFObject
- See Also:
PDFObject.toPDFString()
Copyright 1999-2006 The Apache Software Foundation. All Rights Reserved.