public class AFPDocumentHandler extends AbstractBinaryWritingIFDocumentHandler implements AFPCustomizable
IFDocumentHandler
implementation that produces AFP
(MO:DCA).fontInfo, outputStream
Constructor and Description |
---|
AFPDocumentHandler(IFContext context)
Default constructor.
|
Modifier and Type | Method and Description |
---|---|
java.lang.String |
cacheRoundedCorner(java.lang.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 corner
|
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.
|
java.lang.String |
getCachedRoundedCorner(java.lang.String cornerKey)
This method returns the an id that identifies a cached corner or null if non existent
|
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 |
setDefaultResourceGroupUri(java.net.URI uri)
Sets the default resource group URI
|
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.
|
getFontInfo, setFontInfo, setResult
endDocumentTrailer, endPageTrailer, getContext, getDocumentNavigationHandler, getStructureTreeEventHandler, getUserAgent, setDocumentLocale, startDocumentTrailer, startPageTrailer
public AFPDocumentHandler(IFContext context)
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 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 IFDocumentHandler
startDocumentHeader
in class AbstractIFDocumentHandler
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 objectIFException
- if an error occurs while handling this eventpublic java.lang.String cacheRoundedCorner(java.lang.String cornerKey)
cornerKey
- caller's identifier for the cornerpublic java.lang.String getCachedRoundedCorner(java.lang.String cornerKey)
cornerKey
- caller's identifier for the cornerpublic 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 setBitmapEncodingQuality(float quality)
setBitmapEncodingQuality
in interface AFPCustomizable
quality
- 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 AFPCustomizable
shadingMode
- the shading modepublic void setResolution(int resolution)
setResolution
in interface AFPCustomizable
resolution
- the output resolution (dpi)public void setLineWidthCorrection(float correction)
setLineWidthCorrection
in interface AFPCustomizable
correction
- the line width multiplying factor correctionpublic int getResolution()
getResolution
in interface AFPCustomizable
public void setGOCAEnabled(boolean enabled)
setGOCAEnabled
in interface AFPCustomizable
enabled
- true if GOCA is enabled, false if it is disabledpublic boolean isGOCAEnabled()
isGOCAEnabled
in interface AFPCustomizable
public void setStrokeGOCAText(boolean stroke)
setStrokeGOCAText
in interface AFPCustomizable
stroke
- true to stroke, false to paint with text operators where possiblepublic boolean isStrokeGOCAText()
isStrokeGOCAText
in interface AFPCustomizable
public void setWrapPSeg(boolean pSeg)
setWrapPSeg
in interface AFPCustomizable
pSeg
- true iff images should be wrappedpublic void setFS45(boolean fs45)
setFS45
in interface AFPCustomizable
fs45
- true iff images should be FS45public boolean getWrapPSeg()
getWrapPSeg
in interface AFPCustomizable
public boolean getFS45()
getFS45
in interface AFPCustomizable
public void setDefaultResourceGroupUri(java.net.URI uri)
AFPCustomizable
setDefaultResourceGroupUri
in interface AFPCustomizable
uri
- the default resource group URIpublic void setResourceLevelDefaults(AFPResourceLevelDefaults defaults)
setResourceLevelDefaults
in interface AFPCustomizable
defaults
- the resource level defaultspublic void canEmbedJpeg(boolean canEmbed)
canEmbedJpeg
in interface AFPCustomizable
canEmbed
- whether or not to embed JPEG imageCopyright 1999-2017 The Apache Software Foundation. All Rights Reserved.