Package org.apache.fop.render.afp
Class AFPDocumentHandler
java.lang.Object
org.apache.fop.render.intermediate.AbstractIFDocumentHandler
org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
org.apache.fop.render.afp.AFPDocumentHandler
- All Implemented Interfaces:
AFPCustomizable,IFDocumentHandler
public class AFPDocumentHandler
extends AbstractBinaryWritingIFDocumentHandler
implements AFPCustomizable
IFDocumentHandler implementation that produces AFP
(MO:DCA).-
Field Summary
Fields inherited from class org.apache.fop.render.intermediate.AbstractBinaryWritingIFDocumentHandler
fontInfo, outputStream -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncacheRoundedCorner(String cornerKey) Corner images can be reused by storing at the document level in the AFP The cache is used to map cahced images to caller generated descriptions of the cornervoidcanEmbedJpeg(boolean canEmbed) Sets whether or not to JPEG images can be embedded in the AFP document.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 the page header.voidIndicates the end of a page sequence.getCachedRoundedCorner(String cornerKey) This method returns the an id that identifies a cached corner or null if non existentReturns the configurator for this document handler, if any.booleangetFS45()gets whether images should be FS45Returns the MIME type of the output format that is generated by this implementation.intReturns the output/device resolution.booleangets whether FS11 and FS45 non-inline images should be wrapped in a page segmentvoidhandleExtensionObject(Object extension) Handles an extension object.booleanIndicates whether GOCA is enabled or disabled.booleanIndicates whether to stroke text in GOCA mode or to use text operators where possible.voidsetBitmapEncodingQuality(float quality) Sets the image encoding quality setting to use when encoding bitmap images.voidsetBitsPerPixel(int bitsPerPixel) Sets the number of bits used per pixelvoidsetCMYKImagesSupported(boolean value) Controls whether CMYK images (IOCA FS45) are enabled.voidsetColorImages(boolean colorImages) Sets whether images are color or notvoidsetDefaultFontInfo(FontInfo fontInfo) Sets the default font set (with no custom configuration).voidSets the default resource group URIvoidsetDitheringQuality(float quality) Sets the dithering quality setting to use when converting images to monochrome images.voidsetFS45(boolean fs45) set true if images should be FS45voidsetGOCAEnabled(boolean enabled) Controls whether GOCA is enabled or disabled.voidsetLineWidthCorrection(float correction) Sets the line width correctionvoidsetMaskEnabled(boolean maskEnabled) voidsetNativeImagesSupported(boolean nativeImages) Sets whether images are supported natively or notvoidsetResolution(int resolution) Sets the output/device resolutionvoidSets the resource level defaults.voidsetShadingMode(AFPShadingMode shadingMode) Sets the shading mode for painting filled rectangles.voidsetStrokeGOCAText(boolean stroke) Controls whether to stroke text in GOCA mode or to use text operators where possible.voidsetWrapGocaPSeg(boolean pSeg) voidsetWrapPSeg(boolean pSeg) Sets whether FS11 and FS45 non-inline images should be wrapped in a page segmentvoidIndicates the start of a document.voidIndicates the start of the document header.voidIndicates the start of a new page.Indicates the start of the page content.voidIndicates the start of the page header.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, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentTrailer, startPageTrailer
-
Constructor Details
-
AFPDocumentHandler
Default constructor.
-
-
Method Details
-
supportsPagesOutOfOrder
public boolean supportsPagesOutOfOrder()Indicates whether the painter supports to handle the pages in mixed order rather than ascending order.- Specified by:
supportsPagesOutOfOrderin interfaceIFDocumentHandler- Returns:
- true if out-of-order handling is supported
-
getMimeType
Returns the MIME type of the output format that is generated by this implementation.- Specified by:
getMimeTypein interfaceIFDocumentHandler- Returns:
- the MIME type
-
getConfigurator
Returns the configurator for this document handler, if any.- Specified by:
getConfiguratorin interfaceIFDocumentHandler- Returns:
- the configurator or null if there's no configurator
-
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
-
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
-
startDocumentHeader
Indicates the start of the document header. This method is called right after theIFDocumentHandler.startDocument()method. Extensions sent to this painter betweenIFDocumentHandler.startDocumentHeader()andIFDocumentHandler.endDocumentHeader()apply to the document as a whole (like document metadata).- Specified by:
startDocumentHeaderin interfaceIFDocumentHandler- Overrides:
startDocumentHeaderin classAbstractIFDocumentHandler- 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.- Specified by:
startPageSequencein interfaceIFDocumentHandler- 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.- Specified by:
endPageSequencein interfaceIFDocumentHandler- 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.- Specified by:
startPagein interfaceIFDocumentHandler- 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
-
startPageHeader
Indicates the start of the page header.- Specified by:
startPageHeaderin interfaceIFDocumentHandler- Overrides:
startPageHeaderin classAbstractIFDocumentHandler- Throws:
IFException- if an error occurs while handling this event
-
endPageHeader
Indicates the end of the page header.- Specified by:
endPageHeaderin interfaceIFDocumentHandler- Overrides:
endPageHeaderin classAbstractIFDocumentHandler- 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.- Specified by:
startPageContentin interfaceIFDocumentHandler- Returns:
- the IFPainter for the page content
- Throws:
IFException- if an error occurs while handling this event
-
endPageContent
Indicates the end of the page content. Calls to theIFPainterreturned by the respectiveIFDocumentHandler.startPageContent()method are illegal.- Specified by:
endPageContentin interfaceIFDocumentHandler- Throws:
IFException- if an error occurs while handling this event
-
endPage
Indicates the end of a page- Specified by:
endPagein interfaceIFDocumentHandler- 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.- Specified by:
handleExtensionObjectin interfaceIFDocumentHandler- Parameters:
extension- the extension object- Throws:
IFException- if an error occurs while handling this event
-
cacheRoundedCorner
Corner images can be reused by storing at the document level in the AFP The cache is used to map cahced images to caller generated descriptions of the corner- Parameters:
cornerKey- caller's identifier for the corner- Returns:
- document id of the corner image
-
getCachedRoundedCorner
This method returns the an id that identifies a cached corner or null if non existent- Parameters:
cornerKey- caller's identifier for the corner- Returns:
- document id of the corner image
-
setBitsPerPixel
public void setBitsPerPixel(int bitsPerPixel) Sets the number of bits used per pixel- Specified by:
setBitsPerPixelin interfaceAFPCustomizable- Parameters:
bitsPerPixel- number of bits per pixel
-
setColorImages
public void setColorImages(boolean colorImages) Sets whether images are color or not- Specified by:
setColorImagesin interfaceAFPCustomizable- Parameters:
colorImages- color image output
-
setNativeImagesSupported
public void setNativeImagesSupported(boolean nativeImages) Sets whether images are supported natively or not- Specified by:
setNativeImagesSupportedin interfaceAFPCustomizable- Parameters:
nativeImages- native image support
-
setCMYKImagesSupported
public 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.- Specified by:
setCMYKImagesSupportedin interfaceAFPCustomizable- Parameters:
value- true to enabled CMYK images
-
setDitheringQuality
public void setDitheringQuality(float quality) Sets the dithering quality setting to use when converting images to monochrome images.- Specified by:
setDitheringQualityin interfaceAFPCustomizable- Parameters:
quality- Defines the desired quality level for the conversion. Valid values: a value between 0.0f (fastest) and 1.0f (best)
-
setBitmapEncodingQuality
public void setBitmapEncodingQuality(float quality) Sets the image encoding quality setting to use when encoding bitmap images. The default setting is 1.0 which means loss-less encoding. Settings of less than 1.0 allow loss-less encoding schemes like JPEG. The value serves as quality setting for the encoders in that case.- Specified by:
setBitmapEncodingQualityin interfaceAFPCustomizable- Parameters:
quality- Defines the desired quality level. Valid values: a value between 0.0f (lowest) and 1.0f (best, loss-less)
-
setShadingMode
Sets the shading mode for painting filled rectangles.- Specified by:
setShadingModein interfaceAFPCustomizable- Parameters:
shadingMode- the shading mode
-
setResolution
public void setResolution(int resolution) Sets the output/device resolution- Specified by:
setResolutionin interfaceAFPCustomizable- Parameters:
resolution- the output resolution (dpi)
-
setLineWidthCorrection
public void setLineWidthCorrection(float correction) Sets the line width correction- Specified by:
setLineWidthCorrectionin interfaceAFPCustomizable- Parameters:
correction- the line width multiplying factor correction
-
getResolution
public int getResolution()Returns the output/device resolution.- Specified by:
getResolutionin interfaceAFPCustomizable- Returns:
- the resolution in dpi
-
setGOCAEnabled
public void setGOCAEnabled(boolean enabled) Controls whether GOCA is enabled or disabled.- Specified by:
setGOCAEnabledin interfaceAFPCustomizable- Parameters:
enabled- true if GOCA is enabled, false if it is disabled
-
isGOCAEnabled
public boolean isGOCAEnabled()Indicates whether GOCA is enabled or disabled.- Specified by:
isGOCAEnabledin interfaceAFPCustomizable- Returns:
- true if GOCA is enabled, false if GOCA is disabled
-
setStrokeGOCAText
public void setStrokeGOCAText(boolean stroke) Controls whether to stroke text in GOCA mode or to use text operators where possible.- Specified by:
setStrokeGOCATextin interfaceAFPCustomizable- Parameters:
stroke- true to stroke, false to paint with text operators where possible
-
isStrokeGOCAText
public boolean isStrokeGOCAText()Indicates whether to stroke text in GOCA mode or to use text operators where possible.- Specified by:
isStrokeGOCATextin interfaceAFPCustomizable- Returns:
- true to stroke, false to paint with text operators where possible
-
setWrapPSeg
public void setWrapPSeg(boolean pSeg) Sets whether FS11 and FS45 non-inline images should be wrapped in a page segment- Specified by:
setWrapPSegin interfaceAFPCustomizable- Parameters:
pSeg- true iff images should be wrapped
-
setWrapGocaPSeg
public void setWrapGocaPSeg(boolean pSeg) -
setFS45
public void setFS45(boolean fs45) set true if images should be FS45- Specified by:
setFS45in interfaceAFPCustomizable- Parameters:
fs45- true iff images should be FS45
-
setMaskEnabled
public void setMaskEnabled(boolean maskEnabled) -
getWrapPSeg
public boolean getWrapPSeg()gets whether FS11 and FS45 non-inline images should be wrapped in a page segment- Specified by:
getWrapPSegin interfaceAFPCustomizable- Returns:
- true iff images should be wrapped
-
getFS45
public boolean getFS45()gets whether images should be FS45- Specified by:
getFS45in interfaceAFPCustomizable- Returns:
- true iff images should be FS45
-
setDefaultResourceGroupUri
Description copied from interface:AFPCustomizableSets the default resource group URI- Specified by:
setDefaultResourceGroupUriin interfaceAFPCustomizable- Parameters:
uri- the default resource group URI
-
setResourceLevelDefaults
Sets the resource level defaults. The object passed in provides information which resource level shall be used by default for various kinds of resources.- Specified by:
setResourceLevelDefaultsin interfaceAFPCustomizable- Parameters:
defaults- the resource level defaults
-
canEmbedJpeg
public void canEmbedJpeg(boolean canEmbed) Sets whether or not to JPEG images can be embedded in the AFP document.- Specified by:
canEmbedJpegin interfaceAFPCustomizable- Parameters:
canEmbed- whether or not to embed JPEG image
-