|
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.afp.AFPDocumentHandler
IFDocumentHandler implementation that produces AFP (MO:DCA).
| Field Summary |
| Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler |
fontInfo, outputStream |
| Constructor Summary | |
AFPDocumentHandler()
Default constructor. |
|
| Method Summary | |
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 |
endPageHeader()
Indicates the end of the page header. |
void |
endPageSequence()
Indicates the end of a page sequence. |
IFDocumentHandlerConfigurator |
getConfigurator()
Returns the configurator for this document handler, if any. |
java.lang.String |
getMimeType()
Returns the MIME type of the output format that is generated by this implementation. |
int |
getResolution()
Returns the output/device resolution. |
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 |
setBitsPerPixel(int bitsPerPixel)
Sets the number of bits used per pixel |
void |
setCMYKImagesSupported(boolean value)
Controls whether CMYK images (IOCA FS45) are enabled. By default, support is disabled for wider compatibility. When disabled, any CMYK image is converted to the selected color format. |
void |
setColorImages(boolean colorImages)
Sets whether images are color or not |
void |
setDefaultFontInfo(FontInfo fontInfo)
Sets the default font set (with no custom configuration). |
void |
setDefaultResourceGroupFilePath(java.lang.String filePath)
Sets the default resource group file path |
void |
setDitheringQuality(float quality)
Sets the dithering quality setting to use when converting images to monochrome images. |
void |
setNativeImagesSupported(boolean nativeImages)
Sets whether images are supported natively or not |
void |
setResolution(int resolution)
Sets the output/device resolution |
void |
setResourceLevelDefaults(AFPResourceLevelDefaults defaults)
Sets the resource level defaults. The object passed in provides information which resource level shall be used by default for various kinds of resources. |
void |
setShadingMode(AFPShadingMode shadingMode)
Sets the shading mode for painting filled rectangles. |
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 |
startPageHeader()
Indicates the start of the page header. |
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, endPageTrailer, getContext, getDocumentNavigationHandler, getUserAgent, setContext, startDocumentHeader, startDocumentTrailer, startPageTrailer |
| Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
public AFPDocumentHandler()
| Method Detail |
public boolean supportsPagesOutOfOrder()
supportsPagesOutOfOrder in interface IFDocumentHandlerpublic java.lang.String getMimeType()
getMimeType in interface IFDocumentHandlerpublic IFDocumentHandlerConfigurator getConfigurator()
getConfigurator in interface IFDocumentHandlerpublic void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo in interface IFDocumentHandlersetDefaultFontInfo in class AbstractBinaryWritingIFDocumentHandler
public void startDocument()
throws IFException
startDocument in interface IFDocumentHandlerstartDocument in class AbstractBinaryWritingIFDocumentHandlerIFException
public void endDocumentHeader()
throws IFException
endDocumentHeader in interface IFDocumentHandlerendDocumentHeader in class AbstractIFDocumentHandlerIFException
public void endDocument()
throws IFException
endDocument in interface IFDocumentHandlerendDocument in class AbstractBinaryWritingIFDocumentHandlerIFException
public void startPageSequence(java.lang.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 event
public void endPageSequence()
throws IFException
endPageSequence in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void startPage(int index,
java.lang.String name,
java.lang.String pageMasterName,
java.awt.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 event
public void startPageHeader()
throws IFException
startPageHeader in interface IFDocumentHandlerstartPageHeader in class AbstractIFDocumentHandlerIFException
public void endPageHeader()
throws IFException
endPageHeader in interface IFDocumentHandlerendPageHeader in class AbstractIFDocumentHandlerIFException
public 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 event
public 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 event
public void endPage()
throws IFException
endPage in interface IFDocumentHandlerIFException - if an error occurs while handling this event
public void handleExtensionObject(java.lang.Object extension)
throws IFException
handleExtensionObject in interface IFDocumentHandlerextension - the extension object
IFException - if an error occurs while handling this eventpublic void setBitsPerPixel(int bitsPerPixel)
setBitsPerPixel in interface AFPCustomizablebitsPerPixel - number of bits per pixelpublic void setColorImages(boolean colorImages)
setColorImages in interface AFPCustomizablecolorImages - color image outputpublic void setNativeImagesSupported(boolean nativeImages)
setNativeImagesSupported in interface AFPCustomizablenativeImages - native image supportpublic void setCMYKImagesSupported(boolean value)
setCMYKImagesSupported in interface AFPCustomizablevalue - true to enabled CMYK imagespublic void setDitheringQuality(float quality)
setDitheringQuality in interface AFPCustomizablequality - Defines the desired quality level for the conversion.
Valid values: a value between 0.0f (fastest) and 1.0f (best)public void setShadingMode(AFPShadingMode shadingMode)
setShadingMode in interface AFPCustomizableshadingMode - the shading modepublic void setResolution(int resolution)
setResolution in interface AFPCustomizableresolution - the output resolution (dpi)public int getResolution()
getResolution in interface AFPCustomizablepublic void setDefaultResourceGroupFilePath(java.lang.String filePath)
setDefaultResourceGroupFilePath in interface AFPCustomizablefilePath - the default resource group file pathpublic void setResourceLevelDefaults(AFPResourceLevelDefaults defaults)
setResourceLevelDefaults in interface AFPCustomizabledefaults - the resource level defaults
|
fop 1.0 | ||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||||