123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284 |
- <div class="body-wrap">
- <div class="top-tools">
- <a class="inner-link" href="#Ext.dd.StatusProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
- <a class="inner-link" href="#Ext.dd.StatusProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
- <a class="inner-link" href="#Ext.dd.StatusProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
- <a class="inner-link" href="#Ext.dd.StatusProxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
- <a class="bookmark" href="../docs/?class=Ext.dd.StatusProxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
- </div>
- <h1>Class Ext.dd.StatusProxy</h1>
- <table cellspacing="0">
- <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
- <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StatusProxy.js" target="_blank">StatusProxy.js</a></td></tr>
- <tr><td class="label">Class:</td><td class="hd-info">StatusProxy</td></tr>
- <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
- </table>
- <div class="description">
- A specialized drag proxy that supports a drop status icon, <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> styles and auto-repair. This is the
- default drag proxy used by all Ext.dd components. </div>
-
- <div class="hr"></div>
- <a id="Ext.dd.StatusProxy-configs"></a>
- <h2>Config Options</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Config Options</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="config-row">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-dropAllowed"></a>
- <b>dropAllowed</b> : String <div class="mdesc">
- The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok"). </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="config-row alt">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-dropNotAllowed"></a>
- <b>dropNotAllowed</b> : String <div class="mdesc">
- The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- </table>
- <a id="Ext.dd.StatusProxy-props"></a>
- <h2>Public Properties</h2>
- <div class="no-members">This class has no public properties.</div> <a id="Ext.dd.StatusProxy-methods"></a>
- <h2>Public Methods</h2>
- <table cellspacing="0" class="member-table">
- <tr>
- <th class="sig-header" colspan="2">Method</th>
- <th class="msource-header">Defined By</th>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-StatusProxy"></a>
- <b>StatusProxy</b>( <code>Object config</code> ) <div class="mdesc">
- <div class="short"></div>
- <div class="long">
- <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code></code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-getEl"></a>
- <b>getEl</b>() : Ext.Layer <div class="mdesc">
- <div class="short">Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a></div>
- <div class="long">
- Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a> <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>Ext.Layer</code><div class="sub-desc">el</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-getGhost"></a>
- <b>getGhost</b>() : Ext.Element <div class="mdesc">
- <div class="short">Returns the ghost element</div>
- <div class="long">
- Returns the ghost element <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>Ext.Element</code><div class="sub-desc">el</div></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-hide"></a>
- <b>hide</b>( <code>Boolean clear</code> ) : void <div class="mdesc">
- <div class="short">Hides the proxy</div>
- <div class="long">
- Hides the proxy <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>clear</code> : Boolean<div class="sub-desc">True to reset the status and clear the ghost contents, false to preserve them</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-repair"></a>
- <b>repair</b>( <code>Array xy</code>, <code>Function callback</code>, <code>Object scope</code> ) : void <div class="mdesc">
- <div class="short">Causes the proxy to return to its position of origin via an animation. Should be called after an
- invalid drop operat...</div>
- <div class="long">
- 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. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>xy</code> : Array<div class="sub-desc">The XY position of the element ([x, y])</div></li><li><code>callback</code> : Function<div class="sub-desc">The function to call after the repair is complete</div></li><li><code>scope</code> : Object<div class="sub-desc">The scope in which to execute the callback</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-reset"></a>
- <b>reset</b>( <code>Boolean clearGhost</code> ) : void <div class="mdesc">
- <div class="short">Resets the status indicator to the default dropNotAllowed value</div>
- <div class="long">
- Resets the status indicator to the default dropNotAllowed value <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>clearGhost</code> : Boolean<div class="sub-desc">True to also remove all content from the ghost, false to preserve it</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-setStatus"></a>
- <b>setStatus</b>( <code>String cssClass</code> ) : void <div class="mdesc">
- <div class="short">Updates the proxy's visual element to indicate the status of whether or not drop is allowed
- over the current target e...</div>
- <div class="long">
- Updates the proxy's visual element to indicate the status of whether or not drop is allowed
- over the current target element. <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>cssClass</code> : String<div class="sub-desc">The css class for the new drop status indicator image</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-show"></a>
- <b>show</b>() : void <div class="mdesc">
- <div class="short">Displays this proxy</div>
- <div class="long">
- Displays this proxy <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-stop"></a>
- <b>stop</b>() : void <div class="mdesc">
- <div class="short">Stops the repair animation if it's currently running</div>
- <div class="long">
- Stops the repair animation if it's currently running <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row alt expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-sync"></a>
- <b>sync</b>() : void <div class="mdesc">
- <div class="short">Force the Layer to sync its shadow and shim positions to the element</div>
- <div class="long">
- Force the Layer to sync its shadow and shim positions to the element <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li>None.</li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- <tr class="method-row expandable">
- <td class="micon"><a class="exi" href="#expand"> </a></td>
- <td class="sig">
- <a id="Ext.dd.StatusProxy-update"></a>
- <b>update</b>( <code>String html</code> ) : void <div class="mdesc">
- <div class="short">Updates the contents of the ghost element</div>
- <div class="long">
- Updates the contents of the ghost element <div class="mdetail-params">
- <strong>Parameters:</strong>
- <ul><li><code>html</code> : String<div class="sub-desc">The html that will replace the current innerHTML of the ghost element</div></li> </ul>
- <strong>Returns:</strong>
- <ul>
- <li><code>void</code></li>
- </ul>
- </div>
- </div>
- </div>
- </td>
- <td class="msource">StatusProxy</td>
- </tr>
- </table>
- <a id="Ext.dd.StatusProxy-events"></a>
- <h2>Public Events</h2>
- <div class="no-members">This class has no public events.</div>
- </div>
|