|
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
public class 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. |
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 |
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. |
void |
setBitsPerPixel(int bitsPerPixel)
Sets the number of bits used per pixel |
void |
setCMYKImagesSupported(boolean value)
Controls whether CMYK images (IOCA FS45) are enabled. |
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. |
void |
setShadingMode(AFPShadingMode shadingMode)
Sets the shading mode for painting filled rectangles. |
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 |
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 IFDocumentHandler
public java.lang.String getMimeType()
getMimeType
in interface IFDocumentHandler
public IFDocumentHandlerConfigurator getConfigurator()
getConfigurator
in interface IFDocumentHandler
public void setDefaultFontInfo(FontInfo fontInfo)
setDefaultFontInfo
in interface IFDocumentHandler
setDefaultFontInfo
in class AbstractBinaryWritingIFDocumentHandler
fontInfo
- the font info object to populatepublic 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
startPageSequence
in interface IFDocumentHandler
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
endPageSequence
in interface IFDocumentHandler
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
startPage
in interface IFDocumentHandler
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 void startPageHeader() throws IFException
startPageHeader
in interface IFDocumentHandler
startPageHeader
in class AbstractIFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPageHeader() throws IFException
endPageHeader
in interface IFDocumentHandler
endPageHeader
in class AbstractIFDocumentHandler
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 IFDocumentHandler
IFException
- 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 IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void endPage() throws IFException
endPage
in interface IFDocumentHandler
IFException
- if an error occurs while handling this eventpublic void handleExtensionObject(java.lang.Object extension) throws IFException
handleExtensionObject
in interface IFDocumentHandler
extension
- the extension object
IFException
- if an error occurs while handling this eventpublic void setBitsPerPixel(int bitsPerPixel)
setBitsPerPixel
in interface AFPCustomizable
bitsPerPixel
- number of bits per pixelpublic void setColorImages(boolean colorImages)
setColorImages
in interface AFPCustomizable
colorImages
- color image outputpublic void setNativeImagesSupported(boolean nativeImages)
setNativeImagesSupported
in interface AFPCustomizable
nativeImages
- native image supportpublic void setCMYKImagesSupported(boolean value)
setCMYKImagesSupported
in interface AFPCustomizable
value
- true to enabled CMYK imagespublic void setDitheringQuality(float quality)
setDitheringQuality
in interface AFPCustomizable
quality
- 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 AFPCustomizable
shadingMode
- the shading modepublic void setResolution(int resolution)
setResolution
in interface AFPCustomizable
resolution
- the output resolution (dpi)public int getResolution()
getResolution
in interface AFPCustomizable
public void setDefaultResourceGroupFilePath(java.lang.String filePath)
setDefaultResourceGroupFilePath
in interface AFPCustomizable
filePath
- the default resource group file pathpublic void setResourceLevelDefaults(AFPResourceLevelDefaults defaults)
setResourceLevelDefaults
in interface AFPCustomizable
defaults
- the resource level defaults
|
fop 1.0 | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |