< prev index next >
src/java.desktop/share/classes/javax/imageio/event/IIOReadUpdateListener.java
Print this page
@@ -28,11 +28,11 @@
import java.awt.image.BufferedImage;
import java.util.EventListener;
import javax.imageio.ImageReader;
/**
- * An interface used by <code>ImageReader</code> implementations to
+ * An interface used by {@code ImageReader} implementations to
* notify callers of their image and thumbnail reading methods of
* pixel updates.
*
* @see javax.imageio.ImageReader#addIIOReadUpdateListener
* @see javax.imageio.ImageReader#removeIIOReadUpdateListener
@@ -45,21 +45,21 @@
* 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.
*
* <p> An estimate of the area that will be updated by the pass is
- * indicated by the <code>minX</code>, <code>minY</code>,
- * <code>width</code>, and <code>height</code> parameters. If the
+ * indicated by the {@code minX}, {@code minY},
+ * {@code width}, and {@code height} parameters. If the
* pass is interlaced, that is, it only updates selected rows or
- * columns, the <code>periodX</code> and <code>periodY</code>
+ * columns, the {@code periodX} and {@code periodY}
* parameters will indicate the degree of subsampling. The set of
* bands that may be affected is indicated by the value of
- * <code>bands</code>.
+ * {@code bands}.
*
- * @param source the <code>ImageReader</code> object calling this
+ * @param source the {@code ImageReader} object calling this
* method.
- * @param theImage the <code>BufferedImage</code> being updated.
+ * @param theImage the {@code BufferedImage} being updated.
* @param pass the number of the pass that is about to begin,
* starting with 0.
* @param minPass the index of the first pass that will be decoded.
* @param maxPass the index of the last pass that will be decoded.
* @param minX the X coordinate of the leftmost updated column
@@ -68,11 +68,11 @@
* of pixels.
* @param periodX the horizontal spacing between updated pixels;
* a value of 1 means no gaps.
* @param periodY the vertical spacing between updated pixels;
* a value of 1 means no gaps.
- * @param bands an array of <code>int</code>s indicating the
+ * @param bands an array of {@code int}s indicating the
* set bands that may be updated.
*/
void passStarted(ImageReader source,
BufferedImage theImage,
int pass,
@@ -96,18 +96,18 @@
* 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.
*
- * <p> The particular <code>ImageReader</code> implementation may
+ * <p> The particular {@code 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
- * (<code>minX</code>, <code>minY</code>, <code>width</code>, and
- * <code>height</code>); X and Y subsampling factors
- * (<code>periodX</code> and <code>periodY</code>); and a set of
- * updated bands (<code>bands</code>). For example, the update:
+ * ({@code minX}, {@code minY}, {@code width}, and
+ * {@code height}); X and Y subsampling factors
+ * ({@code periodX} and {@code periodY}); and a set of
+ * updated bands ({@code bands}). For example, the update:
*
* <pre>
* minX = 10
* minY = 20
* width = 3
@@ -125,23 +125,23 @@
* (10, 23) (12, 23) (14, 23)
* (10, 26) (12, 26) (14, 26)
* (10, 29) (12, 29) (14, 29)
* </pre>
*
- * @param source the <code>ImageReader</code> object calling this method.
- * @param theImage the <code>BufferedImage</code> being updated.
+ * @param source the {@code ImageReader} object calling this method.
+ * @param theImage the {@code BufferedImage} being updated.
* @param minX the X coordinate of the leftmost updated column
* of pixels.
* @param minY the Y coordinate of the uppermost updated row
* of pixels.
* @param width the number of updated pixels horizontally.
* @param height the number of updated pixels vertically.
* @param periodX the horizontal spacing between updated pixels;
* a value of 1 means no gaps.
* @param periodY the vertical spacing between updated pixels;
* a value of 1 means no gaps.
- * @param bands an array of <code>int</code>s indicating which
+ * @param bands an array of {@code int}s indicating which
* bands are being updated.
*/
void imageUpdate(ImageReader source,
BufferedImage theImage,
int minX, int minY,
@@ -154,13 +154,13 @@
* 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.
*
- * @param source the <code>ImageReader</code> object calling this
+ * @param source the {@code ImageReader} object calling this
* method.
- * @param theImage the <code>BufferedImage</code> being updated.
+ * @param theImage the {@code BufferedImage} being updated.
*
* @see javax.imageio.ImageReadParam#setSourceProgressivePasses(int, int)
*/
void passComplete(ImageReader source, BufferedImage theImage);
@@ -169,13 +169,13 @@
* 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.
*
- * @param source the <code>ImageReader</code> object calling this
+ * @param source the {@code ImageReader} object calling this
* method.
- * @param theThumbnail the <code>BufferedImage</code> thumbnail
+ * @param theThumbnail the {@code BufferedImage} thumbnail
* being updated.
* @param pass the number of the pass that is about to begin,
* starting with 0.
* @param minPass the index of the first pass that will be decoded.
* @param maxPass the index of the last pass that will be decoded.
@@ -185,11 +185,11 @@
* of pixels.
* @param periodX the horizontal spacing between updated pixels;
* a value of 1 means no gaps.
* @param periodY the vertical spacing between updated pixels;
* a value of 1 means no gaps.
- * @param bands an array of <code>int</code>s indicating the
+ * @param bands an array of {@code int}s indicating the
* set bands that may be updated.
*
* @see #passStarted
*/
void thumbnailPassStarted(ImageReader source,
@@ -204,12 +204,12 @@
* 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.
*
- * @param source the <code>ImageReader</code> object calling this method.
- * @param theThumbnail the <code>BufferedImage</code> thumbnail
+ * @param source the {@code ImageReader} object calling this method.
+ * @param theThumbnail the {@code BufferedImage} thumbnail
* being updated.
* @param minX the X coordinate of the leftmost updated column
* of pixels.
* @param minY the Y coordinate of the uppermost updated row
* of pixels.
@@ -217,11 +217,11 @@
* @param height the number of updated pixels vertically.
* @param periodX the horizontal spacing between updated pixels;
* a value of 1 means no gaps.
* @param periodY the vertical spacing between updated pixels;
* a value of 1 means no gaps.
- * @param bands an array of <code>int</code>s indicating which
+ * @param bands an array of {@code int}s indicating which
* bands are being updated.
*
* @see #imageUpdate
*/
void thumbnailUpdate(ImageReader source,
@@ -236,13 +236,13 @@
* 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.
*
- * @param source the <code>ImageReader</code> object calling this
+ * @param source the {@code ImageReader} object calling this
* method.
- * @param theThumbnail the <code>BufferedImage</code> thumbnail
+ * @param theThumbnail the {@code BufferedImage} thumbnail
* being updated.
*
* @see #passComplete
*/
void thumbnailPassComplete(ImageReader source, BufferedImage theThumbnail);
< prev index next >