* Fixes to the Keyboard Handler to make it work better --

* drop keypress event (not used, registers as keydown in IE< which results
      in double events) 
    * return evt instead of evt.keyCode || evt.charCode, so apps can do
      whatever they like best
 * adjust ModifyFeature to new API
 * Adjust KeyboardDefaults to new API, and include a new set of keyCodes
    in switch statement to catch more cases
 * Include keyboard defaults test in list-tests.

Patch from tcoulter, work from Pedro Simonetti (See #1108), Paul Spencer,
myself. r=pagameba,me (Closes #1292)   


git-svn-id: http://svn.openlayers.org/trunk/openlayers@7644 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf

lib/OpenLayers/Control/KeyboardDefaults.js

@@ -47,18 +47,26 @@ OpenLayers.Control.KeyboardDefaults = OpenLayers.Class(OpenLayers.Control, {
      */
     draw: function() {
         this.handler = new OpenLayers.Handler.Keyboard( this, { 
-                                "keypress": this.defaultKeyPress });
+                                "keydown": this.defaultKeyPress });
         this.activate();
     },
     
     /**
      * Method: defaultKeyPress
+     * When handling the key event, we only use evt.keyCode. This holds 
+     * some drawbacks, though we get around them below. When interpretting
+     * the keycodes below (including the comments associated with them),
+     * consult the URL below. For instance, the Safari browser returns
+     * "IE keycodes", and so is supported by any keycode labeled "IE".
+     * 
+     * Very informative URL:
+     *    http://unixpapa.com/js/key.html
      *
      * Parameters:
      * code - {Integer} 
      */
-    defaultKeyPress: function (code) {
-        switch(code) {
+    defaultKeyPress: function (evt) {
+        switch(evt.keyCode) {
             case OpenLayers.Event.KEY_LEFT:
                 this.map.pan(-this.slideFactor, 0);
                 break;
@@ -72,35 +80,35 @@ OpenLayers.Control.KeyboardDefaults = OpenLayers.Class(OpenLayers.Control, {
                 this.map.pan(0, this.slideFactor);
                 break;
             
-            case 33: // Page Up  
+            case 33: // Page Up. Same in all browsers.
                 var size = this.map.getSize();
                 this.map.pan(0, -0.75*size.h);
                 break;
-            case 34: // Page Down  
+            case 34: // Page Down. Same in all browsers.
                 var size = this.map.getSize();
                 this.map.pan(0, 0.75*size.h);
                 break; 
-            case 35: // End  
+            case 35: // End. Same in all browsers.
                 var size = this.map.getSize();
                 this.map.pan(0.75*size.w, 0);
                 break; 
-            case 36: // Pos1  
+            case 36: // Home. Same in all browsers.
                 var size = this.map.getSize();
                 this.map.pan(-0.75*size.w, 0);
                 break; 
 
-            case 43: // + 
+            case 43:  // +/= (ASCII), keypad + (ASCII, Opera)
+            case 61:  // +/= (Mozilla, Opera, some ASCII)
+            case 187: // +/= (IE)
+            case 107: // keypad + (IE, Mozilla)
                 this.map.zoomIn();
                 break; 
-            case 45: // - 
+            case 45:  // -/_ (ASCII, Opera), keypad - (ASCII, Opera)
+            case 109: // -/_ (Mozilla), keypad - (Mozilla, IE)
+            case 189: // -/_ (IE)
+            case 95:  // -/_ (some ASCII)
                 this.map.zoomOut();
                 break; 
-            case 107: // + (IE only)
-                this.map.zoomIn();
-                break;
-            case 109: // - (IE only)
-                this.map.zoomOut();
-                break;
         } 
     },
 

lib/OpenLayers/Control/ModifyFeature.js

@@ -93,7 +93,7 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
      * {Array(Integer)} Keycodes for deleting verticies.  Set to null to disable
      *     vertex deltion by keypress.  If non-null, keypresses with codes
      *     in this array will delete vertices under the mouse. Default
-     *     is 46 and 100, the 'delete' and lowercase 'd' keys.
+     *     is 46 and 68, the 'delete' and lowercase 'd' keys.
      */
     deleteCodes: null,
 
@@ -183,7 +183,7 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
             this.layer.style || this.layer.styleMap.createSymbolizer());
         this.virtualStyle.fillOpacity = 0.3;
         this.virtualStyle.strokeOpacity = 0.3;
-        this.deleteCodes = [46, 100];
+        this.deleteCodes = [46, 68];
         this.mode = OpenLayers.Control.ModifyFeature.RESHAPE;
         OpenLayers.Control.prototype.initialize.apply(this, [options]);
         if(!(this.deleteCodes instanceof Array)) {
@@ -227,7 +227,7 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
 
         // configure the keyboard handler
         var keyboardOptions = {
-            keypress: this.handleKeypress
+            keydown: this.handleKeypress
         };
         this.handlers = {
             keyboard: new OpenLayers.Handler.Keyboard(this, keyboardOptions)
@@ -517,7 +517,9 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, {
      * Parameters:
      * {Integer} Key code corresponding to the keypress event.
      */
-    handleKeypress: function(code) {
+    handleKeypress: function(evt) {
+        var code = evt.keyCode;
+        
         // check for delete key
         if(this.feature &&
            OpenLayers.Util.indexOf(this.deleteCodes, code) != -1) {

lib/OpenLayers/Handler/Keyboard.js

@@ -24,7 +24,7 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
      * Constant: KEY_EVENTS
      * keydown, keypress, keyup
      */
-    KEY_EVENTS: ["keydown", "keypress", "keyup"],
+    KEY_EVENTS: ["keydown", "keyup"],
 
     /** 
     * Property: eventListener
@@ -72,7 +72,7 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
         if (OpenLayers.Handler.prototype.activate.apply(this, arguments)) {
             for (var i=0, len=this.KEY_EVENTS.length; i<len; i++) {
                 OpenLayers.Event.observe(
-                    window, this.KEY_EVENTS[i], this.eventListener);
+                    document, this.KEY_EVENTS[i], this.eventListener);
             }
             return true;
         } else {
@@ -88,7 +88,7 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
         if (OpenLayers.Handler.prototype.deactivate.apply(this, arguments)) {
             for (var i=0, len=this.KEY_EVENTS.length; i<len; i++) {
                 OpenLayers.Event.stopObserving(
-                    window, this.KEY_EVENTS[i], this.eventListener);
+                    document, this.KEY_EVENTS[i], this.eventListener);
             }
             deactivated = true;
         }
@@ -100,7 +100,7 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
      */
     handleKeyEvent: function (evt) {
         if (this.checkModifiers(evt)) {
-            this.callback(evt.type, [evt.charCode || evt.keyCode]);
+            this.callback(evt.type, [evt]);
         }
     },