com.day.imageio.plugins

Class GIFStreamMetadata

java.lang.Object

javax.imageio.metadata.IIOMetadata

com.day.imageio.plugins.GIFStreamMetadata

public class GIFStreamMetadata
extends javax.imageio.metadata.IIOMetadata

The GIFStreamMetadataExt class extends the GIFStreamMetadata class to add fields and support for animated GIF image files. Namely this is the application extension support to define image loops. An instance of this class is returned by the GifImageWriter.getDefaultStreamMetadata(javax.imageio.ImageWriteParam) method.

This class does not currently contain XML format support for this application extension block.

For more details, look at the GIF89 Specification. Generally this page contains many interesting information on animated GIFs.

Since:

coati

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	GIFStreamMetadata.ApplicationExtension The ApplicationExtension class provides structured access GIF image application extensions.

Field Summary

Fields

Modifier and Type	Field and Description
int	backgroundColorIndex
int	colorResolution
static java.lang.String[]	colorTableSizes
GIFStreamMetadata.ApplicationExtension[]	extensions The application extension blocks, null to nott add any
byte[]	globalColorTable
int	logicalScreenHeight
int	logicalScreenWidth
int	pixelAspectRatio
boolean	sortFlag
java.lang.String	version
static java.lang.String[]	versionStrings

Constructor Summary

Constructors

Constructor and Description
GIFStreamMetadata()

Method Summary

Modifier and Type	Method and Description
org.w3c.dom.Node	getAsTree(java.lang.String formatName)
boolean	isReadOnly()
void	mergeTree(java.lang.String formatName, org.w3c.dom.Node root)
void	removeLoops() Removes the loop application extension block from the meta data, if at all contained.
void	reset()
void	setFromTree(java.lang.String formatName, org.w3c.dom.Node root)
void	setLoops(int loops) Sets the number of loops, the GIF image animation representated by the metadata should use.

Methods inherited from class javax.imageio.metadata.IIOMetadata

activateController, getController, getDefaultController, getExtraMetadataFormatNames, getMetadataFormat, getMetadataFormatNames, getNativeMetadataFormatName, hasController, isStandardMetadataFormatSupported, setController

Methods inherited from class java.lang.Object

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

Field Detail

versionStrings

public static final java.lang.String[] versionStrings

version

public java.lang.String version

logicalScreenWidth

public int logicalScreenWidth

logicalScreenHeight

public int logicalScreenHeight

colorResolution

public int colorResolution

pixelAspectRatio

public int pixelAspectRatio

backgroundColorIndex

public int backgroundColorIndex

sortFlag

public boolean sortFlag

colorTableSizes

public static final java.lang.String[] colorTableSizes

globalColorTable

public byte[] globalColorTable

extensions

public GIFStreamMetadata.ApplicationExtension[] extensions

The application extension blocks, null to nott add any

Constructor Detail

GIFStreamMetadata

public GIFStreamMetadata()

Method Detail

isReadOnly

public boolean isReadOnly()

Specified by:

isReadOnly in class javax.imageio.metadata.IIOMetadata

getAsTree

public org.w3c.dom.Node getAsTree(java.lang.String formatName)

Specified by:

getAsTree in class javax.imageio.metadata.IIOMetadata

setFromTree

public void setFromTree(java.lang.String formatName,
                        org.w3c.dom.Node root)

Overrides:

setFromTree in class javax.imageio.metadata.IIOMetadata

mergeTree

public void mergeTree(java.lang.String formatName,
                      org.w3c.dom.Node root)

Specified by:

mergeTree in class javax.imageio.metadata.IIOMetadata

reset

public void reset()

Specified by:

reset in class javax.imageio.metadata.IIOMetadata

setLoops

public final void setLoops(int loops)

Sets the number of loops, the GIF image animation representated by the metadata should use. This method may be called multiple times, where later calls overwrite earlier settings.

Parameters:

loops - The number of loops to set as an unsigned 16bit value. If specified as 0, the loop application block is removed.

removeLoops

public void removeLoops()

Removes the loop application extension block from the meta data, if at all contained.