de.cau.cs.kieler.viewmanagement
Class AEffect

java.lang.Object
  extended by de.cau.cs.kieler.viewmanagement.AEffect
Direct Known Subclasses:
CompartmentCollapseExpandEffect, DefaultTestEffect, FilterEffect, HighlightEffect, LayoutEffect, ShapeHighlightEffect, TextualRepresentationEffect, UnFilterEffect, ZoomAndScrollToEffect, ZoomEffect

public abstract class AEffect
extends Object

Abstract definition of an effect. An effect is a visual alteration of the affectedObject in order to make it more appealing or useful to the human observer. It has one main method, execute(). Here, the effect will be e.g. set up (colours, line width and so on) placed and painted. Methods setTarget and setParameters are there to set the target of the effect (or affectedObject) and parameters (e.g. text to be displayed).

Rating red

Constructor Summary
AEffect()
           
 
Method Summary
abstract  void execute()
          Abstract method to execute a specific effect.
protected  EditPart getAffectedObject()
           
 void setParameters(Object parameters)
          Method to set the parameters of an effect.
 void setTarget(EditPart target)
          Method to set the target of the effect.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AEffect

public AEffect()
Method Detail

execute

public abstract void execute()
Abstract method to execute a specific effect. Must be implemented by the developer of the effect. Here, you will have to implement the exact behaviour of the effect.


setTarget

public void setTarget(EditPart target)
Method to set the target of the effect. This is the EditPart that will be modified or otherwise worked with by the effect.

Parameters:
target - the target of the effect

setParameters

public void setParameters(Object parameters)
Method to set the parameters of an effect. This may be used to transport additional information such as text to be displayed in an effect, parameters for the visual appearance of the effect, e.g. line width, colors and so on.

Parameters:
parameters - the parameters

getAffectedObject

protected EditPart getAffectedObject()
Returns:
the affectedObject