|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectde.cau.cs.kieler.sim.kiem.KiemEvent
public class KiemEvent
This class implements some constants that define specific events in KIEM. A
DataComponent may register itself using the
AbstractDataComponent.provideEventOfInterest()
method to be a listener of some events. The method
AbstractDataComponent.notifyEvent(KiemEvent)
will then be called by KIEM for the registered events.
Field Summary | |
---|---|
static int |
ACTIVATED
The Constant ACTIVATED event is triggered when the user activates the component. |
static int |
ADDED
The Constant ADDED event is triggered when the user adds a component (instance). |
static int |
CALL_FOR_SHELL
This constant is triggered when the KIEMPlugin needs shell to provide a dialog. |
static int |
CMD_PAUSE
The Constant CMD_PAUSE event is triggered when the user hits the pause button. |
static int |
CMD_RUN
The Constant CMD_RUN event is triggered when the user hits the run button. |
static int |
CMD_STEP
The Constant CMD_STEP event is triggered when the user hits the step button. |
static int |
CMD_STEP_BACK
The Constant CMD_STEP event is triggered when the user hits the step button. |
static int |
CMD_STEP_MACRO
The Constant CMD_STEP event is triggered when the user hits the step button. |
static int |
CMD_STOP
The Constant CMD_STOP event is triggered when user hits the stop button. |
static int |
DEACTIVATED
The Constant DEACTIVATED event is triggered when the user deactivates the component. |
static int |
DELETED
The Constant DELETED event is triggered when the user deletes a component (instance). |
static int |
DISABLE_UI
This constant is triggered when the UI should be locked. |
static int |
ENABLE_UI
This constant is triggered when the UI is released after a lock. |
static int |
ERROR_PAUSE
The Constant ERROR_STOP event is triggered when an error leads to the execution pause. |
static int |
ERROR_STOP
The Constant ERROR_STOP event is triggered when an error leads to the execution stop. |
static int |
EXECUTION_START
This constant is triggered when the UI is released after a lock. |
static int |
EXECUTION_STOP
This constant is triggered when the UI is released after a lock. |
static int |
KIEMPROPERTY_CHANGE
The Constant KIEMPROPERTY_CHANGE event is triggered when the user changes/edited a property value in table. |
static int |
LOAD
The Constant LOAD event is triggered when the user loads a scheduling. |
static int |
NONE
The Constant NONE event represents the default NULL event and means this component does not want to be notified for any event. |
static int |
SAVE
The Constant SAVE event is triggered when the user saves a scheduling. |
static int |
SCHEDULED
The Constant SCHEDULED event is triggered when the user changes the scheduling order. |
static int |
SET_DIRTY
This constant is triggered when the opened execution file is edited. |
static int |
STEP_DONE
The Constant STEP DONE event is triggered after a step has been made. |
static int |
STEP_INFO
The Constant STEP INFO event is triggered before a step is about to occur. |
static int |
VIEW_DONE
This constant is triggered when the Execution Manager finished building the view. |
static int |
VIEW_REFRESH
This constant is triggered when the view may need to refresh. |
Constructor Summary | |
---|---|
KiemEvent()
This KiemEvent constructor sets the no event of interest during construction. |
|
KiemEvent(int eventCodeParam)
This KiemEvent constructor sets the event(s) of interest during construction. |
|
KiemEvent(int[] eventCodesParam)
This KiemEvent constructor sets the event(s) of interest during construction. |
|
KiemEvent(int[] eventCodesParam,
Object infoParam)
This KiemEvent constructor sets the event(s) of interest during construction. |
|
KiemEvent(int eventCodeParam,
Object infoParam)
This KiemEvent constructor sets the event(s) of interest during construction. |
Method Summary | |
---|---|
void |
addEvent(int eventCodeParam)
Sets the event. |
int[] |
getEventCodes()
Gets the current contained events. |
List<Integer> |
getEventCodesAsList()
Gets all events as a list. |
static String |
getEventName(int eventCode)
Gets the event name for an integer event code or null. |
Object |
getInfo()
Gets the info parameter or null if no info was attached. |
boolean |
isEvent(int eventCodeParam)
Checks whether an event is contained. |
void |
resetEvents()
Resets the event to NONE. |
void |
setEvents(int[] eventCodesParam)
Adds the event. |
void |
setInfo(Object infoParam)
Sets the optional info parameter. |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final int NONE
public static final int STEP_INFO
public static final int STEP_DONE
public static final int CMD_STEP
public static final int CMD_STEP_BACK
public static final int CMD_STEP_MACRO
public static final int CMD_RUN
public static final int CMD_PAUSE
public static final int CMD_STOP
public static final int ADDED
public static final int DELETED
public static final int SCHEDULED
public static final int ACTIVATED
public static final int DEACTIVATED
public static final int LOAD
public static final int SAVE
public static final int KIEMPROPERTY_CHANGE
public static final int ERROR_STOP
public static final int ERROR_PAUSE
public static final int CALL_FOR_SHELL
public static final int VIEW_DONE
public static final int VIEW_REFRESH
public static final int SET_DIRTY
public static final int DISABLE_UI
public static final int ENABLE_UI
public static final int EXECUTION_START
public static final int EXECUTION_STOP
Constructor Detail |
---|
public KiemEvent(int[] eventCodesParam, Object infoParam)
infoParam
- the (optional) info parametereventCodesParam
- the event codes parampublic KiemEvent(int[] eventCodesParam)
eventCodesParam
- the event codes parampublic KiemEvent(int eventCodeParam, Object infoParam)
infoParam
- the (optional) info parametereventCodeParam
- the event code parampublic KiemEvent(int eventCodeParam)
eventCodeParam
- the event code parampublic KiemEvent()
Method Detail |
---|
public int[] getEventCodes()
public boolean isEvent(int eventCodeParam)
eventCodeParam
- the event code param
public void addEvent(int eventCodeParam)
eventCodeParam
- the event code parampublic void setEvents(int[] eventCodesParam)
eventCodesParam
- the event codes parampublic void resetEvents()
public void setInfo(Object infoParam)
infoParam
- the new infopublic Object getInfo()
public static String getEventName(int eventCode)
eventCode
- the event code
public List<Integer> getEventCodesAsList()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |