/**
+ * @class Ext.dd.StatusProxy
* A specialized drag proxy that supports a drop status icon, {@link Ext.Layer} styles and auto-repair. This is the
* default drag proxy used by all Ext.dd components.
- * @constructor
- * @param {Object} config
*/
Ext.define('Ext.dd.StatusProxy', {
animRepair: false,
+ /**
+ * Creates new StatusProxy.
+ * @param {Object} config (optional) Config object.
+ */
constructor: function(config){
Ext.apply(this, config);
this.id = this.id || Ext.id();
this.proxy = Ext.createWidget('component', {
floating: true,
+ stateful: false,
id: this.id,
html: '<div class="' + Ext.baseCSSPrefix + 'dd-drop-icon"></div>' +
'<div class="' + Ext.baseCSSPrefix + 'dd-drag-ghost"></div>',
@@ -23,24 +43,24 @@ Ext.define('Ext.dd.StatusProxy', {
this.el = this.proxy.el;
this.el.show();
- this.el.setVisibilityMode(Ext.core.Element.VISIBILITY);
+ this.el.setVisibilityMode(Ext.Element.VISIBILITY);
this.el.hide();
this.ghost = Ext.get(this.el.dom.childNodes[1]);
this.dropStatus = this.dropNotAllowed;
},
- /**
- * @cfg {String} dropAllowed
- * The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").
+ /**
+ * @cfg {String} [dropAllowed="x-dd-drop-ok"]
+ * The CSS class to apply to the status element when drop is allowed.
*/
dropAllowed : Ext.baseCSSPrefix + 'dd-drop-ok',
- /**
- * @cfg {String} dropNotAllowed
- * The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").
+ /**
+ * @cfg {String} [dropNotAllowed="x-dd-drop-nodrop"]
+ * The CSS class to apply to the status element when drop is not allowed.
*/
dropNotAllowed : Ext.baseCSSPrefix + 'dd-drop-nodrop',
- /**
+ /**
* Updates the proxy's visual element to indicate the status of whether or not drop is allowed
* over the current target element.
* @param {String} cssClass The css class for the new drop status indicator image
@@ -53,7 +73,7 @@ Ext.define('Ext.dd.StatusProxy', {
}
},
- /**
+ /**
* Resets the status indicator to the default dropNotAllowed value
* @param {Boolean} clearGhost True to also remove all content from the ghost, false to preserve it
*/
@@ -65,7 +85,7 @@ Ext.define('Ext.dd.StatusProxy', {
}
},
- /**
+ /**
* Updates the contents of the ghost element
* @param {String/HTMLElement} html The html that will replace the current innerHTML of the ghost element, or a
* DOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).
@@ -78,13 +98,13 @@ Ext.define('Ext.dd.StatusProxy', {
html.style.margin = "0";
this.ghost.dom.appendChild(html);
}
- var el = this.ghost.dom.firstChild;
+ var el = this.ghost.dom.firstChild;
if(el){
Ext.fly(el).setStyle('float', 'none');
}
},
- /**
+ /**
* Returns the underlying proxy {@link Ext.Layer}
* @return {Ext.Layer} el
*/
@@ -92,15 +112,15 @@ Ext.define('Ext.dd.StatusProxy', {
return this.el;
},
- /**
+ /**
* Returns the ghost element
- * @return {Ext.core.Element} el
+ * @return {Ext.Element} el
*/
getGhost : function(){
return this.ghost;
},
- /**
+ /**
* Hides the proxy
* @param {Boolean} clear True to reset the status and clear the ghost contents, false to preserve them
*/
@@ -111,7 +131,7 @@ Ext.define('Ext.dd.StatusProxy', {
}
},
- /**
+ /**
* Stops the repair animation if it's currently running
*/
stop : function(){
@@ -120,7 +140,7 @@ Ext.define('Ext.dd.StatusProxy', {
}
},
- /**
+ /**
* Displays this proxy
*/
show : function() {
@@ -128,17 +148,17 @@ Ext.define('Ext.dd.StatusProxy', {
this.proxy.toFront();
},
- /**
+ /**
* Force the Layer to sync its shadow and shim positions to the element
*/
sync : function(){
this.proxy.el.sync();
},
- /**
+ /**
* Causes the proxy to return to its position of origin via an animation. Should be called after an
* invalid drop operation by the item being dragged.
- * @param {Array} xy The XY position of the element ([x, y])
+ * @param {Number[]} xy The XY position of the element ([x, y])
* @param {Function} callback The function to call after the repair is complete.
* @param {Object} scope The scope (<code>this</code> reference) in which the callback function is executed. Defaults to the browser window.
*/
@@ -177,4 +197,6 @@ Ext.define('Ext.dd.StatusProxy', {
destroy: function(){
Ext.destroy(this.ghost, this.proxy, this.el);
}
-});