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 BufferedImageFilter

java.lang.Object extended by java.awt.image.ImageFilter extended by java.awt.image.BufferedImageFilter
All Implemented Interfaces:
ImageConsumer, Cloneable

public class BufferedImageFilter
extends ImageFilter
implements Cloneable

The BufferedImageFilter class subclasses an ImageFilter to provide a simple means of using a single-source/single-destination image operator ({@link BufferedImageOp}) to filter a BufferedImage in the Image Producer/Consumer/Observer paradigm. Examples of these image operators are: {@link ConvolveOp}, {@link AffineTransformOp} and {@link LookupOp}.


Field Summary
 
Fields inherited from class java.awt.image.ImageFilter
consumer
 
Constructor Summary

          Constructs a BufferedImageFilter with the specified single-source/single-destination operator.
 
Method Summary
 BufferedImageOp

          Returns the BufferedImageOp.
 void
imageComplete(int status)

          Filters the information provided in the imageComplete method of the ImageConsumer interface.
 void

          Filters the information provided in the java.awt.image.ImageConsumer.setColorModel method of the ImageConsumer interface.
 void
setDimensions(int width, int height)

          Filters the information provided in the java.awt.image.ImageConsumer.setDimensions method of the java.awt.image.ImageConsumer interface.
 void
setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int off, int scansize)

          Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.
 void
setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int off, int scansize)

          Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.
 
Methods inherited from class java.awt.image.ImageFilter
clone, getFilterInstance, imageComplete, resendTopDownLeftRight, setColorModel, setDimensions, setHints, setPixels, setPixels, setProperties
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

BufferedImageFilter

public BufferedImageFilter(BufferedImageOp op)
Constructs a BufferedImageFilter with the specified single-source/single-destination operator.

Parameters:
op - the specified BufferedImageOp to use to filter a BufferedImage
Method Detail

getBufferedImageOp

public BufferedImageOp getBufferedImageOp()
Returns the BufferedImageOp.

Returns:
the operator of this BufferedImageFilter.

imageComplete

public void imageComplete(int status)
Filters the information provided in the imageComplete method of the ImageConsumer interface.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Overrides:
imageComplete in class ImageFilter
Parameters:
status - the status of image loading

setColorModel

public void setColorModel(ColorModel model)
Filters the information provided in the {@link ImageConsumer#setColorModel(ColorModel) setColorModel} method of the ImageConsumer interface.

If model is null, this method clears the current ColorModel of this BufferedImageFilter.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Overrides:
setColorModel in class ImageFilter
Parameters:
model - the {@link ColorModel} to which to set the ColorModel of this BufferedImageFilter

setDimensions

public void setDimensions(int width,
                          int height)
Filters the information provided in the {@link ImageConsumer#setDimensions(int, int) setDimensions } method of the {@link ImageConsumer} interface.

Note: This method is intended to be called by the {@link ImageProducer} of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Overrides:
setDimensions in class ImageFilter
Parameters:
width - the width to which to set the width of this BufferedImageFilter
height - the height to which to set the height of this BufferedImageFilter

setPixels

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      ColorModel model,
                      byte[] pixels,
                      int off,
                      int scansize)
Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of bytes.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Overrides:
setPixels in class ImageFilter
Parameters:
x
y
w
h
model
pixels
off
scansize

setPixels

public void setPixels(int x,
                      int y,
                      int w,
                      int h,
                      ColorModel model,
                      int[] pixels,
                      int off,
                      int scansize)
Filters the information provided in the setPixels method of the ImageConsumer interface which takes an array of integers.

Note: This method is intended to be called by the ImageProducer of the Image whose pixels are being filtered. Developers using this class to retrieve pixels from an image should avoid calling this method directly since that operation could result in problems with retrieving the requested pixels.

Overrides:
setPixels in class ImageFilter
Parameters:
x
y
w
h
model
pixels
off
scansize


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