com.xmlmind.xmledit.imagetoolkit

Class JavaImageToolkit

java.lang.Object

com.xmlmind.xmledit.imagetoolkit.JavaImageToolkit

All Implemented Interfaces:

ImageToolkit

public final class JavaImageToolkit
extends Object
implements ImageToolkit

Built-in image toolkit plug-in based on javax.imageio.ImageIO.

Constructor Summary

Constructors

Constructor and Description
JavaImageToolkit()

Method Summary

Modifier and Type	Method and Description
String	getDescription() Returns a short description of this toolkit.
ImageConverter	getImageConverter(File inFile, File outFile) Returns an ImageConverter which can be used to convert specified files.
ImageRenderer	getImageRenderer(byte[] data) Returns an ImageRenderer which can be used to create an image representing the specified data.
ImageRenderer	getImageRenderer(Element element) Returns an ImageRenderer which can be used to create an image representing the specified XML element.
ImageRenderer	getImageRenderer(URL url) Returns an ImageRenderer which can be used to create an image representing the specified URL.
String	getName() Returns the name of this toolkit.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

JavaImageToolkit

public JavaImageToolkit()

Method Detail

getName

public String getName()

Description copied from interface: ImageToolkit

Returns the name of this toolkit.

Specified by:

getName in interface ImageToolkit

getDescription

public String getDescription()

Description copied from interface: ImageToolkit

Returns a short description of this toolkit. May be null. May contain newline characters.

Specified by:

getDescription in interface ImageToolkit

getImageRenderer

public ImageRenderer getImageRenderer(URL url)

Description copied from interface: ImageToolkit

Returns an ImageRenderer which can be used to create an image representing the specified URL. Returns null if this toolkit has no such renderer.

This method is invoked when the graphics file that is to be rendered on screen is referenced by the document being edited. DocBook example: <imagedata fileref="URL"/>.

This method typically checks the filename extension of the URL. If this extension denotes a format which is supported by this toolkit, the method returns a properly configured ImageRenderer. Otherwise, this method returns null.

Specified by:

getImageRenderer in interface ImageToolkit

Parameters:

url - URL of a graphics file; "data:" URLs not supported; URLs having a fragment not supported

Returns:

a properly configured ImageRenderer or null

getImageRenderer

public ImageRenderer getImageRenderer(byte[] data)

Description copied from interface: ImageToolkit

Returns an ImageRenderer which can be used to create an image representing the specified data. Returns null if this toolkit has no such renderer.

This method is invoked when the graphics file that is to be rendered on screen is embedded in the document being edited. Example: <image data="au8ze...base64Binary...t514l"/>.

This method typically checks the magic string or binary signature of the data. For example: if the first bytes are 0x4949 or 0x4D4D, the format is TIFF. If this magic string denotes a format which is supported by this toolkit, the method returns a properly configured ImageRenderer. Otherwise, this method returns null.

Specified by:

getImageRenderer in interface ImageToolkit

Parameters:

data - graphics data (that is, the binary contents of a graphics file)

Returns:

a properly configured ImageRenderer or null

See Also:

ImageToolkitUtil.detectImageFormat(byte[]), ImageToolkitUtil.match(byte[], byte[])

getImageRenderer

public ImageRenderer getImageRenderer(Element element)

Description copied from interface: ImageToolkit

Returns an ImageRenderer which can be used to create an image representing the specified XML element. Returns null if this toolkit has no such renderer.

This method is invoked when the graphics that is to be rendered on screen is a sub-tree of the document being edited. DocBook 5 example: <db5:imagedata><svg:svg> ... </svg:svg></db5:imagedata> (the element to be rendered is <svg:svg>, not <db5:imagedata>).

This method typically checks the namespace of the element. If this namespace denotes a format which is supported by this toolkit, the method returns a properly configured ImageRenderer. Otherwise, this method returns null.

Specified by:

getImageRenderer in interface ImageToolkit

Parameters:

element - root of the XML sub-tree

Returns:

a properly configured ImageRenderer or null

getImageConverter

public ImageConverter getImageConverter(File inFile,
                                        File outFile)

Description copied from interface: ImageToolkit

Returns an ImageConverter which can be used to convert specified files. Returns null if this toolkit has no such converter.

This method is invoked when a graphics file needs to be converted from a format to another. The format conversion is specified in the <convertImage> child element of the <process> configuration element. More information in XMLmind XML Editor - Configuration and Deployment.

This method typically checks the filename extensions of both the input file and the output file. If these extensions denotes formats supported by this toolkit, the method returns a properly configured ImageConverter. Otherwise, this method returns null.

Like the getImageRenderer methods, this method is invoked several times in a row until it returns a non-null converter. This means: can you convert this TIFF image to GIF? No. OK, but can you convert this TIFF image to PNG? No. OK, but can you convert his TIFF image to JPEG? And so on. If this method returns null in all cases, then, another image toolkit, if any, is tested.

Specified by:

getImageConverter in interface ImageToolkit

Parameters:

inFile - graphics file to be converted to another format

outFile - graphics file resulting from the conversion

Returns:

a properly configured ImageConverter or null