com.xmlmind.xmledit.imagetoolkit

Class ImageRendererAdapter

java.lang.Object

com.xmlmind.xmledit.imagetoolkit.ImageRendererAdapter

All Implemented Interfaces:

ImageRenderer

public class ImageRendererAdapter
extends Object
implements ImageRenderer

Extend this class to create an ImageRenderer and override only the methods of interest.

Constructor Summary

Constructors

Constructor and Description
ImageRendererAdapter()

Method Summary

Modifier and Type	Method and Description
Image	createImage(byte[] data, URL baseURL, double width, SizeType widthType, double height, SizeType heightType, boolean preserveAspectRatio, boolean smooth) Renders specified image data.
Image	createImage(Element element, double width, SizeType widthType, double height, SizeType heightType, boolean preserveAspectRatio, boolean smooth) Renders specified tree of XML nodes.
Image	createImage(URL url, double width, SizeType widthType, double height, SizeType heightType, boolean preserveAspectRatio, boolean smooth) Renders specified graphics file.
int[]	getImageSize(byte[] data, URL baseURL) Returns the intrinsic dimension of the image contained in specified image data, preferably without fully loading the image.
int[]	getImageSize(Element element) Returns the intrinsic dimension of the image contained in specified tree of XML nodes, preferably without fully loading the image.
int[]	getImageSize(URL url) Returns the intrinsic dimension of the image contained in specified graphics file, preferably without fully loading the image.

Methods inherited from class java.lang.Object

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

Constructor Detail

ImageRendererAdapter

public ImageRendererAdapter()

Method Detail

createImage

public Image createImage(URL url,
                         double width,
                         SizeType widthType,
                         double height,
                         SizeType heightType,
                         boolean preserveAspectRatio,
                         boolean smooth)
                  throws Exception

Renders specified graphics file. This implementation returns null (don't know how to render specified URL).

Specified by:

createImage in interface ImageRenderer

Parameters:

url - specifies the graphics file

width - specifies a width value which is interpreted using widthType

widthType - specifies how to interpret width

height - specifies a height value which is interpreted using heighType

heightType - specifies how to interpret height

preserveAspectRatio - if true and if image is to be fit in a rectangle (widthType and heightType are both SizeType.FIT or SizeType.MAX), preserve its aspect ratio. In all other cases, this argument is ignored (rationale: how to preserve the aspect ratio if first 4 arguments are 100px, 200px and the intrinsic size of the image is 32x32?)

smooth - if true and if image is to be rescaled, favor quality over speed

Returns:

newly created, fully loaded, image

Throws:

Exception - if, for any reason, the image cannot be created (do not return null!)

createImage

public Image createImage(byte[] data,
                         URL baseURL,
                         double width,
                         SizeType widthType,
                         double height,
                         SizeType heightType,
                         boolean preserveAspectRatio,
                         boolean smooth)
                  throws Exception

Renders specified image data. This implementation returns null (don't know how to render specified data).

Specified by:

createImage in interface ImageRenderer

Parameters:

data - specifies the image data

baseURL - used to resolve relative URLs possibly found in data

width - specifies a width value which is interpreted using widthType

widthType - specifies how to interpret width

height - specifies a height value which is interpreted using heighType

heightType - specifies how to interpret height

preserveAspectRatio - if true and if image is to be fit in a rectangle (widthType and heightType are both SizeType.FIT or SizeType.MAX), preserve its aspect ratio. In all other cases, this argument is ignored (rationale: how to preserve the aspect ratio if first 4 arguments are 100px, 200px and the intrinsic size of the image is 32x32?)

smooth - if true and if image is to be rescaled, favor quality over speed

Returns:

newly created, fully loaded, image

Throws:

Exception - if, for any reason, the image cannot be created (do not return null!)

createImage

public Image createImage(Element element,
                         double width,
                         SizeType widthType,
                         double height,
                         SizeType heightType,
                         boolean preserveAspectRatio,
                         boolean smooth)
                  throws Exception

Renders specified tree of XML nodes. This implementation returns null (don't know how to render specified element).

Specified by:

createImage in interface ImageRenderer

Parameters:

element - specifies the XML tree

width - specifies a width value which is interpreted using widthType

widthType - specifies how to interpret width

height - specifies a height value which is interpreted using heighType

heightType - specifies how to interpret height

preserveAspectRatio - if true and if image is to be fit in a rectangle (widthType and heightType are both SizeType.FIT or SizeType.MAX), preserve its aspect ratio. In all other cases, this argument is ignored (rationale: how to preserve the aspect ratio if first 4 arguments are 100px, 200px and the intrinsic size of the image is 32x32?)

smooth - if true and if image is to be rescaled, favor quality over speed

Returns:

newly created, fully loaded, image

Throws:

Exception - if, for any reason, the image cannot be created (do not return null!)

getImageSize

public int[] getImageSize(URL url)
                   throws Exception

Returns the intrinsic dimension of the image contained in specified graphics file, preferably without fully loading the image. This implementation fully loads the image in order to obtain its intrinsic dimension.

Specified by:

getImageSize in interface ImageRenderer

Parameters:

url - specifies the graphics file

Returns:

image dimension in pixels. Never null. First element of the return array is the image width and the second is the image height.

Throws:

Exception - if, for any reason, the image dimension cannot be determined

getImageSize

public int[] getImageSize(byte[] data,
                          URL baseURL)
                   throws Exception

Returns the intrinsic dimension of the image contained in specified image data, preferably without fully loading the image. This implementation fully loads the image in order to obtain its intrinsic dimension.

Specified by:

getImageSize in interface ImageRenderer

Parameters:

data - specifies the image data

baseURL - used to resolve relative URLs possibly found in data

Returns:

image dimension in pixels. Never null. First element of the return array is the image width and the second is the image height.

Throws:

Exception - if, for any reason, the image dimension cannot be determined

getImageSize

public int[] getImageSize(Element element)
                   throws Exception

Returns the intrinsic dimension of the image contained in specified tree of XML nodes, preferably without fully loading the image. This implementation fully loads the image in order to obtain its intrinsic dimension.

Specified by:

getImageSize in interface ImageRenderer

Parameters:

element - specifies the XML tree

Returns:

image dimension in pixels. Never null. First element of the return array is the image width and the second is the image height.

Throws:

Exception - if, for any reason, the image dimension cannot be determined