|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.fop.render.intermediate.AbstractIFDocumentHandler
org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
org.apache.fop.render.bitmap.AbstractBitmapDocumentHandler
Abstract IFDocumentHandler
implementation for producing bitmap images.
Field Summary | |
static java.lang.String |
TARGET_BITMAP_SIZE
Rendering 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 | |
AbstractBitmapDocumentHandler()
Default constructor. |
Method Summary | |
protected java.awt.image.BufferedImage |
createBufferedImage(int bitmapWidth,
int bitmapHeight)
Creates a new BufferedImage. |
void |
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. |
void |
endDocumentHeader()
Indicates the end of the document header. This method is called before the first page sequence. |
void |
endPage()
Indicates the end of a page |
void |
endPageContent()
Indicates the end of the page content. Calls to the IFPainter returned by the
respective IFDocumentHandler.startPageContent() method are illegal. |
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. 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. |
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. This method may only be called once before any other event method. |
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. The method returns an IFPainter interface
which is used to paint the page contents. |
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. |
Methods inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler |
getFontInfo, setFontInfo, setResult |
Methods inherited from class org.apache.fop.render.intermediate.AbstractIFDocumentHandler |
endDocumentTrailer, endPageHeader, endPageTrailer, getContext, getDocumentNavigationHandler, getUserAgent, startDocumentHeader, startDocumentTrailer, startPageHeader, startPageTrailer |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
public static final java.lang.String TARGET_BITMAP_SIZE
Constructor Detail |
public AbstractBitmapDocumentHandler()
Method Detail |
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
public abstract IFDocumentHandlerConfigurator getConfigurator()
public BitmapRenderingSettings getSettings()
public void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo
in interface IFDocumentHandler
setDefaultFontInfo
in class AbstractBinaryWritingIFDocumentHandler
public 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
public void endDocumentHeader() throws IFException
endDocumentHeader
in interface IFDocumentHandler
endDocumentHeader
in class AbstractIFDocumentHandler
IFException
public void endDocument() throws IFException
endDocument
in interface IFDocumentHandler
endDocument
in class AbstractBinaryWritingIFDocumentHandler
IFException
public 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 pixels
public 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 object
IFException
- if an error occurs while handling this event
|
fop 1.0 | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |