Skip to content
Navigation Menu
{{ message }}
forked from adobe/brackets
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathDropdownEventHandler.js
More file actions
333 lines (289 loc) · 11.7 KB
/
Copy pathDropdownEventHandler.js
File metadata and controls
333 lines (289 loc) · 11.7 KB
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
/*
* Copyright (c) 2013 - present Adobe Systems Incorporated. All rights reserved.
*
* Permission is hereby granted, free of charge, to any person obtaining a
* copy of this software and associated documentation files (the "Software"),
* to deal in the Software without restriction, including without limitation
* the rights to use, copy, modify, merge, publish, distribute, sublicense,
* and/or sell copies of the Software, and to permit persons to whom the
* Software is furnished to do so, subject to the following conditions:
*
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
*
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
* FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
* DEALINGS IN THE SOFTWARE.
*
*/
define(function (require, exports, module) {
"use strict";
var KeyBindingManager = require("command/KeyBindingManager"),
KeyEvent = require("utils/KeyEvent"),
PopUpManager = require("widgets/PopUpManager"),
ViewUtils = require("utils/ViewUtils");
/**
* Object to handle events for a dropdown list.
*
* DropdownEventHandler handles these events:
*
* Mouse:
* - click - execute selection callback and dismiss list
* - mouseover - highlight item
* - mouseleave - remove mouse highlighting
*
* Keyboard:
* - Enter - execute selection callback and dismiss list
* - Esc - dismiss list
* - Up/Down - change selection
* - PageUp/Down - change selection
*
* Items whose <a> has the .disabled class do not respond to selection.
*
* @constructor
* @param {jQueryObject} $list associated list object
* @param {Function} selectionCallback function called when list item is selected.
*/
function DropdownEventHandler($list, selectionCallback, closeCallback) {
this.$list = $list;
this.$items = $list.find("li");
this.selectionCallback = selectionCallback;
this.closeCallback = closeCallback;
this.scrolling = false;
/**
* @private
* The selected position in the list; otherwise -1.
* @type {number}
*/
this._selectedIndex = -1;
}
/**
* Public open method
*/
DropdownEventHandler.prototype.open = function () {
var self = this;
/**
* Convert keydown events into hint list navigation actions.
*
* @param {KeyboardEvent} event
* @return {boolean} true if key was handled, otherwise false.
*/
function _keydownHook(event) {
var keyCode;
// (page) up, (page) down, enter and tab key are handled by the list
if (event.type === "keydown") {
keyCode = event.keyCode;
if (keyCode === KeyEvent.DOM_VK_TAB) {
self.close();
} else if (keyCode === KeyEvent.DOM_VK_UP) {
// Move up one, wrapping at edges (if nothing selected, select the last item)
self._tryToSelect(self._selectedIndex === -1 ? -1 : self._selectedIndex - 1, -1);
} else if (keyCode === KeyEvent.DOM_VK_DOWN) {
// Move down one, wrapping at edges (if nothing selected, select the first item)
self._tryToSelect(self._selectedIndex === -1 ? 0 : self._selectedIndex + 1, +1);
} else if (keyCode === KeyEvent.DOM_VK_PAGE_UP) {
// Move up roughly one 'page', stopping at edges (not wrapping) (if nothing selected, selects the first item)
self._tryToSelect((self._selectedIndex || 0) - self._itemsPerPage(), -1, true);
} else if (keyCode === KeyEvent.DOM_VK_PAGE_DOWN) {
// Move down roughly one 'page', stopping at edges (not wrapping) (if nothing selected, selects the item one page down from the top)
self._tryToSelect((self._selectedIndex || 0) + self._itemsPerPage(), +1, true);
} else if (keyCode === KeyEvent.DOM_VK_HOME) {
self._tryToSelect(0, +1);
} else if (keyCode === KeyEvent.DOM_VK_END) {
self._tryToSelect(self.$items.length - 1, -1);
} else if (self._selectedIndex !== -1 &&
(keyCode === KeyEvent.DOM_VK_RETURN)) {
// Trigger a click handler to commmit the selected item
self._selectionHandler();
} else {
// Let the event bubble.
return false;
}
event.stopImmediatePropagation();
event.preventDefault();
return true;
}
// If we didn't handle it, let other global keydown hooks handle it.
return false;
}
/**
* PopUpManager callback
*/
function closeCallback() {
KeyBindingManager.removeGlobalKeydownHook(_keydownHook);
self._cleanup();
}
KeyBindingManager.addGlobalKeydownHook(_keydownHook);
if (this.$list) {
this._registerMouseEvents();
PopUpManager.addPopUp(this.$list, closeCallback, true);
}
};
/**
* Public close method
*/
DropdownEventHandler.prototype.close = function () {
if (this.$list) {
PopUpManager.removePopUp(this.$list);
}
};
/**
* Cleanup
*/
DropdownEventHandler.prototype._cleanup = function () {
if (this.$list) {
this.$list.off(".dropdownEventHandler");
}
if (this.closeCallback) {
this.closeCallback();
}
};
/**
* Try to select item at the given index. If it's disabled or a divider, keep trying by incrementing
* index by 'direction' each time (wrapping around if needed).
* @param {number} index If out of bounds, index either wraps around to remain in range (e.g. -1 yields
* last item, length+1 yields 2nd item) or if noWrap set, clips instead (e.g. -1 yields
* first item, length+1 yields last item).
* @param {number} direction Either +1 or -1
* @param {boolean=} noWrap Clip out of range index values instead of wrapping. Default false (wrap).
*/
DropdownEventHandler.prototype._tryToSelect = function (index, direction, noWrap) {
// Fix up 'index' if out of bounds (>= len or < 0)
var len = this.$items.length;
if (noWrap) {
// Clip to stay in range (and set direction so we don't wrap in the recursion case either)
if (index < 0) {
index = 0;
direction = +1;
} else if (index >= len) {
index = len - 1;
direction = -1;
}
} else {
// Wrap around to keep index in bounds
index %= len;
if (index < 0) {
index += len;
}
}
var $item = this.$items.eq(index);
if ($item.hasClass("divider") || $item.find("a.disabled").length) {
// Desired item is ineligible for selection: try next one
this._tryToSelect(index + direction, direction, noWrap);
} else {
this._setSelectedIndex(index, true);
}
};
/**
* @return {number} The number of items per scroll page.
*/
DropdownEventHandler.prototype._itemsPerPage = function () {
var itemsPerPage = 1,
itemHeight;
if (this.$items.length !== 0) {
itemHeight = $(this.$items[0]).height();
if (itemHeight) {
// round down to integer value
itemsPerPage = Math.floor(this.$list.height() / itemHeight);
itemsPerPage = Math.max(1, Math.min(itemsPerPage, this.$items.length));
}
}
return itemsPerPage;
};
/**
* Call selectionCallback with selected index
*/
DropdownEventHandler.prototype._selectionHandler = function () {
if (this._selectedIndex === -1) {
return;
}
var $link = this.$items.eq(this._selectedIndex).find("a");
this._clickHandler($link);
};
/**
* Call selectionCallback with selected item
*
* @param {jQueryObject} $item
*/
DropdownEventHandler.prototype._clickHandler = function ($link) {
if (!this.selectionCallback || !this.$list || !$link) {
return;
}
if ($link.hasClass("disabled")) {
return;
}
this.selectionCallback($link);
PopUpManager.removePopUp(this.$list);
};
/**
* Select the item in the hint list at the specified index, or remove the
* selection if index < 0.
*
* @private
* @param {number} index
*/
DropdownEventHandler.prototype._setSelectedIndex = function (index, scrollIntoView) {
// Range check
index = Math.max(-1, Math.min(index, this.$items.length - 1));
// Clear old highlight
if (this._selectedIndex !== -1) {
this.$items.eq(this._selectedIndex).find("a").removeClass("selected");
}
this._selectedIndex = index;
// Highlight the new selected item, if necessary
if (this._selectedIndex !== -1) {
var $item = this.$items.eq(this._selectedIndex);
$item.find("a").addClass("selected");
if (scrollIntoView) {
this.scrolling = true;
ViewUtils.scrollElementIntoView(this.$list, $item, false);
}
}
};
/**
* Register mouse event handlers
*/
DropdownEventHandler.prototype._registerMouseEvents = function () {
var self = this;
this.$list
.on("click.dropdownEventHandler", "a", function () {
self._clickHandler($(this));
})
.on("mouseover.dropdownEventHandler", "a", function (e) {
// Don't select item under mouse cursor when scrolling.
if (self.scrolling) {
self.scrolling = false;
return;
}
var $link = $(e.currentTarget),
$item = $link.closest("li"),
viewOffset = self.$list.offset(),
elementOffset = $item.offset();
// Only set selected if enabled & in view
// (dividers are already screened out since they don't have an "a" tag in them)
if (!$link.hasClass("disabled")) {
if (elementOffset.top < viewOffset.top + self.$list.height() && viewOffset.top <= elementOffset.top) {
self._setSelectedIndex(self.$items.index($item), false);
}
}
});
};
/**
* Re-register mouse event handlers
* @param {!jQueryObject} $list newly updated list object
*/
DropdownEventHandler.prototype.reRegisterMouseHandlers = function ($list) {
if (this.$list) {
this.$list.off(".dropdownEventHandler");
this.$list = $list;
this.$items = $list.find("li");
this._registerMouseEvents();
}
};
// Export public API
exports.DropdownEventHandler = DropdownEventHandler;
});
You can’t perform that action at this time.