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
IFDocumentHandler
implementation that produces PDF.-
Nested Class Summary
Nested ClassesModifier and TypeClassDescription(package private) static final class
-
Field Summary
FieldsModifier and TypeFieldDescriptionprivate boolean
private Map<String,
PDFReference> private PDFPage
the current page to add annotations toprivate PDFDocumentHandler.PageReference
the current page's PDF referenceprivate final PDFDocumentNavigationHandler
private PDFContentGenerator
The current content generatorprivate static org.apache.commons.logging.Log
logging instanceprivate PDFLogicalStructureHandler
private Map<Integer,
PDFDocumentHandler.PageReference> Used for bookmarks/outlines.private PDFDocument
the PDF Document being createdprivate PDFResources
the /Resources object of the PDF document being createdprivate final PDFRenderingUtil
Utility class which enables all sorts of features that are not directly connected to the normal rendering process.private PDFStructureTreeBuilder
Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
fontInfo, outputStream
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoid
Indicates the end of a document.void
Indicates the end of the document header.void
endPage()
Indicates the end of a pagevoid
Indicates the end of the page content.void
Indicates the end of a page sequence.Returns the configurator for this document handler, if any.(package private) PDFPage
(package private) PDFDocumentHandler.PageReference
Returns a document navigation handler if this feature is supported.(package private) PDFContentGenerator
(package private) PDFLogicalStructureHandler
Returns the MIME type of the output format that is generated by this implementation.(package private) PDFDocumentHandler.PageReference
getPageReference
(int pageIndex) (package private) PDFDocument
void
handleExtensionObject
(Object extension) Handles an extension object.(package private) void
void
setDocumentLocale
(Locale locale) private void
private void
void
Indicates the start of a document.void
Indicates the start of a new page.Indicates the start of the page content.void
Indicates the start of a new page sequence.boolean
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
-
Field Details
-
log
private static org.apache.commons.logging.Log loglogging instance -
accessEnabled
private boolean accessEnabled -
logicalStructureHandler
-
structureTreeBuilder
-
pdfDoc
the PDF Document being created -
pdfUtil
Utility class which enables all sorts of features that are not directly connected to the normal rendering process. -
pdfResources
the /Resources object of the PDF document being created -
generator
The current content generator -
currentPage
the current page to add annotations to -
currentPageRef
the current page's PDF reference -
pageReferences
Used for bookmarks/outlines. -
pageNumbers
-
contents
-
-
Constructor Details
-
PDFDocumentHandler
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
Returns the MIME type of the output format that is generated by this implementation.- Returns:
- the MIME type
-
getConfigurator
Returns the configurator for this document handler, if any.- Returns:
- the configurator or null if there's no configurator
-
mergeRendererOptionsConfig
-
getLogicalStructureHandler
PDFLogicalStructureHandler getLogicalStructureHandler() -
getPDFDocument
PDFDocument getPDFDocument() -
getCurrentPage
PDFPage getCurrentPage() -
getCurrentPageRef
PDFDocumentHandler.PageReference getCurrentPageRef() -
getGenerator
PDFContentGenerator getGenerator() -
startDocument
Indicates the start of a document. This method may only be called once before any other event method.- Specified by:
startDocument
in interfaceIFDocumentHandler
- Overrides:
startDocument
in classAbstractBinaryWritingIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
setupAccessibility
private void setupAccessibility() -
endDocumentHeader
Indicates the end of the document header. This method is called before the first page sequence.- Specified by:
endDocumentHeader
in interfaceIFDocumentHandler
- Overrides:
endDocumentHeader
in classAbstractIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endDocument
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 interfaceIFDocumentHandler
- Overrides:
endDocument
in classAbstractBinaryWritingIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageSequence
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
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 pagesize
- the size of the page (equivalent to the MediaBox in PDF)- Throws:
IFException
- if an error occurs while handling this event
-
toPDFCoordSystem
-
startPageContent
Indicates the start of the page content. The method returns anIFPainter
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
Indicates the end of the page content. Calls to theIFPainter
returned by the respectiveIFDocumentHandler.startPageContent()
method are illegal.- Throws:
IFException
- if an error occurs while handling this event
-
endPage
Indicates the end of a page- Throws:
IFException
- if an error occurs while handling this event
-
setUpContents
- Throws:
IOException
-
handleExtensionObject
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
- Specified by:
setDocumentLocale
in interfaceIFDocumentHandler
- Overrides:
setDocumentLocale
in classAbstractIFDocumentHandler
- Parameters:
locale
- Locale of the document.
-
getPageReference
-
getStructureTreeEventHandler
Description copied from class:AbstractIFDocumentHandler
- Specified by:
getStructureTreeEventHandler
in interfaceIFDocumentHandler
- Overrides:
getStructureTreeEventHandler
in classAbstractIFDocumentHandler
- Returns:
- the structure tree builder
-
getPageNumbers
-