org.jmage.filter
Class TwinResourceImageFilter

java.lang.Object
  org.jmage.filter.ConfigurableImageFilter
      org.jmage.filter.TwinResourceImageFilter

All Implemented Interfaces:

ImageFilter

Direct Known Subclasses:

BackgroundImageFilter, ImageOverlayFilter

public abstract class TwinResourceImageFilter
extends ConfigurableImageFilter

TwinResourceImageFilter introduces a second image into the filter, used as an additional resource for filter operations.

Field Summary

static java.lang.String	CHAIN_URI
static java.lang.String	IMAGE_URI
protected javax.media.jai.PlanarImage	resourceImage

Fields inherited from class org.jmage.filter.ConfigurableImageFilter

filterProperties, INITIALIZED, NOT_INITIALIZED

Constructor Summary

TwinResourceImageFilter()

Method Summary

protected javax.media.jai.PlanarImage	cloneImage(javax.media.jai.PlanarImage image)
javax.media.jai.PlanarImage	filter(javax.media.jai.PlanarImage image) Filter an image and return the results, which may be a different instance of PlanarImage
javax.media.jai.PlanarImage	filter(javax.media.jai.PlanarImage image, java.util.Properties additionalProperties) Filter the image with additional properties
void	initialize(java.util.Properties filterProperties) Initializes the ImageFilter with properties
protected ImageRequest	mapInternalRequest(javax.media.jai.PlanarImage image)

Methods inherited from class org.jmage.filter.ConfigurableImageFilter

getFilterProperties, toString

Methods inherited from class java.lang.Object

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

Field Detail

IMAGE_URI

public static final java.lang.String IMAGE_URI

See Also:

Constant Field Values

CHAIN_URI

public static final java.lang.String CHAIN_URI

See Also:

Constant Field Values

resourceImage

protected javax.media.jai.PlanarImage resourceImage

Constructor Detail

TwinResourceImageFilter

public TwinResourceImageFilter()

Method Detail

initialize

public void initialize(java.util.Properties filterProperties)
                throws FilterException

Description copied from class: ConfigurableImageFilter

Initializes the ImageFilter with properties

Specified by:

initialize in class ConfigurableImageFilter

Throws:

FilterException - if the filter can't handle the properties.

filter

public javax.media.jai.PlanarImage filter(javax.media.jai.PlanarImage image)
                                   throws FilterException

Description copied from interface: ImageFilter

Filter an image and return the results, which may be a different instance of PlanarImage

Parameters:

image - the image

Returns:

the filtered image

Throws:

FilterException - if an error occurs during filtering

filter

public javax.media.jai.PlanarImage filter(javax.media.jai.PlanarImage image,
                                          java.util.Properties additionalProperties)
                                   throws FilterException

Description copied from class: ConfigurableImageFilter

Filter the image with additional properties

Overrides:

filter in class ConfigurableImageFilter

Parameters:

image - the image

additionalProperties - additional imageProperties used only during this filter call

Returns:

the filtered image

Throws:

FilterException

mapInternalRequest

protected ImageRequest mapInternalRequest(javax.media.jai.PlanarImage image)

cloneImage

protected javax.media.jai.PlanarImage cloneImage(javax.media.jai.PlanarImage image)