Changeset 4252

Timestamp:

09/12/07 21:23:06 (1 year ago)

Author:

euzuro

Message:

Add 'loadstart' and 'loadend' events to some of our exciting layers like WFS, GML, GeoRSS, and Text. tests to back it up. (Closes #808)

Files:

• trunk/openlayers/lib/OpenLayers/Layer/GML.js (modified) (3 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/GeoRSS.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/Text.js (modified) (2 diffs)
• trunk/openlayers/lib/OpenLayers/Layer/WFS.js (modified) (4 diffs)
• trunk/openlayers/lib/OpenLayers/Tile/WFS.js (modified) (2 diffs)
• trunk/openlayers/tests/Layer/test_GML.html (modified) (2 diffs)
• trunk/openlayers/tests/Layer/test_GeoRSS.html (modified) (2 diffs)
• trunk/openlayers/tests/Layer/test_Text.html (modified) (1 diff)
• trunk/openlayers/tests/owls.xml (added)

trunk/openlayers/lib/OpenLayers/Layer/GML.js

@@ -82 +82 @@
-        // See http://trac.openlayers.org/ticket/404
-        if(this.visibility && !this.loaded){
+            this.events.triggerEvent("loadstart");
-            this.loadGML();
-        }
@@ -114 +115 @@
-        var gml = this.format ? new this.format() : new OpenLayers.Format.GML();
-        this.addFeatures(gml.read(doc));
+        this.events.triggerEvent("loadend");
-    },
-    
@@ -126 +128 @@
-    requestFailure: function(request) {
-        alert("Error in loading GML file "+this.url);
+        this.events.triggerEvent("loadend");
-    },
-

trunk/openlayers/lib/OpenLayers/Layer/GeoRSS.js

@@ -68 +68 @@
-        this.location = location;
-        this.features = [];
+        this.events.triggerEvent("loadstart");
-        OpenLayers.loadURL(location, null, this, this.parseData);
-    },
@@ -210 +211 @@
-            this.addMarker(marker);
-        }
+        this.events.triggerEvent("loadend");
-    },
-    

trunk/openlayers/lib/OpenLayers/Layer/Text.js

@@ -48 +48 @@
-        this.features = new Array();
-        if (this.location != null) {
-
+
+
+
+
+
+
+
+
-        }
-    },
@@ -156 +163 @@
-            }
-        }
+        this.events.triggerEvent("loadend");
-    },
-    

trunk/openlayers/lib/OpenLayers/Layer/WFS.js

@@ -22 +22 @@
-     */
-    isBaseLayer: false,
+    
+    /**
+     * Property: tile
+     * {<OpenLayers.Tile.WFS>}
+     */
+    tile: null,    
-    
-    /**
@@ -235 +241 @@
-                this.tile = new OpenLayers.Tile.WFS(this, pos, tileBounds, 
-                                                     url, tileSize);
+                this.addTileMonitoringHooks(this.tile);
-                this.tile.draw();
-            } else {
@@ -244 +251 @@
-                }    
-                this.tile.destroy();
+                this.removeTileMonitoringHooks(this.tile);
-                
-                this.tile = null;
@@ -251 +259 @@
-            } 
-        }
+    },
+
+    /** 
+     * Method: addTileMonitoringHooks
+     * This function takes a tile as input and adds the appropriate hooks to 
+     *     the tile so that the layer can keep track of the loading tile
+     *     (making sure to check that the tile is always the layer's current
+     *     tile before taking any action).
+     * 
+     * Parameters: 
+     * tile - {<OpenLayers.Tile>}
+     */
+    addTileMonitoringHooks: function(tile) {
+        tile.onLoadStart = function() {
+            //if this is the the layer's current tile, then trigger 
+            // a 'loadstart'
+            if (this == this.layer.tile) {
+                this.layer.events.triggerEvent("loadstart");
+            }
+        };
+        tile.events.register("loadstart", tile, tile.onLoadStart);
+      
+        tile.onLoadEnd = function() {
+            //if this is the the layer's current tile, then trigger 
+            // a 'tileloaded' and 'loadend'
+            if (this == this.layer.tile) {
+                this.layer.events.triggerEvent("tileloaded");
+                this.layer.events.triggerEvent("loadend");
+            }
+        };
+        tile.events.register("loadend", tile, tile.onLoadEnd);
+    },
+    
+    /** 
+     * Method: removeTileMonitoringHooks
+     * This function takes a tile as input and removes the tile hooks 
+     *     that were added in addTileMonitoringHooks()
+     * 
+     * Parameters: 
+     * tile - {<OpenLayers.Tile>}
+     */
+    removeTileMonitoringHooks: function(tile) {
+        tile.events.unregister("loadstart", tile, tile.onLoadStart);
+        tile.events.unregister("loadend", tile, tile.onLoadEnd);
-    },
-

