org.apache.batik.transcoder
public abstract class SVGAbstractTranscoder extends XMLAbstractTranscoder
Nested Class Summary | |
---|---|
protected class | SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent
A user agent implementation for PrintTranscoder. |
Field Summary | |
---|---|
protected GVTBuilder | builder
Current gvt builder |
protected BridgeContext | ctx
Current bridge context |
protected Rectangle2D | curAOI
Current area of interest. |
protected AffineTransform | curTxf
Transform needed to render the current area of interest |
static String | DEFAULT_ALLOWED_SCRIPT_TYPES
Default value for the KEY_ALLOWED_SCRIPT_TYPES key |
static String | DEFAULT_DEFAULT_FONT_FAMILY
Value used as a default for the default font-family hint |
protected float | height
Image's width and height (init to 400x400). |
static TranscodingHints.Key | KEY_ALLOWED_SCRIPT_TYPES
The set of supported script languages (i.e., the set of possible
values for the <script> tag's type attribute).
|
static TranscodingHints.Key | KEY_ALTERNATE_STYLESHEET
The alternate stylesheet key.
|
static TranscodingHints.Key | KEY_AOI
The area of interest key.
|
static TranscodingHints.Key | KEY_CONSTRAIN_SCRIPT_ORIGIN
Controls whether or not scripts can only be loaded from the
same location as the document which references them.
|
static TranscodingHints.Key | KEY_DEFAULT_FONT_FAMILY
The default font-family key.
|
static TranscodingHints.Key | KEY_EXECUTE_ONLOAD
The 'onload' execution key.
|
static TranscodingHints.Key | KEY_HEIGHT
The image height key.
|
static TranscodingHints.Key | KEY_LANGUAGE
The language key.
|
static TranscodingHints.Key | KEY_MAX_HEIGHT
The maximux height of the image key.
|
static TranscodingHints.Key | KEY_MAX_WIDTH
The maximum width of the image key.
|
static TranscodingHints.Key | KEY_MEDIA
The media key.
|
static TranscodingHints.Key | KEY_PIXEL_TO_MM
The pixel to millimeter conversion factor key. |
static TranscodingHints.Key | KEY_PIXEL_UNIT_TO_MILLIMETER
The number of millimeters in each pixel key.
|
static TranscodingHints.Key | KEY_SNAPSHOT_TIME
The snapshot time key.
|
static TranscodingHints.Key | KEY_USER_STYLESHEET_URI
The user stylesheet URI key.
|
static TranscodingHints.Key | KEY_WIDTH
The image width key.
|
protected GraphicsNode | root
Current GVT Tree, i.e., the GVT tree representing the page
being printed currently. |
protected UserAgent | userAgent The user agent dedicated to an SVG Transcoder. |
protected float | width
Image's width and height (init to 400x400). |
Constructor Summary | |
---|---|
protected | SVGAbstractTranscoder() |
Method Summary | |
---|---|
protected BridgeContext | createBridgeContext(SVGOMDocument doc)
Factory method for constructing an configuring a
BridgeContext so subclasses can insert new/modified
bridges in the context. |
protected BridgeContext | createBridgeContext()
Creates the default SVG 1.0/1.1 BridgeContext. |
protected BridgeContext | createBridgeContext(String svgVersion)
Creates the BridgeContext. |
protected DocumentFactory | createDocumentFactory(DOMImplementation domImpl, String parserClassname)
Creates a DocumentFactory that is used to create an SVG DOM
tree. |
protected UserAgent | createUserAgent() |
protected CanvasGraphicsNode | getCanvasGraphicsNode(GraphicsNode gn) |
protected void | setImageSize(float docWidth, float docHeight)
Sets document size according to the hints.
|
void | transcode(TranscoderInput input, TranscoderOutput output) |
protected void | transcode(Document document, String uri, TranscoderOutput output)
Transcodes the specified Document as an image in the specified output.
|
Key: |
KEY_ALLOWED_SCRIPT_TYPES |
---|---|
Value: |
String (Comma separated values) |
Default: |
text/ecmascript, application/java-archive |
Required: |
No |
Description: |
Specifies the allowed values for the type attribute in the <script> element. This is a comma separated list. The special value '*' means that all script types are allowed. |
Key: |
KEY_ALTERNATE_STYLESHEET |
---|---|
Value: |
String |
Default: |
null |
Required: |
No |
Description: |
Specify the alternate style sheet title. |
Key: |
KEY_AOI |
---|---|
Value: |
Rectangle2D |
Default: |
The document's size |
Required: |
No |
Description: |
Specify the area of interest to render. The rectangle coordinates must be specified in pixels and in the document coordinates system. |
Key: |
KEY_CONSTRAIN_SCRIPT_ORIGIN |
---|---|
Value: |
boolean |
Default: |
true |
Required: |
No |
Description: |
When set to true, script elements referencing files from a different origin (server) than the document containing the script element will not be loaded. When set to true, script elements may reference script files from any origin. |
Key: |
KEY_DEFAULT_FONT_FAMILY |
---|---|
Value: |
String |
Default: |
"Arial, Helvetica, sans-serif" |
Required: |
No |
Description: |
Controls the default value used by the CSS engine for the font-family property when that property is unspecified.Specify the media to use with CSS. |
Key: |
KEY_EXECUTE_ONLOAD |
---|---|
Value: |
Boolean |
Default: |
false |
Required: |
No |
Description: |
Specify if scripts added on the 'onload' event attribute must be invoked. |
Key: |
KEY_HEIGHT |
---|---|
Value: |
Float |
Default: |
The height of the top most svg element |
Required: |
No |
Description: |
Specify the height of the image to create. |
Key: |
KEY_LANGUAGE |
---|---|
Value: |
String |
Default: |
"en" |
Required: |
No |
Description: |
Specify the preferred language of the document. |
Key: |
KEY_MAX_HEIGHT |
---|---|
Value: |
Float |
Default: |
The height of the top most svg element |
Required: |
No |
Description: |
Specify the maximum height of the image to create. The value will set the maximum height of the image even when bigger height is specified in a document or set with KEY_HEIGHT. |
Key: |
KEY_MAX_WIDTH |
---|---|
Value: |
Float |
Default: |
The width of the top most svg element |
Required: |
No |
Description: |
Specify the maximum width of the image to create. The value will set the maximum width of the image even when bigger width is specified in a document or set with KEY_WIDTH. |
Key: |
KEY_MEDIA |
---|---|
Value: |
String |
Default: |
"screen" |
Required: |
No |
Description: |
Specify the media to use with CSS. |
Deprecated: As of Batik Version 1.5b3
The pixel to millimeter conversion factor key.See Also: Key: Value: Default: Required: Description:
KEY_PIXEL_TO_MM
Float
0.264583
No
Specify the size of a px CSS unit in millimeters.
Key: |
KEY_PIXEL_UNIT_TO_MILLIMETER |
---|---|
Value: |
Float |
Default: |
0.264583 |
Required: |
No |
Description: |
Specify the size of a px CSS unit in millimeters. |
Key: |
KEY_SNAPSHOT_TIME |
---|---|
Value: |
Float |
Default: |
0 |
Required: |
No |
Description: |
Specifies the document time to seek to before
rasterization. Only applies if KEY_EXECUTE_ONLOAD is
set to true . |
Key: |
KEY_USER_STYLESHEET_URI |
---|---|
Value: |
String |
Default: |
null |
Required: |
No |
Description: |
Specify the user style sheet. |
Key: |
KEY_WIDTH |
---|---|
Value: |
Float |
Default: |
The width of the top most svg element |
Required: |
No |
Description: |
Specify the width of the image to create. |
Parameters: doc the SVG document to create the BridgeContext for
Returns: the newly instantiated BridgeContext
Returns: the newly instantiated BridgeContext
See Also: createBridgeContext
Parameters: svgVersion the SVG version in use (ex. "1.0", "1.x" or "1.2")
Returns: the newly instantiated BridgeContext
Parameters: domImpl the DOM Implementation (not used) parserClassname the XML parser classname
Parameters: docWidth Width of the document. docHeight Height of the document.
Parameters: document the document to transcode uri the uri of the document or null if any output the ouput where to transcode
Throws: TranscoderException if an error occured while transcoding