Top Description Methods
javax.imageio.event

public Interface IIOReadProgressListener

extends EventListener
Known Direct Implementers
com.sun.imageio.plugins.bmp.BMPImageReader.EmbeddedProgressAdapter, com.sun.imageio.plugins.jpeg.JFIFMarkerSegment.JFIFThumbJPEG.ThumbnailReadListener
Imports
java.util.EventListener, javax.imageio.ImageReader
An interface used by ImageReader implementations to notify callers of their image and thumbnail reading methods of progress.

This interface receives general indications of decoding progress (via the imageProgress and thumbnailProgress methods), and events indicating when an entire image has been updated (via the imageStarted, imageComplete, thumbnailStarted and thumbnailComplete methods). Applications that wish to be informed of pixel updates as they happen (for example, during progressive decoding), should provide an IIOReadUpdateListener.

See Also
IIOReadUpdateListener, javax.imageio.ImageReader#addIIOReadProgressListener, javax.imageio.ImageReader#removeIIOReadProgressListener

Method Summary

Modifier and TypeMethod and Description
public void
imageComplete(ImageReader
the ImageReader object calling this method.
source)

Reports that the current image read operation has completed.

public void
imageProgress(ImageReader
the ImageReader object calling this method.
source, float
the approximate percentage of decoding that has been completed.
percentageDone)

Reports the approximate degree of completion of the current read call of the associated ImageReader.

public void
imageStarted(ImageReader
the ImageReader object calling this method.
source, int
the index of the image being read within its containing input file or stream.
imageIndex)

Reports that an image read operation is beginning.

public void
readAborted(ImageReader
the ImageReader object calling this method.
source)

Reports that a read has been aborted via the reader's abort method.

public void
sequenceComplete(ImageReader
the ImageReader object calling this method.
source)

Reports that a sequence of read operations has completed.

public void
sequenceStarted(ImageReader
the ImageReader object calling this method.
source, int
the index of the first image to be read.
minIndex)

Reports that a sequence of read operations is beginning.

public void
thumbnailComplete(ImageReader
the ImageReader object calling this method.
source)

Reports that a thumbnail read operation has completed.

public void
thumbnailProgress(ImageReader
the ImageReader object calling this method.
source, float
the approximate percentage of decoding that has been completed.
percentageDone)

Reports the approximate degree of completion of the current getThumbnail call within the associated ImageReader.

public void
thumbnailStarted(ImageReader
the ImageReader object calling this method.
source, int
the index of the image being read within its containing input file or stream.
imageIndex, int
the index of the thumbnail being read.
thumbnailIndex)

Reports that a thumbnail read operation is beginning.

Method Detail

imageCompleteback to summary
public void imageComplete(ImageReader source)

Reports that the current image read operation has completed. All ImageReader implementations are required to call this method exactly once upon completion of each image read operation.

Parameters
source:ImageReader

the ImageReader object calling this method.

imageProgressback to summary
public void imageProgress(ImageReader source, float percentageDone)

Reports the approximate degree of completion of the current read call of the associated ImageReader.

The degree of completion is expressed as a percentage varying from 0.0F to 100.0F. The percentage should ideally be calculated in terms of the remaining time to completion, but it is usually more practical to use a more well-defined metric such as pixels decoded or portion of input stream consumed. In any case, a sequence of calls to this method during a given read operation should supply a monotonically increasing sequence of percentage values. It is not necessary to supply the exact values 0 and 100, as these may be inferred by the callee from other methods.

Each particular ImageReader implementation may call this method at whatever frequency it desires. A rule of thumb is to call it around each 5 percent mark.

Parameters
source:ImageReader

the ImageReader object calling this method.

percentageDone:float

the approximate percentage of decoding that has been completed.

imageStartedback to summary
public void imageStarted(ImageReader source, int imageIndex)

Reports that an image read operation is beginning. All ImageReader implementations are required to call this method exactly once when beginning an image read operation.

Parameters
source:ImageReader

the ImageReader object calling this method.

imageIndex:int

the index of the image being read within its containing input file or stream.

readAbortedback to summary
public void readAborted(ImageReader source)

Reports that a read has been aborted via the reader's abort method. No further notifications will be given.

Parameters
source:ImageReader

the ImageReader object calling this method.

sequenceCompleteback to summary
public void sequenceComplete(ImageReader source)

Reports that a sequence of read operations has completed. ImageReader implementations are required to call this method exactly once from their readAll(Iterator) method.

Parameters
source:ImageReader

the ImageReader object calling this method.

sequenceStartedback to summary
public void sequenceStarted(ImageReader source, int minIndex)

Reports that a sequence of read operations is beginning. ImageReader implementations are required to call this method exactly once from their readAll(Iterator) method.

Parameters
source:ImageReader

the ImageReader object calling this method.

minIndex:int

the index of the first image to be read.

thumbnailCompleteback to summary
public void thumbnailComplete(ImageReader source)

Reports that a thumbnail read operation has completed. All ImageReader implementations are required to call this method exactly once upon completion of each thumbnail read operation.

Parameters
source:ImageReader

the ImageReader object calling this method.

thumbnailProgressback to summary
public void thumbnailProgress(ImageReader source, float percentageDone)

Reports the approximate degree of completion of the current getThumbnail call within the associated ImageReader. The semantics are identical to those of imageProgress.

Parameters
source:ImageReader

the ImageReader object calling this method.

percentageDone:float

the approximate percentage of decoding that has been completed.

thumbnailStartedback to summary
public void thumbnailStarted(ImageReader source, int imageIndex, int thumbnailIndex)

Reports that a thumbnail read operation is beginning. All ImageReader implementations are required to call this method exactly once when beginning a thumbnail read operation.

Parameters
source:ImageReader

the ImageReader object calling this method.

imageIndex:int

the index of the image being read within its containing input file or stream.

thumbnailIndex:int

the index of the thumbnail being read.