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. * * @author Keiron Liddle * @version $Id$ */ public class PDFTranscoder extends AbstractFOPTranscoder implements Configurable { /** * The key is used to specify the resolution for on-the-fly images generated * due to complex effects like gradients and filters. */ public static final TranscodingHints.Key KEY_DEVICE_RESOLUTION = new FloatKey(); /** * The key is used to specify whether the available fonts should be automatically * detected. The alternative is to configure the transcoder manually using a configuration * file. */ public static final TranscodingHints.Key KEY_AUTO_FONTS = new BooleanKey(); private Configuration cfg = null; /** Graphics2D instance that is used to paint to */ protected PDFDocumentGraphics2D graphics = null; /** * Constructs a new PDFTranscoder. */ public PDFTranscoder() { super(); this.handler = new FOPErrorHandler(); } /** * {@inheritDoc} */ protected UserAgent createUserAgent() { return new AbstractFOPTranscoder.FOPTranscoderUserAgent() { // The PDF stuff wants everything at 72dpi public float getPixelUnitToMillimeter() { return super.getPixelUnitToMillimeter(); //return 25.4f / 72; //72dpi = 0.352778f; } }; } /** {@inheritDoc} */ public void configure(Configuration cfg) throws ConfigurationException { this.cfg = cfg; } /** * Transcodes the specified Document as an image in the specified output. * * @param document the document to transcode * @param uri the uri of the document or null if any * @param output the ouput where to transcode * @exception TranscoderException if an error occured while transcoding */ protected void transcode(Document document, String uri, TranscoderOutput output) throws TranscoderException { graphics = new PDFDocumentGraphics2D(isTextStroked()); graphics.getPDFDocument().getInfo().setProducer("Apache FOP Version " + Version.getVersion() + ": PDF Transcoder for Batik"); try { Configuration effCfg = this.cfg; if (effCfg == null) { //By default, enable font auto-detection if no cfg is given boolean autoFonts = true; if (hints.containsKey(KEY_AUTO_FONTS)) { autoFonts = ((Boolean)hints.get(KEY_AUTO_FONTS)).booleanValue(); } if (autoFonts) { DefaultConfiguration c = new DefaultConfiguration("pdf-transcoder"); DefaultConfiguration fonts = new DefaultConfiguration("fonts"); c.addChild(fonts); DefaultConfiguration autodetect = new DefaultConfiguration("auto-detect"); fonts.addChild(autodetect); effCfg = c; } } if (effCfg != null) { PDFDocumentGraphics2DConfigurator configurator = new PDFDocumentGraphics2DConfigurator(); configurator.configure(graphics, effCfg); } else { graphics.setupDefaultFontInfo(); } } catch (Exception e) { throw new TranscoderException( "Error while setting up PDFDocumentGraphics2D", e); } super.transcode(document, uri, output); if (getLogger().isTraceEnabled()) { getLogger().trace("document size: " + width + " x " + height); } // prepare the image to be painted UnitProcessor.Context uctx = UnitProcessor.createContext(ctx, document.getDocumentElement()); float widthInPt = UnitProcessor.userSpaceToSVG(width, SVGLength.SVG_LENGTHTYPE_PT, UnitProcessor.HORIZONTAL_LENGTH, uctx); int w = (int)(widthInPt + 0.5); float heightInPt = UnitProcessor.userSpaceToSVG(height, SVGLength.SVG_LENGTHTYPE_PT, UnitProcessor.HORIZONTAL_LENGTH, uctx); int h = (int)(heightInPt + 0.5); if (getLogger().isTraceEnabled()) { getLogger().trace("document size: " + w + "pt x " + h + "pt"); } // prepare the image to be painted //int w = (int)(width + 0.5); //int h = (int)(height + 0.5); try { if (hints.containsKey(KEY_DEVICE_RESOLUTION)) { graphics.setDeviceDPI(((Float)hints.get(KEY_DEVICE_RESOLUTION)).floatValue()); } graphics.setupDocument(output.getOutputStream(), w, h); graphics.setSVGDimension(width, height); if (hints.containsKey(ImageTranscoder.KEY_BACKGROUND_COLOR)) { graphics.setBackgroundColor ((Color)hints.get(ImageTranscoder.KEY_BACKGROUND_COLOR)); } graphics.setGraphicContext (new org.apache.xmlgraphics.java2d.GraphicContext()); graphics.preparePainting(); graphics.transform(curTxf); graphics.setRenderingHint (RenderingHintsKeyExt.KEY_TRANSCODING, RenderingHintsKeyExt.VALUE_TRANSCODING_VECTOR); this.root.paint(graphics); graphics.finish(); } catch (IOException ex) { throw new TranscoderException(ex); } } /** {@inheritDoc} */ protected BridgeContext createBridgeContext() { //For compatibility with Batik 1.6 return createBridgeContext("1.x"); } /** {@inheritDoc} */ public BridgeContext createBridgeContext(String version) { FontInfo fontInfo = graphics.getFontInfo(); if (isTextStroked()) { fontInfo = null; } BridgeContext ctx = new PDFBridgeContext(userAgent, fontInfo); return ctx; } }