diff --git a/src/objectliterals.jsdoc b/src/objectliterals.jsdoc index 4265022b8c..10037cdc50 100644 --- a/src/objectliterals.jsdoc +++ b/src/objectliterals.jsdoc @@ -53,7 +53,7 @@ * @property {ol.Collection|Array.|undefined} controls * Controls initially added to the map. * @property {ol.Collection|undefined} interactions Interactions. - * @property {Array.|ol.Collection|undefined} layers Layers. + * @property {Array.|ol.Collection|undefined} layers Layers. * @property {ol.Collection|Array.|undefined} overlays * Overlays initially added to the map. * @property {ol.RendererHint|undefined} renderer Renderer. @@ -312,7 +312,7 @@ */ /** - * @typedef {Object} ol.layer.LayerBaseOptions + * @typedef {Object} ol.layer.BaseOptions * @property {number|undefined} brightness Brightness. * @property {number|undefined} contrast Contrast. * @property {number|undefined} hue Hue. @@ -340,7 +340,7 @@ * @property {number|undefined} opacity Opacity. * @property {number|undefined} saturation Saturation. * @property {boolean|undefined} visible Visibility. - * @property {Array.|ol.Collection|undefined} layers Child layers. + * @property {Array.|ol.Collection|undefined} layers Child layers. */ /** diff --git a/src/ol/layer/layer.js b/src/ol/layer/layer.js index 98a3b027a8..ef5a60fb0d 100644 --- a/src/ol/layer/layer.js +++ b/src/ol/layer/layer.js @@ -4,14 +4,14 @@ goog.require('goog.asserts'); goog.require('goog.events'); goog.require('goog.events.EventType'); goog.require('goog.object'); -goog.require('ol.layer.LayerBase'); +goog.require('ol.layer.Base'); goog.require('ol.source.Source'); /** * @constructor - * @extends {ol.layer.LayerBase} + * @extends {ol.layer.Base} * @param {ol.layer.LayerOptions} options Layer options. */ ol.layer.Layer = function(options) { @@ -37,7 +37,7 @@ ol.layer.Layer = function(options) { } }; -goog.inherits(ol.layer.Layer, ol.layer.LayerBase); +goog.inherits(ol.layer.Layer, ol.layer.Base); /** diff --git a/src/ol/layer/layerbase.js b/src/ol/layer/layerbase.js index d1a7f5f05d..67ba0decc0 100644 --- a/src/ol/layer/layerbase.js +++ b/src/ol/layer/layerbase.js @@ -1,4 +1,4 @@ -goog.provide('ol.layer.LayerBase'); +goog.provide('ol.layer.Base'); goog.provide('ol.layer.LayerProperty'); goog.provide('ol.layer.LayerState'); @@ -38,9 +38,9 @@ ol.layer.LayerState; /** * @constructor * @extends {ol.Object} - * @param {ol.layer.LayerBaseOptions} options Layer options. + * @param {ol.layer.BaseOptions} options Layer options. */ -ol.layer.LayerBase = function(options) { +ol.layer.Base = function(options) { goog.base(this); @@ -76,13 +76,13 @@ ol.layer.LayerBase = function(options) { this.handleLayerVisibleChange, false, this); }; -goog.inherits(ol.layer.LayerBase, ol.Object); +goog.inherits(ol.layer.Base, ol.Object); /** * @protected */ -ol.layer.LayerBase.prototype.dispatchChangeEvent = function() { +ol.layer.Base.prototype.dispatchChangeEvent = function() { this.dispatchEvent(goog.events.EventType.CHANGE); }; @@ -90,43 +90,43 @@ ol.layer.LayerBase.prototype.dispatchChangeEvent = function() { /** * @return {number} Brightness. */ -ol.layer.LayerBase.prototype.getBrightness = function() { +ol.layer.Base.prototype.getBrightness = function() { return /** @type {number} */ (this.get(ol.layer.LayerProperty.BRIGHTNESS)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getBrightness', - ol.layer.LayerBase.prototype.getBrightness); + ol.layer.Base.prototype.getBrightness); /** * @return {number} Contrast. */ -ol.layer.LayerBase.prototype.getContrast = function() { +ol.layer.Base.prototype.getContrast = function() { return /** @type {number} */ (this.get(ol.layer.LayerProperty.CONTRAST)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getContrast', - ol.layer.LayerBase.prototype.getContrast); + ol.layer.Base.prototype.getContrast); /** * @return {number} Hue. */ -ol.layer.LayerBase.prototype.getHue = function() { +ol.layer.Base.prototype.getHue = function() { return /** @type {number} */ (this.get(ol.layer.LayerProperty.HUE)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getHue', - ol.layer.LayerBase.prototype.getHue); + ol.layer.Base.prototype.getHue); /** * @return {ol.layer.LayerState} Layer state. */ -ol.layer.LayerBase.prototype.getLayerState = function() { +ol.layer.Base.prototype.getLayerState = function() { var brightness = this.getBrightness(); var contrast = this.getContrast(); var hue = this.getHue(); @@ -151,7 +151,7 @@ ol.layer.LayerBase.prototype.getLayerState = function() { * modified in place). * @return {Array.} Array of layers. */ -ol.layer.LayerBase.prototype.getLayersArray = goog.abstractMethod; +ol.layer.Base.prototype.getLayersArray = goog.abstractMethod; /** @@ -164,49 +164,49 @@ ol.layer.LayerBase.prototype.getLayersArray = goog.abstractMethod; * layerStates: Array.}} Object that store both the * layers and the layerStates. */ -ol.layer.LayerBase.prototype.getLayerStatesArray = goog.abstractMethod; +ol.layer.Base.prototype.getLayerStatesArray = goog.abstractMethod; /** * @return {number} Opacity. */ -ol.layer.LayerBase.prototype.getOpacity = function() { +ol.layer.Base.prototype.getOpacity = function() { return /** @type {number} */ (this.get(ol.layer.LayerProperty.OPACITY)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getOpacity', - ol.layer.LayerBase.prototype.getOpacity); + ol.layer.Base.prototype.getOpacity); /** * @return {number} Saturation. */ -ol.layer.LayerBase.prototype.getSaturation = function() { +ol.layer.Base.prototype.getSaturation = function() { return /** @type {number} */ (this.get(ol.layer.LayerProperty.SATURATION)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getSaturation', - ol.layer.LayerBase.prototype.getSaturation); + ol.layer.Base.prototype.getSaturation); /** * @return {boolean} Visible. */ -ol.layer.LayerBase.prototype.getVisible = function() { +ol.layer.Base.prototype.getVisible = function() { return /** @type {boolean} */ (this.get(ol.layer.LayerProperty.VISIBLE)); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'getVisible', - ol.layer.LayerBase.prototype.getVisible); + ol.layer.Base.prototype.getVisible); /** * @protected */ -ol.layer.LayerBase.prototype.handleLayerChange = function() { +ol.layer.Base.prototype.handleLayerChange = function() { if (this.getVisible() && this.isReady()) { this.dispatchChangeEvent(); } @@ -216,7 +216,7 @@ ol.layer.LayerBase.prototype.handleLayerChange = function() { /** * @protected */ -ol.layer.LayerBase.prototype.handleLayerVisibleChange = function() { +ol.layer.Base.prototype.handleLayerVisibleChange = function() { if (this.isReady()) { this.dispatchChangeEvent(); } @@ -226,7 +226,7 @@ ol.layer.LayerBase.prototype.handleLayerVisibleChange = function() { /** * @return {boolean} Is ready. */ -ol.layer.LayerBase.prototype.isReady = goog.abstractMethod; +ol.layer.Base.prototype.isReady = goog.abstractMethod; /** @@ -249,13 +249,13 @@ ol.layer.LayerBase.prototype.isReady = goog.abstractMethod; * * @param {number} brightness Brightness. */ -ol.layer.LayerBase.prototype.setBrightness = function(brightness) { +ol.layer.Base.prototype.setBrightness = function(brightness) { this.set(ol.layer.LayerProperty.BRIGHTNESS, brightness); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setBrightness', - ol.layer.LayerBase.prototype.setBrightness); + ol.layer.Base.prototype.setBrightness); /** @@ -265,13 +265,13 @@ goog.exportProperty( * * @param {number} contrast Contrast. */ -ol.layer.LayerBase.prototype.setContrast = function(contrast) { +ol.layer.Base.prototype.setContrast = function(contrast) { this.set(ol.layer.LayerProperty.CONTRAST, contrast); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setContrast', - ol.layer.LayerBase.prototype.setContrast); + ol.layer.Base.prototype.setContrast); /** @@ -279,25 +279,25 @@ goog.exportProperty( * unchanged. Other values are radians around the color circle. * @param {number} hue Hue. */ -ol.layer.LayerBase.prototype.setHue = function(hue) { +ol.layer.Base.prototype.setHue = function(hue) { this.set(ol.layer.LayerProperty.HUE, hue); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setHue', - ol.layer.LayerBase.prototype.setHue); + ol.layer.Base.prototype.setHue); /** * @param {number} opacity Opacity. */ -ol.layer.LayerBase.prototype.setOpacity = function(opacity) { +ol.layer.Base.prototype.setOpacity = function(opacity) { this.set(ol.layer.LayerProperty.OPACITY, opacity); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setOpacity', - ol.layer.LayerBase.prototype.setOpacity); + ol.layer.Base.prototype.setOpacity); /** @@ -308,22 +308,22 @@ goog.exportProperty( * * @param {number} saturation Saturation. */ -ol.layer.LayerBase.prototype.setSaturation = function(saturation) { +ol.layer.Base.prototype.setSaturation = function(saturation) { this.set(ol.layer.LayerProperty.SATURATION, saturation); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setSaturation', - ol.layer.LayerBase.prototype.setSaturation); + ol.layer.Base.prototype.setSaturation); /** * @param {boolean} visible Visible. */ -ol.layer.LayerBase.prototype.setVisible = function(visible) { +ol.layer.Base.prototype.setVisible = function(visible) { this.set(ol.layer.LayerProperty.VISIBLE, visible); }; goog.exportProperty( - ol.layer.LayerBase.prototype, + ol.layer.Base.prototype, 'setVisible', - ol.layer.LayerBase.prototype.setVisible); + ol.layer.Base.prototype.setVisible); diff --git a/src/ol/layer/layergroup.js b/src/ol/layer/layergroup.js index b149205765..4a4e040e58 100644 --- a/src/ol/layer/layergroup.js +++ b/src/ol/layer/layergroup.js @@ -10,8 +10,8 @@ goog.require('ol.Collection'); goog.require('ol.CollectionEvent'); goog.require('ol.CollectionEventType'); goog.require('ol.Object'); +goog.require('ol.layer.Base'); goog.require('ol.layer.Layer'); -goog.require('ol.layer.LayerBase'); /** @@ -25,7 +25,7 @@ ol.layer.LayerGroupProperty = { /** * @constructor - * @extends {ol.layer.LayerBase} + * @extends {ol.layer.Base} * @param {ol.layer.LayerGroupOptions=} opt_options Layer options. */ ol.layer.LayerGroup = function(opt_options) { @@ -63,7 +63,7 @@ ol.layer.LayerGroup = function(opt_options) { this.setLayers(layers); }; -goog.inherits(ol.layer.LayerGroup, ol.layer.LayerBase); +goog.inherits(ol.layer.LayerGroup, ol.layer.Base); /** @@ -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.getElement()); + var layer = /** @type {ol.layer.Base} */ (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.getElement()); + var layer = /** @type {ol.layer.Base} */ (collectionEvent.getElement()); var key = goog.getUid(layer).toString(); goog.events.unlistenByKey(this.listenerKeys_[key]); delete this.listenerKeys_[key]; diff --git a/src/ol/map.js b/src/ol/map.js index f5f190f253..9dd714aa2f 100644 --- a/src/ol/map.js +++ b/src/ol/map.js @@ -53,7 +53,7 @@ goog.require('ol.ViewHint'); goog.require('ol.control'); goog.require('ol.extent'); goog.require('ol.interaction'); -goog.require('ol.layer.LayerBase'); +goog.require('ol.layer.Base'); goog.require('ol.layer.LayerGroup'); goog.require('ol.proj'); goog.require('ol.proj.common'); @@ -366,7 +366,7 @@ ol.Map.prototype.addControl = function(control) { /** * Adds the given layer to the top of this map. - * @param {ol.layer.LayerBase} layer Layer. + * @param {ol.layer.Base} layer Layer. */ ol.Map.prototype.addLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); @@ -874,14 +874,14 @@ ol.Map.prototype.removeControl = function(control) { /** * Removes the given layer from the map. - * @param {ol.layer.LayerBase} layer Layer. - * @return {ol.layer.LayerBase|undefined} The removed layer or undefined if the + * @param {ol.layer.Base} layer Layer. + * @return {ol.layer.Base|undefined} The removed layer or undefined if the * layer was not found. */ ol.Map.prototype.removeLayer = function(layer) { var layers = this.getLayerGroup().getLayers(); goog.asserts.assert(goog.isDef(layers)); - return /** @type {ol.layer.LayerBase|undefined} */ (layers.remove(layer)); + return /** @type {ol.layer.Base|undefined} */ (layers.remove(layer)); };