Merge pull request #2229 from tsauerwein/stable

Add stable tags to interactions
This commit is contained in:
Éric Lemoine
2014-07-04 06:31:13 +02:00
16 changed files with 28 additions and 28 deletions

View File

@@ -14,7 +14,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options. * @param {olx.interaction.DoubleClickZoomOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DoubleClickZoom = function(opt_options) { ol.interaction.DoubleClickZoom = function(opt_options) {

View File

@@ -23,7 +23,7 @@ goog.require('ol.proj');
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @fires ol.interaction.DragAndDropEvent * @fires ol.interaction.DragAndDropEvent
* @param {olx.interaction.DragAndDropOptions=} opt_options Options. * @param {olx.interaction.DragAndDropOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragAndDrop = function(opt_options) { ol.interaction.DragAndDrop = function(opt_options) {
@@ -184,7 +184,7 @@ ol.interaction.DragAndDropEventType = {
/** /**
* Triggered when features are added * Triggered when features are added
* @event ol.interaction.DragAndDropEvent#addfeatures * @event ol.interaction.DragAndDropEvent#addfeatures
* @todo api * @todo api stable
*/ */
ADD_FEATURES: 'addfeatures' ADD_FEATURES: 'addfeatures'
}; };
@@ -208,13 +208,13 @@ ol.interaction.DragAndDropEvent =
/** /**
* @type {Array.<ol.Feature>|undefined} * @type {Array.<ol.Feature>|undefined}
* @todo api * @todo api stable
*/ */
this.features = opt_features; this.features = opt_features;
/** /**
* @type {File} * @type {File}
* @todo api * @todo api stable
*/ */
this.file = file; this.file = file;

View File

@@ -28,13 +28,13 @@ ol.DragBoxEventType = {
/** /**
* Triggered upon drag box start. * Triggered upon drag box start.
* @event ol.DragBoxEvent#boxstart * @event ol.DragBoxEvent#boxstart
* @todo api * @todo api stable
*/ */
BOXSTART: 'boxstart', BOXSTART: 'boxstart',
/** /**
* Triggered upon drag box end. * Triggered upon drag box end.
* @event ol.DragBoxEvent#boxend * @event ol.DragBoxEvent#boxend
* @todo api * @todo api stable
*/ */
BOXEND: 'boxend' BOXEND: 'boxend'
}; };
@@ -58,7 +58,7 @@ ol.DragBoxEvent = function(type, coordinate) {
* The coordinate of the drag event. * The coordinate of the drag event.
* @const * @const
* @type {ol.Coordinate} * @type {ol.Coordinate}
* @todo api * @todo api stable
*/ */
this.coordinate = coordinate; this.coordinate = coordinate;
@@ -79,7 +79,7 @@ goog.inherits(ol.DragBoxEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires ol.DragBoxEvent * @fires ol.DragBoxEvent
* @param {olx.interaction.DragBoxOptions=} opt_options Options. * @param {olx.interaction.DragBoxOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragBox = function(opt_options) { ol.interaction.DragBox = function(opt_options) {
@@ -131,7 +131,7 @@ ol.interaction.DragBox.prototype.handlePointerDrag = function(mapBrowserEvent) {
/** /**
* Returns geometry of last drawn box. * Returns geometry of last drawn box.
* @return {ol.geom.Geometry} Geometry. * @return {ol.geom.Geometry} Geometry.
* @todo api * @todo api stable
*/ */
ol.interaction.DragBox.prototype.getGeometry = function() { ol.interaction.DragBox.prototype.getGeometry = function() {
return this.box_.getGeometry(); return this.box_.getGeometry();

View File

@@ -18,7 +18,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragPanOptions=} opt_options Options. * @param {olx.interaction.DragPanOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragPan = function(opt_options) { ol.interaction.DragPan = function(opt_options) {

View File

@@ -25,7 +25,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options. * @param {olx.interaction.DragRotateAndZoomOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragRotateAndZoom = function(opt_options) { ol.interaction.DragRotateAndZoom = function(opt_options) {

View File

@@ -21,7 +21,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.DragRotateOptions=} opt_options Options. * @param {olx.interaction.DragRotateOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragRotate = function(opt_options) { ol.interaction.DragRotate = function(opt_options) {

View File

@@ -20,7 +20,7 @@ goog.require('ol.style.Style');
* @constructor * @constructor
* @extends {ol.interaction.DragBox} * @extends {ol.interaction.DragBox}
* @param {olx.interaction.DragZoomOptions=} opt_options Options. * @param {olx.interaction.DragZoomOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.DragZoom = function(opt_options) { ol.interaction.DragZoom = function(opt_options) {
var options = goog.isDef(opt_options) ? opt_options : {}; var options = goog.isDef(opt_options) ? opt_options : {};

View File

@@ -30,13 +30,13 @@ ol.DrawEventType = {
/** /**
* Triggered upon feature draw start * Triggered upon feature draw start
* @event ol.DrawEvent#drawstart * @event ol.DrawEvent#drawstart
* @todo api * @todo api stable
*/ */
DRAWSTART: 'drawstart', DRAWSTART: 'drawstart',
/** /**
* Triggered upon feature draw end * Triggered upon feature draw end
* @event ol.DrawEvent#drawend * @event ol.DrawEvent#drawend
* @todo api * @todo api stable
*/ */
DRAWEND: 'drawend' DRAWEND: 'drawend'
}; };
@@ -57,7 +57,7 @@ ol.DrawEvent = function(type, feature) {
/** /**
* The feature being drawn. * The feature being drawn.
* @type {ol.Feature} * @type {ol.Feature}
* @todo api * @todo api stable
*/ */
this.feature = feature; this.feature = feature;
@@ -74,7 +74,7 @@ goog.inherits(ol.DrawEvent, goog.events.Event);
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @fires ol.DrawEvent * @fires ol.DrawEvent
* @param {olx.interaction.DrawOptions} options Options. * @param {olx.interaction.DrawOptions} options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.Draw = function(options) { ol.interaction.Draw = function(options) {

View File

@@ -35,7 +35,7 @@ goog.require('ol.interaction.PinchZoom');
* @param {olx.interaction.DefaultsOptions=} opt_options Defaults options. * @param {olx.interaction.DefaultsOptions=} opt_options Defaults options.
* @return {ol.Collection} A collection of interactions to be used with * @return {ol.Collection} A collection of interactions to be used with
* the ol.Map constructor's interactions option. * the ol.Map constructor's interactions option.
* @todo api * @todo api stable
*/ */
ol.interaction.defaults = function(opt_options) { ol.interaction.defaults = function(opt_options) {

View File

@@ -27,7 +27,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.KeyboardPanOptions=} opt_options Options. * @param {olx.interaction.KeyboardPanOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.KeyboardPan = function(opt_options) { ol.interaction.KeyboardPan = function(opt_options) {

View File

@@ -23,7 +23,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @param {olx.interaction.KeyboardZoomOptions=} opt_options Options. * @param {olx.interaction.KeyboardZoomOptions=} opt_options Options.
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @todo api * @todo api stable
*/ */
ol.interaction.KeyboardZoom = function(opt_options) { ol.interaction.KeyboardZoom = function(opt_options) {

View File

@@ -43,7 +43,7 @@ ol.interaction.SegmentDataType;
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.ModifyOptions} options Options. * @param {olx.interaction.ModifyOptions} options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.Modify = function(options) { ol.interaction.Modify = function(options) {

View File

@@ -17,7 +17,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options. * @param {olx.interaction.MouseWheelZoomOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.MouseWheelZoom = function(opt_options) { ol.interaction.MouseWheelZoom = function(opt_options) {

View File

@@ -18,7 +18,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchRotateOptions=} opt_options Options. * @param {olx.interaction.PinchRotateOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.PinchRotate = function(opt_options) { ol.interaction.PinchRotate = function(opt_options) {

View File

@@ -17,7 +17,7 @@ goog.require('ol.interaction.Pointer');
* @constructor * @constructor
* @extends {ol.interaction.Pointer} * @extends {ol.interaction.Pointer}
* @param {olx.interaction.PinchZoomOptions=} opt_options Options. * @param {olx.interaction.PinchZoomOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.PinchZoom = function(opt_options) { ol.interaction.PinchZoom = function(opt_options) {

View File

@@ -24,7 +24,7 @@ goog.require('ol.interaction.Interaction');
* @constructor * @constructor
* @extends {ol.interaction.Interaction} * @extends {ol.interaction.Interaction}
* @param {olx.interaction.SelectOptions=} opt_options Options. * @param {olx.interaction.SelectOptions=} opt_options Options.
* @todo api * @todo api stable
*/ */
ol.interaction.Select = function(opt_options) { ol.interaction.Select = function(opt_options) {
@@ -107,7 +107,7 @@ goog.inherits(ol.interaction.Select, ol.interaction.Interaction);
/** /**
* Get the selected features. * Get the selected features.
* @return {ol.Collection} Features collection. * @return {ol.Collection} Features collection.
* @todo api * @todo api stable
*/ */
ol.interaction.Select.prototype.getFeatures = function() { ol.interaction.Select.prototype.getFeatures = function() {
return this.featureOverlay_.getFeatures(); return this.featureOverlay_.getFeatures();
@@ -187,7 +187,7 @@ ol.interaction.Select.prototype.handleMapBrowserEvent =
* Remove the interaction from its current map, if any, and attach it to a new * Remove the interaction from its current map, if any, and attach it to a new
* map, if any. Pass `null` to just remove the interaction from the current map. * map, if any. Pass `null` to just remove the interaction from the current map.
* @param {ol.Map} map Map. * @param {ol.Map} map Map.
* @todo api * @todo api stable
*/ */
ol.interaction.Select.prototype.setMap = function(map) { ol.interaction.Select.prototype.setMap = function(map) {
var currentMap = this.getMap(); var currentMap = this.getMap();