summaryrefslogtreecommitdiffstats
path: root/awt/javax/imageio/event
diff options
context:
space:
mode:
Diffstat (limited to 'awt/javax/imageio/event')
-rw-r--r--awt/javax/imageio/event/IIOReadProgressListener.java84
-rw-r--r--awt/javax/imageio/event/IIOReadUpdateListener.java200
-rw-r--r--awt/javax/imageio/event/IIOReadWarningListener.java17
-rw-r--r--awt/javax/imageio/event/IIOWriteProgressListener.java67
-rw-r--r--awt/javax/imageio/event/IIOWriteWarningListener.java20
-rw-r--r--awt/javax/imageio/event/package.html8
6 files changed, 245 insertions, 151 deletions
diff --git a/awt/javax/imageio/event/IIOReadProgressListener.java b/awt/javax/imageio/event/IIOReadProgressListener.java
index 3d65807..2944896 100644
--- a/awt/javax/imageio/event/IIOReadProgressListener.java
+++ b/awt/javax/imageio/event/IIOReadProgressListener.java
@@ -18,86 +18,104 @@
* @author Sergey I. Salishev
* @version $Revision: 1.2 $
*/
+
package javax.imageio.event;
import java.util.EventListener;
import javax.imageio.ImageReader;
/**
- * The IIOReadProgressListener interface notifies callers
- * about the progress of the image and thumbnail reading methods.
+ * The IIOReadProgressListener interface notifies callers about the progress of
+ * the image and thumbnail reading methods.
+ *
+ * @since Android 1.0
*/
public interface IIOReadProgressListener extends EventListener {
/**
- * Notifies this listener that the image reading has been completed.
+ * Notifies this listener that the image reading has been completed.
*
- * @param source the ImageReader object which calls this method.
+ * @param source
+ * the ImageReader object which calls this method.
*/
void imageComplete(ImageReader source);
-
+
/**
* Notifies this listener about the degree of completion of the read call.
*
- * @param source the ImageReader object which calls this method.
- * @param percentageDone the percentage of decoding done.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param percentageDone
+ * the percentage of decoding done.
*/
void imageProgress(ImageReader source, float percentageDone);
-
+
/**
- * Notifies this listener that an image read operation has been started.
+ * Notifies this listener that an image read operation has been started.
*
- * @param source the ImageReader object which calls this method.
- * @param imageIndex the index of the image in an input file or
- * stream to be read.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param imageIndex
+ * the index of the image in an input file or stream to be read.
*/
void imageStarted(ImageReader source, int imageIndex);
-
+
/**
* Notifies this listener that a read operation has been aborted.
*
- * @param source the ImageReader object which calls this method.
+ * @param source
+ * the ImageReader object which calls this method.
*/
void readAborted(ImageReader source);
-
+
/**
- * Notifies this listener that a sequence of read operations has been completed.
+ * Notifies this listener that a sequence of read operations has been
+ * completed.
*
- * @param source the ImageReader object which calls this method.
+ * @param source
+ * the ImageReader object which calls this method.
*/
void sequenceComplete(ImageReader source);
-
+
/**
- * Notifies this listener that a sequence of read operation has been started.
+ * Notifies this listener that a sequence of read operation has been
+ * started.
*
- * @param source the ImageReader object which calls this method.
- * @param minIndex the index of the first image to be read.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param minIndex
+ * the index of the first image to be read.
*/
void sequenceStarted(ImageReader source, int minIndex);
-
+
/**
* Notifies that a thumbnail read operation has been completed.
*
- * @param source the ImageReader object which calls this method.
+ * @param source
+ * the ImageReader object which calls this method.
*/
void thumbnailComplete(ImageReader source);
-
+
/**
* Notifies this listener about the degree of completion of the read call.
*
- * @param source the ImageReader object which calls this method.
- * @param percentageDone the percentage of decoding done.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param percentageDone
+ * the percentage of decoding done.
*/
void thumbnailProgress(ImageReader source, float percentageDone);
-
+
/**
- * Notifies this listener that a thumbnail reading operation has been started.
+ * Notifies this listener that a thumbnail reading operation has been
+ * started.
*
- * @param source the ImageReader object which calls this method.
- * @param imageIndex the index of the image in an input file or
- * stream to be read.
- * @param thumbnailIndex the index of the thumbnail to be read.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param imageIndex
+ * the index of the image in an input file or stream to be read.
+ * @param thumbnailIndex
+ * the index of the thumbnail to be read.
*/
void thumbnailStarted(ImageReader source, int imageIndex, int thumbnailIndex);
}
-
diff --git a/awt/javax/imageio/event/IIOReadUpdateListener.java b/awt/javax/imageio/event/IIOReadUpdateListener.java
index ce5e2f1..49bdbcb 100644
--- a/awt/javax/imageio/event/IIOReadUpdateListener.java
+++ b/awt/javax/imageio/event/IIOReadUpdateListener.java
@@ -18,6 +18,7 @@
* @author Sergey I. Salishev
* @version $Revision: 1.2 $
*/
+
package javax.imageio.event;
import java.awt.image.BufferedImage;
@@ -30,109 +31,152 @@ import javax.imageio.ImageReader;
*/
/**
- * The IIOReadUpdateListener interface provides functionality
- * to receive notification of pixel updates during image and thumbnail
- * reading operations.
+ * The IIOReadUpdateListener interface provides functionality to receive
+ * notification of pixel updates during image and thumbnail reading operations.
+ *
+ * @since Android 1.0
*/
public interface IIOReadUpdateListener extends EventListener {
/**
- * Notifies this listener that the specified area of the image has been updated.
+ * Notifies this listener that the specified area of the image has been
+ * updated.
*
- * @param source the ImageReader object which calls this method.
- * @param theImage the image to be updated.
- * @param minX the minimum X coordinate of the pixels in the updated area.
- * @param minY the minimum Y coordinate of the pixels in the updated area.
- * @param width the width of updated area.
- * @param height the height of updated area.
- * @param periodX the horizontal spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param periodY the vertical spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param bands the array of int values indicating the bands being updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theImage
+ * the image to be updated.
+ * @param minX
+ * the minimum X coordinate of the pixels in the updated area.
+ * @param minY
+ * the minimum Y coordinate of the pixels in the updated area.
+ * @param width
+ * the width of updated area.
+ * @param height
+ * the height of updated area.
+ * @param periodX
+ * the horizontal spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param periodY
+ * the vertical spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param bands
+ * the array of integer values indicating the bands being
+ * updated.
*/
- void imageUpdate(ImageReader source, BufferedImage theImage, int minX,
- int minY, int width, int height, int periodX, int periodY,
- int[] bands);
-
+ void imageUpdate(ImageReader source, BufferedImage theImage, int minX, int minY, int width,
+ int height, int periodX, int periodY, int[] bands);
+
/**
- * Notifies this listener that the current read operation has completed a
+ * Notifies this listener that the current read operation has completed a
* progressive pass.
*
- * @param source the ImageReader object which calls this method.
- * @param theImage the image to be updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theImage
+ * the image to be updated.
*/
void passComplete(ImageReader source, BufferedImage theImage);
-
+
/**
- * Notifies this listener that the current read operation has begun
- * a progressive pass.
+ * Notifies this listener that the current read operation has begun a
+ * progressive pass.
*
- * @param source the ImageReader object which calls this method.
- * @param theImage the image to be updated.
- * @param pass the numer of the pass.
- * @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 minimum X coordinate of the pixels in the updated area.
- * @param minY the minimum Y coordinate of the pixels in the updated area.
- * @param periodX the horizontal spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param periodY the vertical spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param bands the array of int values indicating the bands being updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theImage
+ * the image to be updated.
+ * @param pass
+ * the number of the pass.
+ * @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 minimum X coordinate of the pixels in the updated area.
+ * @param minY
+ * the minimum Y coordinate of the pixels in the updated area.
+ * @param periodX
+ * the horizontal spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param periodY
+ * the vertical spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param bands
+ * the array of integer values indicating the bands being
+ * updated.
*/
- void passStarted(ImageReader source, BufferedImage theImage, int pass,
- int minPass, int maxPass, int minX, int minY, int periodX,
- int periodY, int[] bands);
+ void passStarted(ImageReader source, BufferedImage theImage, int pass, int minPass,
+ int maxPass, int minX, int minY, int periodX, int periodY, int[] bands);
/**
- * Notifies this listener that the current thumbnail read operation has
+ * Notifies this listener that the current thumbnail read operation has
* completed a progressive pass.
*
- * @param source the ImageReader object which calls this method.
- * @param theImage the thumbnail to be updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theImage
+ * the thumbnail to be updated.
*/
void thumbnailPassComplete(ImageReader source, BufferedImage theImage);
-
+
/**
- * Notifies this listener that the current thumbnail read operation has
+ * Notifies this listener that the current thumbnail read operation has
* begun a progressive pass.
*
- * @param source the ImageReader object which calls this method.
- * @param theThumbnail the thumbnail to be updated.
- * @param pass the numer of the pass.
- * @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 minimum X coordinate of the pixels in the updated area.
- * @param minY the minimum Y coordinate of the pixels in the updated area.
- * @param periodX the horizontal spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param periodY the vertical spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param bands the array of int values indicating the bands being updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theThumbnail
+ * the thumbnail to be updated.
+ * @param pass
+ * the number of the pass.
+ * @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 minimum X coordinate of the pixels in the updated area.
+ * @param minY
+ * the minimum Y coordinate of the pixels in the updated area.
+ * @param periodX
+ * the horizontal spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param periodY
+ * the vertical spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param bands
+ * the array of integer values indicating the bands being
+ * updated.
*/
- void thumbnailPassStarted(ImageReader source, BufferedImage theThumbnail,
- int pass, int minPass, int maxPass, int minX, int minY,
- int periodX, int periodY, int[] bands);
-
+ void thumbnailPassStarted(ImageReader source, BufferedImage theThumbnail, int pass,
+ int minPass, int maxPass, int minX, int minY, int periodX, int periodY, int[] bands);
+
/**
- * Notifies this listener that a specified area of a thumbnail image has been
- * updated.
+ * Notifies this listener that a specified area of a thumbnail image has
+ * been updated.
*
- * @param source the ImageReader object which calls this method.
- * @param theThumbnail the thumbnail to be updated.
- * @param minX the minimum X coordinate of the pixels in the updated area.
- * @param minY the minimum Y coordinate of the pixels in the updated area.
- * @param width the width of updated area.
- * @param height the height of updated area.
- * @param periodX the horizontal spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param periodY the vertical spacing period between updated
- * pixels, if it equals 1, there is no space between pixels.
- * @param bands the array of int values indicating the bands being updated.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param theThumbnail
+ * the thumbnail to be updated.
+ * @param minX
+ * the minimum X coordinate of the pixels in the updated area.
+ * @param minY
+ * the minimum Y coordinate of the pixels in the updated area.
+ * @param width
+ * the width of updated area.
+ * @param height
+ * the height of updated area.
+ * @param periodX
+ * the horizontal spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param periodY
+ * the vertical spacing period between updated pixels, if it
+ * equals 1, there is no space between pixels.
+ * @param bands
+ * the array of integer values indicating the bands being
+ * updated.
*/
- void thumbnailUpdate(ImageReader source, BufferedImage theThumbnail,
- int minX, int minY, int width, int height, int periodX,
- int periodY, int[] bands);
+ void thumbnailUpdate(ImageReader source, BufferedImage theThumbnail, int minX, int minY,
+ int width, int height, int periodX, int periodY, int[] bands);
}
-
diff --git a/awt/javax/imageio/event/IIOReadWarningListener.java b/awt/javax/imageio/event/IIOReadWarningListener.java
index 92fa275..318a5df 100644
--- a/awt/javax/imageio/event/IIOReadWarningListener.java
+++ b/awt/javax/imageio/event/IIOReadWarningListener.java
@@ -18,6 +18,7 @@
* @author Sergey I. Salishev
* @version $Revision: 1.2 $
*/
+
package javax.imageio.event;
import java.util.EventListener;
@@ -29,18 +30,20 @@ import javax.imageio.ImageReader;
*/
/**
- * The IIOReadWarningListener provides methods to receive notification
- * of warning messages generated by image
- * and thumbnail reading methods.
+ * The IIOReadWarningListener provides methods to receive notification of
+ * warning messages generated by image and thumbnail reading methods.
+ *
+ * @since Android 1.0
*/
public interface IIOReadWarningListener extends EventListener {
/**
- * Notifies this listener about a warning (non-fatal error) during decoding.
+ * Notifies this listener about a warning (non-fatal error) during decoding.
*
- * @param source the ImageReader object which calls this method.
- * @param warning the string describing the warning.
+ * @param source
+ * the ImageReader object which calls this method.
+ * @param warning
+ * the string describing the warning.
*/
public void warningOccurred(ImageReader source, String warning);
}
-
diff --git a/awt/javax/imageio/event/IIOWriteProgressListener.java b/awt/javax/imageio/event/IIOWriteProgressListener.java
index 19ae495..4a2c595 100644
--- a/awt/javax/imageio/event/IIOWriteProgressListener.java
+++ b/awt/javax/imageio/event/IIOWriteProgressListener.java
@@ -18,69 +18,84 @@
* @author Rustem V. Rafikov
* @version $Revision: 1.3 $
*/
+
package javax.imageio.event;
import javax.imageio.ImageWriter;
import java.util.EventListener;
/**
- * The IIOWriteProgressListener interface provides methods to
- * receive notification about the progress of the image and
- * thumbnail writing methods.
+ * The IIOWriteProgressListener interface provides methods to receive
+ * notification about the progress of the image and thumbnail writing methods.
+ *
+ * @since Android 1.0
*/
public interface IIOWriteProgressListener extends EventListener {
-
+
/**
- * Notifies this listener that an image write operation has been started.
+ * Notifies this listener that an image write operation has been started.
*
- * @param source the ImageWriter object which calls this method.
- * @param imageIndex the index of the image being written.
+ * @param source
+ * the ImageWriter object which calls this method.
+ * @param imageIndex
+ * the index of the image being written.
*/
void imageStarted(ImageWriter source, int imageIndex);
-
+
/**
* Notifies this listener about the degree of completion of the write call.
*
- * @param source the ImageWriter object which calls this method.
- * @param percentageDone the percentage of encoding done.
+ * @param source
+ * the ImageWriter object which calls this method.
+ * @param percentageDone
+ * the percentage of encoding done.
*/
void imageProgress(ImageWriter source, float percentageDone);
-
+
/**
- * Notifies this listener that the image writing has been completed.
+ * Notifies this listener that the image writing has been completed.
*
- * @param source the ImageWriter object which calls this method.
+ * @param source
+ * the ImageWriter object which calls this method.
*/
void imageComplete(ImageWriter source);
-
+
/**
- * Notifies this listener that a thumbnail write operation has been started.
+ * Notifies this listener that a thumbnail write operation has been started.
*
- * @param source the ImageWriter object which calls this method.
- * @param imageIndex the index of the image being written.
- * @param thumbnailIndex the index of the thumbnail being written.
+ * @param source
+ * the ImageWriter object which calls this method.
+ * @param imageIndex
+ * the index of the image being written.
+ * @param thumbnailIndex
+ * the index of the thumbnail being written.
*/
void thumbnailStarted(ImageWriter source, int imageIndex, int thumbnailIndex);
-
+
/**
* Notifies this listener about the degree of completion of the write call.
*
- * @param source the ImageWriter object which calls this method.
- * @param percentageDone the percentage of encoding done.
+ * @param source
+ * the ImageWriter object which calls this method.
+ * @param percentageDone
+ * the percentage of encoding done.
*/
void thumbnailProgress(ImageWriter source, float percentageDone);
-
+
/**
- * Notifies this listener that a thumbnail write operation has been completed.
+ * Notifies this listener that a thumbnail write operation has been
+ * completed.
*
- * @param source the ImageWriter object which calls this method.
+ * @param source
+ * the ImageWriter object which calls this method.
*/
void thumbnailComplete(ImageWriter source);
-
+
/**
* Notifies this listener that writing operation has been aborted.
*
- * @param source the ImageWriter object which calls this method.
+ * @param source
+ * the ImageWriter object which calls this method.
*/
void writeAborted(ImageWriter source);
}
diff --git a/awt/javax/imageio/event/IIOWriteWarningListener.java b/awt/javax/imageio/event/IIOWriteWarningListener.java
index f530d25..8ee41cd 100644
--- a/awt/javax/imageio/event/IIOWriteWarningListener.java
+++ b/awt/javax/imageio/event/IIOWriteWarningListener.java
@@ -18,23 +18,29 @@
* @author Rustem V. Rafikov
* @version $Revision: 1.3 $
*/
+
package javax.imageio.event;
import javax.imageio.ImageWriter;
import java.util.EventListener;
/**
- * The IIOWriteWarningListener provides methods to receive notification
- * of warnings generated by image and thumbnail writing methods.
+ * The IIOWriteWarningListener provides methods to receive notification of
+ * warnings generated by image and thumbnail writing methods.
+ *
+ * @since Android 1.0
*/
public interface IIOWriteWarningListener extends EventListener {
-
+
/**
- * Notifies this listener about a warning (non-fatal error) during encoding.
+ * Notifies this listener about a warning (non-fatal error) during encoding.
*
- * @param source the ImageWriter object which calls this method.
- * @param imageIndex the index of the image generating the warning.
- * @param warning the string describing the warning.
+ * @param source
+ * the ImageWriter object which calls this method.
+ * @param imageIndex
+ * the index of the image generating the warning.
+ * @param warning
+ * the string describing the warning.
*/
void warningOccurred(ImageWriter source, int imageIndex, String warning);
}
diff --git a/awt/javax/imageio/event/package.html b/awt/javax/imageio/event/package.html
new file mode 100644
index 0000000..c2fe39f
--- /dev/null
+++ b/awt/javax/imageio/event/package.html
@@ -0,0 +1,8 @@
+<html>
+ <body>
+ <p>
+ This package provides interfaces to handle events which can be fired during the reading or writing of images.
+ </p>
+ @since Android 1.0
+ </body>
+</html>