KeyMap.js
上传用户:dawnssy
上传日期:2022-08-06
资源大小:9345k
文件大小:8k
源码类别:

JavaScript

开发平台:

JavaScript

  1. /*!  * Ext JS Library 3.1.0  * Copyright(c) 2006-2009 Ext JS, LLC  * licensing@extjs.com  * http://www.extjs.com/license  */ /**
  2.  * @class Ext.KeyMap
  3.  * Handles mapping keys to actions for an element. One key map can be used for multiple actions.
  4.  * The constructor accepts the same config object as defined by {@link #addBinding}.
  5.  * If you bind a callback function to a KeyMap, anytime the KeyMap handles an expected key
  6.  * combination it will call the function with this signature (if the match is a multi-key
  7.  * combination the callback will still be called only once): (String key, Ext.EventObject e)
  8.  * A KeyMap can also handle a string representation of keys.<br />
  9.  * Usage:
  10.  <pre><code>
  11. // map one key by key code
  12. var map = new Ext.KeyMap("my-element", {
  13.     key: 13, // or Ext.EventObject.ENTER
  14.     fn: myHandler,
  15.     scope: myObject
  16. });
  17. // map multiple keys to one action by string
  18. var map = new Ext.KeyMap("my-element", {
  19.     key: "arnt",
  20.     fn: myHandler,
  21.     scope: myObject
  22. });
  23. // map multiple keys to multiple actions by strings and array of codes
  24. var map = new Ext.KeyMap("my-element", [
  25.     {
  26.         key: [10,13],
  27.         fn: function(){ alert("Return was pressed"); }
  28.     }, {
  29.         key: "abc",
  30.         fn: function(){ alert('a, b or c was pressed'); }
  31.     }, {
  32.         key: "t",
  33.         ctrl:true,
  34.         shift:true,
  35.         fn: function(){ alert('Control + shift + tab was pressed.'); }
  36.     }
  37. ]);
  38. </code></pre>
  39.  * <b>Note: A KeyMap starts enabled</b>
  40.  * @constructor
  41.  * @param {Mixed} el The element to bind to
  42.  * @param {Object} config The config (see {@link #addBinding})
  43.  * @param {String} eventName (optional) The event to bind to (defaults to "keydown")
  44.  */
  45. Ext.KeyMap = function(el, config, eventName){
  46.     this.el  = Ext.get(el);
  47.     this.eventName = eventName || "keydown";
  48.     this.bindings = [];
  49.     if(config){
  50.         this.addBinding(config);
  51.     }
  52.     this.enable();
  53. };
  54. Ext.KeyMap.prototype = {
  55.     /**
  56.      * True to stop the event from bubbling and prevent the default browser action if the
  57.      * key was handled by the KeyMap (defaults to false)
  58.      * @type Boolean
  59.      */
  60.     stopEvent : false,
  61.     /**
  62.      * Add a new binding to this KeyMap. The following config object properties are supported:
  63.      * <pre>
  64. Property    Type             Description
  65. ----------  ---------------  ----------------------------------------------------------------------
  66. key         String/Array     A single keycode or an array of keycodes to handle
  67. shift       Boolean          True to handle key only when shift is pressed, False to handle the key only when shift is not pressed (defaults to undefined)
  68. ctrl        Boolean          True to handle key only when ctrl is pressed, False to handle the key only when ctrl is not pressed (defaults to undefined)
  69. alt         Boolean          True to handle key only when alt is pressed, False to handle the key only when alt is not pressed (defaults to undefined)
  70. handler     Function         The function to call when KeyMap finds the expected key combination
  71. fn          Function         Alias of handler (for backwards-compatibility)
  72. scope       Object           The scope of the callback function
  73. stopEvent   Boolean          True to stop the event from bubbling and prevent the default browser action if the key was handled by the KeyMap (defaults to false)
  74. </pre>
  75.      *
  76.      * Usage:
  77.      * <pre><code>
  78. // Create a KeyMap
  79. var map = new Ext.KeyMap(document, {
  80.     key: Ext.EventObject.ENTER,
  81.     fn: handleKey,
  82.     scope: this
  83. });
  84. //Add a new binding to the existing KeyMap later
  85. map.addBinding({
  86.     key: 'abc',
  87.     shift: true,
  88.     fn: handleKey,
  89.     scope: this
  90. });
  91. </code></pre>
  92.      * @param {Object/Array} config A single KeyMap config or an array of configs
  93.      */
  94. addBinding : function(config){
  95.         if(Ext.isArray(config)){
  96.             Ext.each(config, function(c){
  97.                 this.addBinding(c);
  98.             }, this);
  99.             return;
  100.         }
  101.         var keyCode = config.key,
  102.             fn = config.fn || config.handler,
  103.             scope = config.scope;
  104. if (config.stopEvent) {
  105.     this.stopEvent = config.stopEvent;    
  106. }
  107.         if(typeof keyCode == "string"){
  108.             var ks = [];
  109.             var keyString = keyCode.toUpperCase();
  110.             for(var j = 0, len = keyString.length; j < len; j++){
  111.                 ks.push(keyString.charCodeAt(j));
  112.             }
  113.             keyCode = ks;
  114.         }
  115.         var keyArray = Ext.isArray(keyCode);
  116.         
  117.         var handler = function(e){
  118.             if(this.checkModifiers(config, e)){
  119.                 var k = e.getKey();
  120.                 if(keyArray){
  121.                     for(var i = 0, len = keyCode.length; i < len; i++){
  122.                         if(keyCode[i] == k){
  123.                           if(this.stopEvent){
  124.                               e.stopEvent();
  125.                           }
  126.                           fn.call(scope || window, k, e);
  127.                           return;
  128.                         }
  129.                     }
  130.                 }else{
  131.                     if(k == keyCode){
  132.                         if(this.stopEvent){
  133.                            e.stopEvent();
  134.                         }
  135.                         fn.call(scope || window, k, e);
  136.                     }
  137.                 }
  138.             }
  139.         };
  140.         this.bindings.push(handler);
  141. },
  142.     
  143.     // private
  144.     checkModifiers: function(config, e){
  145.         var val, key, keys = ['shift', 'ctrl', 'alt'];
  146.         for (var i = 0, len = keys.length; i < len; ++i){
  147.             key = keys[i];
  148.             val = config[key];
  149.             if(!(val === undefined || (val === e[key + 'Key']))){
  150.                 return false;
  151.             }
  152.         }
  153.         return true;
  154.     },
  155.     /**
  156.      * Shorthand for adding a single key listener
  157.      * @param {Number/Array/Object} key Either the numeric key code, array of key codes or an object with the
  158.      * following options:
  159.      * {key: (number or array), shift: (true/false), ctrl: (true/false), alt: (true/false)}
  160.      * @param {Function} fn The function to call
  161.      * @param {Object} scope (optional) The scope (<code>this</code> reference) in which the function is executed. Defaults to the browser window.
  162.      */
  163.     on : function(key, fn, scope){
  164.         var keyCode, shift, ctrl, alt;
  165.         if(typeof key == "object" && !Ext.isArray(key)){
  166.             keyCode = key.key;
  167.             shift = key.shift;
  168.             ctrl = key.ctrl;
  169.             alt = key.alt;
  170.         }else{
  171.             keyCode = key;
  172.         }
  173.         this.addBinding({
  174.             key: keyCode,
  175.             shift: shift,
  176.             ctrl: ctrl,
  177.             alt: alt,
  178.             fn: fn,
  179.             scope: scope
  180.         });
  181.     },
  182.     // private
  183.     handleKeyDown : function(e){
  184.     if(this.enabled){ //just in case
  185.          var b = this.bindings;
  186.          for(var i = 0, len = b.length; i < len; i++){
  187.              b[i].call(this, e);
  188.          }
  189.     }
  190. },
  191. /**
  192.  * Returns true if this KeyMap is enabled
  193.  * @return {Boolean}
  194.  */
  195. isEnabled : function(){
  196.     return this.enabled;
  197. },
  198. /**
  199.  * Enables this KeyMap
  200.  */
  201. enable: function(){
  202. if(!this.enabled){
  203.     this.el.on(this.eventName, this.handleKeyDown, this);
  204.     this.enabled = true;
  205. }
  206. },
  207. /**
  208.  * Disable this KeyMap
  209.  */
  210. disable: function(){
  211. if(this.enabled){
  212.     this.el.removeListener(this.eventName, this.handleKeyDown, this);
  213.     this.enabled = false;
  214. }
  215. },
  216.     
  217.     /**
  218.      * Convenience function for setting disabled/enabled by boolean.
  219.      * @param {Boolean} disabled
  220.      */
  221.     setDisabled : function(disabled){
  222.         this[disabled ? "disable" : "enable"]();
  223.     }
  224. };