public class PCLDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
IFDocumentHandler implementation
that produces PCL 5.| Modifier and Type | Field and Description |
|---|---|
static Object |
COLOR_CANVAS
Enables/Disables a color canvas for bitmap production (required for SVG, for example)
|
static Object |
DISABLE_CLIPPING
Disable clipping
|
protected PCLRenderingUtil |
pclUtil
Utility class for handling all sorts of peripheral tasks around PCL generation.
|
static org.apache.xmlgraphics.util.QName |
SRC_TRANSPARENCY
Source transparency mode
|
fontInfo, outputStream| Constructor and Description |
|---|
PCLDocumentHandler(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.
|
String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation.
|
protected int |
getResolution() |
void |
handleExtensionObject(Object extension)
Handles an extension object.
|
void |
setDefaultFontInfo(FontInfo fontInfo)
Sets the default font set (with no custom configuration).
|
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, setFontInfo, setResultendDocumentTrailer, endPageHeader, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailerprotected PCLRenderingUtil pclUtil
public static final org.apache.xmlgraphics.util.QName SRC_TRANSPARENCY
public static final Object DISABLE_CLIPPING
public static final Object COLOR_CANVAS
public PCLDocumentHandler(IFContext context)
public boolean supportsPagesOutOfOrder()
supportsPagesOutOfOrder in interface IFDocumentHandlerpublic String getMimeType()
getMimeType in interface IFDocumentHandlerpublic IFDocumentHandlerConfigurator getConfigurator()
getConfigurator in interface IFDocumentHandlerpublic void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo in interface IFDocumentHandlersetDefaultFontInfo in class AbstractBinaryWritingIFDocumentHandlerfontInfo - the font info object to populateprotected int getResolution()
public void startDocument()
throws IFException
startDocument in interface IFDocumentHandlerstartDocument in class AbstractBinaryWritingIFDocumentHandlerIFException - if an error occurs while handling this eventpublic void endDocumentHeader()
throws IFException
endDocumentHeader in interface IFDocumentHandlerendDocumentHeader in class AbstractIFDocumentHandlerIFException - if an error occurs while handling this eventpublic void endDocument()
throws IFException
endDocument in interface IFDocumentHandlerendDocument in class AbstractBinaryWritingIFDocumentHandlerIFException - if an error occurs while handling this eventpublic void startPageSequence(String id) throws IFException
startPageSequence in interface IFDocumentHandlerid - the page sequence's identifier (or null if none is available)IFException - if an error occurs while handling this eventpublic void endPageSequence()
throws IFException
endPageSequence in interface IFDocumentHandlerIFException - if an error occurs while handling this eventpublic void startPage(int index,
String name,
String pageMasterName,
Dimension size)
throws IFException
startPage in interface IFDocumentHandlerindex - 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.startPageContent in interface IFDocumentHandlerIFException - if an error occurs while handling this eventpublic void endPageContent()
throws IFException
IFPainter returned by the
respective IFDocumentHandler.startPageContent() method are illegal.endPageContent in interface IFDocumentHandlerIFException - if an error occurs while handling this eventpublic void endPage()
throws IFException
endPage in interface IFDocumentHandlerIFException - if an error occurs while handling this eventpublic void handleExtensionObject(Object extension) throws IFException
handleExtensionObject in interface IFDocumentHandlerextension - the extension objectIFException - if an error occurs while handling this eventCopyright © 2023 Apache Software Foundation. All rights reserved.