public abstract class AbstractBitmapDocumentHandler extends AbstractBinaryWritingIFDocumentHandler
IFDocumentHandler
implementation
for producing bitmap images.Modifier and Type | Field and Description |
---|---|
static java.lang.String |
TARGET_BITMAP_SIZE
Rendering Options key for the controlling the required bitmap size to create.
|
fontInfo, outputStream
Constructor and Description |
---|
AbstractBitmapDocumentHandler()
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
protected java.awt.image.BufferedImage |
createBufferedImage(int bitmapWidth,
int bitmapHeight)
Creates a new BufferedImage.
|
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.
|
abstract IFDocumentHandlerConfigurator |
getConfigurator()
Returns the configurator for this document handler, if any.
|
abstract java.lang.String |
getDefaultExtension()
Returns the default file extension for the supported image type.
|
abstract java.lang.String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation.
|
BitmapRenderingSettings |
getSettings()
Returns the settings for bitmap rendering.
|
void |
handleExtensionObject(java.lang.Object extension)
Handles an extension object.
|
void |
setContext(IFContext context)
Sets the intermediate format context object.
|
void |
setDefaultFontInfo(FontInfo fontInfo)
Sets the default font set (with no custom configuration).
|
void |
setTargetBitmapSize(java.awt.Dimension size)
Sets the target bitmap size (in pixels) of the bitmap that should be produced.
|
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, setFontInfo, setResult
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer
public static final java.lang.String TARGET_BITMAP_SIZE
public AbstractBitmapDocumentHandler()
public boolean supportsPagesOutOfOrder()
public abstract java.lang.String getMimeType()
public abstract java.lang.String getDefaultExtension()
public void setContext(IFContext context)
setContext
in interface IFDocumentHandler
setContext
in class AbstractIFDocumentHandler
context
- the context objectpublic abstract IFDocumentHandlerConfigurator getConfigurator()
public BitmapRenderingSettings getSettings()
public void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo
in interface IFDocumentHandler
setDefaultFontInfo
in class AbstractBinaryWritingIFDocumentHandler
fontInfo
- the font info object to populatepublic void setTargetBitmapSize(java.awt.Dimension size)
size
- the target bitmap size (in pixels)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 eventprotected java.awt.image.BufferedImage createBufferedImage(int bitmapWidth, int bitmapHeight)
bitmapWidth
- the desired width in pixelsbitmapHeight
- the desired height in pixelspublic 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 eventCopyright 1999-2012 The Apache Software Foundation. All Rights Reserved.