From 134d8e6c18574d95e7f55d35d69ec9c08b4e2a23 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:18:01 +0200 Subject: [PATCH 01/11] Add basic docs for doubleclickzoominteraction --- src/ol/interaction/doubleclickzoominteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/doubleclickzoominteraction.js b/src/ol/interaction/doubleclickzoominteraction.js index 5cf8887883..a9cf643b87 100644 --- a/src/ol/interaction/doubleclickzoominteraction.js +++ b/src/ol/interaction/doubleclickzoominteraction.js @@ -41,6 +41,8 @@ goog.inherits(ol.interaction.DoubleClickZoom, ol.interaction.Interaction); /** + * Handles the {@link ol.MapBrowserEvent map browser event} (if it was a + * doubleclick) and eventually zooms the map. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.DoubleClickZoom} From 6da863d6273be66cd1015cfb92e7a94ebc212f38 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:18:29 +0200 Subject: [PATCH 02/11] Add basic docs for draganddropinteraction --- src/ol/interaction/draganddropinteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/draganddropinteraction.js b/src/ol/interaction/draganddropinteraction.js index ecb18fde10..4496ef4414 100644 --- a/src/ol/interaction/draganddropinteraction.js +++ b/src/ol/interaction/draganddropinteraction.js @@ -136,6 +136,8 @@ ol.interaction.DragAndDrop.prototype.handleResult_ = function(file, result) { /** + * Handles the {@link ol.MapBrowserEvent map browser event} unconditionally and + * neither prevents the browser default nor stops event propagation. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.DragAndDrop} From 750a644396f4495e15d342ff3f23b9ebc54b3f6c Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:18:50 +0200 Subject: [PATCH 03/11] Add basic docs for drawinteraction --- src/ol/interaction/drawinteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/drawinteraction.js b/src/ol/interaction/drawinteraction.js index fd564a4d90..4ca3ac8387 100644 --- a/src/ol/interaction/drawinteraction.js +++ b/src/ol/interaction/drawinteraction.js @@ -241,6 +241,8 @@ ol.interaction.Draw.prototype.setMap = function(map) { /** + * Handles the {@link ol.MapBrowserEvent map browser event} and may actually + * draw or finish the drawing. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.Draw} From 1917193ea9795ab6d235ae75f1c729a42f6b1395 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:19:17 +0200 Subject: [PATCH 04/11] Add basic docs for interaction --- src/ol/interaction/interaction.js | 1 + 1 file changed, 1 insertion(+) diff --git a/src/ol/interaction/interaction.js b/src/ol/interaction/interaction.js index 833901a8ec..2e45101983 100644 --- a/src/ol/interaction/interaction.js +++ b/src/ol/interaction/interaction.js @@ -57,6 +57,7 @@ goog.inherits(ol.interaction.Interaction, ol.Object); /** + * Return whether the interaction is currently active. * @return {boolean} `true` if the interaction is active, `false` otherwise. * @observable * @api From 98c6a24861431f638a2d35c95a37cbc79cce257c Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:19:30 +0200 Subject: [PATCH 05/11] Add basic docs for keyboardpaninteraction --- src/ol/interaction/keyboardpaninteraction.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/interaction/keyboardpaninteraction.js b/src/ol/interaction/keyboardpaninteraction.js index 029627f70c..1badd407cc 100644 --- a/src/ol/interaction/keyboardpaninteraction.js +++ b/src/ol/interaction/keyboardpaninteraction.js @@ -61,6 +61,9 @@ goog.inherits(ol.interaction.KeyboardPan, ol.interaction.Interaction); /** + * Handles the {@link ol.MapBrowserEvent map browser event} if it was a + * `KeyEvent`, and decides the direction to pan to (if an arrow key was + * pressed). * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.KeyboardPan} From f756246efcadb676890c684b7f32c23e60ee3fd3 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:19:50 +0200 Subject: [PATCH 06/11] Add basic docs for keyboardzoominteraction --- src/ol/interaction/keyboardzoominteraction.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/interaction/keyboardzoominteraction.js b/src/ol/interaction/keyboardzoominteraction.js index 2bb807e138..7965fd0aa2 100644 --- a/src/ol/interaction/keyboardzoominteraction.js +++ b/src/ol/interaction/keyboardzoominteraction.js @@ -57,6 +57,9 @@ goog.inherits(ol.interaction.KeyboardZoom, ol.interaction.Interaction); /** + * Handles the {@link ol.MapBrowserEvent map browser event} if it was a + * `KeyEvent`, and decides whether to zoom in or out (depending on whether the + * key pressed was '+' or '-'). * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.KeyboardZoom} From 73b103a19c4caa1897b0585fa037e66b9f93a0ec Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:20:06 +0200 Subject: [PATCH 07/11] Add basic docs for modifyinteraction --- src/ol/interaction/modifyinteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/modifyinteraction.js b/src/ol/interaction/modifyinteraction.js index 2890e30898..66f3b5ed28 100644 --- a/src/ol/interaction/modifyinteraction.js +++ b/src/ol/interaction/modifyinteraction.js @@ -535,6 +535,8 @@ ol.interaction.Modify.handleUpEvent_ = function(evt) { /** + * Handles the {@link ol.MapBrowserEvent map browser event} and may modify the + * geometry. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.Modify} From 5a6c95b13ca67ee73b439b9d95253cd0cdc95ceb Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:21:40 +0200 Subject: [PATCH 08/11] Add basic docs for mousewheelzoominteraction --- src/ol/interaction/mousewheelzoominteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/mousewheelzoominteraction.js b/src/ol/interaction/mousewheelzoominteraction.js index bc56288bc2..c163a61014 100644 --- a/src/ol/interaction/mousewheelzoominteraction.js +++ b/src/ol/interaction/mousewheelzoominteraction.js @@ -62,6 +62,8 @@ goog.inherits(ol.interaction.MouseWheelZoom, ol.interaction.Interaction); /** + * Handles the {@link ol.MapBrowserEvent map browser event} (if it was a + * mousewheel-event) and eventually zooms the map. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.MouseWheelZoom} From 340d4805af14c38d3035b30252f24ba4aa19961d Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:20:18 +0200 Subject: [PATCH 09/11] Add basic docs for pointerinteraction --- src/ol/interaction/pointerinteraction.js | 3 +++ 1 file changed, 3 insertions(+) diff --git a/src/ol/interaction/pointerinteraction.js b/src/ol/interaction/pointerinteraction.js index 1fb2961a23..059d1aa4d9 100644 --- a/src/ol/interaction/pointerinteraction.js +++ b/src/ol/interaction/pointerinteraction.js @@ -171,6 +171,9 @@ ol.interaction.Pointer.handleMoveEvent = goog.nullFunction; /** + * Handles the {@link ol.MapBrowserEvent map browser event} and may call into + * other functions, if event sequences like e.g. 'drag' or 'down-up' etc. are + * detected. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.Pointer} From a784157344e23e9cd920b064f72c86c6093cfc26 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:20:55 +0200 Subject: [PATCH 10/11] Add basic docs for selectinteraction --- src/ol/interaction/selectinteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/selectinteraction.js b/src/ol/interaction/selectinteraction.js index c5e5da655f..4b7c61a583 100644 --- a/src/ol/interaction/selectinteraction.js +++ b/src/ol/interaction/selectinteraction.js @@ -187,6 +187,8 @@ ol.interaction.Select.prototype.getFeatures = function() { /** + * Handles the {@link ol.MapBrowserEvent map browser event} and may change the + * selected state of features. * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event. * @return {boolean} `false` to stop event propagation. * @this {ol.interaction.Select} From 4ea8cb7a19cec9c72c2f1efd2c32d8576eaa6580 Mon Sep 17 00:00:00 2001 From: Marc Jansen Date: Wed, 22 Apr 2015 14:21:17 +0200 Subject: [PATCH 11/11] Add basic docs for snapinteraction --- src/ol/interaction/snapinteraction.js | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/ol/interaction/snapinteraction.js b/src/ol/interaction/snapinteraction.js index 576fcfc5f5..dc93a1b437 100644 --- a/src/ol/interaction/snapinteraction.js +++ b/src/ol/interaction/snapinteraction.js @@ -152,6 +152,7 @@ goog.inherits(ol.interaction.Snap, ol.interaction.Pointer); /** + * Add a feature to the collection of features that we may snap to. * @param {ol.Feature} feature Feature. * @param {boolean=} opt_listen Whether to listen to the geometry change or not * Defaults to `true`. @@ -278,6 +279,7 @@ ol.interaction.Snap.prototype.handleGeometryModify_ = function(feature, evt) { /** + * Remove a feature from the collection of features that we may snap to. * @param {ol.Feature} feature Feature * @param {boolean=} opt_unlisten Whether to unlisten to the geometry change * or not. Defaults to `true`.