This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.


java.awt.image
class FilteredImageSource

java.lang.Object extended by java.awt.image.FilteredImageSource
All Implemented Interfaces:
ImageProducer

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));
 
 


Constructor Summary

          Constructs an ImageProducer object from an existing ImageProducer and a filter object.
 
Method Summary
 void

          Adds the specified ImageConsumer to the list of consumers interested in data for the filtered image.
 boolean

          Determines whether an ImageConsumer is on the list of consumers currently interested in data for this image.
 void

          Removes an ImageConsumer from the list of consumers interested in data for this image.
 void

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

          Starts production of the filtered image.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

FilteredImageSource

public FilteredImageSource(ImageProducer orig,
                           ImageFilter imgf)
Constructs an ImageProducer object from an existing ImageProducer and a filter object.

Parameters:
orig - the specified ImageProducer
imgf - the specified ImageFilter
Method Detail

addConsumer

public synchronized void addConsumer(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.

Parameters:
ic - the consumer for the filtered image

isConsumer

public synchronized boolean isConsumer(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.

Parameters:
ic - the specified ImageConsumer
Returns:
true if the ImageConsumer is on the list; false otherwise

removeConsumer

public synchronized void removeConsumer(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.

Parameters:
ic

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. 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.

Parameters:
ic

startProduction

public void startProduction(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.

Parameters:
ic - the consumer for the filtered image


This documentation differs from the official API. Jadeite adds extra features to the API including: variable font sizes, constructions examples, placeholders for classes and methods, and auto-generated “See Also” links. Additionally it is missing some items found in standard Javadoc documentation, including: generics type information, “Deprecated” tags and comments, “See Also” links, along with other minor differences. Please send any questions or feedback to bam@cs.cmu.edu.
This page displays the Jadeite version of the documention, which is derived from the offical documentation that contains this copyright notice:
Copyright 2008 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms. Also see the documentation redistribution policy.
The official Sun™ documentation can be found here at http://java.sun.com/javase/6/docs/api/.