OpenJDK 27 · javax.imageio.event.IIOReadUpdateListener

Method Summary

Modifier and Type	Method and Description
public void	imageUpdate(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` being updated. theImage, int the X coordinate of the leftmost updated column of pixels. minX, int the Y coordinate of the uppermost updated row of pixels. minY, int the number of updated pixels horizontally. width, int the number of updated pixels vertically. height, int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodX, int the vertical spacing between updated pixels; a value of 1 means no gaps. periodY, int[] an array of `int`s indicating which bands are being updated. bands) Reports that a given region of the image has been updated.
public void	passComplete(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` being updated. theImage) Reports that the current read operation has completed a progressive pass.
public void	passStarted(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` being updated. theImage, int the number of the pass that is about to begin, starting with 0. pass, int the index of the first pass that will be decoded. minPass, int the index of the last pass that will be decoded. maxPass, int the X coordinate of the leftmost updated column of pixels. minX, int the Y coordinate of the uppermost updated row of pixels. minY, int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodX, int the vertical spacing between updated pixels; a value of 1 means no gaps. periodY, int[] an array of `int`s indicating the set bands that may be updated. bands) Reports that the current read operation is about to begin a progressive pass.
public void	thumbnailPassComplete(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` thumbnail being updated. theThumbnail) Reports that the current thumbnail read operation has completed a progressive pass.
public void	thumbnailPassStarted(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` thumbnail being updated. theThumbnail, int the number of the pass that is about to begin, starting with 0. pass, int the index of the first pass that will be decoded. minPass, int the index of the last pass that will be decoded. maxPass, int the X coordinate of the leftmost updated column of pixels. minX, int the Y coordinate of the uppermost updated row of pixels. minY, int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodX, int the vertical spacing between updated pixels; a value of 1 means no gaps. periodY, int[] an array of `int`s indicating the set bands that may be updated. bands) Reports that the current thumbnail read operation is about to begin a progressive pass.
public void	thumbnailUpdate(ImageReader the `ImageReader` object calling this method. source, BufferedImage the `BufferedImage` thumbnail being updated. theThumbnail, int the X coordinate of the leftmost updated column of pixels. minX, int the Y coordinate of the uppermost updated row of pixels. minY, int the number of updated pixels horizontally. width, int the number of updated pixels vertically. height, int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodX, int the vertical spacing between updated pixels; a value of 1 means no gaps. periodY, int[] an array of `int`s indicating which bands are being updated. bands) Reports that a given region of a thumbnail image has been updated.

Method Detail

imageUpdate back to summary

imageUpdate	back to summary
public void imageUpdate(ImageReader source, BufferedImage theImage, int minX, int minY, int width, int height, int periodX, int periodY, int[] bands) Reports that a given region of the image has been updated. The application might choose to redisplay the specified area, for example, in order to provide a progressive display effect, or perform other incremental processing. Note that different image format readers may produce decoded pixels in a variety of different orders. Many readers will produce pixels in a simple top-to-bottom, left-to-right-order, but others may use multiple passes of interlacing, tiling, etc. The sequence of updates may even differ from call to call depending on network speeds, for example. A call to this method does not guarantee that all the specified pixels have actually been updated, only that some activity has taken place within some subregion of the one specified. The particular `ImageReader` implementation may choose how often to provide updates. Each update specifies that a given region of the image has been updated since the last update. A region is described by its spatial bounding box (`minX`, `minY`, `width`, and `height`); X and Y subsampling factors (`periodX` and `periodY`); and a set of updated bands (`bands`). For example, the update: minX = 10 minY = 20 width = 3 height = 4 periodX = 2 periodY = 3 bands = { 1, 3 } would indicate that bands 1 and 3 of the following pixels were updated: (10, 20) (12, 20) (14, 20) (10, 23) (12, 23) (14, 23) (10, 26) (12, 26) (14, 26) (10, 29) (12, 29) (14, 29) Parameters source:ImageReader the `ImageReader` object calling this method. theImage:BufferedImage the `BufferedImage` being updated. minX:int the X coordinate of the leftmost updated column of pixels. minY:int the Y coordinate of the uppermost updated row of pixels. width:int the number of updated pixels horizontally. height:int the number of updated pixels vertically. periodX:int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodY:int the vertical spacing between updated pixels; a value of 1 means no gaps. bands:int[] an array of `int`s indicating which bands are being updated.

public void imageUpdate(ImageReader source, BufferedImage theImage, int minX, int minY, int width, int height, int periodX, int periodY, int[] bands)

Reports that a given region of the image has been updated. The application might choose to redisplay the specified area, for example, in order to provide a progressive display effect, or perform other incremental processing.

Note that different image format readers may produce decoded pixels in a variety of different orders. Many readers will produce pixels in a simple top-to-bottom, left-to-right-order, but others may use multiple passes of interlacing, tiling, etc. The sequence of updates may even differ from call to call depending on network speeds, for example. A call to this method does not guarantee that all the specified pixels have actually been updated, only that some activity has taken place within some subregion of the one specified.

The particular ImageReader implementation may choose how often to provide updates. Each update specifies that a given region of the image has been updated since the last update. A region is described by its spatial bounding box (minX, minY, width, and height); X and Y subsampling factors (periodX and periodY); and a set of updated bands (bands). For example, the update:

minX = 10
minY = 20
width = 3
height = 4
periodX = 2
periodY = 3
bands = { 1, 3 }

would indicate that bands 1 and 3 of the following pixels were updated:

(10, 20) (12, 20) (14, 20)
(10, 23) (12, 23) (14, 23)
(10, 26) (12, 26) (14, 26)
(10, 29) (12, 29) (14, 29)

Parameters

source:ImageReader: the ImageReader object calling this method.
theImage:BufferedImage: the BufferedImage being updated.
minX:int: the X coordinate of the leftmost updated column of pixels.
minY:int: the Y coordinate of the uppermost updated row of pixels.
width:int: the number of updated pixels horizontally.
height:int: the number of updated pixels vertically.
periodX:int: the horizontal spacing between updated pixels; a value of 1 means no gaps.
periodY:int: the vertical spacing between updated pixels; a value of 1 means no gaps.
bands:int[]: an array of ints indicating which bands are being updated.

passComplete back to summary

passComplete	back to summary
public void passComplete(ImageReader source, BufferedImage theImage) Reports that the current read operation has completed a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded image. Parameters source:ImageReader the `ImageReader` object calling this method. theImage:BufferedImage the `BufferedImage` being updated. See Also `javax.imageio.ImageReadParam#setSourceProgressivePasses(int, int)`

public void passComplete(ImageReader source, BufferedImage theImage)

Reports that the current read operation has completed a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded image.

Parameters

source:ImageReader: the ImageReader object calling this method.
theImage:BufferedImage: the BufferedImage being updated.

passStarted back to summary

passStarted	back to summary
public void passStarted(ImageReader source, BufferedImage theImage, int pass, int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands) Reports that the current read operation is about to begin a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded image. An estimate of the area that will be updated by the pass is indicated by the `minX`, `minY`, `width`, and `height` parameters. If the pass is interlaced, that is, it only updates selected rows or columns, the `periodX` and `periodY` parameters will indicate the degree of subsampling. The set of bands that may be affected is indicated by the value of `bands`. Parameters source:ImageReader the `ImageReader` object calling this method. theImage:BufferedImage the `BufferedImage` being updated. pass:int the number of the pass that is about to begin, starting with 0. minPass:int the index of the first pass that will be decoded. maxPass:int the index of the last pass that will be decoded. minX:int the X coordinate of the leftmost updated column of pixels. minY:int the Y coordinate of the uppermost updated row of pixels. periodX:int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodY:int the vertical spacing between updated pixels; a value of 1 means no gaps. bands:int[] an array of `int`s indicating the set bands that may be updated.

public void passStarted(ImageReader source, BufferedImage theImage, int pass, int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands)

Reports that the current read operation is about to begin a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded image.

An estimate of the area that will be updated by the pass is indicated by the minX, minY, width, and height parameters. If the pass is interlaced, that is, it only updates selected rows or columns, the periodX and periodY parameters will indicate the degree of subsampling. The set of bands that may be affected is indicated by the value of bands.

Parameters

source:ImageReader: the ImageReader object calling this method.
theImage:BufferedImage: the BufferedImage being updated.
pass:int: the number of the pass that is about to begin, starting with 0.
minPass:int: the index of the first pass that will be decoded.
maxPass:int: the index of the last pass that will be decoded.
minX:int: the X coordinate of the leftmost updated column of pixels.
minY:int: the Y coordinate of the uppermost updated row of pixels.
periodX:int: the horizontal spacing between updated pixels; a value of 1 means no gaps.
periodY:int: the vertical spacing between updated pixels; a value of 1 means no gaps.
bands:int[]: an array of ints indicating the set bands that may be updated.

thumbnailPassComplete back to summary

thumbnailPassComplete	back to summary
public void thumbnailPassComplete(ImageReader source, BufferedImage theThumbnail) Reports that the current thumbnail read operation has completed a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded thumbnail image. Parameters source:ImageReader the `ImageReader` object calling this method. theThumbnail:BufferedImage the `BufferedImage` thumbnail being updated. See Also `passComplete`

public void thumbnailPassComplete(ImageReader source, BufferedImage theThumbnail)

Reports that the current thumbnail read operation has completed a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded thumbnail image.

Parameters

source:ImageReader: the ImageReader object calling this method.
theThumbnail:BufferedImage: the BufferedImage thumbnail being updated.

See Also

passComplete

thumbnailPassStarted back to summary

thumbnailPassStarted	back to summary
public void thumbnailPassStarted(ImageReader source, BufferedImage theThumbnail, int pass, int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands) Reports that the current thumbnail read operation is about to begin a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded thumbnail image. Parameters source:ImageReader the `ImageReader` object calling this method. theThumbnail:BufferedImage the `BufferedImage` thumbnail being updated. pass:int the number of the pass that is about to begin, starting with 0. minPass:int the index of the first pass that will be decoded. maxPass:int the index of the last pass that will be decoded. minX:int the X coordinate of the leftmost updated column of pixels. minY:int the Y coordinate of the uppermost updated row of pixels. periodX:int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodY:int the vertical spacing between updated pixels; a value of 1 means no gaps. bands:int[] an array of `int`s indicating the set bands that may be updated. See Also `passStarted`

public void thumbnailPassStarted(ImageReader source, BufferedImage theThumbnail, int pass, int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands)

Reports that the current thumbnail read operation is about to begin a progressive pass. Readers of formats that support progressive encoding should use this to notify clients when each pass is completed when reading a progressively encoded thumbnail image.

Parameters

source:ImageReader: the ImageReader object calling this method.
theThumbnail:BufferedImage: the BufferedImage thumbnail being updated.
pass:int: the number of the pass that is about to begin, starting with 0.
minPass:int: the index of the first pass that will be decoded.
maxPass:int: the index of the last pass that will be decoded.
minX:int: the X coordinate of the leftmost updated column of pixels.
minY:int: the Y coordinate of the uppermost updated row of pixels.
periodX:int: the horizontal spacing between updated pixels; a value of 1 means no gaps.
periodY:int: the vertical spacing between updated pixels; a value of 1 means no gaps.
bands:int[]: an array of ints indicating the set bands that may be updated.

See Also

passStarted

thumbnailUpdate back to summary

thumbnailUpdate	back to summary
public void thumbnailUpdate(ImageReader source, BufferedImage theThumbnail, int minX, int minY, int width, int height, int periodX, int periodY, int[] bands) Reports that a given region of a thumbnail image has been updated. The application might choose to redisplay the specified area, for example, in order to provide a progressive display effect, or perform other incremental processing. Parameters source:ImageReader the `ImageReader` object calling this method. theThumbnail:BufferedImage the `BufferedImage` thumbnail being updated. minX:int the X coordinate of the leftmost updated column of pixels. minY:int the Y coordinate of the uppermost updated row of pixels. width:int the number of updated pixels horizontally. height:int the number of updated pixels vertically. periodX:int the horizontal spacing between updated pixels; a value of 1 means no gaps. periodY:int the vertical spacing between updated pixels; a value of 1 means no gaps. bands:int[] an array of `int`s indicating which bands are being updated. See Also `imageUpdate`

public void thumbnailUpdate(ImageReader source, BufferedImage theThumbnail, int minX, int minY, int width, int height, int periodX, int periodY, int[] bands)

Reports that a given region of a thumbnail image has been updated. The application might choose to redisplay the specified area, for example, in order to provide a progressive display effect, or perform other incremental processing.

Parameters

source:ImageReader: the ImageReader object calling this method.
theThumbnail:BufferedImage: the BufferedImage thumbnail being updated.
minX:int: the X coordinate of the leftmost updated column of pixels.
minY:int: the Y coordinate of the uppermost updated row of pixels.
width:int: the number of updated pixels horizontally.
height:int: the number of updated pixels vertically.
periodX:int: the horizontal spacing between updated pixels; a value of 1 means no gaps.
periodY:int: the vertical spacing between updated pixels; a value of 1 means no gaps.
bands:int[]: an array of ints indicating which bands are being updated.

See Also

imageUpdate

public Interface IIOReadUpdateListener

Method Summary

Method Detail