trunk/openlayers/lib/OpenLayers/Tile/WFS.js

@@ -76 +76 @@
-    draw:function() {
-        if (OpenLayers.Tile.prototype.draw.apply(this, arguments)) {
+            if (this.isLoading) {
+                //if already loading, send 'reload' instead of 'loadstart'.
+                this.events.triggerEvent("reload"); 
+            } else {
+                this.isLoading = true;
+                this.events.triggerEvent("loadstart");
+            }
-            this.loadFeaturesForRegion(this.requestSuccess);
-        }
@@ -122 +129 @@
-            }
-        }
+        if (this.events) {
+            this.events.triggerEvent("loadend"); 
+        }
-    },
-

trunk/openlayers/tests/Layer/test_GML.html

@@ -5 +5 @@
-
-    var name = "GML Layer";
+    
+    var gml = "./owls.xml";
+
+    // if this test is running online, different rules apply
+    var isMSIE = (navigator.userAgent.indexOf("MSIE") > -1);
+    if (isMSIE) {
+        gml = "." + gml;
+    }
-    
-    function test_01_Layer_GML_constructor(t) {
@@ -15 +23 @@
-
-    }
+    function test_Layer_GML_events(t) {
+        t.plan(3);
+
+        var layer = new OpenLayers.Layer.GML(name, gml, {isBaseLayer: true});
+        layer.events.register("loadstart", layer, function() { 
+            t.ok(true, "loadstart called.")
+        });
+        layer.events.register("loadend", layer, function() { 
+            t.ok(true, "loadend called.")
+        });
+        var map = new OpenLayers.Map("map");
+        map.addLayer(layer);
+        map.zoomToMaxExtent();
+        t.delay_call(1, function() { 
+            t.ok(true, "waited for 1s"); 
+        });
+
+    }
-  </script>
-</head>

trunk/openlayers/tests/Layer/test_GeoRSS.html

@@ -81 +81 @@
-        map.setCenter(new OpenLayers.LonLat(0,0),0);
-        var event = {};
-1
+2
-          t.ok(layer.markers[0].events, "First marker has an events object");
-          t.eq(layer.markers[0].events.listeners['click'].length, 1, "Marker events has one object");
@@ -160 +160 @@
-        });
-    }
-
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
-    function test_99_Layer_GeoRSS_destroy (t) {
-        t.plan( 1 );    

trunk/openlayers/tests/Layer/test_Text.html

@@ -119 +119 @@
-        });
-    }
+    function test_Layer_Text_loadend_Event(t) {
+        t.plan(2);
+        layer = new OpenLayers.Layer.Text('Test Layer', {location:datafile});
+        t.delay_call(2, function() { 
+            layer.events.register('loadend', layer, function() { 
+                t.ok(true, "Loadend event fired"); 
+            });
+            layer.parseData({
+                'responseText':''
+            });
+            t.ok(true, "Parsing data didn't fail"); 
+        });
+    }
-
-    function test_99_Layer_Text_destroy (t) {