001/* IIOWriteProgressListener.java -- 002 Copyright (C) 2004 Free Software Foundation, Inc. 003 004This file is part of GNU Classpath. 005 006GNU Classpath is free software; you can redistribute it and/or modify 007it under the terms of the GNU General Public License as published by 008the Free Software Foundation; either version 2, or (at your option) 009any later version. 010 011GNU Classpath is distributed in the hope that it will be useful, but 012WITHOUT ANY WARRANTY; without even the implied warranty of 013MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 014General Public License for more details. 015 016You should have received a copy of the GNU General Public License 017along with GNU Classpath; see the file COPYING. If not, write to the 018Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 01902110-1301 USA. 020 021Linking this library statically or dynamically with other modules is 022making a combined work based on this library. Thus, the terms and 023conditions of the GNU General Public License cover the whole 024combination. 025 026As a special exception, the copyright holders of this library give you 027permission to link this library with independent modules to produce an 028executable, regardless of the license terms of these independent 029modules, and to copy and distribute the resulting executable under 030terms of your choice, provided that you also meet, for each linked 031independent module, the terms and conditions of the license of that 032module. An independent module is a module which is not derived from 033or based on this library. If you modify this library, you may extend 034this exception to your version of the library, but you are not 035obligated to do so. If you do not wish to do so, delete this 036exception statement from your version. */ 037 038 039package javax.imageio.event; 040 041import java.util.EventListener; 042 043import javax.imageio.ImageWriter; 044 045public interface IIOWriteProgressListener extends EventListener 046{ 047 /** 048 * Reports that an image write operation has completed. 049 * 050 * @param source the <code>ImageWriter</code> object calling this method 051 */ 052 void imageComplete(ImageWriter source); 053 054 /** 055 * Reports the approximate percentage of completion of an image write 056 * operation. 057 * 058 * @param source the <code>ImageWriter</code> object calling this method 059 * @param percentageDone the approximate percentage of decoding completed 060 */ 061 void imageProgress(ImageWriter source, float percentageDone); 062 063 /** 064 * Reports that a thumbnail write operation has started. 065 * 066 * @param source the <code>ImageWriter</code> object calling this method 067 * @param imageIndex the index of the image being written 068 */ 069 void imageStarted(ImageWriter source, int imageIndex); 070 071 /** 072 * Reports that a thumbnail write operation has completed. 073 * 074 * @param source the <code>ImageWriter</code> object calling this method 075 */ 076 void thumbnailComplete(ImageWriter source); 077 078 /** 079 * Reports the approximate percentage of completion of a thumbnail write 080 * operation. 081 * 082 * @param source the <code>ImageWriter</code> object calling this method 083 * @param percentageDone the approximate percentage of decoding completed 084 */ 085 void thumbnailProgress(ImageWriter source, float percentageDone); 086 087 /** 088 * Reports that a thumbnail write operation is beginning. 089 * 090 * @param source the <code>ImageWriter</code> object calling this method 091 * @param imageIndex the index of the image being written 092 * @param thumnailIndex the index of the thumbnail being written 093 */ 094 void thumbnailStarted(ImageWriter source, int imageIndex, int thumnailIndex); 095 096 /** 097 * Reports that an image write operation is aborted. 098 * 099 * @param source the <code>ImageWriter</code> object calling this method 100 */ 101 void writeAborted(ImageWriter source); 102}