java.awt.image
Class CropImageFilter

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

public class CropImageFilter
extends ImageFilter

Currently this filter does almost nothing and needs to be implemented.


Field Summary
 
Fields inherited from class java.awt.image.ImageFilter
consumer
 
Fields inherited from interface java.awt.image.ImageConsumer
COMPLETESCANLINES, IMAGEABORTED, IMAGEERROR, RANDOMPIXELORDER, SINGLEFRAME, SINGLEFRAMEDONE, SINGLEPASS, STATICIMAGEDONE, TOPDOWNLEFTRIGHT
 
Constructor Summary
CropImageFilter(int x, int y, int width, int height)
          Construct a new CropImageFilter instance.
 
Method Summary
 void setDimensions(int width, int height)
          An ImageProducer indicates the size of the image being produced using this method.
 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.awt.image.ImageFilter
clone, getFilterInstance, imageComplete, resendTopDownLeftRight, setColorModel, setHints
 
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

CropImageFilter

public CropImageFilter(int x,
                       int y,
                       int width,
                       int height)
Construct a new CropImageFilter instance.

Parameters:
x - the x-coordinate location of the top-left of the cropped rectangle
y - the y-coordinate location of the top-left of the cropped rectangle
width - the width of the cropped rectangle
height - the height of the cropped rectangle
Method Detail

setDimensions

public void setDimensions(int width,
                          int height)
An ImageProducer indicates the size of the image being produced using this method. This filter overrides this method in order to set the dimentions to the size of the cropped rectangle instead of the size of the image.

Specified by:
setDimensions in interface ImageConsumer
Overrides:
setDimensions in class ImageFilter
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.
FIXME - What property is set for this class?

Specified by:
setProperties in interface ImageConsumer
Overrides:
setProperties in class ImageFilter
Parameters:
props - the list of properties associated with this image

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
Overrides:
setPixels in class ImageFilter
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
Overrides:
setPixels in class ImageFilter
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