Top Description Fields Constructors Methods
com.sun.javafx.iio

public Class ImageMetadata

extends Object
Class Inheritance

A class containing a limited number of relatively important metadata fields. A null-valued field indicates that the metadata field has not been set.

Field Summary

Modifier and TypeField and Description
public final Integer
backgroundColor

An RGB color to be used as a background.

public final Integer
backgroundIndex

A palette index to be used as a background.

public final Boolean
blackIsZero

true if smaller values represent darker shades.

public final Integer
delayTime

The amount of time to wait (in milliseconds) before continuing to process the data stream.

public final Integer
disposalMethod

The disposal method for the image.

public final Float
gamma

The image gamma.

public final Integer
imageHeight

The height of the image.

public final Integer
imageLeftPosition

The X offset of the image relative to the screen origin.

public final Integer
imageTopPosition

The Y offset of the image relative to the screen origin.

public final Integer
imageWidth

The width of of the image.

public final Integer
loopCount

The amount of times to loop the animation, zero or null if the animation should loop endlessly.

public final Integer
transparentIndex

A palette index to be used for transparent pixels.

Constructor Summary

AccessConstructor and Description
public
ImageMetadata(Float
the image gamma
gamma
,
Boolean
whether smaller values represent darker shades
blackIsZero
,
Integer
a palette index to use as background
backgroundIndex
,
Integer
the color to be used as background. The color format, in Integer, is packed as ARGB with 8 bits per channel.
backgroundColor
,
Integer
a palette index to be used as transparency.
transparentIndex
,
Integer
the amount of time to pause at the current image (milliseconds).
delayTime
,
Integer
the amount of times to loop the animation (zero for infinite loop).
loopCount
,
Integer imageWidth, Integer imageHeight, Integer imageLeftPosition, Integer imageTopPosition, Integer disposalMethod)

Method Summary

Modifier and TypeMethod and Description
public String
toString()

Overrides java.lang.Object.toString.

Returns a string representation of the object.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAllwaitwaitwait

Field Detail

backgroundColorback to summary
public final Integer backgroundColor

An RGB color to be used as a background.

backgroundIndexback to summary
public final Integer backgroundIndex

A palette index to be used as a background.

blackIsZeroback to summary
public final Boolean blackIsZero

true if smaller values represent darker shades.

delayTimeback to summary
public final Integer delayTime

The amount of time to wait (in milliseconds) before continuing to process the data stream.

disposalMethodback to summary
public final Integer disposalMethod

The disposal method for the image.

Note

This is applicable to GIF image only.

gammaback to summary
public final Float gamma

The image gamma.

imageHeightback to summary
public final Integer imageHeight

The height of the image.

imageLeftPositionback to summary
public final Integer imageLeftPosition

The X offset of the image relative to the screen origin.

Note

This is applicable to GIF image only.

imageTopPositionback to summary
public final Integer imageTopPosition

The Y offset of the image relative to the screen origin.

Note

This is applicable to GIF image only.

imageWidthback to summary
public final Integer imageWidth

The width of of the image.

loopCountback to summary
public final Integer loopCount

The amount of times to loop the animation, zero or null if the animation should loop endlessly.

transparentIndexback to summary
public final Integer transparentIndex

A palette index to be used for transparent pixels.

Constructor Detail

ImageMetadataback to summary
public ImageMetadata(Float gamma, Boolean blackIsZero, Integer backgroundIndex, Integer backgroundColor, Integer transparentIndex, Integer delayTime, Integer loopCount, Integer imageWidth, Integer imageHeight, Integer imageLeftPosition, Integer imageTopPosition, Integer disposalMethod)
Parameters
gamma:Float

the image gamma

blackIsZero:Boolean

whether smaller values represent darker shades

backgroundIndex:Integer

a palette index to use as background

backgroundColor:Integer

the color to be used as background. The color format, in Integer, is packed as ARGB with 8 bits per channel.

transparentIndex:Integer

a palette index to be used as transparency.

delayTime:Integer

the amount of time to pause at the current image (milliseconds).

loopCount:Integer

the amount of times to loop the animation (zero for infinite loop).

Method Detail

toStringback to summary
public String toString()

Overrides java.lang.Object.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object. Satisfying this method's contract implies a non-null result must be returned.

Annotations
@Override