Package org.apache.fop.render.pdf

Class PDFDocumentHandler

java.lang.Object

org.apache.fop.render.intermediate.AbstractIFDocumentHandler

org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler

org.apache.fop.render.pdf.PDFDocumentHandler

All Implemented Interfaces:

IFDocumentHandler

public class PDFDocumentHandler
extends AbstractBinaryWritingIFDocumentHandler

IFDocumentHandler implementation that produces PDF.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
(package private) static final class	PDFDocumentHandler.PageReference

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	accessEnabled
private Map<String,PDFReference>	contents
private PDFPage	currentPage	the current page to add annotations to
private PDFDocumentHandler.PageReference	currentPageRef	the current page's PDF reference
private final PDFDocumentNavigationHandler	documentNavigationHandler
private PDFContentGenerator	generator	The current content generator
private static org.apache.commons.logging.Log	log	logging instance
private PDFLogicalStructureHandler	logicalStructureHandler
private Map<Integer,PDFArray>	pageNumbers
private Map<Integer,PDFDocumentHandler.PageReference>	pageReferences	Used for bookmarks/outlines.
private PDFDocument	pdfDoc	the PDF Document being created
private PDFResources	pdfResources	the /Resources object of the PDF document being created
private final PDFRenderingUtil	pdfUtil	Utility class which enables all sorts of features that are not directly connected to the normal rendering process.
private PDFStructureTreeBuilder	structureTreeBuilder
private Map<String,Object>	usedFieldNames

Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler

fontInfo, outputStream

Constructor Summary

Constructors

Constructor	Description
PDFDocumentHandler(IFContext context)	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	endDocument()	Indicates the end of a document.
void	endDocumentHeader()	Indicates the end of the document header.
void	endPage()	Indicates the end of a page
void	endPageContent()	Indicates the end of the page content.
void	endPageSequence()	Indicates the end of a page sequence.
IFDocumentHandlerConfigurator	getConfigurator()	Returns the configurator for this document handler, if any.
(package private) PDFPage	getCurrentPage()
(package private) PDFDocumentHandler.PageReference	getCurrentPageRef()
IFDocumentNavigationHandler	getDocumentNavigationHandler()	Returns a document navigation handler if this feature is supported.
(package private) PDFContentGenerator	getGenerator()
(package private) PDFLogicalStructureHandler	getLogicalStructureHandler()
String	getMimeType()	Returns the MIME type of the output format that is generated by this implementation.
Map<Integer,PDFArray>	getPageNumbers()
(package private) PDFDocumentHandler.PageReference	getPageReference(int pageIndex)
(package private) PDFDocument	getPDFDocument()
StructureTreeEventHandler	getStructureTreeEventHandler()
Map<String,Object>	getUsedFieldNames()
void	handleExtensionObject(Object extension)	Handles an extension object.
(package private) void	mergeRendererOptionsConfig(PDFRendererOptionsConfig config)
void	setDocumentLocale(Locale locale)
private void	setupAccessibility()
private void	setUpContents()
void	startDocument()	Indicates the start of a document.
void	startPage(int index, String name, String pageMasterName, Dimension size)	Indicates the start of a new page.
IFPainter	startPageContent()	Indicates the start of the page content.
void	startPageSequence(String id)	Indicates the start of a new page sequence.
boolean	supportsPagesOutOfOrder()	Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.
private Rectangle2D	toPDFCoordSystem(Rectangle box, AffineTransform transform)

Methods inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler

getFontInfo, setDefaultFontInfo, setFontInfo, setResult

Methods inherited from class org.apache.fop.render.intermediate.AbstractIFDocumentHandler

endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getUserAgent, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

log

private static org.apache.commons.logging.Log log

logging instance

accessEnabled

private boolean accessEnabled

logicalStructureHandler

private PDFLogicalStructureHandler logicalStructureHandler

structureTreeBuilder

private PDFStructureTreeBuilder structureTreeBuilder

pdfDoc

private PDFDocument pdfDoc

the PDF Document being created

pdfUtil

private final PDFRenderingUtil pdfUtil

Utility class which enables all sorts of features that are not directly connected to the normal rendering process.

pdfResources

private PDFResources pdfResources

the /Resources object of the PDF document being created

generator

private PDFContentGenerator generator

The current content generator

currentPage

private PDFPage currentPage

the current page to add annotations to

currentPageRef

private PDFDocumentHandler.PageReference currentPageRef

the current page's PDF reference

pageReferences

private Map<Integer,PDFDocumentHandler.PageReference> pageReferences

Used for bookmarks/outlines.

documentNavigationHandler

private final PDFDocumentNavigationHandler documentNavigationHandler

usedFieldNames

private Map<String,Object> usedFieldNames

pageNumbers

private Map<Integer,PDFArray> pageNumbers

contents

private Map<String,PDFReference> contents

Constructor Details

PDFDocumentHandler

public PDFDocumentHandler(IFContext context)

Default constructor.

Method Details

supportsPagesOutOfOrder

