Merge pull request #2928 from elemoine/patch-3

Do not rename handleMapBrowserEvent internally

externs/oli.js

@@ -130,6 +130,7 @@ oli.control.Control = function() {};
 oli.control.Control.prototype.setMap = function(map) {};
 
 
+
 /**
  * @type {Object}
  */
@@ -137,6 +138,20 @@ oli.interaction;
 
 
 
+/**
+ * @interface
+ */
+oli.interaction.Interaction = function() {};
+
+/**
+ * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
+ * @return {boolean} Whether the map browser event should continue
+ *     through the chain of interactions. `false` means stop, `true`
+ *     means continue.
+ */
+oli.interaction.Interaction.prototype.handleMapBrowserEvent = function(e) {};
+
+
 /**
  * @interface
  */

src/ol/interaction/interaction.js

@@ -33,6 +33,7 @@ ol.interaction.InteractionProperty = {
  *
  * @constructor
  * @extends {ol.Object}
+ * @implements {oli.interaction.Interaction}
  * @api
  */
 ol.interaction.Interaction = function() {
@@ -76,10 +77,16 @@ ol.interaction.Interaction.prototype.getMap = function() {
 
 
 /**
+ * Method called by the map to notify the interaction that a browser
+ * event was dispatched on the map. If the interaction wants to handle
+ * that event it can return `false` to prevent the propagation of the
+ * event to other interactions in the map's interactions chain.
  * @param {ol.MapBrowserEvent} mapBrowserEvent Map browser event.
  * @return {boolean} Whether the map browser event should continue
- *     through the chain of interactions. false means stop, true
+ *     through the chain of interactions. `false` means stop, `true`
  *     means continue.
+ * @function
+ * @api
  */
 ol.interaction.Interaction.prototype.handleMapBrowserEvent =
     goog.abstractMethod;