org.apache.fop.pdf

Class PDFPages

Implemented Interfaces:
PDFWritable

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 List
kids
the /Page objects

Fields inherited from class org.apache.fop.pdf.PDFObject

DATE_FORMAT, log

Constructor Summary

PDFPages(int objnum)
create a /Pages object.

Method Summary

void
addPage(PDFPage page)
add a /Page object.
int
getCount()
get the count of /Page objects
void
incrementCount()
increment the count of /Page objects
void
notifyKidRegistered(PDFPage page)
Use this method to notify the PDFPages object that a child page
String
toPDFString()

Methods inherited from class org.apache.fop.pdf.PDFObject

encode, encodeBinaryToHexString, encodeString, encodeText, formatDateTime, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, output, outputInline, referencePDF, setDocument, setObjectNumber, setParent, toPDF, toPDFString

Field Details

count

protected int count
the number of /Page objects

kids

protected List kids
the /Page objects

Constructor Details

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

Method Details

addPage

public void addPage(PDFPage page)
add a /Page object.
Parameters:
page - the PDFPage to add.

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

notifyKidRegistered

public void notifyKidRegistered(PDFPage page)
Use this method to notify the PDFPages object that a child page
Parameters:
page - the child page

toPDFString

public String toPDFString()
Overrides:
toPDFString in interface PDFObject

Copyright 1999-2008 The Apache Software Foundation. All Rights Reserved.