org.jdesktop.jxlayer.plaf.effect
Interface LayerEffect

All Known Implementing Classes:

AbstractBufferedImageOpEffect, AbstractLayerEffect, BufferedImageOpEffect

public interface LayerEffect

This interface represents an abstract type which performes some operations on the BufferedImage.

See Also:

AbstractLayerEffect, BufferedImageOpEffect

Method Summary

void	addPropertyChangeListener(PropertyChangeListener l) Adds a LayerItemListener to the layer item.
void	apply(BufferedImage buf, Shape clip) Performes some operations on the passed BufferedImage.
PropertyChangeListener[]	getPropertyChangeListeners() Returns an array of all the PropertyChangeListeners registered on this LayerItem.
boolean	isEnabled() Indicates if this LayerItem is in active state.
void	removePropertyChangeListener(PropertyChangeListener l) Removes a PropertyChangeListener from this LayerItem.

Method Detail

isEnabled

boolean isEnabled()

Indicates if this LayerItem is in active state.

Returns:

true if this LayerItem is in active state

addPropertyChangeListener

void addPropertyChangeListener(PropertyChangeListener l)

Adds a LayerItemListener to the layer item.

Parameters:

l - the listener to add

getPropertyChangeListeners

PropertyChangeListener[] getPropertyChangeListeners()

Returns an array of all the PropertyChangeListeners registered on this LayerItem.

Returns:

all of this item's LayerItemListeners or an empty array if no item listeners are currently registered

removePropertyChangeListener

void removePropertyChangeListener(PropertyChangeListener l)

Removes a PropertyChangeListener from this LayerItem.

Parameters:

l - the listener to remove

apply

void apply(BufferedImage buf,
           Shape clip)

Performes some operations on the passed BufferedImage.

The effect may take into account the passed clip shape to speed the processing up.

Parameters:

buf - the BufferedImage to be processed

clip - the clip shape or null if the entire BufferedImage must be processed