1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
ash / webui / common / resources / event_tracker.js [blame]
// Copyright 2011 The Chromium Authors
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
/**
* @fileoverview EventTracker is a simple class that manages the addition and
* removal of DOM event listeners. In particular, it keeps track of all
* listeners that have been added and makes it easy to remove some or all of
* them without requiring all the information again. This is particularly handy
* when the listener is a generated function such as a lambda or the result of
* calling Function.bind.
* Note: This file is deprecated in favor of the TypeScript version at
* ui/webui/resources/js/event_tracker.ts. The TypeScript version should be used
* in all TypeScript code, and can also be used by JavaScript code that is not
* typechecked with closure compiler.
*/
export class EventTracker {
/**
* Create an EventTracker to track a set of events.
* EventTracker instances are typically tied 1:1 with other objects or
* DOM elements whose listeners should be removed when the object is
* disposed or the corresponding elements are removed from the DOM.
*/
constructor() {
/**
* @type {Array<EventTrackerEntry>}
* @private
*/
this.listeners_ = [];
}
/**
* Add an event listener - replacement for EventTarget.addEventListener.
* @param {!EventTarget} target The DOM target to add a listener to.
* @param {string} eventType The type of event to subscribe to.
* @param {EventListener|Function} listener The listener to add.
* @param {boolean=} capture Whether to invoke during the capture phase.
*/
add(target, eventType, listener, capture = false) {
const h = {
target: target,
eventType: eventType,
listener: listener,
capture: capture,
};
this.listeners_.push(h);
target.addEventListener(eventType, listener, capture);
}
/**
* Remove any specified event listeners added with this EventTracker.
* @param {!EventTarget} target The DOM target to remove a listener from.
* @param {?string} eventType The type of event to remove.
*/
remove(target, eventType) {
this.listeners_ = this.listeners_.filter(listener => {
if (listener.target === target &&
(!eventType || (listener.eventType === eventType))) {
EventTracker.removeEventListener(listener);
return false;
}
return true;
});
}
/** Remove all event listeners added with this EventTracker. */
removeAll() {
this.listeners_.forEach(
listener => EventTracker.removeEventListener(listener));
this.listeners_ = [];
}
/**
* Remove a single event listener given it's tracking entry. It's up to the
* caller to ensure the entry is removed from listeners_.
* @param {EventTrackerEntry} entry The entry describing the listener to
* remove.
*/
static removeEventListener(entry) {
entry.target.removeEventListener(
entry.eventType, entry.listener, entry.capture);
}
}
/**
* The type of the internal tracking entry.
* @typedef {{target: !EventTarget,
* eventType: string,
* listener: (EventListener|Function),
* capture: boolean}}
*/
let EventTrackerEntry;