public class PDFDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
IFDocumentHandler
implementation that produces PDF.Modifier and Type | Field and Description |
---|---|
protected PDFResourceContext |
currentContext
the current annotation list to add annotations to
|
protected PDFPage |
currentPage
the current page to add annotations to
|
protected org.apache.fop.render.pdf.PDFDocumentHandler.PageReference |
currentPageRef
the current page's PDF reference
|
protected PDFContentGenerator |
generator
The current content generator
|
protected java.util.Map<java.lang.Integer,org.apache.fop.render.pdf.PDFDocumentHandler.PageReference> |
pageReferences
Used for bookmarks/outlines.
|
protected PDFDocument |
pdfDoc
the PDF Document being created
|
protected PDFResources |
pdfResources
the /Resources object of the PDF document being created
|
protected org.apache.fop.render.pdf.PDFRenderingUtil |
pdfUtil
Utility class which enables all sorts of features that are not directly connected to the
normal rendering process.
|
fontInfo, outputStream
Constructor and Description |
---|
PDFDocumentHandler()
Default constructor.
|
Modifier and Type | Method and 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.
|
IFDocumentNavigationHandler |
getDocumentNavigationHandler()
Returns a document navigation handler if this feature is supported.
|
java.lang.String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation.
|
StructureTreeEventHandler |
getStructureTreeEventHandler() |
void |
handleExtensionObject(java.lang.Object extension)
Handles an extension object.
|
void |
setContext(IFContext context)
Sets the intermediate format context object.
|
void |
setDocumentLocale(java.util.Locale locale) |
void |
startDocument()
Indicates the start of a document.
|
void |
startPage(int index,
java.lang.String name,
java.lang.String pageMasterName,
java.awt.Dimension size)
Indicates the start of a new page.
|
IFPainter |
startPageContent()
Indicates the start of the page content.
|
void |
startPageSequence(java.lang.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.
|
getFontInfo, setDefaultFontInfo, setFontInfo, setResult
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getUserAgent, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer
protected PDFDocument pdfDoc
protected org.apache.fop.render.pdf.PDFRenderingUtil pdfUtil
protected PDFResources pdfResources
protected PDFContentGenerator generator
protected PDFResourceContext currentContext
protected PDFPage currentPage
protected org.apache.fop.render.pdf.PDFDocumentHandler.PageReference currentPageRef
protected java.util.Map<java.lang.Integer,org.apache.fop.render.pdf.PDFDocumentHandler.PageReference> pageReferences
public boolean supportsPagesOutOfOrder()
public java.lang.String getMimeType()
public void setContext(IFContext context)
setContext
in interface IFDocumentHandler
setContext
in class AbstractIFDocumentHandler
context
- the context objectpublic IFDocumentHandlerConfigurator getConfigurator()
public IFDocumentNavigationHandler getDocumentNavigationHandler()
getDocumentNavigationHandler
in interface IFDocumentHandler
getDocumentNavigationHandler
in class AbstractIFDocumentHandler
public void startDocument() throws IFException
startDocument
in interface IFDocumentHandler
startDocument
in class AbstractBinaryWritingIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocumentHeader() throws IFException
endDocumentHeader
in interface IFDocumentHandler
endDocumentHeader
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endDocument() throws IFException
endDocument
in interface IFDocumentHandler
endDocument
in class AbstractBinaryWritingIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void startPageSequence(java.lang.String id) throws IFException
id
- the page sequence's identifier (or null if none is available)IFException
- if an error occurs while handling this eventpublic void endPageSequence() throws IFException
IFException
- if an error occurs while handling this eventpublic void startPage(int index, java.lang.String name, java.lang.String pageMasterName, java.awt.Dimension size) throws IFException
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 pagesize
- the size of the page (equivalent to the MediaBox in PDF)IFException
- if an error occurs while handling this eventpublic IFPainter startPageContent() throws IFException
IFPainter
interface
which is used to paint the page contents.IFException
- if an error occurs while handling this eventpublic void endPageContent() throws IFException
IFPainter
returned by the
respective IFDocumentHandler.startPageContent()
method are illegal.IFException
- if an error occurs while handling this eventpublic void endPage() throws IFException
IFException
- if an error occurs while handling this eventpublic void handleExtensionObject(java.lang.Object extension) throws IFException
extension
- the extension objectIFException
- if an error occurs while handling this eventpublic void setDocumentLocale(java.util.Locale locale)
setDocumentLocale
in interface IFDocumentHandler
setDocumentLocale
in class AbstractIFDocumentHandler
locale
- Locale of the document.public StructureTreeEventHandler getStructureTreeEventHandler()
AbstractIFDocumentHandler
getStructureTreeEventHandler
in interface IFDocumentHandler
getStructureTreeEventHandler
in class AbstractIFDocumentHandler
Copyright 1999-2012 The Apache Software Foundation. All Rights Reserved.