APIMethod: addEventType Deprecated. Any event can be triggered without adding it first.
Parameters: eventName - {String}
Method: attachToElement
Parameters: element - {HTMLDOMElement} a DOM element to attach browser events to
Method: handleBrowserEvent Basically just a wrapper to the triggerEvent() function, but takes care to set a property 'xy' on the event with the current mouse position.
Parameters: evt - {Event}
APIMethod: on
Convenience method for registering listeners with a common scope.
Internally, this method calls
Example use: (code) // register a single listener for the "loadstart" event events.on({"loadstart": loadStartListener});
// this is equivalent to the following events.register("loadstart", undefined, loadStartListener);
// register multiple listeners to be called with the same this object
events.on({
"loadstart": loadStartListener,
"loadend": loadEndListener,
scope: object
});
// this is equivalent to the following events.register("loadstart", object, loadStartListener); events.register("loadend", object, loadEndListener); (end)
Parameters: object - {Object}
APIMethod: register Register an event on the events object.
When the event is triggered, the 'func' function will be called, in the context of 'obj'. Imagine we were to register an event, specifying an OpenLayers.Bounds Object as 'obj'. When the event is triggered, the context in the callback function will be our Bounds object. This means that within our callback function, we can access the properties and methods of the Bounds object through the "this" variable. So our callback could execute something like: : leftStr = "Left: " + this.left;
or
: centerStr = "Center: " + this.getCenterLonLat();
Parameters: type - {String} Name of the event to register obj - {Object} The object to bind the context to for the callback#. If no object is specified, default is the Events's 'object' property. func - {Function} The callback function. If no callback is specified, this function does nothing. priority - {Boolean|Object} If true, adds the new listener to the front of the events queue instead of to the end.
Valid options for priority: extension - {Boolean} If true, then the event will be registered as extension event. Extension events are handled before all other events.
Optionalobj: anyOptionalfunc: (arg: any) => voidOptionalpriority: boolean | ObjectAPIMethod: registerPriority Same as register() but adds the new listener to the front of the events queue instead of to the end.
TODO: get rid of this in 3.0 - Decide whether listeners should be
called in the order they were registered or in reverse order.
Parameters: type - {String} Name of the event to register obj - {Object} The object to bind the context to for the callback#. If no object is specified, default is the Events's 'object' property. func - {Function} The callback function. If no callback is specified, this function does nothing.
Method: remove Remove all listeners for a given event type. If type is not registered, does nothing.
Parameters: type - {String}
APIMethod: triggerEvent Trigger a specified registered event.
Parameters: type - {String} evt - {Event || Object} will be passed to the listeners.
Returns: {Boolean} The last listener return. If a listener returns false, the chain of listeners will stop getting called.
Optionalevt: EventAPIMethod: un
Convenience method for unregistering listeners with a common scope.
Internally, this method calls
Example use: (code) // unregister a single listener for the "loadstart" event events.un({"loadstart": loadStartListener});
// this is equivalent to the following events.unregister("loadstart", undefined, loadStartListener);
// unregister multiple listeners with the same this object
events.un({
"loadstart": loadStartListener,
"loadend": loadEndListener,
scope: object
});
// this is equivalent to the following events.unregister("loadstart", object, loadStartListener); events.unregister("loadend", object, loadEndListener); (end)
APIMethod: unregister
Parameters: type - {String} obj - {Object} If none specified, defaults to this.object func - {Function} The callback function to unregister.
Property: listeners {Object} Hashtable of Array(Function): events listener functions