java.awt.image

Class ImageFilter

public class ImageFilter extends Object implements ImageConsumer, Cloneable

The ImageFilter class is a base class which can be extended to provide different types of filters for an image. By default this class does nothing to an image passing through it.

Field Summary
protected ImageConsumer	consumer The consumer this filter is filtering an image data stream for.

Method Summary
Object	clone() By default, returns a shallow copy of the object created by `Object.clone()`
ImageFilter	getFilterInstance(ImageConsumer ic) This is the only method which can set the `ImageConsumer` for this filter.
void	imageComplete(int status) The `ImageProducer` calls this method to indicate a single frame or the entire image is complete.
void	resendTopDownLeftRight(ImageProducer ip) The `ImageConsumer` can use this method to request the pixels be delivered in top-down, left-right order.
void	setColorModel(ColorModel model) Override this method to process calls to this method from the `ImageProducer`.
void	setDimensions(int width, int height) An `ImageProducer` indicates the size of the image being produced using this method.
void	setHints(int flags) The `ImageProducer` should call this method with a bit mask of hints from any of `RANDOMPIXELORDER`, `TOPDOWNLEFTRIGHT`, `COMPLETESCANLINES`, `SINGLEPASS`, `SINGLEFRAME` from the `ImageConsumer` interface.
void	setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int offset, int scansize) This function delivers a rectangle of pixels where any pixel(m,n) is stored in the array as a `byte` at index (n * scansize + m + offset).
void	setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int offset, int scansize) This function delivers a rectangle of pixels where any pixel(m,n) is stored in the array as an `int` at index (n * scansize + m + offset).
void	setProperties(Hashtable<?,?> props) An `ImageProducer` can set a list of properties associated with this image by using this method.

Field Detail

consumer

protected ImageConsumer consumer

The consumer this filter is filtering an image data stream for. It is initialized in the method getFilterInstance.

Method Detail

clone

public Object clone()

By default, returns a shallow copy of the object created by Object.clone()

getFilterInstance

public ImageFilter getFilterInstance(ImageConsumer ic)

This is the only method which can set the ImageConsumer for this filter. By default a clone of this filter with the appropriate consumer set is returned.

imageComplete

public void imageComplete(int status)

The ImageProducer calls this method to indicate a single frame or the entire image is complete. The method is also used to indicate an error in loading or producing the image.

resendTopDownLeftRight

public void resendTopDownLeftRight(ImageProducer ip)

The ImageConsumer can use this method to request the pixels be delivered in top-down, left-right order.
The filter can respond in three different ways.

The default behavior is to forward the request to the ImageProducer using the method requestTopDownLeftRightResend and using the filter as the consumer.
The filter has the pixels and can retransmit them in the top-down, left-right order.
The filter can do nothing when this method is called.

setColorModel

public void setColorModel(ColorModel model)

Override this method to process calls to this method from the ImageProducer. By default the setColorModel method of the consumer is called with the specified model.

Parameters: model the color model to be used most often by setPixels

setDimensions

public void setDimensions(int width, int height)

An ImageProducer indicates the size of the image being produced using this method. A filter can override this method to intercept these calls from the producer in order to change either the width or the height before in turn calling the consumer's setDimensions method.

Parameters: width the width of the image height the height of the image

setHints

public void setHints(int flags)

The ImageProducer should call this method with a bit mask of hints from any of RANDOMPIXELORDER, TOPDOWNLEFTRIGHT, COMPLETESCANLINES, SINGLEPASS, SINGLEFRAME from the ImageConsumer interface.

Parameters: flags a bit mask of hints

setPixels

public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int offset, int scansize)

This function delivers a rectangle of pixels where any pixel(m,n) is stored in the array as a byte at index (n * scansize + m + offset).

Parameters: x the x coordinate of the rectangle y the y coordinate of the rectangle w the width of the rectangle h the height of the rectangle model the ColorModel used to translate the pixels pixels the array of pixel values offset the index of the first pixels in the pixels array scansize the width to use in extracting pixels from the pixels array

setPixels

public void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int offset, int scansize)

This function delivers a rectangle of pixels where any pixel(m,n) is stored in the array as an int at index (n * scansize + m + offset).

setProperties

public void setProperties(Hashtable<?,?> props)

An ImageProducer can set a list of properties associated with this image by using this method.

Parameters: props the list of properties associated with this image