java::awt::image::ImageProducer Class Reference

Inheritance diagram for java::awt::image::ImageProducer:

Inheritance graph
java::lang::Interfacejava::lang::Object
[legend]
Collaboration diagram for java::awt::image::ImageProducer:

Collaboration graph
java::lang::Interfacejava::lang::Object
[legend]

List of all members.


Detailed Description

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 also:
ImageConsumer
Version:
1.19 01/23/03
Author:
Jim Graham

Public Member Functions

virtual void addConsumer (const Ref< ImageConsumer > &ic)=0
 Registers an ImageConsumer with the ImageProducer for access to the image data during a later reconstruction of the Image.
virtual jboolean isConsumer (const Ref< ImageConsumer > &ic)=0
 Determines if a specified ImageConsumer object is currently registered with this ImageProducer as one of its consumers.
virtual void removeConsumer (const Ref< ImageConsumer > &ic)=0
 Removes the specified ImageConsumer object from the list of consumers currently registered to receive image data.
virtual void startProduction (const Ref< ImageConsumer > &ic)=0
 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.
virtual void requestTopDownLeftRightResend (const Ref< ImageConsumer > &ic)=0
 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.

Member Function Documentation

virtual void java::awt::image::ImageProducer::addConsumer ( const Ref< ImageConsumer > &  ic  )  [pure virtual]

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.

Parameters:
ic the specified ImageConsumer
See also:
startProduction

virtual jboolean java::awt::image::ImageProducer::isConsumer ( const Ref< ImageConsumer > &  ic  )  [pure virtual]

Determines if a specified ImageConsumer object is currently registered with this ImageProducer as one of its consumers.

Parameters:
ic the specified ImageConsumer
Returns:
true if the specified ImageConsumer is registered with this ImageProducer; false otherwise.

virtual void java::awt::image::ImageProducer::removeConsumer ( const Ref< ImageConsumer > &  ic  )  [pure virtual]

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.

Parameters:
ic the specified ImageConsumer

virtual void java::awt::image::ImageProducer::startProduction ( const Ref< ImageConsumer > &  ic  )  [pure virtual]

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.

Parameters:
ic the specified ImageConsumer
See also:
addConsumer

virtual void java::awt::image::ImageProducer::requestTopDownLeftRightResend ( const Ref< ImageConsumer > &  ic  )  [pure virtual]

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();
 
Parameters:
ic the specified ImageConsumer
See also:
ImageConsumer::setHints


The documentation for this class was generated from the following file:
Generated on Fri May 16 11:56:23 2008 for CrossPlatformJavaLikeC++API by  doxygen 1.5.3