Handling Keyboard Shortcuts in JavaScript
在web开发中,对页面的进行全局或部分页面进行键盘快捷键事件注册,能够有效的提高页面的用户体验。在ExtJs中的表格Form中就有回车提交的事件,实现方法可以参照我的另一篇文章:Ext监控回车按键。
在网络上看到了一篇处理JavaScript键盘快捷键事件的文章:Handling Keyboard Shortcuts in JavaScript ,其实现方法很简单,只是封装了一个shortcut的类,提供了注册快捷键的方法和删除快捷键事件的方法。
其源代码如下,其中代码逻辑很容易看懂而且其中考虑了各种浏览器的兼容问题(可以参照我的上一篇文章:DOM 事件模型)。通过以下代码,可以熟悉如何处理各种浏览器事件处理的兼容性问题。
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 | /**
* http://www.openjs.com/scripts/events/keyboard_shortcuts/ Version : 2.01.B By
* Binny V A License : BSD
* Modified by www.javachen.com javachen
*/
shortcut = {
'all_shortcuts' : {},// All the shortcuts are stored in this array
'add' : function(shortcut_combination, callback, opt) {
// Provide a set of default options
var default_options = {
'type' : 'keydown',//按键事件类型,IE中keypress不支持功能按键,所以应该用keydown/keyup事件来进行补充。
'propagate' : false,
'disable_in_input' : false,//是否在input,Textarea内有效
'target' : document,//事件作用对象,相当于事件的相应范围scope,该值可以为节点的ID
'keycode' : false
}
//处理配置项,如果为空就使用默认的
if (!opt)
opt = default_options;
else {
for (var dfo in default_options) {
if (typeof opt[dfo] == 'undefined')
opt[dfo] = default_options[dfo];
}
}
//如果target为字符串,则通过该字符串取得该DOM对象
var ele = opt.target;
if (typeof opt.target == 'string')
ele = document.getElementById(opt.target);
var ths = this;//保存当前的this引用
//联合快捷键
shortcut_combination = shortcut_combination.toLowerCase();
// The function to be called at keypress
var func = function(e) {
e = e || window.event;//处理浏览器对event的兼容性,只有IE浏览器的event=window.event
if (opt['disable_in_input']) { // Don't enable shortcut keys in
// Input, Textarea fields
var element;
if (e.target)
//针对IE浏览器
element = e.target;
else if (e.srcElement)
//针对DOM标准浏览器
element = e.srcElement;
//如果当前节点为文本节点,则取其父节点
if (element.nodeType == 3)
element = element.parentNode;
//如果当前节点标签名为INPUT或TEXTAREA,则当前函数不做处理
if (element.tagName == 'INPUT' || element.tagName == 'TEXTAREA')
return;
}
// Find Which key is pressed
if (e.keyCode)
//针对IE浏览器,e.keyCode返回按键对应的数值
code = e.keyCode;
else if (e.which)
//针对DOM标准浏览器,如Firefox,e.keyCode返回按键对应的数值
code = e.which;
//e.which将给出该键的索引值,把索引值转化成该键的字母或数字值的方法需要用到静态函数String.fromCharCode()
var character = String.fromCharCode(code).toLowerCase();
if (code == 188)
character = ",";
if (code == 190)
character = ".";
var keys = shortcut_combination.split("+");
// Key Pressed - counts the number of valid keypresses - if it is
// same as the number of keys, the shortcut function is invoked
var kp = 0;
// Work around for stupid Shift key bug created by using lowercase -
// as a result the shift+num combination was broken
var shift_nums = {
"`" : "~",
"1" : "!",
"2" : "@",
"3" : "#",
"4" : "$",
"5" : "%",
"6" : "^",
"7" : "&",
"8" : "*",
"9" : "(",
"0" : ")",
"-" : "_",
"=" : "+",
";" : ":",
"'" : "\"",
"," : "<",
"." : ">",
"/" : "?",
"\\" : "|"
}
// Special Keys - and their codes
var special_keys = {
'esc' : 27,
'escape' : 27,
'tab' : 9,
'space' : 32,
'return' : 13,
'enter' : 13,
'backspace' : 8,
'scrolllock' : 145,
'scroll_lock' : 145,
'scroll' : 145,
'capslock' : 20,
'caps_lock' : 20,
'caps' : 20,
'numlock' : 144,
'num_lock' : 144,
'num' : 144,
'pause' : 19,
'break' : 19,
'insert' : 45,
'home' : 36,
'delete' : 46,
'end' : 35,
'pageup' : 33,
'page_up' : 33,
'pu' : 33,
'pagedown' : 34,
'page_down' : 34,
'pd' : 34,
'left' : 37,
'up' : 38,
'right' : 39,
'down' : 40,
'f1' : 112,
'f2' : 113,
'f3' : 114,
'f4' : 115,
'f5' : 116,
'f6' : 117,
'f7' : 118,
'f8' : 119,
'f9' : 120,
'f10' : 121,
'f11' : 122,
'f12' : 123
}
var modifiers = {
shift : {
wanted : false,
pressed : false//是否被按
},
ctrl : {
wanted : false,
pressed : false
},
alt : {
wanted : false,
pressed : false
},
meta : {
wanted : false,
pressed : false
} // Meta is Mac specific
};
if (e.ctrlKey)
modifiers.ctrl.pressed = true;
if (e.shiftKey)
modifiers.shift.pressed = true;
if (e.altKey)
modifiers.alt.pressed = true;
if (e.metaKey)
modifiers.meta.pressed = true;
for (var i = 0; k = keys[i], i < keys.length; i++) {
// Modifiers
if (k == 'ctrl' || k == 'control') {
kp++;
modifiers.ctrl.wanted = true;
} else if (k == 'shift') {
kp++;
modifiers.shift.wanted = true;
} else if (k == 'alt') {
kp++;
modifiers.alt.wanted = true;
} else if (k == 'meta') {
kp++;
modifiers.meta.wanted = true;
} else if (k.length > 1) { // If it is a special key
if (special_keys[k] == code)
kp++;
} else if (opt['keycode']) {
if (opt['keycode'] == code)
kp++;
} else { // The special keys did not match
if (character == k)
kp++;
else {
if (shift_nums[character] && e.shiftKey) { // Stupid
// Shift key
// bug
// created
// by using
// lowercase
character = shift_nums[character];
if (character == k)
kp++;
}
}
}
}
if (kp == keys.length
&& modifiers.ctrl.pressed == modifiers.ctrl.wanted
&& modifiers.shift.pressed == modifiers.shift.wanted
&& modifiers.alt.pressed == modifiers.alt.wanted
&& modifiers.meta.pressed == modifiers.meta.wanted) {
callback(e);
if (!opt['propagate']) { // Stop the event
// e.cancelBubble is supported by IE - this will kill the
// bubbling process.
e.cancelBubble = true;
e.returnValue = false;
// e.stopPropagation works in Firefox.
if (e.stopPropagation) {
e.stopPropagation();
e.preventDefault();
}
return false;
}
}
}
this.all_shortcuts[shortcut_combination] = {
'callback' : func,
'target' : ele,
'event' : opt['type']
};
// Attach the function with the event
if (ele.addEventListener)
ele.addEventListener(opt['type'], func, false);
else if (ele.attachEvent)
ele.attachEvent('on' + opt['type'], func);
else
ele['on' + opt['type']] = func;
},
// Remove the shortcut - just specify the shortcut and I will remove the
// binding
'remove' : function(shortcut_combination) {
shortcut_combination = shortcut_combination.toLowerCase();
var binding = this.all_shortcuts[shortcut_combination];
delete(this.all_shortcuts[shortcut_combination])
if (!binding)
return;
var type = binding['event'];
var ele = binding['target'];
var callback = binding['callback'];
if (ele.detachEvent)
ele.detachEvent('on' + type, callback);
else if (ele.removeEventListener)
ele.removeEventListener(type, callback, false);
else
ele['on' + type] = false;
}
} |
Recent Comments