|
fop 1.1 | |||||||||
| 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 |
canEmbedJpeg(boolean canEmbed)
Sets whether or not to JPEG images can be embedded in the AFP document. |
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. |
boolean |
getFS45()
gets whether images should be FS45 |
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. |
boolean |
getWrapPSeg()
gets whether FS11 and FS45 non-inline images should be wrapped in a page segment |
void |
handleExtensionObject(java.lang.Object extension)
Handles an extension object. |
boolean |
isGOCAEnabled()
Indicates whether GOCA is enabled or disabled. |
boolean |
isStrokeGOCAText()
Indicates whether to stroke text in GOCA mode or to use text operators where possible. |
void |
setBitmapEncodingQuality(float quality)
Sets the image encoding quality setting to use when encoding bitmap images. |
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 |
setFS45(boolean fs45)
set true if images should be FS45 |
void |
setGOCAEnabled(boolean enabled)
Controls whether GOCA is enabled or disabled. |
void |
setLineWidthCorrection(float correction)
Sets the line width correction |
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 |
setStrokeGOCAText(boolean stroke)
Controls whether to stroke text in GOCA mode or to use text operators where possible. |
void |
setWrapPSeg(boolean pSeg)
Sets whether FS11 and FS45 non-inline images should be wrapped in a page segment |
void |
startDocument()
Indicates the start of a document. |
void |
startDocumentHeader()
Indicates the start of the document header. |
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, getStructureTreeEventHandler, getUserAgent, setContext, setDocumentLocale, 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 AbstractBinaryWritingIFDocumentHandlerfontInfo - the font info object to populate
public void startDocument()
throws IFException
startDocument in interface IFDocumentHandlerstartDocument in class AbstractBinaryWritingIFDocumentHandlerIFException - if an error occurs while handling this event
public void startDocumentHeader()
throws IFException
IFDocumentHandler.startDocument() method. Extensions sent to this painter between
IFDocumentHandler.startDocumentHeader() and IFDocumentHandler.endDocumentHeader() apply to the document as
a whole (like document metadata).
startDocumentHeader in interface IFDocumentHandlerstartDocumentHeader in class AbstractIFDocumentHandlerIFException - if an error occurs while handling this event
public void endDocumentHeader()
throws IFException
endDocumentHeader in interface IFDocumentHandlerendDocumentHeader in class AbstractIFDocumentHandlerIFException - if an error occurs while handling this event
public void endDocument()
throws IFException
endDocument in interface IFDocumentHandlerendDocument in class AbstractBinaryWritingIFDocumentHandlerIFException - if an error occurs while handling this event
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 - if an error occurs while handling this event
public void endPageHeader()
throws IFException
endPageHeader in interface IFDocumentHandlerendPageHeader in class AbstractIFDocumentHandlerIFException - if an error occurs while handling this event
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 setBitmapEncodingQuality(float quality)
setBitmapEncodingQuality in interface AFPCustomizablequality - Defines the desired quality level.
Valid values: a value between 0.0f (lowest) and 1.0f (best, loss-less)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 void setLineWidthCorrection(float correction)
setLineWidthCorrection in interface AFPCustomizablecorrection - the line width multiplying factor correctionpublic int getResolution()
getResolution in interface AFPCustomizablepublic void setGOCAEnabled(boolean enabled)
setGOCAEnabled in interface AFPCustomizableenabled - true if GOCA is enabled, false if it is disabledpublic boolean isGOCAEnabled()
isGOCAEnabled in interface AFPCustomizablepublic void setStrokeGOCAText(boolean stroke)
setStrokeGOCAText in interface AFPCustomizablestroke - true to stroke, false to paint with text operators where possiblepublic boolean isStrokeGOCAText()
isStrokeGOCAText in interface AFPCustomizablepublic void setWrapPSeg(boolean pSeg)
setWrapPSeg in interface AFPCustomizablepSeg - true iff images should be wrappedpublic void setFS45(boolean fs45)
setFS45 in interface AFPCustomizablefs45 - true iff images should be FS45public boolean getWrapPSeg()
getWrapPSeg in interface AFPCustomizablepublic boolean getFS45()
getFS45 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 defaultspublic void canEmbedJpeg(boolean canEmbed)
canEmbedJpeg in interface AFPCustomizablecanEmbed - whether or not to embed JPEG image
|
fop 1.1 | |||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||