ashatora/openlayers
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

Merge pull request #5861 from fredj/more_renaming

Browse Source 
More renaming to have one provide per file
This commit is contained in:
Frédéric Junod
2016-09-07 13:02:40 +02:00
committed by GitHub
parent a40717b7c9 d35537e975
commit 9a9b22ec5e
14 changed files with 169 additions and 165 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
changelog/upgrade-notes.md
View File

@@ -17,13 +17,21 @@ A number of internal types have been renamed. This will not affect those who us
* rename `ol.OverlayProperty` to `ol.Overlay.Property`
* rename `ol.control.MousePositionProperty` to `ol.control.MousePosition.Property`
* rename `ol.format.IGCZ` to `ol.format.IGC.Z`
* rename `ol.interaction.ExtentEvent` to `ol.interaction.Extent.Event`
* rename `ol.interaction.ExtentEventType` to `ol.interaction.Extent.EventType`
* rename `ol.interaction.DragAndDropEvent` to `ol.interaction.DragAndDrop.Event`
* rename `ol.interaction.DragAndDropEventType` to `ol.interaction.DragAndDrop.EventType`
* rename `ol.interaction.TranslateEvent` to `ol.interaction.Translate.Event`
* rename `ol.interaction.TranslateEventType` to `ol.interaction.Translate.EventType`
* rename `ol.layer.GroupProperty` to `ol.layer.Group.Property`
* rename `ol.layer.HeatmapLayerProperty` to `ol.layer.Heatmap.Property`
* rename `ol.layer.TileProperty` to `ol.layer.Tile.Property`
* rename `ol.layer.VectorTileRenderType` to `ol.layer.VectorTile.RenderType`
* rename `ol.MapEventType` to `ol.MapEvent.Type`
* rename `ol.MapProperty` to `ol.Map.Property`
* rename `ol.RendererType` to `ol.renderer.Type`
* rename `ol.source.ImageEvent` to `ol.source.Image.Event`
* rename `ol.source.ImageEventType` to `ol.source.Image.EventType`
* rename `ol.source.TileEvent` to `ol.source.Tile.Event`
* rename `ol.source.TileEventType` to `ol.source.Tile.EventType`
* rename `ol.source.VectorEvent` to `ol.source.Vector.Event`

4
src/ol/control/control.js
View File

@@ -2,7 +2,7 @@ goog.provide('ol.control.Control');
goog.require('ol.events');
goog.require('ol');
goog.require('ol.MapEventType');
goog.require('ol.MapEvent');
goog.require('ol.Object');
goog.require('ol.dom');
@@ -118,7 +118,7 @@ ol.control.Control.prototype.setMap = function(map) {
target.appendChild(this.element);
if (this.render !== ol.nullFunction) {
this.listenerKeys.push(ol.events.listen(map,
ol.MapEventType.POSTRENDER, this.render, this));
ol.MapEvent.Type.POSTRENDER, this.render, this));
}
map.render();
}

4
src/ol/control/overviewmap.js
View File

