/**
* @class Ext.dd.DragSource
* @extends Ext.dd.DDProxy
* A simple class that provides the basic implementation needed to make any element draggable.
@@ -13,31 +30,31 @@ Ext.define('Ext.dd.DragSource', {
'Ext.dd.DragDropManager'
],
- /**
+ /**
* @cfg {String} ddGroup
* A named drag drop group to which this object belongs. If a group is specified, then this object will only
* interact with other drag drop objects in the same group (defaults to undefined).
*/
- /**
+ /**
* @cfg {String} dropAllowed
* The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").
*/
dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok',
- /**
+ /**
* @cfg {String} dropNotAllowed
* The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").
*/
dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop',
- /**
+ /**
* @cfg {Boolean} animRepair
* Defaults to true. If true, animates the proxy element back to the position of the handle element used to trigger the drag.
*/
animRepair: true,
- /**
+ /**
* @cfg {String} repairHighlightColor The color to use when visually highlighting the drag source in the afterRepair
* method after a failed drop (defaults to 'c3daf9' - light blue). The color must be a 6 digit hex value, without
* a preceding '#'.
@@ -63,7 +80,7 @@ Ext.define('Ext.dd.DragSource', {
this.dragging = false;
},
- /**
+ /**
* Returns the data object associated with this drag source
* @return {Object} data An object containing arbitrary data
*/
@@ -84,7 +101,7 @@ Ext.define('Ext.dd.DragSource', {
}
if (this.afterDragEnter) {
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* when the dragged item enters the drop target by providing an implementation.
* @param {Ext.dd.DragDrop} target The drop target
@@ -97,7 +114,7 @@ Ext.define('Ext.dd.DragSource', {
}
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* before the dragged item enters the drop target and optionally cancel the onDragEnter.
* @param {Ext.dd.DragDrop} target The drop target
@@ -125,7 +142,7 @@ Ext.define('Ext.dd.DragSource', {
}
if (this.afterDragOver) {
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* while the dragged item is over the drop target by providing an implementation.
* @param {Ext.dd.DragDrop} target The drop target
@@ -138,7 +155,7 @@ Ext.define('Ext.dd.DragSource', {
}
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* while the dragged item is over the drop target and optionally cancel the onDragOver.
* @param {Ext.dd.DragDrop} target The drop target
@@ -159,7 +176,7 @@ Ext.define('Ext.dd.DragSource', {
}
this.proxy.reset();
if (this.afterDragOut) {
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* after the dragged item is dragged out of the target without dropping.
* @param {Ext.dd.DragDrop} target The drop target
@@ -173,7 +190,7 @@ Ext.define('Ext.dd.DragSource', {
this.cachedTarget = null;
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action before the dragged
* item is dragged out of the target without dropping, and optionally cancel the onDragOut.
* @param {Ext.dd.DragDrop} target The drop target
@@ -200,7 +217,7 @@ Ext.define('Ext.dd.DragSource', {
}
if (this.afterDragDrop) {
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* after a valid drag drop has occurred by providing an implementation.
* @param {Ext.dd.DragDrop} target The drop target
@@ -214,7 +231,7 @@ Ext.define('Ext.dd.DragSource', {
delete this.cachedTarget;
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action before the dragged
* item is dropped onto the target and optionally cancel the onDragDrop.
* @param {Ext.dd.DragDrop} target The drop target
@@ -230,7 +247,7 @@ Ext.define('Ext.dd.DragSource', {
onValidDrop: function(target, e, id){
this.hideProxy();
if(this.afterValidDrop){
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* after a valid drop has occurred by providing an implementation.
* @param {Object} target The target DD
@@ -259,7 +276,7 @@ Ext.define('Ext.dd.DragSource', {
this.proxy.repair(this.getRepairXY(e, this.dragData), this.afterRepair, this);
if (this.afterInvalidDrop) {
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action
* after an invalid drop has occurred by providing an implementation.
* @param {Event} e The event object
@@ -279,7 +296,7 @@ Ext.define('Ext.dd.DragSource', {
me.dragging = false;
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action after an invalid
* drop has occurred.
* @param {Ext.dd.DragDrop} target The drop target
@@ -304,7 +321,7 @@ Ext.define('Ext.dd.DragSource', {
}
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action before the initial
* drag event begins and optionally cancel it.
* @param {Object} data An object containing arbitrary data to be shared with drop targets
@@ -315,11 +332,12 @@ Ext.define('Ext.dd.DragSource', {
return true;
},
- /**
+ /**
* An empty function by default, but provided so that you can perform a custom action once the initial
* drag event has begun. The drag cannot be canceled from this function.
* @param {Number} x The x position of the click on the dragged object
* @param {Number} y The y position of the click on the dragged object
+ * @method
*/
onStartDrag: Ext.emptyFn,
@@ -341,7 +359,7 @@ Ext.define('Ext.dd.DragSource', {
return true;
},
- /**
+ /**
* Returns the drag source's underlying {@link Ext.dd.StatusProxy}
* @return {Ext.dd.StatusProxy} proxy The StatusProxy
*/
@@ -349,7 +367,7 @@ Ext.define('Ext.dd.DragSource', {
return this.proxy;
},
- /**
+ /**
* Hides the drag source's {@link Ext.dd.StatusProxy}
*/
hideProxy: function() {
@@ -386,4 +404,6 @@ Ext.define('Ext.dd.DragSource', {
Ext.destroy(this.proxy);
}
});
-