libjava/javax/imageio/event/IIOWriteProgressListener.java

   1 /* IIOWriteProgressListener.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., 59 Temple Place, Suite 330, Boston, MA
  19 02111-1307 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.ImageWriter;
  44
  45 public interface IIOWriteProgressListener extends EventListener
  46 {
  47   /**
  48    * Reports that an image write operation has completed.
  49    *
  50    * @param source the <code>ImageWriter</code> object calling this method
  51    */
  52   void imageComplete(ImageWriter source);
  53
  54   /**
  55    * Reports the approximate percentage of completion of an image write
  56    * operation.
  57    *
  58    * @param source the <code>ImageWriter</code> object calling this method
  59    * @param percentageDone the approximate percentage of decoding completed
  60    */
  61   void imageProgress(ImageWriter source, float percentageDone);
  62
  63   /**
  64    * Reports that a thumbnail write operation has started.
  65    *
  66    * @param source the <code>ImageWriter</code> object calling this method
  67    * @param imageIndex the index of the image being written
  68    */
  69   void imageStarted(ImageWriter source, int imageIndex);
  70
  71   /**
  72    * Reports that a thumbnail write operation has completed.
  73    *
  74    * @param source the <code>ImageWriter</code> object calling this method
  75    */
  76   void thumbnailComplete(ImageWriter source);
  77
  78   /**
  79    * Reports the approximate percentage of completion of a thumbnail write
  80    * operation.
  81    *
  82    * @param source the <code>ImageWriter</code> object calling this method
  83    * @param percentageDone the approximate percentage of decoding completed
  84    */
  85   void thumbnailProgress(ImageWriter source, float percentageDone);
  86
  87   /**
  88    * Reports that a thumbnail write operation is beginning.
  89    *
  90    * @param source the <code>ImageWriter</code> object calling this method
  91    * @param imageIndex the index of the image being written
  92    * @param thumnailIndex the index of the thumbnail being written
  93    */
  94   void thumbnailStarted(ImageWriter source, int imageIndex, int thumnailIndex);
  95
  96   /**
  97    * Reports that an image write operation is aborted.
  98    *
  99    * @param source the <code>ImageWriter</code> object calling this method
 100    */
 101   void writeAborted(ImageWriter source);
 102 }