com.inductiveautomation.rm.graphics

Class RMEffect

java.lang.Object

com.inductiveautomation.rm.base.RMListenerList

com.inductiveautomation.rm.base.RMObject

com.inductiveautomation.rm.graphics.RMEffect

All Implemented Interfaces:

Archivable, DeepChangeListener, RMPropertyChanger, java.beans.PropertyChangeListener, java.lang.Cloneable, java.util.EventListener

Direct Known Subclasses:

RMImageEffect

public class RMEffect
extends RMObject
implements java.beans.PropertyChangeListener, DeepChangeListener, Archivable

An RMFill subclass for drawing effects that rely on shape's standard fill/stroke.

Constructor Summary

Constructors

Constructor and Description
RMEffect()

Method Summary

Modifier and Type	Method and Description
RMEffect	clone() Standard clone implementation.
void	deepChange(java.beans.PropertyChangeListener aSource, java.beans.PropertyChangeEvent anEvent) DeepChangeListener method.
java.lang.Object	fromXML(RXArchiver anArchiver, RXElement anElement) XML unarchival.
RMRect	getBounds(RMShape aShape) Returns the bounds required to render this fill for this shape.
java.lang.String	getName() Returns the name of the effect.
boolean	isEnabled() Returns whether effect is currently enabled.
void	paint(RMShapePainter aPntr, RMShape aShape) Render this fill in a Java2D Graphics2D.
void	propertyChange(java.beans.PropertyChangeEvent anEvent) PropertyChangeListener method.
void	reset() Tells the effect to reset.
boolean	setEnabled(boolean aValue) Sets whether effect is currently enabled.
java.lang.String	toString() Returns a string representation.
RXElement	toXML(RXArchiver anArchiver) XML archival.

Methods inherited from class com.inductiveautomation.rm.base.RMObject

addPropertyChangeListener, animUpdate, firePropertyChange, firePropertyChange, firePropertyChange, getPCEvent, removePropertyChangeListener, sendPropertyChange

Methods inherited from class com.inductiveautomation.rm.base.RMListenerList

addListener, getListener, getListenerCount, getListenerCount, getListenerList, getListeners, hasListeners, removeListener

Methods inherited from class java.lang.Object

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

Constructor Detail

RMEffect

public RMEffect()

Method Detail

isEnabled

public boolean isEnabled()

Returns whether effect is currently enabled.

setEnabled

public boolean setEnabled(boolean aValue)

Sets whether effect is currently enabled.

getName

public java.lang.String getName()

Returns the name of the effect.

getBounds

public RMRect getBounds(RMShape aShape)

Returns the bounds required to render this fill for this shape.

paint

public void paint(RMShapePainter aPntr,
                  RMShape aShape)

Render this fill in a Java2D Graphics2D.

reset

public void reset()

Tells the effect to reset.

propertyChange

public void propertyChange(java.beans.PropertyChangeEvent anEvent)

PropertyChangeListener method. Forward to deepChange().

Specified by:

propertyChange in interface java.beans.PropertyChangeListener

deepChange

public void deepChange(java.beans.PropertyChangeListener aSource,
                       java.beans.PropertyChangeEvent anEvent)

DeepChangeListener method. When shape or shape child has property change clear cache and/or remove listener.

Specified by:

deepChange in interface DeepChangeListener

clone

public RMEffect clone()

Standard clone implementation.

Overrides:

clone in class RMListenerList

toXML

public RXElement toXML(RXArchiver anArchiver)

XML archival.

Specified by:

toXML in interface Archivable

fromXML

public java.lang.Object fromXML(RXArchiver anArchiver,
                                RXElement anElement)

XML unarchival.

Specified by:

fromXML in interface Archivable

toString

public java.lang.String toString()

Returns a string representation.

Overrides:

toString in class RMObject