public class PDFTranscoder extends AbstractFOPTranscoder
This class enables to transcode an input to a PDF document.
Two transcoding hints (KEY_WIDTH and
KEY_HEIGHT) can be used to respectively specify the image
width and the image height. If only one of these keys is specified,
the transcoder preserves the aspect ratio of the original image.
The KEY_BACKGROUND_COLOR defines the background color
to use for opaque image formats, or the background color that may
be used for image formats that support alpha channel.
The KEY_AOI represents the area of interest to paint
in device space.
Three additional transcoding hints that act on the SVG processor can be specified:
KEY_LANGUAGE to set the default language to use (may be
used by a <switch> SVG element for example),
KEY_USER_STYLESHEET_URI to fix the URI of a user
stylesheet, and KEY_PIXEL_TO_MM to specify the pixel to
millimeter conversion factor.
KEY_AUTO_FONTS to disable the auto-detection of fonts installed in the system.
The PDF Transcoder cannot use AWT's font subsystem and that's why the fonts have to be
configured differently. By default, font auto-detection is enabled to match the behaviour
of the other transcoders, but this may be associated with a price in the form of a small
performance penalty. If font auto-detection is not desired, it can be disable using this key.
This work was authored by Keiron Liddle (keiron@aftexsw.com).
AbstractFOPTranscoder.FOPErrorHandler, AbstractFOPTranscoder.FOPTranscoderUserAgent| Modifier and Type | Field and Description |
|---|---|
protected PDFDocumentGraphics2D |
graphics
Graphics2D instance that is used to paint to
|
KEY_AUTO_FONTS, KEY_DEVICE_RESOLUTION, KEY_STROKE_TEXT, VALUE_FORMAT_OFF, VALUE_FORMAT_ONbuilder, ctx, curAOI, curTxf, DEFAULT_ALLOWED_SCRIPT_TYPES, DEFAULT_DEFAULT_FONT_FAMILY, height, KEY_ALLOW_EXTERNAL_RESOURCES, KEY_ALLOWED_SCRIPT_TYPES, KEY_ALTERNATE_STYLESHEET, KEY_AOI, KEY_CONSTRAIN_SCRIPT_ORIGIN, KEY_DEFAULT_FONT_FAMILY, KEY_EXECUTE_ONLOAD, KEY_HEIGHT, KEY_LANGUAGE, KEY_MAX_HEIGHT, KEY_MAX_WIDTH, KEY_MEDIA, KEY_PIXEL_TO_MM, KEY_PIXEL_UNIT_TO_MILLIMETER, KEY_SNAPSHOT_TIME, KEY_USER_STYLESHEET_URI, KEY_WIDTH, root, userAgent, width| Constructor and Description |
|---|
PDFTranscoder()
Constructs a new
PDFTranscoder. |
| Modifier and Type | Method and Description |
|---|---|
protected org.apache.batik.bridge.BridgeContext |
createBridgeContext() |
org.apache.batik.bridge.BridgeContext |
createBridgeContext(String version) |
protected AbstractFOPTranscoder.FOPTranscoderUserAgent |
createUserAgent()
Creates and returns the default user agent for this transcoder.
|
protected void |
transcode(Document document,
String uri,
org.apache.batik.transcoder.TranscoderOutput output)
Transcodes the specified Document as an image in the specified output.
|
configure, createDocumentFactory, getAutoFontsDefault, getDeviceResolution, getEffectiveConfiguration, getImageManager, getImageSessionContext, getLogger, isTextStroked, setEntityResolver, setLogger, setupImageInfrastructurecreateBridgeContext, getCanvasGraphicsNode, setImageSize, transcodeaddTranscodingHint, getErrorHandler, getTranscodingHints, removeTranscodingHint, setErrorHandler, setTranscodingHints, setTranscodingHintsprotected PDFDocumentGraphics2D graphics
public PDFTranscoder()
PDFTranscoder.protected AbstractFOPTranscoder.FOPTranscoderUserAgent createUserAgent()
createUserAgent in class AbstractFOPTranscoderprotected void transcode(Document document, String uri, org.apache.batik.transcoder.TranscoderOutput output) throws org.apache.batik.transcoder.TranscoderException
transcode in class org.apache.batik.transcoder.SVGAbstractTranscoderdocument - the document to transcodeuri - the uri of the document or null if anyoutput - the ouput where to transcodeorg.apache.batik.transcoder.TranscoderException - if an error occured while transcodingprotected org.apache.batik.bridge.BridgeContext createBridgeContext()
createBridgeContext in class org.apache.batik.transcoder.SVGAbstractTranscoderpublic org.apache.batik.bridge.BridgeContext createBridgeContext(String version)
createBridgeContext in class org.apache.batik.transcoder.SVGAbstractTranscoderCopyright © 2023 Apache Software Foundation. All rights reserved.