|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.core.kivi.KiVi
public class KiVi
Core controller for the view management.
Field Summary | |
---|---|
static String |
PROPERTY_ACTIVE
The property key holding the active value. |
Constructor Summary | |
---|---|
KiVi()
Instantiate the singleton class. |
Method Summary | |
---|---|
void |
addEffectsListener(IEffectsListener listener)
Add an effects listener to the effects worker. |
void |
distributeTriggerState(ITriggerState triggerState)
Distribute the event from the given trigger state to all combinations waiting for such a trigger state class. |
static void |
error(ICombination responsibleCombination,
ITriggerState trigger,
Throwable cause)
Log an error in a Combination that was triggered by a specific Trigger. |
static void |
error(String m)
Log an error. |
static void |
error(Throwable t)
Log an error. |
void |
executeEffect(IEffect effect)
Tell the view management to execute an effect. |
List<CombinationDescriptor> |
getAvailableCombinations()
Get a list of all available combinations registered to the combinations extension point. |
int |
getEffectsQueueSize()
Get the current size of the effects queue. |
static KiVi |
getInstance()
Get the singleton view management instance. |
ITriggerState |
getTriggerState(Class<?> clazz)
Get the current trigger state of the given class. |
void |
initialize()
Called on eclipse startup to do a short initialization. |
boolean |
isActive()
Checks whether view management is active or not. |
boolean |
isCombinationClassActive(Class<?> clazz)
Check whether any combination of the given class is active. |
boolean |
isDebug()
Whether the View Management is currently in debug mode. |
void |
loadActiveStates()
Update activity state for each combination after preference page submit. |
void |
registerCombination(ICombination combination,
boolean register)
Register or unregister a combination when it is activated or deactivated to enable or disable reception of trigger events. |
void |
removeEffectsListener(IEffectsListener listener)
Remove an effects listener from the effects worker. |
void |
setActive(boolean a)
Activate or deactivate the entire view management. |
void |
setDebug(boolean debug)
Set the View Management debug mode status. |
void |
trigger(ITriggerState triggerState)
Inform the view management about an event contained in the given trigger state. |
void |
undoEffect(IEffect effect)
Undo an effect. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final String PROPERTY_ACTIVE
Constructor Detail |
---|
public KiVi()
Method Detail |
---|
public boolean isDebug()
public void setDebug(boolean debug)
debug
- the debug mode statuspublic static KiVi getInstance()
public void initialize()
public void setActive(boolean a)
a
- true if activatingpublic boolean isActive()
public ITriggerState getTriggerState(Class<?> clazz)
clazz
- the class of trigger state to look for
public void loadActiveStates()
public List<CombinationDescriptor> getAvailableCombinations()
public int getEffectsQueueSize()
public void registerCombination(ICombination combination, boolean register)
combination
- the newly activated or deactivated combinationregister
- true if registering, false if unregisteringpublic void trigger(ITriggerState triggerState)
triggerState
- the triggerState created by the eventpublic void executeEffect(IEffect effect)
effect
- the effect to executepublic void undoEffect(IEffect effect)
effect
- the effect to be undonepublic void distributeTriggerState(ITriggerState triggerState)
triggerState
- the triggerState that contains the eventpublic boolean isCombinationClassActive(Class<?> clazz)
clazz
- the combination class to look for
public static void error(Throwable t)
t
- the causing throwablepublic static void error(ICombination responsibleCombination, ITriggerState trigger, Throwable cause)
responsibleCombination
- the Combination involvedtrigger
- the Trigger that caused the execution of the combinationcause
- the original exceptionpublic static void error(String m)
m
- the error messagepublic void addEffectsListener(IEffectsListener listener)
listener
- the listener to addpublic void removeEffectsListener(IEffectsListener listener)
listener
- the listener to remove
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |