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
|
/* ************************************************************************
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.locale.Key)
************************************************************************ */
/**
* This contains a command with shortcut.
*
* Each command could be assigned to multiple widgets.
*
* @event execute {qx.event.type.DataEvent} when the command is executed. Sets the
* "data" property of the event to the object that issued the command.
*
* @param vShortcut {String} shortcuts can be composed of optional modifier
* keys Control, Alt, Shift, Meta and a non modifier key.
* If no non modifier key is specified, the second paramater is evaluated.
* The key must be seperated by a <code>+</code> or <code>-</code> character.
* Examples: Alt+F1, Control+C, Control+Alt+Enf
*
* @param vKeyCode {Integer} Additional key of the command interpreted as a keyCode.
*/
qx.OO.defineClass("qx.client.Command", qx.core.Target,
function(vShortcut, vKeyCode)
{
qx.core.Target.call(this);
this._modifier = {};
this._key = null;
if (vShortcut != null) {
this.setShortcut(vShortcut);
}
if (vKeyCode != null)
{
this.warn("The use of keyCode in command is deprecated. Use keyIdentifier instead.");
this.setKeyCode(vKeyCode);
}
// OSX warning for Alt key combinations
if (this._modifier.Alt && this._key && this._key.length == 1) {
if (
(this._key >= "A" && this._key <= "Z") ||
(this._key >= "0" && this._key <= "9")
) {
this.warn("A shortcut containing Alt and a letter or number will not work under OS X!");
}
}
qx.event.handler.EventHandler.getInstance().addCommand(this);
});
/** the command shortcut */
qx.OO.addProperty({ name : "shortcut", type : "string" });
/**
* keyCode
* @deprecated
*
* Still there for compatibility with the old key handler/commands
*/
qx.OO.addProperty({ name : "keyCode", type : "number" });
/** KeyIdentifier */
qx.OO.addProperty({ name : "keyIdentifier", type : "string" });
/*
---------------------------------------------------------------------------
USER METHODS
---------------------------------------------------------------------------
*/
/**
* Fire the "execute" event on this command.
*
* @param vTarget {Object} Object which issued the execute event
*/
qx.Proto.execute = function(vTarget)
{
if (this.hasEventListeners("execute")) {
var event = new qx.event.type.DataEvent("execute", vTarget);
this.dispatchEvent(event, true);
}
return false;
};
/*
---------------------------------------------------------------------------
MODIFIER
---------------------------------------------------------------------------
*/
qx.Proto._modifyShortcut = function(propValue, propOldValue, propData)
{
if (propValue)
{
this._modifier = {};
this._key = null;
// split string to get each key which must be pressed
// build a hash with active keys
var a = propValue.split(/[-+\s]+/);
var al = a.length;
for (var i=0; i<al; i++)
{
var identifier = this._oldKeyNameToKeyIdentifier(a[i]);
switch (identifier)
{
case "Control":
case "Shift":
case "Meta":
case "Alt":
this._modifier[identifier] = true;
break;
case "Unidentified":
var msg = "Not a valid key name for a command: " + a[i];
this.error(msg);
throw msg;
default:
if (this._key) {
var msg = "You can only specify one non modifier key!";
this.error(msg);
throw msg;
}
this._key = identifier;
}
}
}
return true;
};
/*
--------------------------------------------------------------------------
INTERNAL MATCHING LOGIC
---------------------------------------------------------------------------
*/
/**
* Checks wether the given key event matches the command's shortcut
*
* @param e {qx.event.type.KeyEvent} the key event object
* @return {Boolean} wether the commands shortcut matches the key event
*/
qx.Proto._matchesKeyEvent = function(e)
{
var key = this._key || this.getKeyIdentifier();
if (!key && !this.getKeyCode()) {
// no shortcut defined.
return;
}
// pre-check for check special keys
// we handle this here to omit to check this later again.
if (
(this._modifier.Shift && !e.isShiftPressed()) ||
(this._modifier.Control && !e.isCtrlPressed()) ||
// (this._modifier.Meta && !e.getMetaKey()) ||
(this._modifier.Alt && !e.isAltPressed())
) {
return false;
}
if (key)
{
if (key == e.getKeyIdentifier()) {
return true;
}
}
else
{
if (this.getKeyCode() == e.getKeyCode()) {
return true;
}
}
return false;
};
/*
---------------------------------------------------------------------------
COMPATIBILITY TO COMMAND
---------------------------------------------------------------------------
*/
qx.Proto._oldKeyNameToKeyIdentifierMap =
{
// all other keys are converted by converting the first letter to uppercase
esc : "Escape",
ctrl : "Control",
print : "PrintScreen",
del : "Delete",
pageup : "PageUp",
pagedown : "PageDown",
numlock : "NumLock",
numpad_0 : "0",
numpad_1 : "1",
numpad_2 : "2",
numpad_3 : "3",
numpad_4 : "4",
numpad_5 : "5",
numpad_6 : "6",
numpad_7 : "7",
numpad_8 : "8",
numpad_9 : "9",
numpad_divide : "/",
numpad_multiply : "*",
numpad_minus : "-",
numpad_plus : "+"
};
/**
* converts an old key name as found in {@link qx.event.type.KeyEvent.keys} to
* the new keyIdentifier.
*
* @param keyName {String} old name of the key.
* @return {String} corresponding keyIdentifier or "Unidentified" if a conversion was not possible
*/
qx.Proto._oldKeyNameToKeyIdentifier = function(keyName)
{
var keyHandler = qx.event.handler.KeyEventHandler.getInstance();
var keyIdentifier = "Unidentified";
if (keyHandler.isValidKeyIdentifier(keyName)) {
return keyName;
}
if (keyName.length == 1 && keyName >= "a" && keyName <= "z") {
return keyName.toUpperCase();
}
keyName = keyName.toLowerCase();
// check wether its a valid old key name
if (!qx.event.type.KeyEvent.keys[keyName]) {
return "Unidentified";
}
var keyIdentifier = this._oldKeyNameToKeyIdentifierMap[keyName];
if (keyIdentifier) {
return keyIdentifier;
} else {
return qx.lang.String.toFirstUp(keyName);
}
};
/*
---------------------------------------------------------------------------
STRING CONVERTION
---------------------------------------------------------------------------
*/
/**
* Returns the shortcut as string
*
* @return {String} shortcut
*/
qx.Proto.toString = function()
{
//var vShortcut = this.getShortcut();
var vKeyCode = this.getKeyCode();
var key = this._key || this.getKeyIdentifier();
var vString = [];
for (var modifier in this._modifier) {
vString.push(qx.locale.Key.getKeyName("short", modifier));
}
if (key) {
vString.push(qx.locale.Key.getKeyName("short", key));
}
/*
if (vShortcut != null) {
vString.push(vShortcut);
}
*/
if (vKeyCode != null)
{
var vTemp = qx.event.type.KeyEvent.codes[vKeyCode];
vString.push(vTemp ? qx.lang.String.toFirstUp(vTemp) : String(vKeyCode));
}
return vString.join("-");
};
/*
---------------------------------------------------------------------------
DISPOSER
---------------------------------------------------------------------------
*/
/**
* Destructor
*/
qx.Proto.dispose = function()
{
if (this.getDisposed()) {
return;
}
this._shortcutParts = null;
var vMgr = qx.event.handler.EventHandler.getInstance();
if (vMgr) {
vMgr.removeCommand(this);
}
return qx.core.Target.prototype.dispose.call(this);
};
|