java.awt.image.ImageProducer Maven / Gradle / Ivy

Neither this file nor any files generated from it describe a complete specification, and they may only be used as described below. For example, no permission is given for you to incorporate this file, in whole or in part, in an implementation of a Java specification.

Sun Microsystems Inc. owns the copyright in this file and it is provided to you for informative, as opposed to normative, use. The file and any files generated from it may be used to generate other informative documentation, such as a unified set of documents of API signatures for a platform that includes technologies expressed as Java APIs. The file may also be used to produce "compilation stubs," which allow applications to be compiled and validated for such platforms.

Any work generated from this file, such as unified javadocs or compiled stub files, must be accompanied by this notice in its entirety.

This work corresponds to the API signatures of JSR 217: Personal Basis Profile 1.1. In the event of a discrepency between this work and the JSR 217 specification, which is available at http://www.jcp.org/en/jsr/detail?id=217, the latter takes precedence. */ package java.awt.image; /** * The interface for objects which can produce the image data for Images. * Each image contains an ImageProducer which is used to reconstruct * the image whenever it is needed, for example, when a new size of the * Image is scaled, or when the width or height of the Image is being * requested. * * @see ImageConsumer * * @version 1.19 01/23/03 * @author Jim Graham */ public interface ImageProducer { /** * Registers an ImageConsumer with the * ImageProducer for access to the image data * during a later reconstruction of the Image. * The ImageProducer may, at its discretion, * start delivering the image data to the consumer * using the ImageConsumer interface immediately, * or when the next available image reconstruction is triggered * by a call to the startProduction method. * @param ic the specified ImageConsumer * @see #startProduction */ public void addConsumer(ImageConsumer ic); /** * Determines if a specified ImageConsumer * object is currently registered with this * ImageProducer as one of its consumers. * @param ic the specified ImageConsumer * @return true if the specified * ImageConsumer is registered with * this ImageProducer; * false otherwise. */ public boolean isConsumer(ImageConsumer ic); /** * Removes the specified ImageConsumer object * from the list of consumers currently registered to * receive image data. It is not considered an error * to remove a consumer that is not currently registered. * The ImageProducer should stop sending data * to this consumer as soon as is feasible. * @param ic the specified ImageConsumer */ public void removeConsumer(ImageConsumer ic); /** * Registers the specified ImageConsumer object * as a consumer and starts an immediate reconstruction of * the image data which will then be delivered to this * consumer and any other consumer which might have already * been registered with the producer. This method differs * from the addConsumer method in that a reproduction of * the image data should be triggered as soon as possible. * @param ic the specified ImageConsumer * @see #addConsumer */ public void startProduction(ImageConsumer ic); /** * Requests, on behalf of the ImageConsumer, * that the ImageProducer attempt to resend * the image data one more time in TOPDOWNLEFTRIGHT order * so that higher quality conversion algorithms which * depend on receiving pixels in order can be used to * produce a better output version of the image. The * ImageProducer is free to * ignore this call if it cannot resend the data in that * order. If the data can be resent, the * ImageProducer should respond by executing * the following minimum set of ImageConsumer * method calls: *

     *	ic.setHints(TOPDOWNLEFTRIGHT | < otherhints >);
     *	ic.setPixels(...);	// As many times as needed
     *	ic.imageComplete();
     *