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

All Superinterfaces:
ITriggerListener
All Known Implementing Classes:
AbstractCombination, E2STransformationCombination, HighlightSelectedTransitionsCombination, KiviMenuContributionDemoCombination, KSBasECombination, LayoutAfterCollapseExpandCombination, LayoutAfterDiagramReinitCombination, LayoutAfterModelChangedCombination, LayoutAnalysisCombination, LayoutCombination, ManualFocusCombination, RandomLayoutCombination, ShowGraphitiHierarchyCombination, ShowHierarchyCombination, SignalFlowCombination, StateMachineCombination, SyncChartsCombination, TestCombinationA, TestCombinationB, TestCombinationEffectsTrigger, TestCombinationEffectsTrigger2, TestCombinationManyExecutes, TestCombinationNoExecute, TestCombinationOverlappingParameters, TestCombinationSpammer, TestCombinationSpammerSynchronized, TestCombinationTwoEffects, TestCombinationUndo, TestCombinationWrongParameterType, UpdateVisibilityCombination

public interface ICombination
extends ITriggerListener

A combination connects triggers and effects, it receives a set of events from triggers and determines which effects need to be executed. Handling of triggers is done by the ITriggerListener interface. During a call of ITriggerListener.handle(ITriggerState), the combination should collect some IEffects, which KiVi will retrieve by getEffects().

Rating red

Method Summary
 List<IEffect> getEffects()
          Get the list of effects that are ready to be executed after the last triggering of an ITriggerState.
 boolean isActive()
          Check whether this combination is active.
 void setActive(boolean active)
          Change the active status of this combination.
 void undo()
          Attempt to undo all active effects, for example when shutting down view management or when disabling this combination.
 
Methods inherited from interface de.cau.cs.kieler.core.kivi.ITriggerListener
getTriggerStates, handle
 

Method Detail

getEffects

List<IEffect> getEffects()
Get the list of effects that are ready to be executed after the last triggering of an ITriggerState.

Returns:
list of effects that should be executed

undo

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


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