[OpenLayers-Commits] r6039 - sandbox/tschaub/events/lib/OpenLayers

[commits at openlayers.org]

Author: tschaub
Date: 2008-02-07 17:30:57 -0500 (Thu, 07 Feb 2008)
New Revision: 6039

Modified:
   sandbox/tschaub/events/lib/OpenLayers/Map.js
Log:
Documenting map events handling.  Listeners receive an event object with properties relevant to the event type.

Modified: sandbox/tschaub/events/lib/OpenLayers/Map.js
===================================================================
--- sandbox/tschaub/events/lib/OpenLayers/Map.js	2008-02-07 22:29:05 UTC (rev 6038)
+++ sandbox/tschaub/events/lib/OpenLayers/Map.js	2008-02-07 22:30:57 UTC (rev 6039)
@@ -32,11 +32,30 @@
      * map.events.register(type, obj, listener);
      * (end)
      *
+     * Listeners will be called with a reference to an event object.  The
+     *     properties of this event depends on exactly what happened.
+     *
+     * All event objects have at least the following properties:
+     *  - *object* {Object} A reference to map.events.object.
+     *  - *element* {DOMElement} A reference to map.events.element.
+     *
+     * Browser events have the following additional properties:
+     *  - *xy* {<OpenLayers.Pixel>} The pixel location of the event (relative
+     *      to the the map viewport).
+     *  - other properties that come with browser events
+     *
      * Supported map event types:
-     *  - *addlayer* triggered after a layer has been added
-     *  - *removelayer* triggered after a layer has been removed
+     *  - *addlayer* triggered after a layer has been added.  The event object
+     *      will include a *layer* property that references the added layer.
+     *  - *removelayer* triggered after a layer has been removed.  The event
+     *      object will include a *layer* property that references the removed
+     *      layer.
      *  - *changelayer* triggered after a layer name change, order change, or
-     *      visibility change (due to resolution thresholds)
+     *      visibility change (due to resolution thresholds).  Listeners will
+     *      receive an event object with *layer* and *property* properties.  The
+     *      *layer* property will be a reference to the changed layer.  The
+     *      *property* property will be a key to the changed property (name,
+     *      visibility, or order).
      *  - *movestart* triggered after the start of a drag, pan, or zoom
      *  - *move* triggered after each drag, pan, or zoom
      *  - *moveend* triggered after a drag, pan, or zoom completes