public class

GIFImageMetadata

extends IIOMetadata

java.lang.Object
↳	javax.imageio.metadata.IIOMetadata
	↳	com.sun.imageio.plugins.gif.GIFImageMetadata

Summary

Fields
public List	applicationData
public List	applicationIDs
public List	authenticationCodes
public int	characterCellHeight
public int	characterCellWidth
public List	comments
public int	delayTime
public int	disposalMethod
public boolean	hasPlainTextExtension
public int	imageHeight
public int	imageLeftPosition
public int	imageTopPosition
public int	imageWidth
public boolean	interlaceFlag
public byte[]	localColorTable
public boolean	sortFlag
public byte[]	text
public int	textBackgroundColor
public int	textForegroundColor
public int	textGridHeight
public int	textGridLeft
public int	textGridTop
public int	textGridWidth
public boolean	transparentColorFlag
public int	transparentColorIndex
public boolean	userInputFlag

[Expand]

Inherited Fields

From class javax.imageio.metadata.IIOMetadata

protected IIOMetadataController	controller	The `IIOMetadataController` that will be used to provide settings for this `IIOMetadata` object when the `activateController` method is called.
protected IIOMetadataController	defaultController	An `IIOMetadataController` that is suggested for use as the controller for this `IIOMetadata` object.
protected String[]	extraMetadataFormatClassNames	An array of names of classes implementing `IIOMetadataFormat` and representing the metadata formats, other than the standard and native formats, that are supported by this plug-in, initialized to `null` and set via the constructor.
protected String[]	extraMetadataFormatNames	An array of names of formats, other than the standard and native formats, that are supported by this plug-in, initialized to `null` and set via the constructor.
protected String	nativeMetadataFormatClassName	The name of the class implementing `IIOMetadataFormat` and representing the native metadata format, initialized to `null` and set via the constructor.
protected String	nativeMetadataFormatName	The name of the native metadata format for this object, initialized to `null` and set via the constructor.
protected boolean	standardFormatSupported	A boolean indicating whether the concrete subclass supports the standard metadata format, set via the constructor.

Public Constructors
	GIFImageMetadata()

Protected Constructors
	GIFImageMetadata(boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)

Public Methods
Node	getAsTree(String formatName) Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.
IIOMetadataNode	getStandardChromaNode() Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardCompressionNode() Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDataNode() Returns an `IIOMetadataNode` representing the data format information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDimensionNode() Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTextNode() Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTransparencyNode() Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
boolean	isReadOnly() Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods.
void	mergeTree(String formatName, Node root) Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.
void	reset() Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific.
void	setFromTree(String formatName, Node root) Sets the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.

Protected Methods
static void	fatal(Node node, String reason)
static String	getAttribute(Node node, String name, String defaultValue, boolean required)
static String	getAttribute(Node node, String name)
static boolean	getBooleanAttribute(Node node, String name, boolean defaultValue, boolean required)
static boolean	getBooleanAttribute(Node node, String name)
byte[]	getColorTable(Node colorTableNode, String entryNodeName, boolean lengthExpected, int expectedLength)
static int	getEnumeratedAttribute(Node node, String name, String[] legalNames)
static int	getEnumeratedAttribute(Node node, String name, String[] legalNames, int defaultValue, boolean required)
static float	getFloatAttribute(Node node, String name, float defaultValue, boolean required)
static float	getFloatAttribute(Node node, String name)
static int	getIntAttribute(Node node, String name, int defaultValue, boolean required, boolean bounded, int min, int max)
static int	getIntAttribute(Node node, String name, boolean bounded, int min, int max)
static String	getStringAttribute(Node node, String name, String defaultValue, boolean required, String[] range)
void	mergeNativeTree(Node root)
void	mergeStandardTree(Node root)

[Expand]

Inherited Methods

From class javax.imageio.metadata.IIOMetadata

