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.
-
-
Constructor Summary
Constructors Constructor Description PDFPage(PDFResources resources, int pageIndex, java.awt.geom.Rectangle2D mediaBox, java.awt.geom.Rectangle2D cropBox, java.awt.geom.Rectangle2D bleedBox, java.awt.geom.Rectangle2D trimBox)
Create a /Page object
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description int
getPageIndex()
java.lang.Integer
getStructParents()
Returns the value of the StructParents entry.void
setBleedBox(java.awt.geom.Rectangle2D box)
Sets the "BleedBox" entryvoid
setContents(PDFReference contents)
set this page contentsvoid
setCropBox(java.awt.geom.Rectangle2D box)
Sets the "CropBox" entryvoid
setMediaBox(java.awt.geom.Rectangle2D box)
Sets the "MediaBox" entryvoid
setMetadata(PDFMetadata meta)
void
setParent(PDFPages parent)
set this page's parentprivate void
setSimplePageSize(java.awt.geom.Rectangle2D mediaBox, java.awt.geom.Rectangle2D cropBox, java.awt.geom.Rectangle2D bleedBox, java.awt.geom.Rectangle2D trimBox)
void
setStructParents(int structParents)
Sets the "StructParents" value.void
setTabs(PDFName value)
Specifies the tab order for annotations on a page.void
setTransition(int dur, TransitionDictionary tr)
Set the transition dictionary and duration.void
setTrimBox(java.awt.geom.Rectangle2D box)
Sets the "TrimBox" entryprivate PDFArray
toPDFArray(java.awt.geom.Rectangle2D box)
-
Methods inherited from class org.apache.fop.pdf.PDFResourceContext
addAnnotation, addGState, addPattern, addShading, addXObject, getAnnotations, getGStates, getPatterns, getPDFResources, getShadings, getXObjects
-
Methods inherited from class org.apache.fop.pdf.PDFDictionary
containsKey, get, getChildren, getChildren, keySet, output, put, put, remove, writeDictionary
-
Methods inherited from class org.apache.fop.pdf.PDFObject
contentEquals, encode, encodeBinaryToHexString, encodeString, encodeText, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, getParent, hasObjectNumber, makeReference, outputInline, referencePDF, setDocument, setObjectNumber, setObjectNumber, setObjectNumber, setParent, toPDF, toPDFString
-
-
-
-
Constructor Detail
-
PDFPage
public PDFPage(PDFResources resources, int pageIndex, java.awt.geom.Rectangle2D mediaBox, java.awt.geom.Rectangle2D cropBox, java.awt.geom.Rectangle2D bleedBox, java.awt.geom.Rectangle2D trimBox)
Create a /Page object- Parameters:
resources
- the /Resources objectpageIndex
- the page's zero-based index (or -1 if the page number is auto-determined)mediaBox
- the MediaBoxcropBox
- the CropBox. If null, mediaBox is used.bleedBox
- the BleedBox. If null, cropBox is used.trimBox
- the TrimBox. If null, bleedBox is used.
-
-
Method Detail
-
setSimplePageSize
private void setSimplePageSize(java.awt.geom.Rectangle2D mediaBox, java.awt.geom.Rectangle2D cropBox, java.awt.geom.Rectangle2D bleedBox, java.awt.geom.Rectangle2D trimBox)
-
toPDFArray
private PDFArray toPDFArray(java.awt.geom.Rectangle2D box)
-
setMediaBox
public void setMediaBox(java.awt.geom.Rectangle2D box)
Sets the "MediaBox" entry- Parameters:
box
- the media rectangle
-
setCropBox
public void setCropBox(java.awt.geom.Rectangle2D box)
Sets the "CropBox" entry- Parameters:
box
- the bleed rectangle
-
setBleedBox
public void setBleedBox(java.awt.geom.Rectangle2D box)
Sets the "BleedBox" entry- Parameters:
box
- the bleed rectangle
-
setTrimBox
public void setTrimBox(java.awt.geom.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 secondstr
- 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 java.lang.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
-
setMetadata
public void setMetadata(PDFMetadata meta)
-
-