Class TIFFTranscoder
- All Implemented Interfaces:
Transcoder
This class is an
ImageTranscoder
that produces a TIFF image.- Version:
- $Id: TIFFTranscoder.java 1810083 2017-09-29 10:39:45Z ssteiner $
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionstatic interface
This interface is used byTIFFTranscoder
to write TIFF images through different codecs.Nested classes/interfaces inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
SVGAbstractTranscoder.SVGAbstractTranscoderUserAgent
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final TranscodingHints.Key
The compression method for the image.static final TranscodingHints.Key
The forceTransparentWhite key.Fields inherited from class org.apache.batik.transcoder.image.ImageTranscoder
KEY_BACKGROUND_COLOR
Fields inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
builder, 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
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
Constructors -
Method Summary
Modifier and TypeMethodDescriptioncreateImage
(int width, int height) Creates a new ARGB image with the specified dimension.private TIFFTranscoder.WriteAdapter
getWriteAdapter
(String className) void
writeImage
(BufferedImage img, TranscoderOutput output) Writes the specified image to the specified output.Methods inherited from class org.apache.batik.transcoder.image.ImageTranscoder
createRenderer, forceTransparentWhite, transcode
Methods inherited from class org.apache.batik.transcoder.SVGAbstractTranscoder
createBridgeContext, createBridgeContext, createBridgeContext, createDocumentFactory, createUserAgent, 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 Details
-
KEY_FORCE_TRANSPARENT_WHITE
The forceTransparentWhite key.Key: KEY_FORCE_TRANSPARENT_WHITE Value: Boolean Default: false Required: No Description: It controls whether the encoder should force the image's fully transparent pixels to be fully transparent white instead of fully transparent black. This is useful when the encoded TIFF is displayed in a viewer which does not support TIFF transparency and lets the image display with a white background instead of a black background.
However, note that the modified image will display differently over a white background in a viewer that supports transparency. -
KEY_COMPRESSION_METHOD
The compression method for the image.Key: KEY_COMPRESSION_METHOD Value: String ("none", "packbits", "jpeg" etc.) Default: "none" (no compression) Required: Recommended Description: Specify the compression method used to encode the image.
-
-
Constructor Details
-
TIFFTranscoder
public TIFFTranscoder()Constructs a new transcoder that produces tiff images.
-
-
Method Details
-
getUserAgent
- Returns:
- the transcoder's user agent
-
createImage
Creates a new ARGB image with the specified dimension.- Specified by:
createImage
in classImageTranscoder
- Parameters:
width
- the image width in pixelsheight
- the image height in pixels
-
getWriteAdapter
-
writeImage
Writes the specified image to the specified output.- Specified by:
writeImage
in classImageTranscoder
- Parameters:
img
- the image to writeoutput
- the output where to store the image- Throws:
TranscoderException
- if an error occured while storing the image
-