com.twelvemonkeys.servlet.image

Class CropFilter

java.lang.Object

com.twelvemonkeys.servlet.GenericFilter

com.twelvemonkeys.servlet.image.ImageFilter

com.twelvemonkeys.servlet.image.ScaleFilter

com.twelvemonkeys.servlet.image.CropFilter

All Implemented Interfaces:

Serializable, javax.servlet.Filter, javax.servlet.FilterConfig

public class CropFilter
extends ScaleFilter

This Servlet is able to render a cropped part of an image.

Parameters:

cropX

integer, the new left edge of the image.

cropY

integer, the new top of the image.

cropWidth

integer, the new width of the image.

cropHeight

integer, the new height of the image.

cropUniform

boolean, wether or not uniform scalnig should be used. Default is true.

cropUnits

string, one of PIXELS, PERCENT. PIXELS is default.

image

string, the URL of the image to scale.

scaleX

integer, the new width of the image.

scaleY

integer, the new height of the image.

scaleUniform

boolean, wether or not uniform scalnig should be used. Default is true.

scaleUnits

string, one of PIXELS, PERCENT. PIXELS is default.

scaleQuality

string, one of SCALE_SMOOTH, SCALE_FAST, SCALE_REPLICATE, SCALE_AREA_AVERAGING. SCALE_DEFAULT is default.

Version:

$Id: CropFilter.java#1 $

Author:

Harald Kuhr, last modified by $Author: haku $

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	PARAM_CROP_HEIGHT cropHeight
protected static String	PARAM_CROP_UNIFORM cropUniform
protected static String	PARAM_CROP_UNITS cropUnits
protected static String	PARAM_CROP_WIDTH cropWidth
protected static String	PARAM_CROP_X cropX
protected static String	PARAM_CROP_Y cropY

Fields inherited from class com.twelvemonkeys.servlet.image.ScaleFilter

defaultScaleQuality, PARAM_IMAGE, PARAM_SCALE_QUALITY, PARAM_SCALE_UNIFORM, PARAM_SCALE_UNITS, PARAM_SCALE_X, PARAM_SCALE_Y, UNITS_PERCENT, UNITS_PIXELS, UNITS_UNKNOWN

Fields inherited from class com.twelvemonkeys.servlet.image.ImageFilter

triggerParams

Fields inherited from class com.twelvemonkeys.servlet.GenericFilter

oncePerRequest

Constructor Summary

Constructors

Constructor and Description
CropFilter()

Method Summary

Modifier and Type	Method and Description
protected RenderedImage	doFilter(BufferedImage pImage, javax.servlet.ServletRequest pRequest, ImageServletResponse pResponse) Reads the image from the requested URL, scales it, crops it, and returns it in the Servlet stream.
protected Rectangle	getBounds(int pX, int pY, int pWidth, int pHeight, int pUnits, boolean pUniform, BufferedImage pImg)

Methods inherited from class com.twelvemonkeys.servlet.image.ScaleFilter

getDimensions, getQuality, getUnits, setDefaultScaleQuality

Methods inherited from class com.twelvemonkeys.servlet.image.ImageFilter

doFilterImpl, setTriggerParams, trigger

Methods inherited from class com.twelvemonkeys.servlet.GenericFilter

destroy, doFilter, getFilterConfig, getFilterName, getInitParameter, getInitParameterNames, getServletContext, init, init, log, log, setFilterConfig, setOncePerRequest

Methods inherited from class java.lang.Object

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

Field Detail

PARAM_CROP_X

protected static final String PARAM_CROP_X

cropX

See Also:

Constant Field Values

PARAM_CROP_Y

protected static final String PARAM_CROP_Y

cropY

See Also:

Constant Field Values

PARAM_CROP_WIDTH

protected static final String PARAM_CROP_WIDTH

cropWidth

See Also:

Constant Field Values

PARAM_CROP_HEIGHT

protected static final String PARAM_CROP_HEIGHT

cropHeight

See Also:

Constant Field Values

PARAM_CROP_UNIFORM

protected static final String PARAM_CROP_UNIFORM

cropUniform

See Also:

Constant Field Values

PARAM_CROP_UNITS

protected static final String PARAM_CROP_UNITS

cropUnits

See Also:

Constant Field Values

Constructor Detail

CropFilter

public CropFilter()

Method Detail

doFilter

protected RenderedImage doFilter(BufferedImage pImage,
                                 javax.servlet.ServletRequest pRequest,
                                 ImageServletResponse pResponse)

Reads the image from the requested URL, scales it, crops it, and returns it in the Servlet stream. See above for details on parameters.

Overrides:

doFilter in class ScaleFilter

Parameters:

pImage - the image to filter

pRequest - the servlet request

pResponse - the servlet response

Returns:

the filtered image

getBounds

protected Rectangle getBounds(int pX,
                              int pY,
                              int pWidth,
                              int pHeight,
                              int pUnits,
                              boolean pUniform,
                              BufferedImage pImg)