JavaTM 2 Platform
Standard Ed. 5.0

java.awt.image.renderable
Class RenderableImageProducer

java.lang.Object
  extended by java.awt.image.renderable.RenderableImageProducer
All Implemented Interfaces:
ImageProducer, Runnable

public class RenderableImageProducer
extends Object
implements ImageProducer, Runnable

An adapter class that implements ImageProducer to allow the asynchronous production of a RenderableImage. The size of the ImageConsumer is determined by the scale factor of the usr2dev transform in the RenderContext. If the RenderContext is null, the default rendering of the RenderableImage is used. This class implements an asynchronous production that produces the image in one thread at one resolution. This class may be subclassed to implement versions that will render the image using several threads. These threads could render either the same image at progressively better quality, or different sections of the image at a single resolution.


Constructor Summary
RenderableImageProducer(RenderableImage rdblImage, RenderContext rc)
          Constructs a new RenderableImageProducer from a RenderableImage and a RenderContext.
 
Method Summary
 void addConsumer(ImageConsumer ic)
          Adds an ImageConsumer to the list of consumers interested in data for this image.
 boolean isConsumer(ImageConsumer ic)
          Determine if an ImageConsumer is on the list of consumers currently interested in data for this image.
 void removeConsumer(ImageConsumer ic)
          Remove an ImageConsumer from the list of consumers interested in data for this image.
 void requestTopDownLeftRightResend(ImageConsumer ic)
          Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order.
 void run()
          The runnable method for this class.
 void setRenderContext(RenderContext rc)
          Sets a new RenderContext to use for the next startProduction() call.
 void startProduction(ImageConsumer ic)
          Adds an ImageConsumer to the list of consumers interested in data for this image, and immediately starts delivery of the image data through the ImageConsumer interface.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

RenderableImageProducer

public RenderableImageProducer(RenderableImage rdblImage,
                               RenderContext rc)
Constructs a new RenderableImageProducer from a RenderableImage and a RenderContext.

Parameters:
rdblImage - the RenderableImage to be rendered.
rc - the RenderContext to use for producing the pixels.
Method Detail

setRenderContext

public void setRenderContext(RenderContext rc)
Sets a new RenderContext to use for the next startProduction() call.

Parameters:
rc - the new RenderContext.

addConsumer

public void addConsumer(ImageConsumer ic)
Adds an ImageConsumer to the list of consumers interested in data for this image.

Specified by:
addConsumer in interface ImageProducer
Parameters:
ic - an ImageConsumer to be added to the interest list.
See Also:
ImageProducer.startProduction(java.awt.image.ImageConsumer)

isConsumer

public boolean isConsumer(ImageConsumer ic)
Determine if an ImageConsumer is on the list of consumers currently interested in data for this image.

Specified by:
isConsumer in interface ImageProducer
Parameters:
ic - the ImageConsumer to be checked.
Returns:
true if the ImageConsumer is on the list; false otherwise.

removeConsumer

public void removeConsumer(ImageConsumer ic)
Remove an ImageConsumer from the list of consumers interested in data for this image.

Specified by:
removeConsumer in interface ImageProducer
Parameters:
ic - the ImageConsumer to be removed.

startProduction

public void startProduction(ImageConsumer ic)
Adds an ImageConsumer to the list of consumers interested in data for this image, and immediately starts delivery of the image data through the ImageConsumer interface.

Specified by:
startProduction in interface ImageProducer
Parameters:
ic - the ImageConsumer to be added to the list of consumers.
See Also:
ImageProducer.addConsumer(java.awt.image.ImageConsumer)

requestTopDownLeftRightResend

public void requestTopDownLeftRightResend(ImageConsumer ic)
Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order.

Specified by:
requestTopDownLeftRightResend in interface ImageProducer
Parameters:
ic - the ImageConsumer requesting the resend.
See Also:
ImageConsumer.setHints(int)

run

public void run()
The runnable method for this class. This will produce an image using the current RenderableImage and RenderContext and send it to all the ImageConsumer currently registered with this class.

Specified by:
run in interface Runnable
See Also:
Thread.run()

JavaTM 2 Platform
Standard Ed. 5.0

Submit a bug or feature
For further API reference and developer documentation, see Java 2 SDK SE Developer Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.

Copyright 2004 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.