java.awt.image
public class ImageFilter extends Object implements ImageConsumer, Cloneable
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.Modifier and Type | Field and Description |
---|---|
protected ImageConsumer |
consumer
The consumer this filter is filtering an image data stream for.
|
COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
Constructor and Description |
---|
ImageFilter() |
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. |
protected ImageConsumer consumer
getFilterInstance
.public ImageFilter()
public void resendTopDownLeftRight(ImageProducer ip)
ImageConsumer
can use this method to request
the pixels be delivered in top-down, left-right order.
ImageProducer
using the method requestTopDownLeftRightResend
and using the filter as the consumer.public Object clone()
Object.clone()
public ImageFilter getFilterInstance(ImageConsumer ic)
ImageConsumer
for this filter. By default a clone
of this filter with the appropriate consumer set is returned.()
public void setDimensions(int width, int height)
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.setDimensions
in interface ImageConsumer
width
- the width of the imageheight
- the height of the imagepublic void setProperties(Hashtable<?,?> props)
ImageProducer
can set a list of properties
associated with this image by using this method.setProperties
in interface ImageConsumer
props
- the list of properties associated with this imagepublic void setColorModel(ColorModel model)
ImageProducer
. By default the setColorModel
method of the consumer is called with the specified model
.setColorModel
in interface ImageConsumer
model
- the color model to be used most often by setPixelsColorModel
public void setHints(int flags)
ImageProducer
should call this method with a
bit mask of hints from any of RANDOMPIXELORDER
,
TOPDOWNLEFTRIGHT
, COMPLETESCANLINES
,
SINGLEPASS
, SINGLEFRAME
from the
ImageConsumer
interface.setHints
in interface ImageConsumer
flags
- a bit mask of hintsImageConsumer
public void setPixels(int x, int y, int w, int h, ColorModel model, byte[] pixels, int offset, int scansize)
byte
at
index (n * scansize + m + offset).setPixels
in interface ImageConsumer
x
- the x coordinate of the rectangley
- the y coordinate of the rectanglew
- the width of the rectangleh
- the height of the rectanglemodel
- the ColorModel
used to translate the pixelspixels
- the array of pixel valuesoffset
- the index of the first pixels in the pixels
arrayscansize
- the width to use in extracting pixels from the pixels
arraypublic void setPixels(int x, int y, int w, int h, ColorModel model, int[] pixels, int offset, int scansize)
int
at
index (n * scansize + m + offset).setPixels
in interface ImageConsumer
x
- the x coordinate of the rectangley
- the y coordinate of the rectanglew
- the width of the rectangleh
- the height of the rectanglemodel
- the ColorModel
used to translate the pixelspixels
- the array of pixel valuesoffset
- the index of the first pixels in the pixels
arrayscansize
- the width to use in extracting pixels from the pixels
arraypublic void imageComplete(int status)
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.imageComplete
in interface ImageConsumer
status
- the status of image production, represented by a
bitwise OR of ImageConsumer flags