org.apache.fop.pdf
Class PDFPage

org.apache.fop.pdf.PDFObject
  |
  +--org.apache.fop.pdf.PDFPage

public class PDFPage
extends PDFObject

class representing a /Page object. There is one of these for every page in a PDF document. The object specifies the dimensions of the page and references a /Resources object, a contents stream and the page's parent in the page hierarchy.


Constructor Summary
PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
          create a /Page object

Method Summary
 voidaddShading(PDFShading shading)
           
 PDFAnnotListgetAnnotList()
          get this page's annotation list
 voidsetAnnotList(PDFAnnotList annotList)
          set this page's annotation list
 voidsetParent(PDFPages parent)
          set this page's parent
 byte[]toPDF()
          represent this object as PDF

Methods inherited from class org.apache.fop.pdf.PDFObject
getNumber, referencePDF

Constructor Detail

PDFPage

public PDFPage(int number, PDFResources resources, PDFStream contents, int pagewidth, int pageheight)
create a /Page object
Parameters:
number - the object's number
resources - the /Resources object
contents - the content stream
pagewidth - the page's width in points
pageheight - the page's height in points
Method Detail

addShading

public void addShading(PDFShading shading)

getAnnotList

public PDFAnnotList getAnnotList()
get this page's annotation list
Returns: annotList a PDFAnnotList list of annotations

setAnnotList

public void setAnnotList(PDFAnnotList annotList)
set this page's annotation list
Parameters:
annotList - a PDFAnnotList list of annotations

setParent

public void setParent(PDFPages parent)
set this page's parent
Parameters:
parent - the /Pages object that is this page's parent

toPDF

public byte[] toPDF()
represent this object as PDF
Returns: the PDF string

Association Links

to Class org.apache.fop.pdf.PDFPages

the page's parent, a /Pages object

to Class org.apache.fop.pdf.PDFResources

the page's /Resource object

to Class org.apache.fop.pdf.PDFStream

the contents stream

to Class org.apache.fop.pdf.PDFAnnotList

the list of annotation objects for this page