de.cau.cs.kieler.core.kivi
Interface ICombination

All Known Implementing Classes:
AbstractCombination, HighlightSelectedTransitionsCombination, KSBasECombination, LayoutAfterCollapseCombination, LayoutAfterModelChangedCombination, LayoutAnalysisCombination, LayoutCombination, ShowHierarchyCombination, SignalFlowCombination, SyncChartsCombination

public interface ICombination

A combination connects triggers and effects, it receives a set of events from triggers and determines which effects need to be executed.

Rating red

Method Summary
 Class<? extends ITriggerState>[] getTriggerStates()
          Get the array of trigger state classes this combination listens to.
 boolean isActive()
          Check whether this combination is active.
 void setActive(boolean active)
          Change the active status of this combination.
 List<IEffect> trigger(ITriggerState triggerState)
          Trigger the execution of this combination.
 void undo()
          Attempt to undo all active effects, for example when shutting down view management or when disabling this combination.
 

Method Detail

trigger

List<IEffect> trigger(ITriggerState triggerState)
Trigger the execution of this combination.

Parameters:
triggerState - the trigger state responsible for the triggering
Returns:
the list of effects to execute

getTriggerStates

Class<? extends ITriggerState>[] getTriggerStates()
Get the array of trigger state classes this combination listens to.

Returns:
array of trigger states

undo

void undo()
Attempt to undo all active effects, for example when shutting down view management or when disabling this combination.


isActive

boolean isActive()
Check whether this combination is active.

Returns:
true if the combination is active

setActive

void setActive(boolean active)
Change the active status of this combination.

Parameters:
active - new active status