Class JEvent
Object
|
+--JEvent
- class
JEvent
An object which encapsulates the details of an event where
an event is defined as the emission of a signal.
Defined in JSignal.js
Field Summary |
Array |
detail
The event details provided by the emitter. |
Object |
emitter
The object which emitted the signal. |
int |
signalId
The id of the signal emitted. |
String |
signalName
The name of the signal emitted. |
Constructor Summary |
JEvent
(sid, name, obj, detail)
|
Method Summary |
Array
|
getEventDetail()
Used to obtain a reference to the collection of name => value
pairs which were emitted along with the signal.
|
Object
|
getOrigin()
Used to obtain a pointer to the object which emitted
or initiated the event.
|
int
|
getSignalId()
Used to obtain the ID of the emitted signal.
|
String
|
getSignalName()
Used to obtain the name of the emitted signal.
|
detail
Array detail
The event details provided by the emitter.
emitter
Object emitter
The object which emitted the signal.
signalId
int signalId
The id of the signal emitted.
signalName
String signalName
The name of the signal emitted.
JEvent
JEvent(sid, name, obj, detail)
getEventDetail
Array getEventDetail()
Used to obtain a reference to the collection of name => value
pairs which were emitted along with the signal. The name / value
pairs are arbitrary and are populated by the originating object instance.
Returns:
A collection of name => value pairs which were defined / created by the originating object instance.
getOrigin
Object getOrigin()
Used to obtain a pointer to the object which emitted
or initiated the event.
Returns:
A pointer to the instance of the emitting object
getSignalId
int getSignalId()
Used to obtain the ID of the emitted signal.
Returns:
the ID of the issued signal
getSignalName
String getSignalName()
Used to obtain the name of the emitted signal.
Returns:
the registered name of the issued signal
Documentation generated by
JSDoc on Fri Mar 24 20:53:22 2006