openlayers/src/ol/control/attributioncontrol.js

// FIXME handle date line wrap

goog.provide('ol.control.Attribution');

goog.require('goog.array');
goog.require('goog.dom');
goog.require('goog.dom.TagName');
goog.require('goog.events');
goog.require('goog.object');
goog.require('goog.style');
goog.require('ol.Attribution');
goog.require('ol.FrameState');
goog.require('ol.MapEvent');
goog.require('ol.MapEventType');
goog.require('ol.TileRange');
goog.require('ol.control.Control');
goog.require('ol.source.Source');



/**
 * @constructor
 * @extends {ol.control.Control}
 * @param {ol.control.AttributionOptions=} opt_options Options.
 */
ol.control.Attribution = function(opt_options) {

  var options = goog.isDef(opt_options) ? opt_options : {};

  this.ulElement_ = goog.dom.createElement(goog.dom.TagName.UL);

  var element = goog.dom.createDom(goog.dom.TagName.DIV, {
    'class': 'ol-attribution ol-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.attributionElements_ = {};

  /**
   * @private
   * @type {Object.<string, boolean>}
   */
  this.attributionElementRenderedVisible_ = {};

  /**
   * @private
   * @type {Array.<?number>}
   */
  this.listenerKeys_ = null;

};
goog.inherits(ol.control.Attribution, ol.control.Control);


/**
 * @param {?Object.<string, Object.<string, ol.TileRange>>} usedTiles Used
 *     tiles.
 * @param {Object.<string, ol.source.Source>} sources Sources.
 * @return {Object.<string, ol.Attribution>} Attributions.
 */
ol.control.Attribution.prototype.getTileSourceAttributions =
    function(usedTiles, sources) {
  /** @type {Object.<string, ol.Attribution>} */
  var attributions = {};
  var i, tileRanges, tileSource, tileSourceAttribution,
      tileSourceAttributionKey, tileSourceAttributions, tileSourceKey, z;
  for (tileSourceKey in usedTiles) {
    goog.asserts.assert(tileSourceKey in sources);
    tileSource = sources[tileSourceKey];
    tileSourceAttributions = tileSource.getAttributions();
    if (goog.isNull(tileSourceAttributions)) {
      continue;
    }
    tileRanges = usedTiles[tileSourceKey];
    for (i = 0; i < tileSourceAttributions.length; ++i) {
      tileSourceAttribution = tileSourceAttributions[i];
      tileSourceAttributionKey = goog.getUid(tileSourceAttribution).toString();
      if (tileSourceAttributionKey in attributions) {
        continue;
      }
      if (tileSourceAttribution.intersectsAnyTileRange(tileRanges)) {
        attributions[tileSourceAttributionKey] = tileSourceAttribution;
      }
    }
  }
  return attributions;
};


/**
 * @param {ol.MapEvent} mapEvent Map event.
 */
ol.control.Attribution.prototype.handleMapPostrender = function(mapEvent) {
  this.updateElement_(mapEvent.frameState);
};


/**
 * @inheritDoc
 */
ol.control.Attribution.prototype.setMap = function(map) {
  if (!goog.isNull(this.listenerKeys_)) {
    goog.array.forEach(this.listenerKeys_, goog.events.unlistenByKey);
    this.listenerKeys_ = null;
  }
  goog.base(this, 'setMap', map);
  if (!goog.isNull(map)) {
    this.listenerKeys_ = [
      goog.events.listen(map, ol.MapEventType.POSTRENDER,
          this.handleMapPostrender, false, this)
    ];
  }
};


/**
 * @private
 * @param {?ol.FrameState} frameState Frame state.
 */
ol.control.Attribution.prototype.updateElement_ = function(frameState) {

  if (goog.isNull(frameState)) {
    if (this.renderedVisible_) {
      goog.style.showElement(this.element, false);
      this.renderedVisible_ = false;
    }
    return;
  }

  var map = this.getMap();

  /** @type {Object.<string, boolean>} */
  var attributionsToRemove = {};
  /** @type {Object.<string, ol.source.Source>} */
  var sources = {};
  var layers = map.getLayers();
  if (goog.isDef(layers)) {
    layers.forEach(function(layer) {
      var source = layer.getSource();
      sources[goog.getUid(source).toString()] = source;
      var attributions = source.getAttributions();
      if (!goog.isNull(attributions)) {
        var attribution, i;
        for (i = 0; i < attributions.length; ++i) {
          attribution = attributions[i];
          attributionKey = goog.getUid(attribution).toString();
          attributionsToRemove[attributionKey] = true;
        }
      }
    });
  }

  /** @type {Object.<string, ol.Attribution>} */
  var attributions = goog.object.clone(frameState.attributions);
  var tileSourceAttributions = this.getTileSourceAttributions(
      frameState.usedTiles, sources);
  goog.object.extend(attributions, tileSourceAttributions);

  /** @type {Array.<number>} */
  var attributionKeys =
      goog.array.map(goog.object.getKeys(attributions), Number);
  goog.array.sort(attributionKeys);
  var i, attributionElement, attributionKey;
  for (i = 0; i < attributionKeys.length; ++i) {
    attributionKey = attributionKeys[i].toString();
    if (attributionKey in this.attributionElements_) {
      if (!this.attributionElementRenderedVisible_[attributionKey]) {
        goog.style.showElement(this.attributionElements_[attributionKey], true);
        this.attributionElementRenderedVisible_[attributionKey] = true;
      }
    } else {
      attributionElement = goog.dom.createElement(goog.dom.TagName.LI);
      attributionElement.innerHTML = attributions[attributionKey].getHTML();
      goog.dom.appendChild(this.ulElement_, attributionElement);
      this.attributionElements_[attributionKey] = attributionElement;
      this.attributionElementRenderedVisible_[attributionKey] = true;
    }
    delete attributionsToRemove[attributionKey];
  }

  for (attributionKey in attributionsToRemove) {
    goog.dom.removeNode(this.attributionElements_[attributionKey]);
    delete this.attributionElements_[attributionKey];
    delete this.attributionElementRenderedVisible_[attributionKey];
  }

  var renderVisible = !goog.array.isEmpty(attributionKeys);
  if (this.renderedVisible_ != renderVisible) {
    goog.style.showElement(this.element, renderVisible);
    this.renderedVisible_ = renderVisible;
  }

};