Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(8)

Side by Side Diff: ui/webui/resources/js/event_tracker.js

Issue 454223004: Typecheck JS files for chrome://history (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@B_download
Patch Set: fixed issues Created 6 years, 4 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View unified diff | Download patch
OLDNEW
1 // Copyright (c) 2011 The Chromium Authors. All rights reserved. 1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be 2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file. 3 // found in the LICENSE file.
4 4
5 /** 5 /**
6 * @fileoverview EventTracker is a simple class that manages the addition and 6 * @fileoverview EventTracker is a simple class that manages the addition and
7 * removal of DOM event listeners. In particular, it keeps track of all 7 * removal of DOM event listeners. In particular, it keeps track of all
8 * listeners that have been added and makes it easy to remove some or all of 8 * listeners that have been added and makes it easy to remove some or all of
9 * them without requiring all the information again. This is particularly handy 9 * them without requiring all the information again. This is particularly handy
10 * when the listener is a generated function such as a lambda or the result of 10 * when the listener is a generated function such as a lambda or the result of
11 * calling Function.bind. 11 * calling Function.bind.
12 */ 12 */
13 13
14 /** 14 /**
15 * The type of the internal tracking entry. TODO(dbeam): move this back to 15 * The type of the internal tracking entry. TODO(dbeam): move this back to
16 * EventTracker.Entry when https://github.com/google/closure-compiler/issues/544 16 * EventTracker.Entry when https://github.com/google/closure-compiler/issues/544
17 * is fixed. 17 * is fixed.
18 * @typedef {{node: !Node, 18 * @typedef {{node: !Node,
19 * eventType: string, 19 * eventType: string,
20 * listener: Function, 20 * listener: Function,
21 * capture: boolean}} 21 * capture: boolean}}
22 */ 22 */
23 var EventTrackerEntry; 23 var EventTrackerEntry;
24 24
25 // Use an anonymous function to enable strict mode just for this file (which 25 /**
26 // will be concatenated with other files when embedded in Chrome). 26 * Create an EventTracker to track a set of events.
27 var EventTracker = (function() { 27 * EventTracker instances are typically tied 1:1 with other objects or
28 'use strict'; 28 * DOM elements whose listeners should be removed when the object is disposed
29 * or the corresponding elements are removed from the DOM.
30 * @constructor
31 */
32 function EventTracker() {
33 /**
34 * @type {Array.<EventTrackerEntry>}
35 * @private
36 */
37 this.listeners_ = [];
38 }
39
40 EventTracker.prototype = {
41 /**
42 * Add an event listener - replacement for Node.addEventListener.
43 * @param {!Node} node The DOM node to add a listener to.
44 * @param {string} eventType The type of event to subscribe to.
45 * @param {Function} listener The listener to add.
46 * @param {boolean=} opt_capture Whether to invoke during the capture phase.
47 */
48 add: function(node, eventType, listener, opt_capture) {
49 var capture = !!opt_capture;
50 var h = {
51 node: node,
52 eventType: eventType,
53 listener: listener,
54 capture: capture,
55 };
56 this.listeners_.push(h);
57 node.addEventListener(eventType, listener, capture);
58 },
29 59
30 /** 60 /**
31 * Create an EventTracker to track a set of events. 61 * Remove any specified event listeners added with this EventTracker.
32 * EventTracker instances are typically tied 1:1 with other objects or 62 * @param {!Node} node The DOM node to remove a listener from.
33 * DOM elements whose listeners should be removed when the object is disposed 63 * @param {?string} eventType The type of event to remove.
34 * or the corresponding elements are removed from the DOM.
35 * @constructor
36 */ 64 */
37 function EventTracker() { 65 remove: function(node, eventType) {
38 /** 66 this.listeners_ = this.listeners_.filter(function(h) {
39 * @type {Array.<EventTrackerEntry>} 67 if (h.node == node && (!eventType || (h.eventType == eventType))) {
40 * @private 68 EventTracker.removeEventListener_(h);
41 */ 69 return false;
70 }
71 return true;
72 });
73 },
74
75 /**
76 * Remove all event listeners added with this EventTracker.
77 */
78 removeAll: function() {
79 this.listeners_.forEach(EventTracker.removeEventListener_);
42 this.listeners_ = []; 80 this.listeners_ = [];
43 } 81 }
82 };
44 83
45 EventTracker.prototype = { 84 /**
46 /** 85 * Remove a single event listener given it's tracking entry. It's up to the
47 * Add an event listener - replacement for Node.addEventListener. 86 * caller to ensure the entry is removed from listeners_.
48 * @param {!Node} node The DOM node to add a listener to. 87 * @param {EventTrackerEntry} h The entry describing the listener to remove.
49 * @param {string} eventType The type of event to subscribe to. 88 * @private
50 * @param {Function} listener The listener to add. 89 */
51 * @param {boolean=} opt_capture Whether to invoke during the capture phase. 90 EventTracker.removeEventListener_ = function(h) {
52 */ 91 h.node.removeEventListener(h.eventType, h.listener, h.capture);
53 add: function(node, eventType, listener, opt_capture) { 92 };
54 var capture = !!opt_capture;
55 var h = {
56 node: node,
57 eventType: eventType,
58 listener: listener,
59 capture: capture,
60 };
61 this.listeners_.push(h);
62 node.addEventListener(eventType, listener, capture);
63 },
64
65 /**
66 * Remove any specified event listeners added with this EventTracker.
67 * @param {!Node} node The DOM node to remove a listener from.
68 * @param {?string} eventType The type of event to remove.
69 */
70 remove: function(node, eventType) {
71 this.listeners_ = this.listeners_.filter(function(h) {
72 if (h.node == node && (!eventType || (h.eventType == eventType))) {
73 EventTracker.removeEventListener_(h);
74 return false;
75 }
76 return true;
77 });
78 },
79
80 /**
81 * Remove all event listeners added with this EventTracker.
82 */
83 removeAll: function() {
84 this.listeners_.forEach(EventTracker.removeEventListener_);
85 this.listeners_ = [];
86 }
87 };
88
89 /**
90 * Remove a single event listener given it's tracking entry. It's up to the
91 * caller to ensure the entry is removed from listeners_.
92 * @param {EventTrackerEntry} h The entry describing the listener to remove.
93 * @private
94 */
95 EventTracker.removeEventListener_ = function(h) {
96 h.node.removeEventListener(h.eventType, h.listener, h.capture);
97 };
98
99 return EventTracker;
100 })();
101
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698