forked from chieffancypants/angular-hotkeys
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathhotkeys.js
More file actions
1661 lines (1432 loc) · 52.2 KB
/
hotkeys.js
File metadata and controls
1661 lines (1432 loc) · 52.2 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
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
/*!
* angular-hotkeys v1.7.0
* https://chieffancypants.github.io/angular-hotkeys
* Copyright (c) 2016 Wes Cruver
* License: MIT
*/
/*
* angular-hotkeys
*
* Automatic keyboard shortcuts for your angular apps
*
* (c) 2016 Wes Cruver
* License: MIT
*/
(function() {
'use strict';
angular.module('cfp.hotkeys', []).provider('hotkeys', ['$injector', function($injector) {
/**
* Configurable setting to disable the cheatsheet entirely
* @type {Boolean}
*/
this.includeCheatSheet = true;
/**
* Configurable setting to disable ngRoute hooks
* @type {Boolean}
*/
this.useNgRoute = $injector.has('ngViewDirective');
/**
* Configurable setting for the cheat sheet title
* @type {String}
*/
this.templateTitle = 'Keyboard Shortcuts:';
/**
* Configurable settings for the cheat sheet header and footer. Both are HTML, and the header
* overrides the normal title if specified.
* @type {String}
*/
this.templateHeader = null;
this.templateFooter = null;
/**
* Cheat sheet template in the event you want to totally customize it.
* @type {String}
*/
this.template = '<div class="cfp-hotkeys-container fade" ng-class="{in: helpVisible}" style="display: none;"><div class="cfp-hotkeys">' +
'<h4 class="cfp-hotkeys-title" ng-if="!header">{{ title }}</h4>' +
'<div ng-bind-html="header" ng-if="header"></div>' +
'<table><tbody>' +
'<tr ng-repeat="hotkey in hotkeys | filter:{ description: \'!$$undefined$$\' }">' +
'<td class="cfp-hotkeys-keys">' +
'<span ng-repeat="key in hotkey.format() track by $index" class="cfp-hotkeys-key">{{ key }}</span>' +
'</td>' +
'<td class="cfp-hotkeys-text">{{ hotkey.description }}</td>' +
'</tr>' +
'</tbody></table>' +
'<div ng-bind-html="footer" ng-if="footer"></div>' +
'<div class="cfp-hotkeys-close" ng-click="toggleCheatSheet()">×</div>' +
'</div></div>';
/**
* Configurable setting for the cheat sheet hotkey
* @type {String}
*/
this.cheatSheetHotkey = '?';
/**
* Configurable setting for the cheat sheet description
* @type {String}
*/
this.cheatSheetDescription = 'Show / hide this help menu';
this.$get = ['$rootElement', '$rootScope', '$compile', '$window', '$document', function ($rootElement, $rootScope, $compile, $window, $document) {
var mouseTrapEnabled = true;
function pause() {
mouseTrapEnabled = false;
}
function unpause() {
mouseTrapEnabled = true;
}
// monkeypatch Mousetrap's stopCallback() function
// this version doesn't return true when the element is an INPUT, SELECT, or TEXTAREA
// (instead we will perform this check per-key in the _add() method)
Mousetrap.prototype.stopCallback = function(event, element) {
if (!mouseTrapEnabled) {
return true;
}
// if the element has the class "mousetrap" then no need to stop
if ((' ' + element.className + ' ').indexOf(' mousetrap ') > -1) {
return false;
}
return (element.contentEditable && element.contentEditable == 'true');
};
/**
* Convert strings like cmd into symbols like ⌘
* @param {String} combo Key combination, e.g. 'mod+f'
* @return {String} The key combination with symbols
*/
function symbolize (combo) {
var map = {
command : '\u2318', // ⌘
shift : '\u21E7', // ⇧
left : '\u2190', // ←
right : '\u2192', // →
up : '\u2191', // ↑
down : '\u2193', // ↓
'return' : '\u23CE', // ⏎
backspace : '\u232B' // ⌫
};
combo = combo.split('+');
for (var i = 0; i < combo.length; i++) {
// try to resolve command / ctrl based on OS:
if (combo[i] === 'mod') {
if ($window.navigator && $window.navigator.platform.indexOf('Mac') >=0 ) {
combo[i] = 'command';
} else {
combo[i] = 'ctrl';
}
}
combo[i] = map[combo[i]] || combo[i];
}
return combo.join(' + ');
}
/**
* Hotkey object used internally for consistency
*
* @param {array} combo The keycombo. it's an array to support multiple combos
* @param {String} description Description for the keycombo
* @param {Function} callback function to execute when keycombo pressed
* @param {string} action the type of event to listen for (for mousetrap)
* @param {array} allowIn an array of tag names to allow this combo in ('INPUT', 'SELECT', and/or 'TEXTAREA')
* @param {Boolean} persistent Whether the hotkey persists navigation events
*/
function Hotkey (combo, description, callback, action, allowIn, persistent) {
// TODO: Check that the values are sane because we could
// be trying to instantiate a new Hotkey with outside dev's
// supplied values
this.combo = combo instanceof Array ? combo : [combo];
this.description = description;
this.callback = callback;
this.action = action;
this.allowIn = allowIn;
this.persistent = persistent;
this._formated = null;
}
/**
* Helper method to format (symbolize) the key combo for display
*
* @return {[Array]} An array of the key combination sequence
* for example: "command+g c i" becomes ["⌘ + g", "c", "i"]
*
*/
Hotkey.prototype.format = function() {
if (this._formated === null) {
// Don't show all the possible key combos, just the first one. Not sure
// of usecase here, so open a ticket if my assumptions are wrong
var combo = this.combo[0];
var sequence = combo.split(/[\s]/);
for (var i = 0; i < sequence.length; i++) {
sequence[i] = symbolize(sequence[i]);
}
this._formated = sequence;
}
return this._formated;
};
/**
* A new scope used internally for the cheatsheet
* @type {$rootScope.Scope}
*/
var scope = $rootScope.$new();
/**
* Holds an array of Hotkey objects currently bound
* @type {Array}
*/
scope.hotkeys = [];
/**
* Contains the state of the help's visibility
* @type {Boolean}
*/
scope.helpVisible = false;
/**
* Holds the title string for the help menu
* @type {String}
*/
scope.title = this.templateTitle;
/**
* Holds the header HTML for the help menu
* @type {String}
*/
scope.header = this.templateHeader;
/**
* Holds the footer HTML for the help menu
* @type {String}
*/
scope.footer = this.templateFooter;
/**
* Expose toggleCheatSheet to hotkeys scope so we can call it using
* ng-click from the template
* @type {function}
*/
scope.toggleCheatSheet = toggleCheatSheet;
/**
* Holds references to the different scopes that have bound hotkeys
* attached. This is useful to catch when the scopes are `$destroy`d and
* then automatically unbind the hotkey.
*
* @type {Object}
*/
var boundScopes = {};
if (this.useNgRoute) {
$rootScope.$on('$routeChangeSuccess', function (event, route) {
purgeHotkeys();
if (route && route.hotkeys) {
angular.forEach(route.hotkeys, function (hotkey) {
// a string was given, which implies this is a function that is to be
// $eval()'d within that controller's scope
// TODO: hotkey here is super confusing. sometimes a function (that gets turned into an array), sometimes a string
var callback = hotkey[2];
if (typeof(callback) === 'string' || callback instanceof String) {
hotkey[2] = [callback, route];
}
// todo: perform check to make sure not already defined:
// this came from a route, so it's likely not meant to be persistent
hotkey[5] = false;
_add.apply(this, hotkey);
});
}
});
}
// Auto-create a help menu:
if (this.includeCheatSheet) {
var document = $document[0];
var element = $rootElement[0];
var helpMenu = angular.element(this.template);
_add(this.cheatSheetHotkey, this.cheatSheetDescription, toggleCheatSheet);
// If $rootElement is document or documentElement, then body must be used
if (element === document || element === document.documentElement) {
element = document.body;
}
angular.element(element).append($compile(helpMenu)(scope));
}
/**
* Purges all non-persistent hotkeys (such as those defined in routes)
*
* Without this, the same hotkey would get recreated everytime
* the route is accessed.
*/
function purgeHotkeys() {
var i = scope.hotkeys.length;
while (i--) {
var hotkey = scope.hotkeys[i];
if (hotkey && !hotkey.persistent) {
_del(hotkey);
}
}
}
/**
* Toggles the help menu element's visiblity
*/
var previousEsc = false;
function toggleCheatSheet() {
scope.helpVisible = !scope.helpVisible;
// Bind to esc to remove the cheat sheet. Ideally, this would be done
// as a directive in the template, but that would create a nasty
// circular dependency issue that I don't feel like sorting out.
if (scope.helpVisible) {
previousEsc = _get('esc');
_del('esc');
// Here's an odd way to do this: we're going to use the original
// description of the hotkey on the cheat sheet so that it shows up.
// without it, no entry for esc will ever show up (#22)
_add('esc', previousEsc.description, toggleCheatSheet, null, ['INPUT', 'SELECT', 'TEXTAREA']);
} else {
_del('esc');
// restore the previously bound ESC key
if (previousEsc !== false) {
_add(previousEsc);
}
}
}
/**
* Creates a new Hotkey and creates the Mousetrap binding
*
* @param {string} combo mousetrap key binding
* @param {string} description description for the help menu
* @param {Function} callback method to call when key is pressed
* @param {string} action the type of event to listen for (for mousetrap)
* @param {array} allowIn an array of tag names to allow this combo in ('INPUT', 'SELECT', and/or 'TEXTAREA')
* @param {boolean} persistent if true, the binding is preserved upon route changes
*/
function _add (combo, description, callback, action, allowIn, persistent) {
// used to save original callback for "allowIn" wrapping:
var _callback;
// these elements are prevented by the default Mousetrap.stopCallback():
var preventIn = ['INPUT', 'SELECT', 'TEXTAREA'];
// Determine if object format was given:
var objType = Object.prototype.toString.call(combo);
if (objType === '[object Object]') {
description = combo.description;
callback = combo.callback;
action = combo.action;
persistent = combo.persistent;
allowIn = combo.allowIn;
combo = combo.combo;
}
// no duplicates please
_del(combo);
// description is optional:
if (description instanceof Function) {
action = callback;
callback = description;
description = '$$undefined$$';
} else if (angular.isUndefined(description)) {
description = '$$undefined$$';
}
// any items added through the public API are for controllers
// that persist through navigation, and thus undefined should mean
// true in this case.
if (persistent === undefined) {
persistent = true;
}
// if callback is defined, then wrap it in a function
// that checks if the event originated from a form element.
// the function blocks the callback from executing unless the element is specified
// in allowIn (emulates Mousetrap.stopCallback() on a per-key level)
if (typeof callback === 'function') {
// save the original callback
_callback = callback;
// make sure allowIn is an array
if (!(allowIn instanceof Array)) {
allowIn = [];
}
// remove anything from preventIn that's present in allowIn
var index;
for (var i=0; i < allowIn.length; i++) {
allowIn[i] = allowIn[i].toUpperCase();
index = preventIn.indexOf(allowIn[i]);
if (index !== -1) {
preventIn.splice(index, 1);
}
}
// create the new wrapper callback
callback = function(event) {
var shouldExecute = true;
// if the callback is executed directly `hotkey.get('w').callback()`
// there will be no event, so just execute the callback.
if (event) {
var target = event.target || event.srcElement; // srcElement is IE only
var nodeName = target.nodeName.toUpperCase();
// check if the input has a mousetrap class, and skip checking preventIn if so
if ((' ' + target.className + ' ').indexOf(' mousetrap ') > -1) {
shouldExecute = true;
} else {
// don't execute callback if the event was fired from inside an element listed in preventIn
for (var i=0; i<preventIn.length; i++) {
if (preventIn[i] === nodeName) {
shouldExecute = false;
break;
}
}
}
}
if (shouldExecute) {
wrapApply(_callback.apply(this, arguments));
}
};
}
if (typeof(action) === 'string') {
Mousetrap.bind(combo, wrapApply(callback), action);
} else {
Mousetrap.bind(combo, wrapApply(callback));
}
var hotkey = new Hotkey(combo, description, callback, action, allowIn, persistent);
scope.hotkeys.push(hotkey);
return hotkey;
}
/**
* delete and unbind a Hotkey
*
* @param {mixed} hotkey Either the bound key or an instance of Hotkey
* @return {boolean} true if successful
*/
function _del (hotkey) {
var combo = (hotkey instanceof Hotkey) ? hotkey.combo : hotkey;
Mousetrap.unbind(combo);
if (angular.isArray(combo)) {
var retStatus = true;
var i = combo.length;
while (i--) {
retStatus = _del(combo[i]) && retStatus;
}
return retStatus;
} else {
var index = scope.hotkeys.indexOf(_get(combo));
if (index > -1) {
// if the combo has other combos bound, don't unbind the whole thing, just the one combo:
if (scope.hotkeys[index].combo.length > 1) {
scope.hotkeys[index].combo.splice(scope.hotkeys[index].combo.indexOf(combo), 1);
} else {
// remove hotkey from bound scopes
angular.forEach(boundScopes, function (boundScope) {
var scopeIndex = boundScope.indexOf(scope.hotkeys[index]);
if (scopeIndex !== -1) {
boundScope.splice(scopeIndex, 1);
}
});
scope.hotkeys.splice(index, 1);
}
return true;
}
}
return false;
}
/**
* Get a Hotkey object by key binding
*
* @param {[string]} [combo] the key the Hotkey is bound to. Returns all key bindings if no key is passed
* @return {Hotkey} The Hotkey object
*/
function _get (combo) {
if (!combo) {
return scope.hotkeys;
}
var hotkey;
for (var i = 0; i < scope.hotkeys.length; i++) {
hotkey = scope.hotkeys[i];
if (hotkey.combo.indexOf(combo) > -1) {
return hotkey;
}
}
return false;
}
/**
* Binds the hotkey to a particular scope. Useful if the scope is
* destroyed, we can automatically destroy the hotkey binding.
*
* @param {Object} scope The scope to bind to
*/
function bindTo (scope) {
// Only initialize once to allow multiple calls for same scope.
if (!(scope.$id in boundScopes)) {
// Add the scope to the list of bound scopes
boundScopes[scope.$id] = [];
scope.$on('$destroy', function () {
var i = boundScopes[scope.$id].length;
while (i--) {
_del(boundScopes[scope.$id].pop());
}
});
}
// return an object with an add function so we can keep track of the
// hotkeys and their scope that we added via this chaining method
return {
add: function (args) {
var hotkey;
if (arguments.length > 1) {
hotkey = _add.apply(this, arguments);
} else {
hotkey = _add(args);
}
boundScopes[scope.$id].push(hotkey);
return this;
}
};
}
/**
* All callbacks sent to Mousetrap are wrapped using this function
* so that we can force a $scope.$apply()
*
* @param {Function} callback [description]
* @return {[type]} [description]
*/
function wrapApply (callback) {
// return mousetrap a function to call
return function (event, combo) {
// if this is an array, it means we provided a route object
// because the scope wasn't available yet, so rewrap the callback
// now that the scope is available:
if (callback instanceof Array) {
var funcString = callback[0];
var route = callback[1];
callback = function (event) {
route.scope.$eval(funcString);
};
}
// this takes place outside angular, so we'll have to call
// $apply() to make sure angular's digest happens
$rootScope.$apply(function() {
// call the original hotkey callback with the keyboard event
callback(event, _get(combo));
});
};
}
var publicApi = {
add : _add,
del : _del,
get : _get,
bindTo : bindTo,
template : this.template,
toggleCheatSheet : toggleCheatSheet,
includeCheatSheet : this.includeCheatSheet,
cheatSheetHotkey : this.cheatSheetHotkey,
cheatSheetDescription : this.cheatSheetDescription,
useNgRoute : this.useNgRoute,
purgeHotkeys : purgeHotkeys,
templateTitle : this.templateTitle,
pause : pause,
unpause : unpause
};
return publicApi;
}];
}])
.directive('hotkey', ['hotkeys', function (hotkeys) {
return {
restrict: 'A',
link: function (scope, el, attrs) {
var keys = [],
allowIn;
angular.forEach(scope.$eval(attrs.hotkey), function (func, hotkey) {
// split and trim the hotkeys string into array
allowIn = typeof attrs.hotkeyAllowIn === "string" ? attrs.hotkeyAllowIn.split(/[\s,]+/) : [];
keys.push(hotkey);
hotkeys.add({
combo: hotkey,
description: attrs.hotkeyDescription,
callback: func,
action: attrs.hotkeyAction,
allowIn: allowIn
});
});
// remove the hotkey if the directive is destroyed:
el.bind('$destroy', function() {
angular.forEach(keys, hotkeys.del);
});
}
};
}])
.run(['hotkeys', function(hotkeys) {
// force hotkeys to run by injecting it. Without this, hotkeys only runs
// when a controller or something else asks for it via DI.
}]);
})();
/*global define:false */
/**
* Copyright 2015 Craig Campbell
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*
* Mousetrap is a simple keyboard shortcut library for Javascript with
* no external dependencies
*
* @version 1.5.2
* @url craig.is/killing/mice
*/
(function(window, document, undefined) {
/**
* mapping of special keycodes to their corresponding keys
*
* everything in this dictionary cannot use keypress events
* so it has to be here to map to the correct keycodes for
* keyup/keydown events
*
* @type {Object}
*/
var _MAP = {
8: 'backspace',
9: 'tab',
13: 'enter',
16: 'shift',
17: 'ctrl',
18: 'alt',
20: 'capslock',
27: 'esc',
32: 'space',
33: 'pageup',
34: 'pagedown',
35: 'end',
36: 'home',
37: 'left',
38: 'up',
39: 'right',
40: 'down',
45: 'ins',
46: 'del',
91: 'meta',
93: 'meta',
224: 'meta'
};
/**
* mapping for special characters so they can support
*
* this dictionary is only used incase you want to bind a
* keyup or keydown event to one of these keys
*
* @type {Object}
*/
var _KEYCODE_MAP = {
106: '*',
107: '+',
109: '-',
110: '.',
111 : '/',
186: ';',
187: '=',
188: ',',
189: '-',
190: '.',
191: '/',
192: '`',
219: '[',
220: '\\',
221: ']',
222: '\''
};
/**
* this is a mapping of keys that require shift on a US keypad
* back to the non shift equivelents
*
* this is so you can use keyup events with these keys
*
* note that this will only work reliably on US keyboards
*
* @type {Object}
*/
var _SHIFT_MAP = {
'~': '`',
'!': '1',
'@': '2',
'#': '3',
'$': '4',
'%': '5',
'^': '6',
'&': '7',
'*': '8',
'(': '9',
')': '0',
'_': '-',
'+': '=',
':': ';',
'\"': '\'',
'<': ',',
'>': '.',
'?': '/',
'|': '\\'
};
/**
* this is a list of special strings you can use to map
* to modifier keys when you specify your keyboard shortcuts
*
* @type {Object}
*/
var _SPECIAL_ALIASES = {
'option': 'alt',
'command': 'meta',
'return': 'enter',
'escape': 'esc',
'plus': '+',
'mod': /Mac|iPod|iPhone|iPad/.test(navigator.platform) ? 'meta' : 'ctrl'
};
/**
* variable to store the flipped version of _MAP from above
* needed to check if we should use keypress or not when no action
* is specified
*
* @type {Object|undefined}
*/
var _REVERSE_MAP;
/**
* loop through the f keys, f1 to f19 and add them to the map
* programatically
*/
for (var i = 1; i < 20; ++i) {
_MAP[111 + i] = 'f' + i;
}
/**
* loop through to map numbers on the numeric keypad
*/
for (i = 0; i <= 9; ++i) {
_MAP[i + 96] = i;
}
/**
* cross browser add event method
*
* @param {Element|HTMLDocument} object
* @param {string} type
* @param {Function} callback
* @returns void
*/
function _addEvent(object, type, callback) {
if (object.addEventListener) {
object.addEventListener(type, callback, false);
return;
}
object.attachEvent('on' + type, callback);
}
/**
* takes the event and returns the key character
*
* @param {Event} e
* @return {string}
*/
function _characterFromEvent(e) {
// for keypress events we should return the character as is
if (e.type == 'keypress') {
var character = String.fromCharCode(e.which);
// if the shift key is not pressed then it is safe to assume
// that we want the character to be lowercase. this means if
// you accidentally have caps lock on then your key bindings
// will continue to work
//
// the only side effect that might not be desired is if you
// bind something like 'A' cause you want to trigger an
// event when capital A is pressed caps lock will no longer
// trigger the event. shift+a will though.
if (!e.shiftKey) {
character = character.toLowerCase();
}
return character;
}
// for non keypress events the special maps are needed
if (_MAP[e.which]) {
return _MAP[e.which];
}
if (_KEYCODE_MAP[e.which]) {
return _KEYCODE_MAP[e.which];
}
// if it is not in the special map
// with keydown and keyup events the character seems to always
// come in as an uppercase character whether you are pressing shift
// or not. we should make sure it is always lowercase for comparisons
return String.fromCharCode(e.which).toLowerCase();
}
/**
* checks if two arrays are equal
*
* @param {Array} modifiers1
* @param {Array} modifiers2
* @returns {boolean}
*/
function _modifiersMatch(modifiers1, modifiers2) {
return modifiers1.sort().join(',') === modifiers2.sort().join(',');
}
/**
* takes a key event and figures out what the modifiers are
*
* @param {Event} e
* @returns {Array}
*/
function _eventModifiers(e) {
var modifiers = [];
if (e.shiftKey) {
modifiers.push('shift');
}
if (e.altKey) {
modifiers.push('alt');
}
if (e.ctrlKey) {
modifiers.push('ctrl');
}
if (e.metaKey) {
modifiers.push('meta');
}
return modifiers;
}
/**
* prevents default for this event
*
* @param {Event} e
* @returns void
*/
function _preventDefault(e) {
if (e.preventDefault) {
e.preventDefault();
return;
}
e.returnValue = false;
}
/**
* stops propogation for this event
*
* @param {Event} e
* @returns void
*/
function _stopPropagation(e) {
if (e.stopPropagation) {
e.stopPropagation();
return;
}
e.cancelBubble = true;
}
/**
* determines if the keycode specified is a modifier key or not
*
* @param {string} key
* @returns {boolean}
*/
function _isModifier(key) {
return key == 'shift' || key == 'ctrl' || key == 'alt' || key == 'meta';
}
/**
* reverses the map lookup so that we can look for specific keys
* to see what can and can't use keypress
*
* @return {Object}
*/
function _getReverseMap() {
if (!_REVERSE_MAP) {
_REVERSE_MAP = {};
for (var key in _MAP) {
// pull out the numeric keypad from here cause keypress should
// be able to detect the keys from the character
if (key > 95 && key < 112) {
continue;
}
if (_MAP.hasOwnProperty(key)) {
_REVERSE_MAP[_MAP[key]] = key;
}
}
}
return _REVERSE_MAP;
}
/**
* picks the best action based on the key combination
*
* @param {string} key - character for key
* @param {Array} modifiers
* @param {string=} action passed in
*/
function _pickBestAction(key, modifiers, action) {
// if no action was picked in we should try to pick the one
// that we think would work best for this key
if (!action) {
action = _getReverseMap()[key] ? 'keydown' : 'keypress';
}
// modifier keys don't work as expected with keypress,
// switch to keydown
if (action == 'keypress' && modifiers.length) {
action = 'keydown';
}
return action;
}
/**
* Converts from a string key combination to an array
*
* @param {string} combination like "command+shift+l"
* @return {Array}
*/
function _keysFromString(combination) {
if (combination === '+') {
return ['+'];
}
combination = combination.replace(/\+{2}/g, '+plus');
return combination.split('+');
}