java.awt.image

Class CropImageFilter

Implemented Interfaces:
Cloneable, ImageConsumer

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, setDimensions, setHints, setPixels, setPixels, setProperties

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

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 Details

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 interface ImageFilter
Parameters:
width - the width of the image
height - the height of the 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 interface 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 interface 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

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 interface ImageFilter
Parameters:
props - the list of properties associated with this image

CropImageFilter.java -- Java class for cropping image filter Copyright (C) 1999, 2004 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.