Package org.apache.fop.pdf

Class PDFPage

java.lang.Object
org.apache.fop.pdf.PDFObject
org.apache.fop.pdf.PDFDictionary
org.apache.fop.pdf.PDFResourceContext
org.apache.fop.pdf.PDFPage
All Implemented Interfaces:
PDFWritable
public class PDFPage extends PDFResourceContext
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.

  • Field Details

    • pageIndex

      protected int pageIndex
      the page index (zero-based)

  • Constructor Details

    • PDFPage

      public PDFPage(PDFResources resources, int pageIndex, Rectangle2D mediaBox, Rectangle2D cropBox, Rectangle2D bleedBox, Rectangle2D trimBox)
      Create a /Page object
      Parameters:
      resources - the /Resources object
      pageIndex - the page's zero-based index (or -1 if the page number is auto-determined)
      mediaBox - the MediaBox
      cropBox - the CropBox. If null, mediaBox is used.
      bleedBox - the BleedBox. If null, cropBox is used.
      trimBox - the TrimBox. If null, bleedBox is used.

  • Method Details

    • setMediaBox

      public void setMediaBox(Rectangle2D box)
      Sets the "MediaBox" entry
      Parameters:
      box - the media rectangle

    • setCropBox

      public void setCropBox(Rectangle2D box)
      Sets the "CropBox" entry
      Parameters:
      box - the bleed rectangle

    • setBleedBox

      public void setBleedBox(Rectangle2D box)
      Sets the "BleedBox" entry
      Parameters:
      box - the bleed rectangle

    • setTrimBox

      public void setTrimBox(Rectangle2D box)
      Sets the "TrimBox" entry
      Parameters:
      box - the trim rectangle

    • setContents

      public void setContents(PDFReference contents)
      set this page contents
      Parameters:
      contents - the contents of the page

    • setParent

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

    • setTransition

      public void setTransition(int dur, TransitionDictionary tr)
      Set the transition dictionary and duration. This sets the duration of the page and the transition dictionary used when going to the next page.
      Parameters:
      dur - the duration in seconds
      tr - the transition dictionary

    • getPageIndex

      public int getPageIndex()
      Returns:
      the page Index of this page (zero-based), -1 if it the page index should automatically be determined.

    • setStructParents

      public void setStructParents(int structParents)
      Sets the "StructParents" value.
      Parameters:
      structParents - the integer key of this object's entry in the structural parent tree.

    • getStructParents

      public Integer getStructParents()
      Returns the value of the StructParents entry.
      Returns:
      the StructParents value, null if the entry has not been set

    • setTabs

      public void setTabs(PDFName value)
      Specifies the tab order for annotations on a page.
      Parameters:
      value - one of the allowed values (see PDF 1.5)
      Since:
      PDF 1.5