@@ -3,7 +3,7 @@ goog.provide('ol.control.OverviewMap');
goog.require('ol');
goog.require('ol.Collection');
goog.require('ol.Map');
goog.require('ol.MapEventType');
goog.require('ol.MapEvent');
goog.require('ol.Object');
goog.require('ol.ObjectEventType');
goog.require('ol.Overlay');
@@ -445,7 +445,7 @@ ol.control.OverviewMap.prototype.handleToggle_ = function() {
if (!this.collapsed_ && !ovmap.isRendered()) {
ovmap.updateSize();
this.resetExtent_();
ol.events.listenOnce(ovmap, ol.MapEventType.POSTRENDER,
ol.events.listenOnce(ovmap, ol.MapEvent.Type.POSTRENDER,
function(event) {
this.updateBox_();
},

75
src/ol/interaction/extent.js
View File

@@ -1,6 +1,4 @@
goog.provide('ol.interaction.Extent');
goog.provide('ol.interaction.ExtentEvent');
goog.provide('ol.interaction.ExtentEventType');
goog.require('ol');
goog.require('ol.Feature');
@@ -18,40 +16,6 @@ goog.require('ol.source.Vector');
goog.require('ol.style.Style');
/**
* @enum {string}
*/
ol.interaction.ExtentEventType = {
/**
* Triggered after the extent is changed
* @event ol.interaction.ExtentEvent
* @api
*/
EXTENTCHANGED: 'extentchanged'
};
/**
* @classdesc
* Events emitted by {@link ol.interaction.Extent} instances are instances of
* this type.
*
* @constructor
* @param {ol.Extent} extent the new extent
* @extends {ol.events.Event}
*/
ol.interaction.ExtentEvent = function(extent) {
ol.events.Event.call(this, ol.interaction.ExtentEventType.EXTENTCHANGED);
/**
* The current extent.
* @type {ol.Extent}
* @api
*/
this.extent_ = extent;
};
ol.inherits(ol.interaction.ExtentEvent, ol.events.Event);
/**
* @classdesc
* Allows the user to draw a vector box by clicking and dragging on the map.
@@ -60,7 +24,7 @@ ol.inherits(ol.interaction.ExtentEvent, ol.events.Event);
*
* @constructor
* @extends {ol.interaction.Pointer}
* @fires ol.interaction.ExtentEvent
* @fires ol.interaction.Extent.Event
* @param {olx.interaction.ExtentOptions=} opt_options Options.
* @api
*/
@@ -473,5 +437,40 @@ ol.interaction.Extent.prototype.setExtent = function(extent) {
//Null extent means no bbox
this.extent_ = extent ? extent : null;
this.createOrUpdateExtentFeature_(extent);
this.dispatchEvent(new ol.interaction.ExtentEvent(this.extent_));
this.dispatchEvent(new ol.interaction.Extent.Event(this.extent_));
};
/**
* @classdesc
* Events emitted by {@link ol.interaction.Extent} instances are instances of
* this type.
*
* @constructor
* @param {ol.Extent} extent the new extent
* @extends {ol.events.Event}
*/
ol.interaction.Extent.Event = function(extent) {
ol.events.Event.call(this, ol.interaction.Extent.EventType.EXTENTCHANGED);
/**
* The current extent.
* @type {ol.Extent}
* @api
*/
this.extent_ = extent;
};
ol.inherits(ol.interaction.Extent.Event, ol.events.Event);
/**
* @enum {string}
*/
ol.interaction.Extent.EventType = {
/**
* Triggered after the extent is changed
* @event ol.interaction.Extent.Event
* @api
*/
EXTENTCHANGED: 'extentchanged'
};

133
src/ol/interaction/translate.js
View File

@@ -1,5 +1,4 @@
goog.provide('ol.interaction.Translate');
goog.provide('ol.interaction.TranslateEvent');
goog.require('ol');
goog.require('ol.events.Event');
@@ -8,72 +7,13 @@ goog.require('ol.array');
goog.require('ol.interaction.Pointer');
/**
* @enum {string}
*/
ol.interaction.TranslateEventType = {
/**
* Triggered upon feature translation start.
* @event ol.interaction.TranslateEvent#translatestart
* @api
*/
TRANSLATESTART: 'translatestart',
/**
* Triggered upon feature translation.
* @event ol.interaction.TranslateEvent#translating
* @api
*/
TRANSLATING: 'translating',
/**
* Triggered upon feature translation end.
* @event ol.interaction.TranslateEvent#translateend
* @api
*/
TRANSLATEEND: 'translateend'
};
/**
* @classdesc
* Events emitted by {@link ol.interaction.Translate} instances are instances of
* this type.
*
* @constructor
* @extends {ol.events.Event}
* @implements {oli.interaction.TranslateEvent}
* @param {ol.interaction.TranslateEventType} type Type.
* @param {ol.Collection.<ol.Feature>} features The features translated.
* @param {ol.Coordinate} coordinate The event coordinate.
*/
ol.interaction.TranslateEvent = function(type, features, coordinate) {
ol.events.Event.call(this, type);
/**
* The features being translated.
* @type {ol.Collection.<ol.Feature>}
* @api
*/
this.features = features;
/**
* The coordinate of the drag event.
* @const
* @type {ol.Coordinate}
* @api
*/
this.coordinate = coordinate;
};
ol.inherits(ol.interaction.TranslateEvent, ol.events.Event);
/**
* @classdesc
* Interaction for translating (moving) features.
*
* @constructor
* @extends {ol.interaction.Pointer}
* @fires ol.interaction.TranslateEvent
* @fires ol.interaction.Translate.Event
* @param {olx.interaction.TranslateOptions} options Options.
* @api
*/
@@ -149,8 +89,8 @@ ol.interaction.Translate.handleDownEvent_ = function(event) {
this.lastCoordinate_ = event.coordinate;
ol.interaction.Translate.handleMoveEvent_.call(this, event);
this.dispatchEvent(
new ol.interaction.TranslateEvent(
ol.interaction.TranslateEventType.TRANSLATESTART, this.features_,
new ol.interaction.Translate.Event(
ol.interaction.Translate.EventType.TRANSLATESTART, this.features_,
event.coordinate));
return true;
}
@@ -169,8 +109,8 @@ ol.interaction.Translate.handleUpEvent_ = function(event) {
this.lastCoordinate_ = null;
ol.interaction.Translate.handleMoveEvent_.call(this, event);
this.dispatchEvent(
new ol.interaction.TranslateEvent(
ol.interaction.TranslateEventType.TRANSLATEEND, this.features_,
new ol.interaction.Translate.Event(
ol.interaction.Translate.EventType.TRANSLATEEND, this.features_,
event.coordinate));
return true;
}
@@ -203,8 +143,8 @@ ol.interaction.Translate.handleDragEvent_ = function(event) {
this.lastCoordinate_ = newCoordinate;
this.dispatchEvent(
new ol.interaction.TranslateEvent(
ol.interaction.TranslateEventType.TRANSLATING, this.features_,
new ol.interaction.Translate.Event(
ol.interaction.Translate.EventType.TRANSLATING, this.features_,
newCoordinate));
}
};
@@ -261,3 +201,62 @@ ol.interaction.Translate.prototype.featuresAtPixel_ = function(pixel, map) {
return found;
};
/**
* @classdesc
* Events emitted by {@link ol.interaction.Translate} instances are instances of
* this type.
*
* @constructor
* @extends {ol.events.Event}
* @implements {oli.interaction.TranslateEvent}
* @param {ol.interaction.Translate.EventType} type Type.
* @param {ol.Collection.<ol.Feature>} features The features translated.
* @param {ol.Coordinate} coordinate The event coordinate.
*/
ol.interaction.Translate.Event = function(type, features, coordinate) {
ol.events.Event.call(this, type);
/**
* The features being translated.
* @type {ol.Collection.<ol.Feature>}
* @api
*/
this.features = features;
/**
* The coordinate of the drag event.
* @const
* @type {ol.Coordinate}
* @api
*/
this.coordinate = coordinate;
};
ol.inherits(ol.interaction.Translate.Event, ol.events.Event);
/**
* @enum {string}
*/
ol.interaction.Translate.EventType = {
/**
* Triggered upon feature translation start.
* @event ol.interaction.Translate.Event#translatestart
* @api
*/
TRANSLATESTART: 'translatestart',
/**
* Triggered upon feature translation.
* @event ol.interaction.Translate.Event#translating
* @api
*/
TRANSLATING: 'translating',
/**
* Triggered upon feature translation end.
* @event ol.interaction.Translate.Event#translateend
* @api
*/
TRANSLATEEND: 'translateend'
};

26
src/ol/layer/tile.js
View File

@@ -5,15 +5,6 @@ goog.require('ol.layer.Layer');
goog.require('ol.obj');
/**
* @enum {string}
*/
ol.layer.TileProperty = {
PRELOAD: 'preload',
USE_INTERIM_TILES_ON_ERROR: 'useInterimTilesOnError'
};
/**
* @classdesc
* For layer sources that provide pre-rendered, tiled images in grids that are
@@ -51,7 +42,7 @@ ol.inherits(ol.layer.Tile, ol.layer.Layer);
* @api
*/
ol.layer.Tile.prototype.getPreload = function() {
return /** @type {number} */ (this.get(ol.layer.TileProperty.PRELOAD));
return /** @type {number} */ (this.get(ol.layer.Tile.Property.PRELOAD));
};
@@ -71,7 +62,7 @@ ol.layer.Tile.prototype.getSource;
* @api
*/
ol.layer.Tile.prototype.setPreload = function(preload) {
this.set(ol.layer.TileProperty.PRELOAD, preload);
this.set(ol.layer.Tile.Property.PRELOAD, preload);
};
@@ -83,7 +74,7 @@ ol.layer.Tile.prototype.setPreload = function(preload) {
*/
ol.layer.Tile.prototype.getUseInterimTilesOnError = function() {
return /** @type {boolean} */ (
this.get(ol.layer.TileProperty.USE_INTERIM_TILES_ON_ERROR));
this.get(ol.layer.Tile.Property.USE_INTERIM_TILES_ON_ERROR));
};
@@ -95,5 +86,14 @@ ol.layer.Tile.prototype.getUseInterimTilesOnError = function() {
*/
ol.layer.Tile.prototype.setUseInterimTilesOnError = function(useInterimTilesOnError) {
this.set(
ol.layer.TileProperty.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
ol.layer.Tile.Property.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
};
/**
* @enum {string}
*/
ol.layer.Tile.Property = {
PRELOAD: 'preload',
USE_INTERIM_TILES_ON_ERROR: 'useInterimTilesOnError'
};

5
src/ol/layer/vectortile.js
View File

@@ -2,6 +2,7 @@ goog.provide('ol.layer.VectorTile');
goog.require('ol');
goog.require('ol.asserts');
goog.require('ol.layer.Tile');
goog.require('ol.layer.Vector');
goog.require('ol.obj');
@@ -94,7 +95,7 @@ ol.layer.VectorTile.prototype.getUseInterimTilesOnError = function() {
* @api
*/
ol.layer.VectorTile.prototype.setPreload = function(preload) {
this.set(ol.layer.TileProperty.PRELOAD, preload);
this.set(ol.layer.Tile.Property.PRELOAD, preload);
};
@@ -106,7 +107,7 @@ ol.layer.VectorTile.prototype.setPreload = function(preload) {
*/
ol.layer.VectorTile.prototype.setUseInterimTilesOnError = function(useInterimTilesOnError) {
this.set(
ol.layer.TileProperty.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
ol.layer.Tile.Property.USE_INTERIM_TILES_ON_ERROR, useInterimTilesOnError);
};

5
src/ol/map.js
View File

@@ -10,7 +10,6 @@ goog.require('ol.MapBrowserEvent');
goog.require('ol.MapBrowserEvent.EventType');
goog.require('ol.MapBrowserEventHandler');
goog.require('ol.MapEvent');
goog.require('ol.MapEventType');
goog.require('ol.Object');
goog.require('ol.ObjectEventType');
goog.require('ol.TileQueue');
@@ -1290,13 +1289,13 @@ ol.Map.prototype.renderFrame_ = function(time) {
if (idle) {
this.dispatchEvent(
new ol.MapEvent(ol.MapEventType.MOVEEND, this, frameState));
new ol.MapEvent(ol.MapEvent.Type.MOVEEND, this, frameState));
ol.extent.clone(frameState.extent, this.previousExtent_);
}
}
this.dispatchEvent(
new ol.MapEvent(ol.MapEventType.POSTRENDER, this, frameState));
new ol.MapEvent(ol.MapEvent.Type.POSTRENDER, this, frameState));
setTimeout(this.handlePostRender.bind(this), 0);

45
src/ol/mapevent.js
View File

@@ -1,32 +1,9 @@
goog.provide('ol.MapEvent');
goog.provide('ol.MapEventType');
goog.require('ol');
goog.require('ol.events.Event');
/**
* @enum {string}
*/
ol.MapEventType = {
/**
* Triggered after a map frame is rendered.
* @event ol.MapEvent#postrender
* @api
*/
POSTRENDER: 'postrender',
/**
* Triggered after the map is moved.
* @event ol.MapEvent#moveend
* @api stable
*/
MOVEEND: 'moveend'
};
/**
* @classdesc
* Events emitted as map events are instances of this type.
@@ -59,3 +36,25 @@ ol.MapEvent = function(type, map, opt_frameState) {
};
ol.inherits(ol.MapEvent, ol.events.Event);
/**
* @enum {string}
*/
ol.MapEvent.Type = {
/**
* Triggered after a map frame is rendered.
* @event ol.MapEvent#postrender
* @api
*/
POSTRENDER: 'postrender',
/**
* Triggered after the map is moved.
* @event ol.MapEvent#moveend
* @api stable
*/
MOVEEND: 'moveend'
};

4
src/ol/overlay.js
View File

@@ -1,7 +1,7 @@
goog.provide('ol.Overlay');
goog.require('ol');
goog.require('ol.MapEventType');
goog.require('ol.MapEvent');
goog.require('ol.Object');
goog.require('ol.animation');
goog.require('ol.dom');
@@ -237,7 +237,7 @@ ol.Overlay.prototype.handleMapChanged = function() {
var map = this.getMap();
if (map) {
this.mapPostrenderListenerKey_ = ol.events.listen(map,
ol.MapEventType.POSTRENDER, this.render, this);
ol.MapEvent.Type.POSTRENDER, this.render, this);
this.updatePixelPosition();
var container = this.stopEvent_ ?
map.getOverlayContainerStopEvent() : map.getOverlayContainer();

19
src/ol/source/image.js
View File

@@ -1,5 +1,4 @@
goog.provide('ol.source.Image');
goog.provide('ol.source.ImageEvent');
goog.require('ol');
goog.require('ol.Image');
@@ -150,17 +149,17 @@ ol.source.Image.prototype.handleImageChange = function(event) {
switch (image.getState()) {
case ol.Image.State.LOADING:
this.dispatchEvent(
new ol.source.ImageEvent(ol.source.ImageEventType.IMAGELOADSTART,
new ol.source.Image.Event(ol.source.Image.EventType.IMAGELOADSTART,
image));
break;
case ol.Image.State.LOADED:
this.dispatchEvent(
new ol.source.ImageEvent(ol.source.ImageEventType.IMAGELOADEND,
new ol.source.Image.Event(ol.source.Image.EventType.IMAGELOADEND,
image));
break;
case ol.Image.State.ERROR:
this.dispatchEvent(
new ol.source.ImageEvent(ol.source.ImageEventType.IMAGELOADERROR,
new ol.source.Image.Event(ol.source.Image.EventType.IMAGELOADERROR,
image));
break;
default:
@@ -191,7 +190,7 @@ ol.source.Image.defaultImageLoadFunction = function(image, src) {
* @param {string} type Type.
* @param {ol.Image} image The image.
*/
ol.source.ImageEvent = function(type, image) {
ol.source.Image.Event = function(type, image) {
ol.events.Event.call(this, type);
@@ -203,31 +202,31 @@ ol.source.ImageEvent = function(type, image) {
this.image = image;
};
ol.inherits(ol.source.ImageEvent, ol.events.Event);
ol.inherits(ol.source.Image.Event, ol.events.Event);
/**
* @enum {string}
*/
ol.source.ImageEventType = {
ol.source.Image.EventType = {
/**
* Triggered when an image starts loading.
* @event ol.source.ImageEvent#imageloadstart
* @event ol.source.Image.Event#imageloadstart
* @api
*/
IMAGELOADSTART: 'imageloadstart',
/**
* Triggered when an image finishes loading.
* @event ol.source.ImageEvent#imageloadend
* @event ol.source.Image.Event#imageloadend
* @api
*/
IMAGELOADEND: 'imageloadend',
/**
* Triggered if image loading results in an error.
* @event ol.source.ImageEvent#imageloaderror
* @event ol.source.Image.Event#imageloaderror
* @api
*/
IMAGELOADERROR: 'imageloaderror'

2
src/ol/source/imagearcgisrest.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.uri');
* {@link ol.source.TileArcGISRest} data source.
*
* @constructor
* @fires ol.source.ImageEvent
* @fires ol.source.Image.Event
* @extends {ol.source.Image}
* @param {olx.source.ImageArcGISRestOptions=} opt_options Image ArcGIS Rest Options.
* @api

2
src/ol/source/imagemapguide.js
View File

@@ -15,7 +15,7 @@ goog.require('ol.uri');
* Source for images from Mapguide servers
*
* @constructor
* @fires ol.source.ImageEvent
* @fires ol.source.Image.Event
* @extends {ol.source.Image}
* @param {olx.source.ImageMapGuideOptions} options Options.
* @api stable

2
src/ol/source/imagewms.js
View File

@@ -21,7 +21,7 @@ goog.require('ol.uri');
* Source for WMS servers providing single, untiled images.
*
* @constructor
* @fires ol.source.ImageEvent
* @fires ol.source.Image.Event
* @extends {ol.source.Image}
* @param {olx.source.ImageWMSOptions=} opt_options Options.
* @api stable