Package org.apache.fop.render.bitmap
Class AbstractBitmapDocumentHandler
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFDocumentHandler
org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
org.apache.fop.render.bitmap.AbstractBitmapDocumentHandler
- All Implemented Interfaces:
IFDocumentHandler
- Direct Known Subclasses:
PNGDocumentHandler,TIFFDocumentHandler
Abstract
IFDocumentHandler implementation
for producing bitmap images.-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final StringRendering Options key for the controlling the required bitmap size to create.Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
fontInfo, outputStream -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected BufferedImagecreateBufferedImage(int bitmapWidth, int bitmapHeight) Creates a new BufferedImage.voidIndicates the end of a document.voidIndicates the end of the document header.voidendPage()Indicates the end of a pagevoidIndicates the end of the page content.voidIndicates the end of a page sequence.abstract IFDocumentHandlerConfiguratorReturns the configurator for this document handler, if any.abstract StringReturns the default file extension for the supported image type.abstract StringReturns the MIME type of the output format that is generated by this implementation.Returns the settings for bitmap rendering.voidhandleExtensionObject(Object extension) Handles an extension object.voidsetDefaultFontInfo(FontInfo fontInfo) Sets the default font set (with no custom configuration).voidsetTargetBitmapSize(Dimension size) Sets the target bitmap size (in pixels) of the bitmap that should be produced.voidIndicates the start of a document.voidIndicates the start of a new page.Indicates the start of the page content.voidIndicates the start of a new page sequence.booleanIndicates whether the painter supports to handle the pages in mixed order rather than ascending order.Methods inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
getFontInfo, setFontInfo, setResultMethods inherited from class org.apache.fop.render.intermediate.AbstractIFDocumentHandler
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer
-
Field Details
-
TARGET_BITMAP_SIZE
Rendering Options key for the controlling the required bitmap size to create. This is used to create thumbnails, for example. If used, the target resolution is ignored. Value type: java.awt.Dimension (size in pixels)- See Also:
-
-
Constructor Details
-
AbstractBitmapDocumentHandler
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
-
getDefaultExtension
Returns the default file extension for the supported image type.- Returns:
- the default file extension (ex. "png")
-
getConfigurator
Returns the configurator for this document handler, if any.- Returns:
- the configurator or null if there's no configurator
-
getSettings
Returns the settings for bitmap rendering.- Returns:
- the settings object
-
setDefaultFontInfo
Sets the default font set (with no custom configuration).- Specified by:
setDefaultFontInfoin interfaceIFDocumentHandler- Overrides:
setDefaultFontInfoin classAbstractBinaryWritingIFDocumentHandler- Parameters:
fontInfo- the font info object to populate
-
setTargetBitmapSize
Sets the target bitmap size (in pixels) of the bitmap that should be produced. Normally, the bitmap size is calculated automatically based on the page size and the target resolution. But for example, if you want to create thumbnails or small preview bitmaps from pages it is more practical (and efficient) to set the required bitmap size.- Parameters:
size- the target bitmap size (in pixels)
-
startDocument
Indicates the start of a document. This method may only be called once before any other event method.- Specified by:
startDocumentin interfaceIFDocumentHandler- Overrides:
startDocumentin classAbstractBinaryWritingIFDocumentHandler- Throws:
IFException- if an error occurs while handling this event
-
endDocumentHeader
Indicates the end of the document header. This method is called before the first page sequence.- Specified by:
endDocumentHeaderin interfaceIFDocumentHandler- Overrides:
endDocumentHeaderin 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:
endDocumentin interfaceIFDocumentHandler- Overrides:
endDocumentin 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
-
startPageContent
Indicates the start of the page content. The method returns anIFPainterinterface 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
-
createBufferedImage
Creates a new BufferedImage.- Parameters:
bitmapWidth- the desired width in pixelsbitmapHeight- the desired height in pixels- Returns:
- the new BufferedImage instance
-
endPageContent
Indicates the end of the page content. Calls to theIFPainterreturned 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
-
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
-