Source for javax.imageio.event.IIOReadProgressListener

   1: /* IIOReadProgressListener.java --
   2:    Copyright (C) 2004  Free Software Foundation, Inc.
   3: 
   4: This file is part of GNU Classpath.
   5: 
   6: GNU Classpath is free software; you can redistribute it and/or modify
   7: it under the terms of the GNU General Public License as published by
   8: the Free Software Foundation; either version 2, or (at your option)
   9: any later version.
  10: 
  11: GNU Classpath is distributed in the hope that it will be useful, but
  12: WITHOUT ANY WARRANTY; without even the implied warranty of
  13: MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
  14: General Public License for more details.
  15: 
  16: You should have received a copy of the GNU General Public License
  17: along with GNU Classpath; see the file COPYING.  If not, write to the
  18: Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
  19: 02110-1301 USA.
  20: 
  21: Linking this library statically or dynamically with other modules is
  22: making a combined work based on this library.  Thus, the terms and
  23: conditions of the GNU General Public License cover the whole
  24: combination.
  25: 
  26: As a special exception, the copyright holders of this library give you
  27: permission to link this library with independent modules to produce an
  28: executable, regardless of the license terms of these independent
  29: modules, and to copy and distribute the resulting executable under
  30: terms of your choice, provided that you also meet, for each linked
  31: independent module, the terms and conditions of the license of that
  32: module.  An independent module is a module which is not derived from
  33: or based on this library.  If you modify this library, you may extend
  34: this exception to your version of the library, but you are not
  35: obligated to do so.  If you do not wish to do so, delete this
  36: exception statement from your version. */
  37: 
  38: 
  39: package javax.imageio.event;
  40: 
  41: import java.util.EventListener;
  42: 
  43: import javax.imageio.ImageReader;
  44: 
  45: public interface IIOReadProgressListener extends EventListener
  46: {
  47:   /**
  48:    * Reports that the current image read operation has completed.
  49:    * 
  50:    * @param source the <code>ImageReader</code> object calling this method
  51:    */
  52:   void imageComplete(ImageReader source);
  53: 
  54:   /**
  55:    * Reports the approximate percentage of completions of this image read
  56:    * operation.
  57:    * 
  58:    * @param source the <code>ImageReader</code> object calling this method
  59:    * @param percentageDone the approximate percentage of encoding completed
  60:    */
  61:   void imageProgress(ImageReader source, float percentageDone);
  62: 
  63:   /**
  64:    * Reports that the current image read operation has started.
  65:    * 
  66:    * @param source the <code>ImageReader</code> object calling this method
  67:    * @param imageIndex the index of the image to read
  68:    */
  69:   void imageStarted(ImageReader source, int imageIndex);
  70: 
  71:   /**
  72:    * Reports that a read operation has been aborted.
  73:    * 
  74:    * @param source the <code>ImageReader</code> object calling this method
  75:    */
  76:   void readAborted(ImageReader source);
  77: 
  78:   /**
  79:    * Reports that a sequence of read operationshas completed.
  80:    * 
  81:    * @param source the <code>ImageReader</code> object calling this method
  82:    */
  83:   void sequenceComplete(ImageReader source);
  84: 
  85:   /**
  86:    * Reports that a sequence of read operations is beginning.
  87:    * 
  88:    * @param source the <code>ImageReader</code> object calling this method
  89:    * @param minIndex the index of the first image to be read
  90:    */
  91:   void sequenceStarted(ImageReader source, int minIndex);
  92: 
  93:   /**
  94:    * Reports that a thumbnail read operation has completed.
  95:    * 
  96:    * @param source the <code>ImageReader</code> object calling this method
  97:    */
  98:   void thumbnailComplete(ImageReader source);
  99: 
 100:   /**
 101:    * Reports the approximate percentage of completion of a thumbnail read
 102:    * operation.
 103:    * 
 104:    * @param source the <code>ImageReader</code> object calling this method
 105:    * @param percentageDone the approximate percentage of encoding completed
 106:    */
 107:   void thumbnailProgress(ImageReader source, float percentageDone);
 108: 
 109:   /**
 110:    * Reports that a thumbnail read operation is beginning.
 111:    * 
 112:    * @param source the <code>ImageReader</code> object calling this method
 113:    * @param imageIndex the index of the image being read
 114:    * @param thumbnailIndex the index of the thumbnail being read
 115:    */
 116:   void thumbnailStarted(ImageReader source, int imageIndex, int thumbnailIndex);
 117: }