adding OpenLayers.Control.Attribution to the list of controls in the OL suite. includes example and tests. very nice. Thanks to pensyakito and cr5 for getting this together and complete. (Closes #103)

git-svn-id: http://svn.openlayers.org/trunk/openlayers@4231 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf
2007-09-12 04:37:45 +00:00
parent 983618f2fa
commit c519879391
7 changed files with 162 additions and 1 deletions
--- a/lib/OpenLayers/Control/Attribution.js
+++ b/lib/OpenLayers/Control/Attribution.js
@@ -0,0 +1,78 @@
+/* Copyright (c) 2006-2007 MetaCarta, Inc., published under a modified BSD license.
+ * See http://svn.openlayers.org/trunk/openlayers/repository-license.txt 
+ * for the full text of the license. */
+
+/**
+ * @requires OpenLayers/Control.js
+ * 
+ * Class: OpenLayers.Control.Attribution
+ * Add attribution from layers to the map display. Uses 'attribution' property
+ * of each layer.
+ */
+OpenLayers.Control.Attribution = 
+  OpenLayers.Class(OpenLayers.Control, {
+    
+    /**
+     * APIProperty: seperator
+     * {String} String used to seperate layers.
+     */
+    seperator: ", ",
+       
+    /**
+     * Constructor: OpenLayers.Control.Attribution 
+     * 
+     * Parameters:
+     * options - {Object} Options for control.
+     */
+    initialize: function(options) {
+        OpenLayers.Control.prototype.initialize.apply(this, arguments);
+    },
+
+    /** 
+     * Method: destroy
+     * Destroy control.
+     */
+    destroy: function() {
+        this.map.events.unregister("removelayer", this, this.updateAttribution);
+        this.map.events.unregister("addlayer", this, this.updateAttribution);
+        this.map.events.unregister("changelayer", this, this.updateAttribution);
+        
+        OpenLayers.Control.prototype.destroy.apply(this, arguments);
+    },    
+    
+    /**
+     * Method: draw
+     * Initialize control.
+     * 
+     * Returns: 
+     * {DOMElement} A reference to the DIV DOMElement containing the control
+     */    
+    draw: function() {
+        OpenLayers.Control.prototype.draw.apply(this, arguments);
+        
+        this.map.events.register('changelayer', this, this.updateAttribution);
+        this.map.events.register('addlayer', this, this.updateAttribution);
+        this.map.events.register('removelayer', this, this.updateAttribution);
+        this.updateAttribution();
+        
+        return this.div;    
+    },
+
+    /**
+     * Method: updateAttribution
+     * Update attribution string.
+     */
+    updateAttribution: function() {
+        var attributions = [];
+        for(var i=0; i < this.map.layers.length; i++) {
+            var layer = this.map.layers[i];
+            if (layer.attribution && layer.getVisibility()) {
+                attributions.push( layer.attribution );
+            }
+        }  
+        this.div.innerHTML = attributions.join(this.seperator);
+    },
+
+    /** @final @type String */
+    CLASS_NAME: "OpenLayers.Control.Attribution"
+});