com.sun.javafx.iio

Interface ImageLoader

All Known Implementing Classes:

BMPImageLoader, GIFImageLoader2, ImageLoaderImpl, IosImageLoader, JPEGImageLoader, PNGImageLoader2

public interface ImageLoader

A loader for images stored in a given format.

Method Summary

Modifier and Type	Method and Description
void	addListener(ImageLoadListener listener) Adds a listener to monitor this loader.
void	dispose() Disposes of any resources (such as native libraries) held by this loader.
ImageFormatDescription	getFormatDescription() Gets a description of the image format supported by this loader.
ImageFrame	load(int imageIndex, int width, int height, boolean preserveAspectRatio, boolean smooth) Loads the image at a given index in an image stream.
void	removeListener(ImageLoadListener listener) Removes a listener from the list of those monitoring this loader.

Method Detail

getFormatDescription

ImageFormatDescription getFormatDescription()

Gets a description of the image format supported by this loader.

Returns:

a description of the image format handled by this loader.

dispose

void dispose()

Disposes of any resources (such as native libraries) held by this loader. Any further invocation of any methods on this object are undefined.

addListener

void addListener(ImageLoadListener listener)

Adds a listener to monitor this loader.

Parameters:

listener - the listener to add.

removeListener

void removeListener(ImageLoadListener listener)

Removes a listener from the list of those monitoring this loader.

Parameters:

listener - the listener to remove.

load

ImageFrame load(int imageIndex,
                int width,
                int height,
                boolean preserveAspectRatio,
                boolean smooth)
         throws java.io.IOException

Loads the image at a given index in an image stream. If no image exists at that index null will be returned.

Parameters:

imageIndex - the zero-relative index of the image to load.

width - the desired image width. If non-positive, an IllegalArgumentException will be thrown.

height - the desired image height. If non-positive, an IllegalArgumentException will be thrown.

preserveAspectRatio - whether to preserve the width-to-height ratio of the image.

smooth - whether to use a smooth downscaling algorithm.

Returns:

the image at the specified index or null on error.

Throws:

java.io.IOException