java.awt.image

Class ImageFilter

java.lang.Object

java.awt.image.ImageFilter

All Implemented Interfaces:

ImageConsumer, Cloneable

Direct Known Subclasses:

BufferedImageFilter, CropImageFilter, ReplicateScaleFilter, RGBImageFilter

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

Fields

Modifier and Type	Field and Description
protected ImageConsumer	consumer The consumer this filter is filtering an image data stream for.

Fields inherited from interface java.awt.image.ImageConsumer

COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT

Constructor Summary

Constructors

Constructor and Description
ImageFilter()

Method Summary

Methods

Modifier and Type	Method and Description
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.

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

consumer

protected ImageConsumer consumer

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

Constructor Detail

ImageFilter

public ImageFilter()

Method Detail

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.

clone

public Object clone()

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

Overrides:

clone in class Object

Returns:

a copy of the Object

See Also:

()

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.

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.

Specified by:

setDimensions in interface ImageConsumer

Parameters:

width - the width of the image

height - the height of the image

setProperties

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

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

Specified by:

setProperties in interface ImageConsumer

Parameters:

props - the list of properties associated with this image

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.

Specified by:

setColorModel in interface ImageConsumer

Parameters:

model - the color model to be used most often by setPixels

See Also:

ColorModel

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.

Specified by:

setHints in interface ImageConsumer

Parameters:

flags - a bit mask of hints

See Also:

ImageConsumer

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

Specified by:

setPixels in interface ImageConsumer

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

Specified by:

setPixels in interface ImageConsumer

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

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.

Specified by:

imageComplete in interface ImageConsumer

Parameters:

status - the status of image production, represented by a bitwise OR of ImageConsumer flags