Package uk.ac.rdg.resc.edal.graphics.formats

Class GifFormat

java.lang.Object

uk.ac.rdg.resc.edal.graphics.formats.ImageFormat

uk.ac.rdg.resc.edal.graphics.formats.SimpleFormat

uk.ac.rdg.resc.edal.graphics.formats.GifFormat

public class GifFormat
extends SimpleFormat

Creates (possibly animated) GIFs. Only one instance of this class will ever be created, so this class contains no member variables to ensure thread safety.

Author:

Jon Blower

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	GifFormat()

Method Summary

Modifier and Type	Method	Description
String	getMimeType()	Returns the MIME type that is supported by this ImageFormat object.
boolean	supportsFullyTransparentPixels()	Returns true if this image format supports fully-transparent pixels.
boolean	supportsMultipleFrames()	Returns true if this image format supports multi-frame animations.
boolean	supportsPartiallyTransparentPixels()	Returns true if this image format supports partially-transparent pixels.
void	writeImage(List<BufferedImage> frames, OutputStream out, Integer frameRate)	Writes the given list of java.awt.BufferedImages to the given OutputStream.

Methods inherited from class uk.ac.rdg.resc.edal.graphics.formats.SimpleFormat

requiresLegend, writeImage

Methods inherited from class uk.ac.rdg.resc.edal.graphics.formats.ImageFormat

get, getSupportedMimeTypes

Methods inherited from class java.lang.Object

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

Constructor Detail

GifFormat

protected GifFormat()

Method Detail

writeImage

public void writeImage(List<BufferedImage> frames,
                       OutputStream out,
                       Integer frameRate)
                throws IOException

Description copied from class: SimpleFormat

Writes the given list of java.awt.BufferedImages to the given OutputStream. If this ImageFormat doesn't support animations then the given list of frames should only contain one entry, otherwise an IllegalArgumentException will be thrown.

Specified by:

writeImage in class SimpleFormat

Parameters:

frames - List of BufferedImages to render into an image

out - The OutputStream to which the image will be written

frameRate - The frame rate to use if this is an animation.

Throws:

IOException - if there was an error writing to the output stream

getMimeType

public String getMimeType()

Description copied from class: ImageFormat

Returns the MIME type that is supported by this ImageFormat object.

Specified by:

getMimeType in class ImageFormat

supportsMultipleFrames

public boolean supportsMultipleFrames()

Description copied from class: ImageFormat

Returns true if this image format supports multi-frame animations.

Specified by:

supportsMultipleFrames in class ImageFormat

supportsFullyTransparentPixels

public boolean supportsFullyTransparentPixels()

Description copied from class: ImageFormat

Returns true if this image format supports fully-transparent pixels.

Specified by:

supportsFullyTransparentPixels in class ImageFormat

supportsPartiallyTransparentPixels

public boolean supportsPartiallyTransparentPixels()

Description copied from class: ImageFormat

Returns true if this image format supports partially-transparent pixels. If this is true then supportsFullyTransparentPixels() should also be true.

Specified by:

supportsPartiallyTransparentPixels in class ImageFormat