org.apache.fop.pdf
Class PDFRoot
- PDFWritable
class representing a Root (/Catalog) object
encode , encodeString , encodeText , formatDateTime , formatObject , getDocument , getDocumentSafely , getGeneration , getObjectID , getObjectNumber , hasObjectNumber , makeReference , output , referencePDF , setDocument , setObjectNumber , toInlinePDFString , toPDF , toPDFString |
PAGEMODE_FULLSCREEN
public static final int PAGEMODE_FULLSCREEN
Full screen page mode
PAGEMODE_USENONE
public static final int PAGEMODE_USENONE
Use no page mode setting, default
PAGEMODE_USEOUTLINES
public static final int PAGEMODE_USEOUTLINES
Use outlines page mode to show bookmarks
PAGEMODE_USETHUMBS
public static final int PAGEMODE_USETHUMBS
Use thumbs page mode to show thumbnail images
rootPages
protected PDFPages rootPages
the /Pages object that is root of the Pages hierarchy
PDFRoot
public PDFRoot(int objnum,
PDFPages pages)
create a Root (/Catalog) object. NOTE: The PDFRoot
object must be created before the PDF document is
generated, but it is not assigned an object ID until
it is about to be written (immediately before the xref
table as part of the trsailer). (mark-fop@inomial.com)
objnum
- the object's numberpages
- the PDFPages object
addOutputIntent
public void addOutputIntent(PDFOutputIntent outputIntent)
Adds an OutputIntent to the PDF
outputIntent
- the OutputIntent dictionary
addPage
public void addPage(PDFPage page)
add a /Page object to the root /Pages object
page
- the /Page object to add
getMetadata
public PDFMetadata getMetadata()
- the Metadata object if set, null otherwise.
getNames
public PDFNames getNames()
- the Names object if set, null otherwise.
getRootOutline
public PDFOutline getRootOutline()
Get the root PDF outline for the document.
setMetadata
public void setMetadata(PDFMetadata meta)
Set the optional Metadata object.
meta
- the Metadata object
setNames
public void setNames(PDFNames names)
Set the Names object.
setPageMode
public void setPageMode(int mode)
Set the page mode for the PDF document.
setRootOutline
public void setRootOutline(PDFOutline out)
Set the root outline for the PDF document.
out
- the root PDF Outline
setRootPages
public void setRootPages(PDFPages pages)
set the root /Pages object
pages
- the /Pages object to set as root
Copyright 1999-2007 The Apache Software Foundation. All Rights Reserved.