Use string instead of string|ol.events.EventType

This commit is contained in:
Tim Schaub
2016-02-02 13:11:08 -07:00
committed by Andreas Hocevar
parent f10c90bdba
commit f3b97d6bef
4 changed files with 17 additions and 19 deletions

View File

@@ -65,7 +65,7 @@ ol.events.LISTENER_MAP_PROP_ = 'olm_' + ((Math.random() * 1e4) | 0);
* @typedef {EventTarget|ol.events.EventTarget|
* {addEventListener: function(string, Function, boolean=),
* removeEventListener: function(string, Function, boolean=),
* dispatchEvent: function((ol.events.EventType|string))}}
* dispatchEvent: function(string)}}
*/
ol.events.EventTargetLike;
@@ -95,7 +95,7 @@ ol.events.ListenerFunctionType;
* callOnce: boolean,
* listener: ol.events.ListenerFunctionType,
* target: (EventTarget|ol.events.EventTarget),
* type: (ol.events.EventType|string)}}
* type: string}}
*/
ol.events.ListenerObjType;
@@ -147,7 +147,7 @@ ol.events.findListener_ = function(
/**
* @param {ol.events.EventTargetLike} target Target.
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @return {Array.<ol.events.ListenerObjType>|undefined} Listeners.
*/
ol.events.getListeners = function(target, type) {
@@ -178,7 +178,7 @@ ol.events.getListenerMap_ = function(target) {
* listener objects will be removed, and if no listeners remain in the listener
* map, it will be removed from the target.
* @param {ol.events.EventTargetLike} target Target.
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @private
*/
ol.events.removeListeners_ = function(target, type) {
@@ -208,8 +208,7 @@ ol.events.removeListeners_ = function(target, type) {
* a key for use with {@link ol.events.unlistenByKey}.
*
* @param {ol.events.EventTargetLike} target Event target.
* @param {ol.events.EventType|string} type
* Event type.
* @param {string} type Event type.
* @param {ol.events.ListenerFunctionType} listener Listener.
* @param {Object=} opt_this Object referenced by the `this` keyword in the
* listener. Default is the `target`.
@@ -259,7 +258,7 @@ ol.events.listen = function(target, type, listener, opt_this, opt_once) {
* listener.
*
* @param {ol.events.EventTargetLike} target Event target.
* @param {ol.events.EventType|string} type Event type.
* @param {string} type Event type.
* @param {ol.events.ListenerFunctionType} listener Listener.
* @param {Object=} opt_this Object referenced by the `this` keyword in the
* listener. Default is the `target`.
@@ -279,7 +278,7 @@ ol.events.listenOnce = function(
* arguments that were used for a previous {@link ol.events.listen} call.
*
* @param {ol.events.EventTargetLike} target Event target.
* @param {ol.events.EventType|string} type Event type.
* @param {string} type Event type.
* @param {ol.events.ListenerFunctionType} listener Listener.
* @param {Object=} opt_this Object referenced by the `this` keyword in the
* listener. Default is the `target`.

View File

@@ -12,7 +12,7 @@ goog.provide('ol.events.Event');
* {@link ol.events.EventTarget}.
*
* @constructor
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @param {Object=} opt_target Target.
*/
ol.events.Event = function(type, opt_target) {

View File

@@ -37,11 +37,10 @@ goog.inherits(ol.events.EventTarget, goog.Disposable);
/**
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @param {ol.events.ListenerFunctionType} listener Listener.
*/
ol.events.EventTarget.prototype.addEventListener = function(
type, listener) {
ol.events.EventTarget.prototype.addEventListener = function(type, listener) {
var listeners = this.listeners_[type];
if (!listeners) {
listeners = this.listeners_[type] = [];
@@ -53,9 +52,9 @@ ol.events.EventTarget.prototype.addEventListener = function(
/**
* @param {{type: (ol.events.EventType|string),
* @param {{type: string,
* target: (EventTarget|ol.events.EventTarget|undefined)}|ol.events.Event|
* ol.events.EventType|string} event Event or event type.
* string} event Event or event type.
* @return {boolean|undefined} `false` if anyone called preventDefault on the
* event object or if any of the listeners returned false.
*/
@@ -88,7 +87,7 @@ ol.events.EventTarget.prototype.disposeInternal = function() {
* Get the listeners for a specified event type. Listeners are returned in the
* opposite order that they will be called in.
*
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @return {Array.<ol.events.ListenerFunctionType>} Listeners.
*/
ol.events.EventTarget.prototype.getListeners = function(type) {
@@ -97,7 +96,7 @@ ol.events.EventTarget.prototype.getListeners = function(type) {
/**
* @param {(ol.events.EventType|string)=} opt_type Type. If not provided,
* @param {string=} opt_type Type. If not provided,
* `true` will be returned if this EventTarget has any listeners.
* @return {boolean} Has listeners.
*/
@@ -109,7 +108,7 @@ ol.events.EventTarget.prototype.hasListener = function(opt_type) {
/**
* @param {ol.events.EventType|string} type Type.
* @param {string} type Type.
* @param {ol.events.ListenerFunctionType} listener Listener.
*/
ol.events.EventTarget.prototype.removeEventListener = function(type, listener) {

View File

@@ -72,9 +72,9 @@ ol.Observable.prototype.changed = function() {
* of this type. The event parameter can either be a string or an
* Object with a `type` property.
*
* @param {{type: (ol.events.EventType|string),
* @param {{type: string,
* target: (EventTarget|ol.events.EventTarget|undefined)}|ol.events.Event|
* ol.events.EventType|string} event Event object.
* string} event Event object.
* @function
* @api
*/