boolean	activateController() Activates the installed `IIOMetadataController` for this `IIOMetadata` object and returns the resulting value.
abstract Node	getAsTree(String formatName) Returns an XML DOM `Node` object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.
IIOMetadataController	getController() Returns whatever `IIOMetadataController` is currently installed.
IIOMetadataController	getDefaultController() Returns the default `IIOMetadataController`, if there is one, regardless of the currently installed controller.
String[]	getExtraMetadataFormatNames() Returns an array of `String`s containing the names of additional metadata formats, other than the native and standard formats, recognized by this plug-in's `getAsTree`, `setFromTree`, and `mergeTree` methods.
IIOMetadataFormat	getMetadataFormat(String formatName) Returns an `IIOMetadataFormat` object describing the given metadata format, or `null` if no description is available.
String[]	getMetadataFormatNames() Returns an array of `String`s containing the names of all metadata formats, including the native and standard formats, recognized by this plug-in's `getAsTree`, `setFromTree`, and `mergeTree` methods.
String	getNativeMetadataFormatName() Returns the name of the "native" metadata format for this plug-in, which typically allows for lossless encoding and transmission of the metadata stored in the format handled by this plug-in.
IIOMetadataNode	getStandardChromaNode() Returns an `IIOMetadataNode` representing the chroma information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardCompressionNode() Returns an `IIOMetadataNode` representing the compression information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDataNode() Returns an `IIOMetadataNode` representing the data format information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDimensionNode() Returns an `IIOMetadataNode` representing the dimension information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardDocumentNode() Returns an `IIOMetadataNode` representing the document information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTextNode() Returns an `IIOMetadataNode` representing the textual information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTileNode() Returns an `IIOMetadataNode` representing the tiling information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
IIOMetadataNode	getStandardTransparencyNode() Returns an `IIOMetadataNode` representing the transparency information of the standard `javax_imageio_1.0` metadata format, or `null` if no such information is available.
final IIOMetadataNode	getStandardTree() A utility method to return a tree of `IIOMetadataNode`s representing the metadata contained within this object according to the conventions of the standard `javax_imageio_1.0` metadata format.
boolean	hasController() Returns `true` if there is a controller installed for this `IIOMetadata` object.
abstract boolean	isReadOnly() Returns `true` if this object does not support the `mergeTree`, `setFromTree`, and `reset` methods.
boolean	isStandardMetadataFormatSupported() Returns `true` if the standard metadata format is supported by `getMetadataFormat`, `getAsTree`, `setFromTree`, and `mergeTree`.
abstract void	mergeTree(String formatName, Node root) Alters the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.
abstract void	reset() Resets all the data stored in this object to default values, usually to the state this object was in immediately after construction, though the precise semantics are plug-in specific.
void	setController(IIOMetadataController controller) Sets the `IIOMetadataController` to be used to provide settings for this `IIOMetadata` object when the `activateController` method is called, overriding any default controller.
void	setFromTree(String formatName, Node root) Sets the internal state of this `IIOMetadata` object from a tree of XML DOM `Node`s whose syntax is defined by the given metadata format.

From class java.lang.Object

Object	clone() Creates and returns a copy of this object.
boolean	equals(Object obj) Indicates whether some other object is "equal to" this one.
void	finalize() Called by the garbage collector on an object when garbage collection determines that there are no more references to the object.
final Class<?>	getClass() Returns the runtime class of this `Object`.
int	hashCode() Returns a hash code value for the object.
final void	notify() Wakes up a single thread that is waiting on this object's monitor.
final void	notifyAll() Wakes up all threads that are waiting on this object's monitor.
String	toString() Returns a string representation of the object.
final void	wait() Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object.
final void	wait(long timeout, int nanos) Causes the current thread to wait until another thread invokes the `notify()` method or the `notifyAll()` method for this object, or some other thread interrupts the current thread, or a certain amount of real time has elapsed.
final void	wait(long timeout) Causes the current thread to wait until either another thread invokes the `notify()` method or the `notifyAll()` method for this object, or a specified amount of time has elapsed.

Fields

public List applicationData

public List applicationIDs

public List authenticationCodes

public int characterCellHeight

public int characterCellWidth

public List comments

public int delayTime

public int disposalMethod

public boolean hasPlainTextExtension

public int imageHeight

public int imageLeftPosition

public int imageTopPosition

public int imageWidth

public boolean interlaceFlag

public byte[] localColorTable

public boolean sortFlag

public byte[] text

public int textBackgroundColor

public int textForegroundColor

public int textGridHeight

public int textGridLeft

public int textGridTop

public int textGridWidth

public boolean transparentColorFlag

public int transparentColorIndex

public boolean userInputFlag

Public Constructors

public GIFImageMetadata ()

Protected Constructors

protected GIFImageMetadata (boolean standardMetadataFormatSupported, String nativeMetadataFormatName, String nativeMetadataFormatClassName, String[] extraMetadataFormatNames, String[] extraMetadataFormatClassNames)

Public Methods

public Node getAsTree (String formatName)

Returns an XML DOM Node object that represents the root of a tree of metadata contained within this object according to the conventions defined by a given metadata format.

The names of the available metadata formats may be queried using the getMetadataFormatNames method.

Parameters

formatName	the desired metadata format.

Returns

an XML DOM Node object forming the root of a tree.

public IIOMetadataNode getStandardChromaNode ()

Returns an IIOMetadataNode representing the chroma information of the standard javax_imageio_1.0 metadata format, or null if no such information is available. This method is intended to be called by the utility routine getStandardTree.