Index (Frames) | Index (No Frames) | Package | Package Tree | Tree
java.awt.image

Class ImageFilter

java.lang.Object
|
+--java.awt.image.ImageFilter

All Implemented Interfaces:

ImageConsumer, Cloneable


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.

Author:

Field Summary

java.awt.image.ImageConsumerconsumer

The consumer this filter is filtering an image data stream for.

Method Summary

java.lang.Objectclone()

By default, returns a shallow copy of the object created by Object.clone()
java.awt.image.ImageFiltergetFilterInstance(java.awt.image.ImageConsumer ic)

This is the only method which can set the ImageConsumer for this filter.
voidimageComplete(int status)

The ImageProducer calls this method to indicate a single frame or the entire image is complete.
voidresendTopDownLeftRight(java.awt.image.ImageProducer ip)

The ImageConsumer can use this method to request the pixels be delivered in top-down, left-right order.
voidsetColorModel(java.awt.image.ColorModel model)

Override this method to process calls to this method from the ImageProducer.
voidsetDimensions(int width, int height)

An ImageProducer indicates the size of the image being produced using this method.
voidsetHints(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.
voidsetPixels(int x, int y, int w, int h, java.awt.image.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).
voidsetPixels(int x, int y, int w, int h, java.awt.image.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).
voidsetProperties(java.util.Hashtable props)

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

Field Details

consumer

protected ImageConsumer consumer

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


Method Details

clone

public Object clone()

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

See Also:


getFilterInstance

public ImageFilter getFilterInstance(java.awt.image.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.

Parameters:

See Also:


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.

Parameters:


resendTopDownLeftRight

public void resendTopDownLeftRight(java.awt.image.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.

Parameters:


setColorModel

public void setColorModel(java.awt.image.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:

See Also:


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:


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:

See Also:


setPixels

public void setPixels(int x, int y, int w, int h, java.awt.image.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:


setPixels

public void setPixels(int x, int y, int w, int h, java.awt.image.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).

Parameters:


setProperties

public void setProperties(java.util.Hashtable props)

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

Parameters: