de.cau.cs.kieler.viewmanagement
Class ATrigger

java.lang.Object
  extended by de.cau.cs.kieler.viewmanagement.ATrigger
Direct Known Subclasses:
CollapseExpandTrigger, ElementDeletedTrigger, KSBasETrigger, LabelSizeChangedTrigger.ViewManagementTrigger, LayoutTrigger, SelectionTrigger, StateActivityTrigger

public abstract class ATrigger
extends Object

Abstract definition of a trigger. A trigger can have listeners which it will notify whenever an event occurs. An event may be external (the trigger being a listener itself) or internal with the trigger generating events. These events need to be packaged in an TriggerEventObject which will then will be argument for the notify method.

Rating red

Constructor Summary
ATrigger()
           
 
Method Summary
 void addListener(ITriggerListener triggerlistener)
          Adds a listener to a trigger.
 int getListenerQuantity()
          Method to read the number of listeners on a trigger.
protected  void notifyTrigger(TriggerEventObject triggerEvent)
          Notifies all listeners with the triggerEvent when an event occurs
 void removeListener(ITriggerListener triggerlistener)
          Removes a listener from a trigger
 EObject translateToEObject(EditPart sourceObject)
          Translates an Editpart to EObject.
 String translateToURI(EditPart sourceObject)
          Translates an EditPart to URIFragment.
 void wrapup()
          Release all system resources for this object.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ATrigger

public ATrigger()
Method Detail

addListener

public final void addListener(ITriggerListener triggerlistener)
Adds a listener to a trigger. It will be notified with a TriggerEventObject in case the trigger fires.

Parameters:
triggerlistener - the listener to be added

removeListener

public final void removeListener(ITriggerListener triggerlistener)
Removes a listener from a trigger

Parameters:
triggerlistener - the listener to be removed

notifyTrigger

protected void notifyTrigger(TriggerEventObject triggerEvent)
Notifies all listeners with the triggerEvent when an event occurs

Parameters:
triggerEvent - the object all listeners receive on occurrence of an event

getListenerQuantity

public int getListenerQuantity()
Method to read the number of listeners on a trigger.

Returns:
number of listeners

translateToURI

public final String translateToURI(EditPart sourceObject)
Translates an EditPart to URIFragment. Note: To address the objects, URIFragments should no longer be used. Addressing with EObjects provides a much better functionality, such as sematical addressing, addressing of TransitionEditParts.

Parameters:
sourceObject - EditPart that should be translated
Returns:
String with URIFragment, if available

translateToEObject

public final EObject translateToEObject(EditPart sourceObject)
Translates an Editpart to EObject. This should be used instead of addressing with URIFragements. EObjects are used to exchange the objects that are t be affected by effects of the View Management between the plugins of the View Management or other plugins.

Parameters:
sourceObject - EditPart that should be translated
Returns:
EObject that represents the EditPart

wrapup

public void wrapup()
Release all system resources for this object.