public boolean supportsPagesOutOfOrder()

Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.

Returns:

true if out-of-order handling is supported

getMimeType

public String getMimeType()

Returns the MIME type of the output format that is generated by this implementation.

Returns:

the MIME type

getConfigurator

public IFDocumentHandlerConfigurator getConfigurator()

Returns the configurator for this document handler, if any.

Returns:

the configurator or null if there's no configurator

getDocumentNavigationHandler

public IFDocumentNavigationHandler getDocumentNavigationHandler()

Returns a document navigation handler if this feature is supported.

Specified by:

getDocumentNavigationHandler in interface IFDocumentHandler

Overrides:

getDocumentNavigationHandler in class AbstractIFDocumentHandler

Returns:

the document navigation handler or null if not supported

mergeRendererOptionsConfig

void mergeRendererOptionsConfig(PDFRendererOptionsConfig config)

getLogicalStructureHandler

PDFLogicalStructureHandler getLogicalStructureHandler()

getPDFDocument

PDFDocument getPDFDocument()

getCurrentPage

PDFPage getCurrentPage()

getCurrentPageRef

PDFDocumentHandler.PageReference getCurrentPageRef()

getGenerator

PDFContentGenerator getGenerator()

startDocument

public void startDocument()
                   throws IFException

Indicates the start of a document. This method may only be called once before any other event method.

Specified by:

startDocument in interface IFDocumentHandler

Overrides:

startDocument in class AbstractBinaryWritingIFDocumentHandler

Throws:

IFException - if an error occurs while handling this event

setupAccessibility

private void setupAccessibility()

endDocumentHeader

public void endDocumentHeader()
                       throws IFException

Indicates the end of the document header. This method is called before the first page sequence.

Specified by:

endDocumentHeader in interface IFDocumentHandler

Overrides:

endDocumentHeader in class AbstractIFDocumentHandler

Throws:

IFException - if an error occurs while handling this event

endDocument

public void endDocument()
                 throws IFException

Indicates the end of a document. This method may only be called once after the whole document has been handled. Implementations can release resources (close streams). It is an error to call any event method after this method.

Specified by:

endDocument in interface IFDocumentHandler

Overrides:

endDocument in class AbstractBinaryWritingIFDocumentHandler

Throws:

IFException - if an error occurs while handling this event

startPageSequence

public void startPageSequence(String id)
                       throws IFException

Indicates the start of a new page sequence.

Parameters:

id - the page sequence's identifier (or null if none is available)

Throws:

IFException - if an error occurs while handling this event

endPageSequence

public void endPageSequence()
                     throws IFException

Indicates the end of a page sequence.

Throws:

IFException - if an error occurs while handling this event

startPage

public void startPage(int index,
 String name,
 String pageMasterName,
 Dimension size)
               throws IFException

Indicates the start of a new page.

Parameters:

index - the index of the page (0-based)

name - the page name (usually the formatted page number)

pageMasterName - the name of the simple-page-master that generated this page

size - the size of the page (equivalent to the MediaBox in PDF)

Throws:

IFException - if an error occurs while handling this event

toPDFCoordSystem

private Rectangle2D toPDFCoordSystem(Rectangle box,
 AffineTransform transform)

startPageContent

public IFPainter startPageContent()
                           throws IFException

Indicates the start of the page content. The method returns an IFPainter interface which is used to paint the page contents.

Returns:

the IFPainter for the page content

Throws:

IFException - if an error occurs while handling this event

endPageContent

public void endPageContent()
                    throws IFException

Indicates the end of the page content. Calls to the IFPainter returned by the respective IFDocumentHandler.startPageContent() method are illegal.

Throws:

IFException - if an error occurs while handling this event

endPage

public void endPage()
             throws IFException

Indicates the end of a page

Throws:

IFException - if an error occurs while handling this event

setUpContents

private void setUpContents()
                    throws IOException

Throws:

IOException

handleExtensionObject

public void handleExtensionObject(Object extension)
                           throws IFException

Handles an extension object. This can be a DOM document or any arbitrary object. If an implementation doesn't know how to handle a particular extension it is simply ignored.

Parameters:

extension - the extension object

Throws:

IFException - if an error occurs while handling this event

setDocumentLocale

public void setDocumentLocale(Locale locale)

Specified by:

setDocumentLocale in interface IFDocumentHandler

Overrides:

setDocumentLocale in class AbstractIFDocumentHandler

Parameters:

locale - Locale of the document.

getPageReference

PDFDocumentHandler.PageReference getPageReference(int pageIndex)

getStructureTreeEventHandler

public StructureTreeEventHandler getStructureTreeEventHandler()

Description copied from class: AbstractIFDocumentHandler

Specified by:

getStructureTreeEventHandler in interface IFDocumentHandler

Overrides:

getStructureTreeEventHandler in class AbstractIFDocumentHandler

Returns:

the structure tree builder

getUsedFieldNames

public Map<String,Object> getUsedFieldNames()

getPageNumbers

public Map<Integer,PDFArray> getPageNumbers()