fop 1.0

org.apache.fop.render.ps
Class AbstractPSTranscoder

java.lang.Object
  extended by org.apache.batik.transcoder.TranscoderSupport
      extended by org.apache.batik.transcoder.AbstractTranscoder
          extended by org.apache.batik.transcoder.XMLAbstractTranscoder
              extended by org.apache.batik.transcoder.SVGAbstractTranscoder
                  extended by org.apache.fop.svg.AbstractFOPTranscoder
                      extended by org.apache.fop.render.ps.AbstractPSTranscoder
All Implemented Interfaces:
org.apache.batik.transcoder.Transcoder
Direct Known Subclasses:
EPSTranscoder, PSTranscoder

public abstract class AbstractPSTranscoder
extends AbstractFOPTranscoder

This class enables to transcode an input to a PostScript 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.

Version:
$Id: AbstractPSTranscoder.java 820689 2009-10-01 15:36:10Z jeremias $
Author:
Keiron Liddle

Nested Class Summary
 
Nested classes/interfaces inherited from class org.apache.fop.svg.AbstractFOPTranscoder
AbstractFOPTranscoder.FOPErrorHandler, AbstractFOPTranscoder.FOPTranscoderUserAgent
 
Nested classes/interfaces inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
org.apache.batik.transcoder.SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent
 
Field Summary
protected  org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D graphics
          the root Graphics2D instance for generating PostScript
 
Fields inherited from class org.apache.fop.svg.AbstractFOPTranscoder
KEY_AUTO_FONTS, KEY_DEVICE_RESOLUTION, KEY_STROKE_TEXT, userAgent, VALUE_FORMAT_OFF, VALUE_FORMAT_ON
 
Fields inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
builder, ctx, curAOI, curTxf, DEFAULT_ALLOWED_SCRIPT_TYPES, DEFAULT_DEFAULT_FONT_FAMILY, height, 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, width
 
Fields inherited from class org.apache.batik.transcoder.XMLAbstractTranscoder
KEY_DOCUMENT_ELEMENT, KEY_DOCUMENT_ELEMENT_NAMESPACE_URI, KEY_DOM_IMPLEMENTATION, KEY_XML_PARSER_CLASSNAME, KEY_XML_PARSER_VALIDATING
 
Fields inherited from class org.apache.batik.transcoder.TranscoderSupport
handler, hints
 
Constructor Summary
AbstractPSTranscoder()
          Constructs a new AbstractPSTranscoder.
 
Method Summary
protected  org.apache.batik.bridge.BridgeContext createBridgeContext()
          
 org.apache.batik.bridge.BridgeContext createBridgeContext(java.lang.String version)
          
protected abstract  org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D createDocumentGraphics2D()
          Creates the root Graphics2D instance for generating PostScript.
protected  boolean getAutoFontsDefault()
          Returns the default value for the KEY_AUTO_FONTS value.
protected  void transcode(org.w3c.dom.Document document, java.lang.String uri, org.apache.batik.transcoder.TranscoderOutput output)
          Transcodes the specified Document as an image in the specified output.
 
Methods inherited from class org.apache.fop.svg.AbstractFOPTranscoder
configure, createDocumentFactory, createUserAgent, getDeviceResolution, getEffectiveConfiguration, getImageManager, getImageSessionContext, getLogger, isTextStroked, setEntityResolver, setLogger, setupImageInfrastructure
 
Methods inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
createBridgeContext, getCanvasGraphicsNode, setImageSize, transcode
 
Methods inherited from class org.apache.batik.transcoder.TranscoderSupport
addTranscodingHint, getErrorHandler, getTranscodingHints, removeTranscodingHint, setErrorHandler, setTranscodingHints, setTranscodingHints
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface org.apache.batik.transcoder.Transcoder
addTranscodingHint, getErrorHandler, getTranscodingHints, removeTranscodingHint, setErrorHandler, setTranscodingHints, setTranscodingHints
 

Field Detail

graphics

protected org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D graphics
the root Graphics2D instance for generating PostScript

Constructor Detail

AbstractPSTranscoder

public AbstractPSTranscoder()
Constructs a new AbstractPSTranscoder.

Method Detail

createDocumentGraphics2D

protected abstract org.apache.xmlgraphics.java2d.ps.AbstractPSDocumentGraphics2D createDocumentGraphics2D()
Creates the root Graphics2D instance for generating PostScript.

Returns:
the root Graphics2D

getAutoFontsDefault

protected boolean getAutoFontsDefault()
Returns the default value for the KEY_AUTO_FONTS value.

Overrides:
getAutoFontsDefault in class AbstractFOPTranscoder
Returns:
the default value

transcode

protected void transcode(org.w3c.dom.Document document,
                         java.lang.String uri,
                         org.apache.batik.transcoder.TranscoderOutput output)
                  throws org.apache.batik.transcoder.TranscoderException
Transcodes the specified Document as an image in the specified output.

Overrides:
transcode in class org.apache.batik.transcoder.SVGAbstractTranscoder
Parameters:
document - the document to transcode
uri - the uri of the document or null if any
output - the ouput where to transcode
Throws:
org.apache.batik.transcoder.TranscoderException - if an error occured while transcoding

createBridgeContext

protected org.apache.batik.bridge.BridgeContext createBridgeContext()

Overrides:
createBridgeContext in class org.apache.batik.transcoder.SVGAbstractTranscoder

createBridgeContext

public org.apache.batik.bridge.BridgeContext createBridgeContext(java.lang.String version)

Overrides:
createBridgeContext in class org.apache.batik.transcoder.SVGAbstractTranscoder

fop 1.0

Copyright 1999-2010 The Apache Software Foundation. All Rights Reserved.