de.cau.cs.kieler.viewmanagement
Class TriggerEventObject

java.lang.Object
  extended by de.cau.cs.kieler.viewmanagement.TriggerEventObject

public class TriggerEventObject
extends Object

Object that is used to exchange information on an event between triggers, combinations and effects. Carries triggerActive, an indicator whether or not the event is present, affectedObject, which represents the object that should be affected by the resulting effect and parameters, an optional object that may carry additional information, e.g. the text to be displayed in a textual effect. The TriggerEventObject should be set by the trigger and only read by combination and effect.

Rating red

Constructor Summary
TriggerEventObject()
           
 
Method Summary
 EObject getAffectedObject()
          getter method for the affectedObject.
 Object getParameters()
          getter method for the parameters.
 boolean getTriggerState()
          getter method for the triggerActive parameter.
 void setAffectedObject(EObject eObject)
          setter method for the affectedObject
 void setParameters(Object newParameters)
          setter method for the parameters
 void setTriggerActive(boolean newState)
          setter method for the triggerActive method
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

TriggerEventObject

public TriggerEventObject()
Method Detail

getTriggerState

public final boolean getTriggerState()
getter method for the triggerActive parameter. The triggerActive determines, whether or not the event is present or absent. The trigger should set it to true to indicate an event has just occurred and to false to indicate the event is now invalid. This gives the combination the ability to react accordingly, if needed

Returns:
the state

setTriggerActive

public final void setTriggerActive(boolean newState)
setter method for the triggerActive method

Parameters:
newState - the new state
See Also:
getTriggerState()

getAffectedObject

public final EObject getAffectedObject()
getter method for the affectedObject. The affectedObject is the object a combination and later an effect will work with. To be set properly by the trigger.

Returns:
the affectedObject

setAffectedObject

public final void setAffectedObject(EObject eObject)
setter method for the affectedObject

Parameters:
eObject - the new affectedObject
See Also:
getAffectedObject()

getParameters

public final Object getParameters()
getter method for the parameters. The parameters can be used to transport additional information such as text to be displayed or parameters for the later effect. It is up to the combination whether or not the parameters are optional and how they are used.

Returns:
the parameters

setParameters

public final void setParameters(Object newParameters)
setter method for the parameters

Parameters:
newParameters - the new parameters
See Also:
getParameters()