FileDocCategorySizeDatePackage
FilteredImageSource.javaAPI DocJava SE 5 API6124Fri Aug 26 14:56:54 BST 2005java.awt.image

FilteredImageSource

public class FilteredImageSource extends Object implements ImageProducer
This class is an implementation of the ImageProducer interface which takes an existing image and a filter object and uses them to produce image data for a new filtered version of the original image. Here is an example which filters an image by swapping the red and blue compents:

Image src = getImage("doc:///demo/images/duke/T1.gif");
ImageFilter colorfilter = new RedBlueSwapFilter();
Image img = createImage(new FilteredImageSource(src.getSource(),
colorfilter));

see
ImageProducer
version
1.28 12/19/03
author
Jim Graham

Fields Summary
ImageProducer
src
ImageFilter
filter
private Hashtable
proxies
Constructors Summary
public FilteredImageSource(ImageProducer orig, ImageFilter imgf)
Constructs an ImageProducer object from an existing ImageProducer and a filter object.

param
orig the specified ImageProducer
param
imgf the specified ImageFilter
see
ImageFilter
see
java.awt.Component#createImage

	src = orig;
	filter = imgf;
    
Methods Summary
public synchronized voidaddConsumer(java.awt.image.ImageConsumer ic)
Adds the specified ImageConsumer to the list of consumers interested in data for the filtered image. An instance of the original ImageFilter is created (using the filter's getFilterInstance method) to manipulate the image data for the specified ImageConsumer. The newly created filter instance is then passed to the addConsumer method of the original ImageProducer.

This method is public as a side effect of this class implementing the ImageProducer interface. It should not be called from user code, and its behavior if called from user code is unspecified.

param
ic the consumer for the filtered image
see
ImageConsumer

	if (proxies == null) {
	    proxies = new Hashtable();
	}
	if (!proxies.containsKey(ic)) {
	    ImageFilter imgf = filter.getFilterInstance(ic);
	    proxies.put(ic, imgf);
	    src.addConsumer(imgf);
	}
    
public synchronized booleanisConsumer(java.awt.image.ImageConsumer ic)
Determines whether an ImageConsumer is on the list of consumers currently interested in data for this image.

This method is public as a side effect of this class implementing the ImageProducer interface. It should not be called from user code, and its behavior if called from user code is unspecified.

param
ic the specified ImageConsumer
return
true if the ImageConsumer is on the list; false otherwise
see
ImageConsumer

	return (proxies != null && proxies.containsKey(ic));
    
public synchronized voidremoveConsumer(java.awt.image.ImageConsumer ic)
Removes an ImageConsumer from the list of consumers interested in data for this image.

This method is public as a side effect of this class implementing the ImageProducer interface. It should not be called from user code, and its behavior if called from user code is unspecified.

see
ImageConsumer

	if (proxies != null) {
	    ImageFilter imgf = (ImageFilter) proxies.get(ic);
	    if (imgf != null) {
		src.removeConsumer(imgf);
		proxies.remove(ic);
		if (proxies.isEmpty()) {
		    proxies = null;
		}
	    }
	}
    
public voidrequestTopDownLeftRightResend(java.awt.image.ImageConsumer ic)
Requests that a given ImageConsumer have the image data delivered one more time in top-down, left-right order. The request is handed to the ImageFilter for further processing, since the ability to preserve the pixel ordering depends on the filter.

This method is public as a side effect of this class implementing the ImageProducer interface. It should not be called from user code, and its behavior if called from user code is unspecified.

see
ImageConsumer

	if (proxies != null) {
	    ImageFilter imgf = (ImageFilter) proxies.get(ic);
	    if (imgf != null) {
		imgf.resendTopDownLeftRight(src);
	    }
	}
    
public voidstartProduction(java.awt.image.ImageConsumer ic)
Starts production of the filtered image. If the specified ImageConsumer isn't already a consumer of the filtered image, an instance of the original ImageFilter is created (using the filter's getFilterInstance method) to manipulate the image data for the ImageConsumer. The filter instance for the ImageConsumer is then passed to the startProduction method of the original ImageProducer.

This method is public as a side effect of this class implementing the ImageProducer interface. It should not be called from user code, and its behavior if called from user code is unspecified.

param
ic the consumer for the filtered image
see
ImageConsumer

	if (proxies == null) {
	    proxies = new Hashtable();
	}
	ImageFilter imgf = (ImageFilter) proxies.get(ic);
	if (imgf == null) {
	    imgf = filter.getFilterInstance(ic);
	    proxies.put(ic, imgf);
	}
	src.startProduction(imgf);