new Event
A generic utility class for managing subscribers for a particular event. This class is usually instantiated inside of a container class and exposed as a property for others to subscribe to.
Example
MyObject.prototype.myListener = function(arg1, arg2) {
this.myArg1Copy = arg1;
this.myArg2Copy = arg2;
}
var myObjectInstance = new MyObject();
var evt = new Event();
evt.addEventListener(MyObject.prototype.myListener, myObjectInstance);
evt.raiseEvent('1', '2');
evt.removeEventListener(MyObject.prototype.myListener);
Source:
Methods
-
addEventListener
-
Registers a callback function to be executed whenever the event is raised. An optional scope can be provided to serve as the
thispointer in which the function will execute.Parameters:
Name Type Argument Description listenerFunction The function to be executed when the event is raised. scopeObject <optional>
An optional object scope to serve as the thispointer in which the listener function will execute.Throws:
DeveloperError : listener is required and must be a function.Returns:
Function A function that will remove this event listener when invoked. -
getNumberOfListeners
-
Gets the number of listeners currently subscribed to the event.
Returns:
Number The number of subscribed listeners. -
raiseEvent
-
Raises the event by calling each registered listener with all supplied arguments.
Parameters:
Name Type Description arguments* This method takes any number of parameters and passes them through to the listener functions. -
removeEventListener
-
Unregisters a previously registered callback.
Parameters:
Name Type Argument Description listenerFunction The function to be unregistered. scopeObject <optional>
The scope that was originally passed to addEventListener. Throws:
-
DeveloperError : listener is required and must be a function.
-
DeveloperError : listener is not subscribed.
-