magoffin.matt.ma2.image.awt
Class CompositeEffect

java.lang.Object
  magoffin.matt.ma2.image.awt.BaseAwtMediaEffect
      magoffin.matt.ma2.image.awt.CompositeEffect

All Implemented Interfaces:

AwtMediaEffect, MediaEffect

public class CompositeEffect
extends BaseAwtMediaEffect

A watermark effect for AWT based processing, that composites the watermark image on top of the media image.

Version:

$Revision: 43 $ $Date: 2007-10-21 11:10:01 +1300 (Sun, 21 Oct 2007) $

Author:

matt.magoffin

Field Summary

static java.lang.String

COMPOSITE_KEY The key for this effect.

Fields inherited from class magoffin.matt.ma2.image.awt.BaseAwtMediaEffect

log

Fields inherited from interface magoffin.matt.ma2.image.awt.AwtMediaEffect

INPUT_BUFFERED_IMAGE_KEY

Fields inherited from interface magoffin.matt.ma2.MediaEffect

KEY_ROTATE, KEY_SCALE, KEY_WATERMARK, MEDIA_REQUEST_PARAM_ROTATE_DEGREES, MEDIA_REQUEST_PARAM_WATERMARK_RESOURCE

Constructor Summary

CompositeEffect()

Method Summary

java.awt.image.BufferedImage	applyEffect(MediaItem item, MediaRequest request, java.awt.image.BufferedImage source) Apply an effect on a BufferedImage and return the result as a new BufferedImage.
ImageMediaHelper	getImageMediaHelper()
java.lang.String	getKey() Get the key for this effect.
void	setImageMediaHelper(ImageMediaHelper imageMediaHelper)

Methods inherited from class magoffin.matt.ma2.image.awt.BaseAwtMediaEffect

apply, getMediaBiz, setMediaBiz

Methods inherited from class java.lang.Object

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

Field Detail

COMPOSITE_KEY

public static final java.lang.String COMPOSITE_KEY

The key for this effect.

See Also:

Constant Field Values

Constructor Detail

CompositeEffect

public CompositeEffect()

Method Detail

applyEffect

public java.awt.image.BufferedImage applyEffect(MediaItem item,
                                                MediaRequest request,
                                                java.awt.image.BufferedImage source)

Description copied from interface: AwtMediaEffect

Apply an effect on a BufferedImage and return the result as a new BufferedImage.

If no change is made to the source BufferedImage then source can be returned from this method.

Parameters:

item - the MediaItem the effect is being applied to

request - the request

source - the source BufferedImage

Returns:

the updated BufferedImage

getKey

public java.lang.String getKey()

Description copied from interface: MediaEffect

Get the key for this effect.

Keys uniquely describe the implementation and function of the effect. The implementation key should come first, and the function key at the end. Some standard function key values are defined in this API: MediaEffect.KEY_SCALE for re-sizing and MediaEffect.KEY_ROTATE for rotating.

For example, a key might look like image.awt.rotate for an image rotation effect based on a Java AWT implementation.

Returns:

the effect key

getImageMediaHelper

public ImageMediaHelper getImageMediaHelper()

Returns:

the imageMediaHelper

setImageMediaHelper

public void setImageMediaHelper(ImageMediaHelper imageMediaHelper)

Parameters:

imageMediaHelper - the imageMediaHelper to set