Sencha Documentation

Ext.dd.StatusProxy

Overview
A specialized drag proxy that supports a drop status icon, Ext.Layer styles and auto-repair. This is the default drag proxy used by all Ext.dd components.

Config Options

 
dropAllowed : String
The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").
The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").
 
dropNotAllowed : String
The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").
The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").

Methods

 
getEl : Ext.Layer
Returns the underlying proxy Ext.Layer
Returns the underlying proxy Ext.Layer
 
getGhost : Ext.core.Element
Returns the ghost element
Returns the ghost element
 
hide( Boolean clear ) : Void
Hides the proxy
Hides the proxy

Parameters

  • clear : Boolean
    True to reset the status and clear the ghost contents, false to preserve them

Returns

  • Void
 
repair( Array xy, Function callback, Object scope ) : Void
Causes the proxy to return to its position of origin via an animation. Should be called after an invalid drop operat...
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.

Parameters

  • xy : Array
    The XY position of the element ([x, y])
  • callback : Function
    The function to call after the repair is complete.
  • scope : Object
    The scope (this reference) in which the callback function is executed. Defaults to the browser window.

Returns

  • Void
 
reset( Boolean clearGhost ) : Void
Resets the status indicator to the default dropNotAllowed value
Resets the status indicator to the default dropNotAllowed value

Parameters

  • clearGhost : Boolean
    True to also remove all content from the ghost, false to preserve it

Returns

  • Void
 
setStatus( String cssClass ) : Void
Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target e...
Updates the proxy's visual element to indicate the status of whether or not drop is allowed over the current target element.

Parameters

  • cssClass : String
    The css class for the new drop status indicator image

Returns

  • Void
 
show : Void
Displays this proxy
Displays this proxy
 
stop : Void
Stops the repair animation if it's currently running
Stops the repair animation if it's currently running
 
sync : Void
Force the Layer to sync its shadow and shim positions to the element
Force the Layer to sync its shadow and shim positions to the element
 
update( String/HTMLElement html ) : Void
Updates the contents of the ghost element
Updates the contents of the ghost element

Parameters

  • html : String/HTMLElement
    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).

Returns

  • Void
© 2011 Sencha Inc.