From 6d59830d0ea412e0c3b289f4fbec7755dda61174 Mon Sep 17 00:00:00 2001 From: Tim Schaub Date: Tue, 11 Mar 2008 16:02:39 +0000 Subject: [PATCH] Documenting onModification* methods as deprecated in ModifyFeature control. git-svn-id: http://svn.openlayers.org/trunk/openlayers@6490 dc9f47b5-9b13-0410-9fdd-eb0c1a62fdaf --- lib/OpenLayers/Control/ModifyFeature.js | 18 +++++++++++++++--- 1 file changed, 15 insertions(+), 3 deletions(-) diff --git a/lib/OpenLayers/Control/ModifyFeature.js b/lib/OpenLayers/Control/ModifyFeature.js index 7c8a314a54..8bbd5d1ce3 100644 --- a/lib/OpenLayers/Control/ModifyFeature.js +++ b/lib/OpenLayers/Control/ModifyFeature.js @@ -131,7 +131,11 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, { /** * APIProperty: onModificationStart - * {Function} Optional function to be called when a feature is selected + * {Function} *Deprecated*. Register for "beforefeaturemodified" instead. + * The "beforefeaturemodified" event is triggered on the layer before + * any modification begins. + * + * Optional function to be called when a feature is selected * to be modified. The function should expect to be called with a * feature. This could be used for example to allow to lock the * feature on server-side. @@ -140,14 +144,22 @@ OpenLayers.Control.ModifyFeature = OpenLayers.Class(OpenLayers.Control, { /** * APIProperty: onModification - * {Function} Optional function to be called when a feature has been + * {Function} *Deprecated*. Register for "featuremodified" instead. + * The "featuremodified" event is triggered on the layer with each + * feature modification. + * + * Optional function to be called when a feature has been * modified. The function should expect to be called with a feature. */ onModification: function() {}, /** * APIProperty: onModificationEnd - * {Function} Optional function to be called when a feature is finished + * {Function} *Deprecated*. Register for "afterfeaturemodified" instead. + * The "afterfeaturemodified" event is triggered on the layer after + * a feature has been modified. + * + * Optional function to be called when a feature is finished * being modified. The function should expect to be called with a * feature. */