com.jhlabs.image

Class AbstractBufferedImageOp

java.lang.Object

com.jhlabs.image.AbstractBufferedImageOp

All Implemented Interfaces:

BufferedImageOp, Cloneable, FilterListener, ImageFilterOpSupport

Direct Known Subclasses:

ApplyMaskFilter, BicubicScaleFilter, BlockFilter, BorderFilter, BoxBlurFilter, ChromaKeyFilter, ColorHalftoneFilter, CompositeFilter, CompoundFilter, ConvolveFilter, CropFilter, DeinterlaceFilter, DoGFilter, FeedbackFilter, FlipFilter, GlintFilter, GradientFilter, GradientWipeFilter, HalftoneFilter, InterpolateFilter, IteratedFilter, KeyFilter, LaplaceFilter, LensBlurFilter, MirrorFilter, MotionBlurFilter, MotionBlurOp, PointFilter, RenderTextFilter, ScaleFilter, ScratchFilter, ShadowFilter, ShatterFilter, ShineFilter, SmartBlurFilter, TileImageFilter, TransformFilter, TransitionFilter, VariableBlurFilter, WholeImageFilter

public abstract class AbstractBufferedImageOp
extends Object
implements BufferedImageOp, Cloneable, FilterListener, ImageFilterOpSupport

A convenience class which implements those methods of BufferedImageOp which are rarely changed.

Author:

Jerry Huxtable (2006), Adam Zimowski (mrazjava) (2013) - event handling and warning cleanup

Field Summary

Fields

Modifier and Type	Field and Description
protected FilterListener	filterListener

Constructor Summary

Constructors

Constructor and Description
AbstractBufferedImageOp()

Method Summary

Methods

Modifier and Type	Method and Description
Object	clone()
BufferedImage	createCompatibleDestImage(BufferedImage src, ColorModel dstCM)
BufferedImage	createCompatibleDestImage(BufferedImage src, ColorModel dstCM, Integer width, Integer height)
BufferedImage	filter(BufferedImage src, BufferedImage dest)
void	filterDone()
void	filterInitialize()
void	filterProgress(int percentComplete)
void	filterStart(int totalPixels)
Rectangle2D	getBounds2D(BufferedImage src)
ImageFilterOps	getMetaData() Bambi filter metadata.
Point2D	getPoint2D(Point2D srcPt, Point2D dstPt)
RenderingHints	getRenderingHints()
int[]	getRGB(BufferedImage image, int x, int y, int width, int height, int[] pixels) A convenience method for getting ARGB pixels from an image.
void	setFilterListener(FilterListener listener)
void	setRGB(BufferedImage image, int x, int y, int width, int height, int[] pixels) A convenience method for setting ARGB pixels in an image.

Methods inherited from class java.lang.Object

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

Field Detail

filterListener

protected FilterListener filterListener

Constructor Detail

AbstractBufferedImageOp

public AbstractBufferedImageOp()

Method Detail

setFilterListener

public void setFilterListener(FilterListener listener)

createCompatibleDestImage

public BufferedImage createCompatibleDestImage(BufferedImage src,
                                      ColorModel dstCM)

Specified by:

createCompatibleDestImage in interface BufferedImageOp

createCompatibleDestImage

public BufferedImage createCompatibleDestImage(BufferedImage src,
                                      ColorModel dstCM,
                                      Integer width,
                                      Integer height)

getBounds2D

public Rectangle2D getBounds2D(BufferedImage src)

Specified by:

getBounds2D in interface BufferedImageOp

getPoint2D

public Point2D getPoint2D(Point2D srcPt,
                 Point2D dstPt)

Specified by:

getPoint2D in interface BufferedImageOp

getRenderingHints

public RenderingHints getRenderingHints()

Specified by:

getRenderingHints in interface BufferedImageOp

getRGB

public int[] getRGB(BufferedImage image,
           int x,
           int y,
           int width,
           int height,
           int[] pixels)

A convenience method for getting ARGB pixels from an image. This tries to avoid the performance penalty of BufferedImage.getRGB unmanaging the image.

Parameters:

image - a BufferedImage object

x - the left edge of the pixel block

y - the right edge of the pixel block

width - the width of the pixel arry

height - the height of the pixel arry

pixels - the array to hold the returned pixels. May be null.

Returns:

the pixels

See Also:

setRGB(java.awt.image.BufferedImage, int, int, int, int, int[])

setRGB

public void setRGB(BufferedImage image,
          int x,
          int y,
          int width,
          int height,
          int[] pixels)

A convenience method for setting ARGB pixels in an image. This tries to avoid the performance penalty of BufferedImage.setRGB unmanaging the image.

Parameters:

image - a BufferedImage object

x - the left edge of the pixel block

y - the right edge of the pixel block

width - the width of the pixel arry

height - the height of the pixel arry

pixels - the array of pixels to set

See Also:

getRGB(java.awt.image.BufferedImage, int, int, int, int, int[])

clone

public Object clone()

Overrides:

clone in class Object

filter

public BufferedImage filter(BufferedImage src,
                   BufferedImage dest)

Specified by:

filter in interface BufferedImageOp

filterInitialize

public void filterInitialize()

Specified by:

filterInitialize in interface FilterListener

filterStart

public void filterStart(int totalPixels)

Specified by:

filterStart in interface FilterListener

filterProgress

public void filterProgress(int percentComplete)

Specified by:

filterProgress in interface FilterListener

filterDone

public void filterDone()

Specified by:

filterDone in interface FilterListener

getMetaData

public ImageFilterOps getMetaData()

Bambi filter metadata. This implementation always returns throws exception because this method can only be called if defined. This method should be overwritten if child filter is used within a Bambi app. The reason exception is throw rather than returning null is to help identify offending class which is much easier than tracing NPE.

Specified by:

getMetaData in interface ImageFilterOpSupport

Throws:

IllegalStateException - on every invocation