natural docs comments for the keyboard handler

git-svn-id: http://svn.openlayers.org/trunk/openlayers@4107 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
This commit is contained in:
Tim Schaub
2007-08-29 16:15:45 +00:00
parent 46c5cd6812
commit eb65e9c2b3
+18 -5
View File
@@ -6,7 +6,9 @@
* @requires OpenLayers/Handler.js * @requires OpenLayers/Handler.js
* @requires OpenLayers/Events.js * @requires OpenLayers/Events.js
* *
* Class: OpenLayers.handler.Keyboard * Class: OpenLayers.handler.Keyboard
* A handler for keyboard events. Create a new instance with the
* <OpenLayers.Handler.Keyboard> constructor.
* *
* Inherits from: * Inherits from:
* - <OpenLayers.Handler> * - <OpenLayers.Handler>
@@ -16,8 +18,6 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
/* http://www.quirksmode.org/js/keys.html explains key x-browser /* http://www.quirksmode.org/js/keys.html explains key x-browser
key handling quirks in pretty nice detail */ key handling quirks in pretty nice detail */
/* supported named callbacks are: keyup, keydown, keypress */
/** /**
* Constant: KEY_EVENTS * Constant: KEY_EVENTS
* keydown, keypress, keyup * keydown, keypress, keyup
@@ -30,9 +30,22 @@ OpenLayers.Handler.Keyboard = OpenLayers.Class(OpenLayers.Handler, {
*/ */
eventListener: null, eventListener: null,
/** /**
* Constructor: OpenLayers.Handler.Keyboard * Constructor: OpenLayers.Handler.Keyboard
*/ * Returns a new keyboard handler.
*
* Parameters:
* control - {<OpenLayers.Control>} The control that is making use of
* this handler. If a handler is being used without a control, the
* handlers setMap method must be overridden to deal properly with
* the map.
* callbacks - {Object} An object containing a single function to be
* called when the drag operation is finished. The callback should
* expect to recieve a single argument, the pixel location of the event.
* Callbacks for 'keydown', 'keypress', and 'keyup' are supported.
* options - {Object} Optional object whose properties will be set on the
* handler.
*/
initialize: function () { initialize: function () {
OpenLayers.Handler.prototype.initialize.apply(this, arguments); OpenLayers.Handler.prototype.initialize.apply(this, arguments);
// cache the bound event listener method so it can be unobserved later // cache the bound event listener method so it can be unobserved later