Merge pull request #929 from elemoine/collectionevent

Add ol.CollectionEvent#getElement

src/ol/collection.exports

@@ -10,3 +10,5 @@
 @exportProperty ol.Collection.prototype.remove
 @exportProperty ol.Collection.prototype.removeAt
 @exportProperty ol.Collection.prototype.setAt
+
+@exportProperty ol.CollectionEvent.prototype.getElement

src/ol/collection.js

@@ -35,14 +35,23 @@ ol.CollectionEvent = function(type, opt_elem, opt_target) {
   goog.base(this, type, opt_target);
 
   /**
+   * @private
    * @type {*}
    */
-  this.elem = opt_elem;
+  this.elem_ = opt_elem;
 
 };
 goog.inherits(ol.CollectionEvent, goog.events.Event);
 
 
+/**
+ * @return {*} The element to which this event pertains.
+ */
+ol.CollectionEvent.prototype.getElement = function() {
+  return this.elem_;
+};
+
+
 /**
  * @enum {string}
  */

src/ol/layer/layergroup.js

@@ -123,7 +123,7 @@ ol.layer.LayerGroup.prototype.handleLayersChanged_ = function(event) {
  * @private
  */
 ol.layer.LayerGroup.prototype.handleLayersAdd_ = function(collectionEvent) {
-  var layer = /** @type {ol.layer.LayerBase} */ (collectionEvent.elem);
+  var layer = /** @type {ol.layer.LayerBase} */ (collectionEvent.getElement());
   this.listenerKeys_[goog.getUid(layer).toString()] = goog.events.listen(
       layer, goog.events.EventType.CHANGE, this.handleLayerChange, false,
       this);
@@ -136,7 +136,7 @@ ol.layer.LayerGroup.prototype.handleLayersAdd_ = function(collectionEvent) {
  * @private
  */
 ol.layer.LayerGroup.prototype.handleLayersRemove_ = function(collectionEvent) {
-  var layer = /** @type {ol.layer.LayerBase} */ (collectionEvent.elem);
+  var layer = /** @type {ol.layer.LayerBase} */ (collectionEvent.getElement());
   var key = goog.getUid(layer).toString();
   goog.events.unlistenByKey(this.listenerKeys_[key]);
   delete this.listenerKeys_[key];

test/spec/ol/collection.test.js

@@ -117,7 +117,7 @@ describe('ol.collection', function() {
       goog.events.listen(collection, ol.CollectionEventType.REMOVE, cb);
       expect(collection.remove(1)).to.eql(1);
       expect(cb).to.be.called();
-      expect(cb.lastCall.args[0].elem).to.eql(1);
+      expect(cb.lastCall.args[0].getElement()).to.eql(1);
     });
     it('does not remove more than one matching element', function() {
       var collection = new ol.Collection([0, 1, 1, 2]);
@@ -138,11 +138,11 @@ describe('ol.collection', function() {
       var collection = new ol.Collection(['a', 'b']);
       var added, removed;
       goog.events.listen(collection, ol.CollectionEventType.ADD, function(e) {
-        added = e.elem;
+        added = e.getElement();
       });
       goog.events.listen(
           collection, ol.CollectionEventType.REMOVE, function(e) {
-            removed = e.elem;
+            removed = e.getElement();
           });
       collection.setAt(1, 1);
       expect(added).to.eql(1);
@@ -156,7 +156,7 @@ describe('ol.collection', function() {
       var removed;
       goog.events.listen(
           collection, ol.CollectionEventType.REMOVE, function(e) {
-            removed = e.elem;
+            removed = e.getElement();
           });
       collection.pop();
       expect(removed).to.eql('a');
@@ -169,7 +169,7 @@ describe('ol.collection', function() {
       var added;
       goog.events.listen(
           collection, ol.CollectionEventType.ADD, function(e) {
-            added = e.elem;
+            added = e.getElement();
           });
       collection.insertAt(1, 1);
       expect(added).to.eql(1);
@@ -181,7 +181,7 @@ describe('ol.collection', function() {
       var added = [];
       goog.events.listen(
           collection, ol.CollectionEventType.ADD, function(e) {
-            added.push(e.elem);
+            added.push(e.getElement());
           });
       collection.setAt(2, 0);
       expect(collection.getLength()).to.eql(3);
@@ -230,7 +230,7 @@ describe('ol.collection', function() {
       var collection = new ol.Collection();
       var elem;
       goog.events.listen(collection, ol.CollectionEventType.ADD, function(e) {
-        elem = e.elem;
+        elem = e.getElement();
       });
       collection.push(1);
       expect(elem).to.eql(1);
@@ -249,16 +249,15 @@ describe('ol.collection', function() {
         goog.events.listen(collection, ol.CollectionEventType.ADD, cb1);
         goog.events.listen(collection, ol.CollectionEventType.REMOVE, cb2);
         collection.setAt(0, 2);
-        expect(cb2.lastCall.args[0].elem).to.eql(1);
+        expect(cb2.lastCall.args[0].getElement()).to.eql(1);
-        expect(cb1.lastCall.args[0].elem).to.eql(2);
+        expect(cb1.lastCall.args[0].getElement()).to.eql(2);
       });
     });
     describe('pop', function() {
       it('triggers remove', function() {
-        var elem;
         goog.events.listen(collection, ol.CollectionEventType.REMOVE, cb1);
         collection.pop();
-        expect(cb1.lastCall.args[0].elem).to.eql(1);
+        expect(cb1.lastCall.args[0].getElement()).to.eql(1);
       });
     });
   });