public class PDFDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
IFDocumentHandler
implementation that produces PDF.fontInfo, outputStream
Constructor and Description |
---|
PDFDocumentHandler(IFContext context)
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.
|
String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation.
|
Map<Integer,PDFArray> |
getPageNumbers() |
StructureTreeEventHandler |
getStructureTreeEventHandler() |
Map<String,Object> |
getUsedFieldNames() |
void |
handleExtensionObject(Object extension)
Handles an extension object.
|
void |
setDocumentLocale(Locale locale) |
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.
|
getFontInfo, setDefaultFontInfo, setFontInfo, setResult
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getUserAgent, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer
public PDFDocumentHandler(IFContext context)
public boolean supportsPagesOutOfOrder()
public String getMimeType()
public 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(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, String name, String pageMasterName, 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(Object extension) throws IFException
extension
- the extension objectIFException
- if an error occurs while handling this eventpublic void setDocumentLocale(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 © 2025 Apache Software Foundation. All rights reserved.