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
|
/* ************************************************************************
qooxdoo - the new era of web development
http://qooxdoo.org
Copyright:
2004-2007 1&1 Internet AG, Germany, http://www.1and1.org
License:
LGPL: http://www.gnu.org/licenses/lgpl.html
EPL: http://www.eclipse.org/org/documents/epl-v10.php
See the LICENSE file in the project's top-level directory for details.
Authors:
* Sebastian Werner (wpbasti)
* Andreas Ecker (ecker)
* Fabian Jakobs (fjakobs)
************************************************************************ */
/* ************************************************************************
#module(ui_core)
#require(qx.event.type.KeyEvent)
#require(qx.lang.Function);
************************************************************************ */
/**
* This class provides unified key event handler for Internet Explorer,
* Firefox, Opera and Safari
*/
qx.OO.defineClass("qx.event.handler.KeyEventHandler", qx.core.Target, function()
{
qx.core.Target.call(this);
// Object Wrapper to Events (Needed for DOM-Events)
var o = this;
/**
* private
*
* @param e {Event} event
*/
this.__onkeypress = function(e) { o._onkeypress(e); };
/**
* private
*
* @param e {Event} event
*/
this.__onkeyupdown = function(e) { o._onkeyupdown(e); };
});
/*
---------------------------------------------------------------------------
EVENT-MAPPING
---------------------------------------------------------------------------
*/
/** attach the key event handler to the DOM events */
qx.Proto._attachEvents = function()
{
var el = qx.core.Client.getInstance().isGecko() ? window : document.body;
qx.html.EventRegistration.addEventListener(el, "keypress", this.__onkeypress);
qx.html.EventRegistration.addEventListener(el, "keyup", this.__onkeyupdown);
qx.html.EventRegistration.addEventListener(el, "keydown", this.__onkeyupdown);
};
/** detach the key event handler from the DOM events */
qx.Proto._detachEvents = function()
{
var el = qx.core.Client.getInstance().isGecko() ? window : document.body;
// Unregister dom events
qx.html.EventRegistration.removeEventListener(el, "keypress", this.__onkeypress);
qx.html.EventRegistration.removeEventListener(el, "keyup", this.__onkeyupdown);
qx.html.EventRegistration.removeEventListener(el, "keydown", this.__onkeyupdown);
};
/*
---------------------------------------------------------------------------
KEY-MAPS
---------------------------------------------------------------------------
*/
/** maps the charcodes of special printable keys to key identifiers */
qx.Proto._specialCharCodeMap =
{
8 : "Backspace", // The Backspace (Back) key.
9 : "Tab", // The Horizontal Tabulation (Tab) key.
32 : "Space" // The Space (Spacebar) key.
};
/** maps the keycodes of non printable keys to key identifiers */
qx.Proto._keyCodeToIdentifierMap =
{
13 : "Enter", // The Enter key.
// Note: This key identifier is also used for the
// Return (Macintosh numpad) key.
16 : "Shift", // The Shift key.
17 : "Control", // The Control (Ctrl) key.
18 : "Alt", // The Alt (Menu) key.
20 : "CapsLock", // The CapsLock key
224 : "Meta", // The Meta key. (Apple Meta and Windows key)
27 : "Escape", // The Escape (Esc) key.
37 : "Left", // The Left Arrow key.
38 : "Up", // The Up Arrow key.
39 : "Right", // The Right Arrow key.
40 : "Down", // The Down Arrow key.
33 : "PageUp", // The Page Up key.
34 : "PageDown", // The Page Down (Next) key.
35 : "End", // The End key.
36 : "Home", // The Home key.
45 : "Insert", // The Insert (Ins) key. (Does not fire in Opera/Win)
46 : "Delete", // The Delete (Del) Key.
112 : "F1", // The F1 key.
113 : "F2", // The F2 key.
114 : "F3", // The F3 key.
115 : "F4", // The F4 key.
116 : "F5", // The F5 key.
117 : "F6", // The F6 key.
118 : "F7", // The F7 key.
119 : "F8", // The F8 key.
120 : "F9", // The F9 key.
121 : "F10", // The F10 key.
122 : "F11", // The F11 key.
123 : "F12", // The F12 key.
144 : "NumLock", // The Num Lock key.
44 : "PrintScreen", // The Print Screen (PrintScrn, SnapShot) key.
145 : "Scroll", // The scroll lock key
19 : "Pause", // The pause/break key
91 : "Win", // The Windows Logo key
93 : "Apps" // The Application key (Windows Context Menu)
};
/** maps the keycodes of the numpad keys to the right charcodes */
qx.Proto._numpadToCharCode =
{
96 : "0".charCodeAt(0),
97 : "1".charCodeAt(0),
98 : "2".charCodeAt(0),
99 : "3".charCodeAt(0),
100 : "4".charCodeAt(0),
101 : "5".charCodeAt(0),
102 : "6".charCodeAt(0),
103 : "7".charCodeAt(0),
104 : "8".charCodeAt(0),
105 : "9".charCodeAt(0),
106 : "*".charCodeAt(0),
107 : "+".charCodeAt(0),
109 : "-".charCodeAt(0),
110 : ",".charCodeAt(0),
111 : "/".charCodeAt(0)
};
// construct invers of keyCodeToIdentifierMap
(function()
{
if (!qx.Proto._identifierToKeyCodeMap)
{
qx.Proto._identifierToKeyCodeMap = {};
for (var key in qx.Proto._keyCodeToIdentifierMap) {
qx.Proto._identifierToKeyCodeMap[qx.Proto._keyCodeToIdentifierMap[key]] = parseInt(key);
}
for (var key in qx.Proto._specialCharCodeMap) {
qx.Proto._identifierToKeyCodeMap[qx.Proto._specialCharCodeMap[key]] = parseInt(key);
}
}
})();
/*
---------------------------------------------------------------------------
HELPER-METHODS
---------------------------------------------------------------------------
*/
qx.Proto._charCodeA = "A".charCodeAt(0);
qx.Proto._charCodeZ = "Z".charCodeAt(0);
qx.Proto._charCode0 = "0".charCodeAt(0);
qx.Proto._charCode9 = "9".charCodeAt(0);
/**
* Checks wether the keyCode represents a non printable key
*
* @param keyCode {String}
* @return {Boolean}
*/
qx.Proto._isNonPrintableKeyCode = function(keyCode) {
return this._keyCodeToIdentifierMap[keyCode] ? true : false;
};
/**
* Check wether the keycode can be reliably detected in keyup/keydown events
*
* @param keyCode {String}
* @return {Boolean}
*/
qx.Proto._isIdentifiableKeyCode = function(keyCode)
{
// A-Z
if (keyCode >= this._charCodeA && keyCode <= this._charCodeZ) {
return true;
}
// 0-9
if (keyCode >= this._charCode0 && keyCode <= this._charCode9) {
return true;
}
// Enter, Space, Tab, Backspace
if (this._specialCharCodeMap[keyCode]) {
return true;
}
// Numpad
if (this._numpadToCharCode[keyCode]) {
return true;
}
// non printable keys
if (this._isNonPrintableKeyCode(keyCode)) {
return true;
}
return false;
};
/**
* Checks wether a given string is a valid keyIdentifier
*
* @param keyIdentifier {String} The key identifier.
* @return {Boolean} wether the given string is a valid keyIdentifier
*/
qx.Proto.isValidKeyIdentifier = function(keyIdentifier)
{
if (this._identifierToKeyCodeMap[keyIdentifier]) {
return true;
}
if (keyIdentifier.length != 1) {
return false;
}
if (keyIdentifier >= "0" && keyIdentifier <= "9") {
return true;
}
if (keyIdentifier >= "A" && keyIdentifier <= "Z") {
return true;
}
switch (keyIdentifier)
{
case "+":
case "-":
case "*":
case "/":
return true;
default:
return false;
}
};
/**
* converts a keyboard code to the corresponding identifier
*
* @param keyCode {Integer}
* @return {String} key identifier
*/
qx.Proto._keyCodeToIdentifier = function(keyCode)
{
if (this._isIdentifiableKeyCode(keyCode))
{
var numPadKeyCode = this._numpadToCharCode[keyCode];
if (numPadKeyCode) {
return String.fromCharCode(numPadKeyCode);
}
return (
this._keyCodeToIdentifierMap[keyCode] ||
this._specialCharCodeMap[keyCode] ||
String.fromCharCode(keyCode)
);
}
else
{
return "Unidentified";
}
};
/**
* converts a character code to the corresponding identifier
*
* @param charCode {String}
* @return {String} key identifier
*/
qx.Proto._charCodeToIdentifier = function(charCode) {
return this._specialCharCodeMap[charCode] || String.fromCharCode(charCode).toUpperCase();
};
/**
* converts a key identifier back to a keycode
*
* @param keyIdentifier {String}
* @return {Integer} keyboard code
*/
qx.Proto._identifierToKeyCode = function(keyIdentifier) {
return this._identifierToKeyCodeMap[keyIdentifier] || keyIdentifier.charCodeAt(0);
};
/*
---------------------------------------------------------------------------
IDEALIZED-KEY-HANDLER
---------------------------------------------------------------------------
*/
/**
* Key handler for an idealized browser.
* Runs after the browser specific key handlers have normalized the key events.
*
* @param keyCode {String} keyboard code
* @param charCode {String} character code
* @param eventType {String} type of the event (keydown, keypress, keyup)
* @param domEvent {Element} DomEvent
*/
qx.Proto._idealKeyHandler = function(keyCode, charCode, eventType, domEvent)
{
if (!keyCode && !charCode) {
return;
}
var keyIdentifier;
// Use: keyCode
if (keyCode)
{
keyIdentifier = this._keyCodeToIdentifier(keyCode);
qx.event.handler.EventHandler.getInstance()._onkeyevent_post(domEvent, eventType, keyCode, charCode, keyIdentifier);
}
// Use: charCode
else
{
keyIdentifier = this._charCodeToIdentifier(charCode);
qx.event.handler.EventHandler.getInstance()._onkeyevent_post(domEvent, "keypress", keyCode, charCode, keyIdentifier);
qx.event.handler.EventHandler.getInstance()._onkeyevent_post(domEvent, "keyinput", keyCode, charCode, keyIdentifier);
}
};
/*
---------------------------------------------------------------------------
BROWSER-SPECIFIC-KEY-HANDLER: MSHTML
---------------------------------------------------------------------------
*/
if (qx.core.Client.getInstance().isMshtml())
{
qx.Proto._lastUpDownType = {};
qx.Proto._charCode2KeyCode =
{
13 : 13,
27 : 27
};
qx.Proto._onkeyupdown = function(domEvent)
{
domEvent = window.event || domEvent;
var keyCode = domEvent.keyCode;
var charcode = 0;
var type = domEvent.type;
// Ignore the down in such sequences dp dp dp
if (!(this._lastUpDownType[keyCode] == "keydown" && type == "keydown")) {
this._idealKeyHandler(keyCode, charcode, type, domEvent);
}
// On non print-able character be sure to add a keypress event
if (this._isNonPrintableKeyCode(keyCode) && type == "keydown") {
this._idealKeyHandler(keyCode, charcode, "keypress", domEvent);
}
// Store last type
this._lastUpDownType[keyCode] = type;
};
qx.Proto._onkeypress = function(domEvent)
{
domEvent = window.event || domEvent;
if (this._charCode2KeyCode[domEvent.keyCode]) {
this._idealKeyHandler(this._charCode2KeyCode[domEvent.keyCode], 0, domEvent.type, domEvent);
} else {
this._idealKeyHandler(0, domEvent.keyCode, domEvent.type, domEvent);
}
};
}
/*
---------------------------------------------------------------------------
BROWSER-SPECIFIC-KEY-HANDLER: GECKO
---------------------------------------------------------------------------
*/
else if (qx.core.Client.getInstance().isGecko())
{
qx.Proto._lastUpDownType = {};
qx.Proto._keyCodeFix = {
12 : qx.Proto._identifierToKeyCode("NumLock")
};
/**
* key handler for Gecko
*
* @param domEvent {Element} DomEvent
*/
qx.Proto._onkeyupdown = qx.Proto._onkeypress = function(domEvent)
{
var keyCode = this._keyCodeFix[domEvent.keyCode] || domEvent.keyCode;
var charCode = domEvent.charCode;
var type = domEvent.type;
// FF repeats under windows keydown events like IE
if (qx.core.Client.getInstance().runsOnWindows())
{
var keyIdentifier = keyCode ? this._keyCodeToIdentifier(keyCode) : this._charCodeToIdentifier(charCode)
if (!(this._lastUpDownType[keyIdentifier] == "keypress" && type == "keydown")) {
this._idealKeyHandler(keyCode, charCode, type, domEvent);
}
// Store last type
this._lastUpDownType[keyIdentifier] = type;
}
// all other OSes
else
{
this._idealKeyHandler(keyCode, charCode, type, domEvent);
}
};
}
/*
---------------------------------------------------------------------------
BROWSER-SPECIFIC-KEY-HANDLER: WEBKIT
---------------------------------------------------------------------------
*/
else if (qx.core.Client.getInstance().isWebkit())
{
qx.Proto._charCode2KeyCode =
{
// Safari/Webkit Mappings
63289 : qx.Proto._identifierToKeyCode("NumLock"),
63276 : qx.Proto._identifierToKeyCode("PageUp"),
63277 : qx.Proto._identifierToKeyCode("PageDown"),
63275 : qx.Proto._identifierToKeyCode("End"),
63273 : qx.Proto._identifierToKeyCode("Home"),
63234 : qx.Proto._identifierToKeyCode("Left"),
63232 : qx.Proto._identifierToKeyCode("Up"),
63235 : qx.Proto._identifierToKeyCode("Right"),
63233 : qx.Proto._identifierToKeyCode("Down"),
63272 : qx.Proto._identifierToKeyCode("Delete"),
63302 : qx.Proto._identifierToKeyCode("Insert"),
63236 : qx.Proto._identifierToKeyCode("F1"),
63237 : qx.Proto._identifierToKeyCode("F2"),
63238 : qx.Proto._identifierToKeyCode("F3"),
63239 : qx.Proto._identifierToKeyCode("F4"),
63240 : qx.Proto._identifierToKeyCode("F5"),
63241 : qx.Proto._identifierToKeyCode("F6"),
63242 : qx.Proto._identifierToKeyCode("F7"),
63243 : qx.Proto._identifierToKeyCode("F8"),
63244 : qx.Proto._identifierToKeyCode("F9"),
63245 : qx.Proto._identifierToKeyCode("F10"),
63246 : qx.Proto._identifierToKeyCode("F11"),
63247 : qx.Proto._identifierToKeyCode("F12"),
63248 : qx.Proto._identifierToKeyCode("PrintScreen"),
3 : qx.Proto._identifierToKeyCode("Enter"),
12 : qx.Proto._identifierToKeyCode("NumLock"),
13 : qx.Proto._identifierToKeyCode("Enter")
};
qx.Proto._onkeyupdown = qx.Proto._onkeypress = function(domEvent)
{
var keyCode = 0;
var charCode = 0;
var type = domEvent.type;
// prevent Safari from sending key signals twice
// This bug is fixed in recent Webkit builds so we need a revision check
// see http://trac.mochikit.com/ticket/182 for details
if (qx.core.Client.getInstance().getVersion() < 420)
{
if (!this._lastCharCodeForType) {
this._lastCharCodeForType = {};
}
var isSafariSpecialKey = this._lastCharCodeForType[type] > 63000;
if (isSafariSpecialKey) {
this._lastCharCodeForType[type] = null;
return;
}
this._lastCharCodeForType[type] = domEvent.charCode;
}
if (type == "keyup" || type == "keydown") {
keyCode = this._charCode2KeyCode[domEvent.charCode] || domEvent.keyCode;
}
else
{
if (this._charCode2KeyCode[domEvent.charCode]) {
keyCode = this._charCode2KeyCode[domEvent.charCode];
} else {
charCode = domEvent.charCode;
}
}
this._idealKeyHandler(keyCode, charCode, type, domEvent);
};
}
/*
---------------------------------------------------------------------------
BROWSER-SPECIFIC-KEY-HANDLER: OPERA
---------------------------------------------------------------------------
*/
else if (qx.core.Client.getInstance().isOpera())
{
qx.Proto._onkeyupdown = function(domEvent) {
this._idealKeyHandler(domEvent.keyCode, 0, domEvent.type, domEvent);
};
qx.Proto._onkeypress = function(domEvent)
{
if (this._keyCodeToIdentifierMap[domEvent.keyCode]) {
this._idealKeyHandler(domEvent.keyCode, 0, domEvent.type, domEvent);
} else {
this._idealKeyHandler(0, domEvent.keyCode, domEvent.type, domEvent);
}
};
}
/*
---------------------------------------------------------------------------
DISPOSE
---------------------------------------------------------------------------
*/
/**
* Destructor
*/
qx.Proto.dispose = function()
{
if (this.getDisposed()) {
return;
}
// Detach keyboard events
this._detachEvents();
return qx.core.Target.prototype.dispose.call(this);
};
/*
---------------------------------------------------------------------------
DEFER SINGLETON INSTANCE
---------------------------------------------------------------------------
*/
/**
* Singleton Instance Getter
*/
qx.Class.getInstance = qx.lang.Function.returnInstance;
|