Source for java.awt.image.ImageProducer

   1: /* ImageProducer.java -- Java interface for image production
   2:    Copyright (C) 1999 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 java.awt.image;
  40: 
  41: /**
  42:  * An object implementing the <code>ImageProducer</code> interface can
  43:  * produce data for images.  Each image has a corresponding
  44:  * <code>ImageProducer</code> which is needed for things such as
  45:  * resizing the image.
  46:  *
  47:  * @see ImageConsumer
  48:  * @author C. Brian Jones (cbj@gnu.org) 
  49:  */
  50: public interface ImageProducer
  51: {
  52:     /**
  53:      * Used to register an <code>ImageConsumer</code> with this
  54:      * <code>ImageProducer</code>.  
  55:      */
  56:     void addConsumer(ImageConsumer ic);
  57: 
  58:     /**
  59:      * Used to determine if the given <code>ImageConsumer</code> is
  60:      * already registered with this <code>ImageProducer</code>.  
  61:      */
  62:     boolean isConsumer(ImageConsumer ic);
  63: 
  64:     /**
  65:      * Used to remove an <code>ImageConsumer</code> from the list of
  66:      * registered consumers for this <code>ImageProducer</code>.  
  67:      */
  68:     void removeConsumer(ImageConsumer ic);
  69: 
  70:     /**
  71:      * Used to register an <code>ImageConsumer</code> with this
  72:      * <code>ImageProducer</code> and then immediately start
  73:      * reconstruction of the image data to be delivered to all
  74:      * registered consumers.  
  75:      */
  76:     void startProduction(ImageConsumer ic);
  77: 
  78:     /**
  79:      * Used to register an <code>ImageConsumer</code> with this
  80:      * <code>ImageProducer</code> and then request that this producer
  81:      * resend the image data in the order top-down, left-right.  
  82:      */
  83:     void requestTopDownLeftRightResend(ImageConsumer ic);
  84: }