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
-
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 cornervoid
canEmbedJpeg
(boolean canEmbed) Sets whether or not to JPEG images can be embedded in the AFP document.void
Indicates the end of a document.void
Indicates the end of the document header.void
endPage()
Indicates the end of a pagevoid
Indicates the end of the page content.void
Indicates the end of the page header.void
Indicates 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.boolean
getFS45()
gets whether images should be FS45Returns the MIME type of the output format that is generated by this implementation.int
Returns the output/device resolution.boolean
gets whether FS11 and FS45 non-inline images should be wrapped in a page segmentvoid
handleExtensionObject
(Object extension) Handles an extension object.boolean
Indicates whether GOCA is enabled or disabled.boolean
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 pixelvoid
setCMYKImagesSupported
(boolean value) Controls whether CMYK images (IOCA FS45) are enabled.void
setColorImages
(boolean colorImages) Sets whether images are color or notvoid
setDefaultFontInfo
(FontInfo fontInfo) Sets the default font set (with no custom configuration).void
Sets the default resource group URIvoid
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 FS45void
setGOCAEnabled
(boolean enabled) Controls whether GOCA is enabled or disabled.void
setLineWidthCorrection
(float correction) Sets the line width correctionvoid
setNativeImagesSupported
(boolean nativeImages) Sets whether images are supported natively or notvoid
setResolution
(int resolution) Sets the output/device resolutionvoid
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
setWrapGocaPSeg
(boolean pSeg) void
setWrapPSeg
(boolean pSeg) Sets whether FS11 and FS45 non-inline images should be wrapped in a page segmentvoid
Indicates the start of a document.void
Indicates the start of the document header.void
Indicates the start of a new page.Indicates the start of the page content.void
Indicates the start of the page header.void
Indicates the start of a new page sequence.boolean
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, 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:
supportsPagesOutOfOrder
in 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:
getMimeType
in interfaceIFDocumentHandler
- Returns:
- the MIME type
-
getConfigurator
Returns the configurator for this document handler, if any.- Specified by:
getConfigurator
in interfaceIFDocumentHandler
- Returns:
- the configurator or null if there's no configurator
-
setDefaultFontInfo
Sets the default font set (with no custom configuration).- Specified by:
setDefaultFontInfo
in interfaceIFDocumentHandler
- Overrides:
setDefaultFontInfo
in 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:
startDocument
in interfaceIFDocumentHandler
- Overrides:
startDocument
in 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:
startDocumentHeader
in interfaceIFDocumentHandler
- Overrides:
startDocumentHeader
in 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:
endDocumentHeader
in interfaceIFDocumentHandler
- Overrides:
endDocumentHeader
in 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:
endDocument
in interfaceIFDocumentHandler
- Overrides:
endDocument
in classAbstractBinaryWritingIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageSequence
Indicates the start of a new page sequence.- Specified by:
startPageSequence
in 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:
endPageSequence
in 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:
startPage
in 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:
startPageHeader
in interfaceIFDocumentHandler
- Overrides:
startPageHeader
in classAbstractIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endPageHeader
Indicates the end of the page header.- Specified by:
endPageHeader
in interfaceIFDocumentHandler
- Overrides:
endPageHeader
in classAbstractIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
startPageContent
Indicates the start of the page content. The method returns anIFPainter
interface which is used to paint the page contents.- Specified by:
startPageContent
in 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 theIFPainter
returned by the respectiveIFDocumentHandler.startPageContent()
method are illegal.- Specified by:
endPageContent
in interfaceIFDocumentHandler
- Throws:
IFException
- if an error occurs while handling this event
-
endPage
Indicates the end of a page- Specified by:
endPage
in 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:
handleExtensionObject
in 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:
setBitsPerPixel
in interfaceAFPCustomizable
- Parameters:
bitsPerPixel
- number of bits per pixel
-
setColorImages
public void setColorImages(boolean colorImages) Sets whether images are color or not- Specified by:
setColorImages
in interfaceAFPCustomizable
- Parameters:
colorImages
- color image output
-
setNativeImagesSupported
public void setNativeImagesSupported(boolean nativeImages) Sets whether images are supported natively or not- Specified by:
setNativeImagesSupported
in 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:
setCMYKImagesSupported
in 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:
setDitheringQuality
in 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:
setBitmapEncodingQuality
in 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:
setShadingMode
in interfaceAFPCustomizable
- Parameters:
shadingMode
- the shading mode
-
setResolution
public void setResolution(int resolution) Sets the output/device resolution- Specified by:
setResolution
in interfaceAFPCustomizable
- Parameters:
resolution
- the output resolution (dpi)
-
setLineWidthCorrection
public void setLineWidthCorrection(float correction) Sets the line width correction- Specified by:
setLineWidthCorrection
in interfaceAFPCustomizable
- Parameters:
correction
- the line width multiplying factor correction
-
getResolution
public int getResolution()Returns the output/device resolution.- Specified by:
getResolution
in interfaceAFPCustomizable
- Returns:
- the resolution in dpi
-
setGOCAEnabled
public void setGOCAEnabled(boolean enabled) Controls whether GOCA is enabled or disabled.- Specified by:
setGOCAEnabled
in 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:
isGOCAEnabled
in 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:
setStrokeGOCAText
in 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:
isStrokeGOCAText
in 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:
setWrapPSeg
in 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:
setFS45
in interfaceAFPCustomizable
- Parameters:
fs45
- true iff images should be FS45
-
getWrapPSeg
public boolean getWrapPSeg()gets whether FS11 and FS45 non-inline images should be wrapped in a page segment- Specified by:
getWrapPSeg
in interfaceAFPCustomizable
- Returns:
- true iff images should be wrapped
-
getFS45
public boolean getFS45()gets whether images should be FS45- Specified by:
getFS45
in interfaceAFPCustomizable
- Returns:
- true iff images should be FS45
-
setDefaultResourceGroupUri
Description copied from interface:AFPCustomizable
Sets the default resource group URI- Specified by:
setDefaultResourceGroupUri
in 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:
setResourceLevelDefaults
in 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:
canEmbedJpeg
in interfaceAFPCustomizable
- Parameters:
canEmbed
- whether or not to embed JPEG image
-