org.apache.fop.pdf

Class PDFRoot

Implemented Interfaces:
PDFWritable

public class PDFRoot
extends PDFObject

class representing a Root (/Catalog) object

Field Summary

static int
PAGEMODE_FULLSCREEN
Full screen page mode
static int
PAGEMODE_USENONE
Use no page mode setting, default
static int
PAGEMODE_USEOUTLINES
Use outlines page mode to show bookmarks
static int
PAGEMODE_USETHUMBS
Use thumbs page mode to show thumbnail images
protected PDFPages
rootPages
the /Pages object that is root of the Pages hierarchy

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

DATE_FORMAT, log

Constructor Summary

PDFRoot(int objnum, PDFPages pages)
create a Root (/Catalog) object.

Method Summary

void
addOutputIntent(PDFOutputIntent outputIntent)
Adds an OutputIntent to the PDF
void
addPage(PDFPage page)
add a /Page object to the root /Pages object
PDFMetadata
getMetadata()
PDFNames
getNames()
PDFOutline
getRootOutline()
Get the root PDF outline for the document.
void
setMetadata(PDFMetadata meta)
Set the optional Metadata object.
void
setNames(PDFNames names)
Set the Names object.
void
setPageMode(int mode)
Set the page mode for the PDF document.
void
setRootOutline(PDFOutline out)
Set the root outline for the PDF document.
void
setRootPages(PDFPages pages)
set the root /Pages object
String
toPDFString()

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

encode, encodeString, encodeText, formatDateTime, formatObject, getDocument, getDocumentSafely, getGeneration, getObjectID, getObjectNumber, hasObjectNumber, makeReference, output, referencePDF, setDocument, setObjectNumber, toInlinePDFString, toPDF, toPDFString

Field Details

PAGEMODE_FULLSCREEN

public static final int PAGEMODE_FULLSCREEN
Full screen page mode
Field Value:
3

PAGEMODE_USENONE

public static final int PAGEMODE_USENONE
Use no page mode setting, default
Field Value:
0

PAGEMODE_USEOUTLINES

public static final int PAGEMODE_USEOUTLINES
Use outlines page mode to show bookmarks
Field Value:
1

PAGEMODE_USETHUMBS

public static final int PAGEMODE_USETHUMBS
Use thumbs page mode to show thumbnail images
Field Value:
2

rootPages

protected PDFPages rootPages
the /Pages object that is root of the Pages hierarchy

Constructor Details

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)
Parameters:
objnum - the object's number
pages - the PDFPages object

Method Details

addOutputIntent

public void addOutputIntent(PDFOutputIntent outputIntent)
Adds an OutputIntent to the PDF
Parameters:
outputIntent - the OutputIntent dictionary

addPage

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

getMetadata

public PDFMetadata getMetadata()
Returns:
the Metadata object if set, null otherwise.
Since:
PDF 1.4

getNames

public PDFNames getNames()
Returns:
the Names object if set, null otherwise.
Since:
PDF 1.2

getRootOutline

public PDFOutline getRootOutline()
Get the root PDF outline for the document.
Returns:
the root PDF Outline

setMetadata

public void setMetadata(PDFMetadata meta)
Set the optional Metadata object.
Parameters:
meta - the Metadata object
Since:
PDF 1.4

setNames

public void setNames(PDFNames names)
Set the Names object.
Parameters:
names - the Names object
Since:
PDF 1.2

setPageMode

public void setPageMode(int mode)
Set the page mode for the PDF document.
Parameters:
mode - the page mode

setRootOutline

public void setRootOutline(PDFOutline out)
Set the root outline for the PDF document.
Parameters:
out - the root PDF Outline

setRootPages

public void setRootPages(PDFPages pages)
set the root /Pages object
Parameters:
pages - the /Pages object to set as root

toPDFString

public String toPDFString()
Overrides:
toPDFString in interface PDFObject

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