Merge pull request #480 from twpayne/logo-control

Add logo control

src/ol/control/defaults.js

@@ -2,6 +2,7 @@ goog.provide('ol.control.defaults');
 
 goog.require('goog.array');
 goog.require('ol.control.Attribution');
+goog.require('ol.control.Logo');
 goog.require('ol.control.Zoom');
 
 
@@ -25,6 +26,14 @@ ol.control.defaults = function(opt_options, opt_controls) {
     controls.push(new ol.control.Attribution(attributionControlOptions));
   }
 
+  var logoControl = goog.isDef(options.logo) ?
+      options.logo : true;
+  if (logoControl) {
+    var logoControlOptions = goog.isDef(options.logoOptions) ?
+        options.logoOptions : undefined;
+    controls.push(new ol.control.Logo(logoControlOptions));
+  }
+
   var zoomControl = goog.isDef(options.zoom) ?
       options.zoom : true;
   if (zoomControl) {

src/ol/control/logocontrol.js

@@ -0,0 +1,129 @@
+goog.provide('ol.control.Logo');
+
+goog.require('goog.dom');
+goog.require('goog.dom.TagName');
+goog.require('goog.events');
+goog.require('goog.object');
+goog.require('goog.style');
+goog.require('ol.FrameState');
+goog.require('ol.MapEvent');
+goog.require('ol.MapEventType');
+goog.require('ol.control.Control');
+
+
+
+/**
+ * @constructor
+ * @extends {ol.control.Control}
+ * @param {ol.control.LogoOptions=} opt_options Options.
+ */
+ol.control.Logo = function(opt_options) {
+
+  var options = goog.isDef(opt_options) ? opt_options : {};
+
+  /**
+   * @private
+   * @type {Element}
+   */
+  this.ulElement_ = goog.dom.createElement(goog.dom.TagName.UL);
+
+  var element = goog.dom.createDom(goog.dom.TagName.DIV, {
+    'class': 'ol-logo ' + ol.CSS_CLASS_UNSELECTABLE
+  }, this.ulElement_);
+
+  goog.base(this, {
+    element: element,
+    map: options.map,
+    target: options.target
+  });
+
+  /**
+   * @private
+   * @type {boolean}
+   */
+  this.renderedVisible_ = true;
+
+  /**
+   * @private
+   * @type {Object.<string, Element>}
+   */
+  this.logoElements_ = {};
+
+  /**
+   * @private
+   * @type {?number}
+   */
+  this.postrenderListenKey_ = null;
+
+};
+goog.inherits(ol.control.Logo, ol.control.Control);
+
+
+/**
+ * @param {ol.MapEvent} mapEvent Map event.
+ */
+ol.control.Logo.prototype.handleMapPostrender = function(mapEvent) {
+  this.updateElement_(mapEvent.frameState);
+};
+
+
+/**
+ * @inheritDoc
+ */
+ol.control.Logo.prototype.setMap = function(map) {
+  if (!goog.isNull(this.postrenderListenKey_)) {
+    goog.events.unlistenByKey(this.postrenderListenKey_);
+    this.postrenderListenKey_ = null;
+  }
+  goog.base(this, 'setMap', map);
+  if (!goog.isNull(map)) {
+    this.postrenderListenKey_ = goog.events.listen(
+        map, ol.MapEventType.POSTRENDER, this.handleMapPostrender, false, this);
+  }
+};
+
+
+/**
+ * @param {?ol.FrameState} frameState Frame state.
+ * @private
+ */
+ol.control.Logo.prototype.updateElement_ = function(frameState) {
+
+  if (goog.isNull(frameState)) {
+    if (this.renderedVisible_) {
+      goog.style.showElement(this.element, false);
+      this.renderedVisible_ = false;
+    }
+    return;
+  }
+
+  var logo;
+  var logos = frameState.logos;
+  var logoElements = this.logoElements_;
+
+  for (logo in logoElements) {
+    if (!(logo in logos)) {
+      goog.dom.removeNode(logoElements[logo]);
+      delete logoElements[logo];
+    }
+  }
+
+  var image, logoElement;
+  for (logo in logos) {
+    if (!(logo in logoElements)) {
+      image = new Image();
+      image.src = logo;
+      logoElement = goog.dom.createElement(goog.dom.TagName.LI);
+      logoElement.appendChild(image);
+      goog.dom.appendChild(this.ulElement_, logoElement);
+      logoElements[logo] = logoElement;
+    }
+  }
+
+  var renderVisible = !goog.object.isEmpty(logos);
+  if (this.renderedVisible_ != renderVisible) {
+    goog.style.showElement(this.element, renderVisible);
+    this.renderedVisible_ = renderVisible;
+  }
+
+};