docs/output/Ext.dd.StatusProxy.html

   1         <div class="body-wrap">
   2         <div class="top-tools">
   3             <a class="inner-link" href="#Ext.dd.StatusProxy-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
   4             <a class="inner-link" href="#Ext.dd.StatusProxy-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
   5             <a class="inner-link" href="#Ext.dd.StatusProxy-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
   6                             <a class="inner-link" href="#Ext.dd.StatusProxy-configs"><img src="../resources/images/default/s.gif" class="item-icon icon-config">Config Options</a>
   7                         <a class="bookmark" href="../docs/?class=Ext.dd.StatusProxy"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
   8         </div>
   9                 <h1>Class Ext.dd.StatusProxy</h1>
  10         <table cellspacing="0">
  11             <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
  12             <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/StatusProxy.js" target="_blank">StatusProxy.js</a></td></tr>
  13             <tr><td class="label">Class:</td><td class="hd-info">StatusProxy</td></tr>
  14                                     <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  15                     </table>
  16         <div class="description">
  17             *
  18 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
  19 default drag proxy used by all Ext.dd components.        </div>
  20
  21         <div class="hr"></div>
  22                 <a id="Ext.dd.StatusProxy-configs"></a>
  23         <h2>Config Options</h2>
  24         <table cellspacing="0" class="member-table">
  25             <tr>
  26                 <th class="sig-header" colspan="2">Config Options</th>
  27                 <th class="msource-header">Defined By</th>
  28             </tr>
  29                 <tr class="config-row">\r
  30         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  31         <td class="sig">\r
  32         <a id="Ext.dd.StatusProxy-dropAllowed"></a>\r
  33             <b>dropAllowed</b> : String            <div class="mdesc">\r
  34                             The CSS class to apply to the status element when drop is allowed (defaults to "x-dd-drop-ok").                        </div>\r
  35         </td>\r
  36         <td class="msource">StatusProxy</td>\r
  37     </tr>\r
  38         <tr class="config-row alt">\r
  39         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  40         <td class="sig">\r
  41         <a id="Ext.dd.StatusProxy-dropNotAllowed"></a>\r
  42             <b>dropNotAllowed</b> : String            <div class="mdesc">\r
  43                             The CSS class to apply to the status element when drop is not allowed (defaults to "x-dd-drop-nodrop").                        </div>\r
  44         </td>\r
  45         <td class="msource">StatusProxy</td>\r
  46     </tr>\r
  47             </table>
  48                 <a id="Ext.dd.StatusProxy-props"></a>
  49         <h2>Public Properties</h2>
  50         <div class="no-members">This class has no public properties.</div>        <a id="Ext.dd.StatusProxy-methods"></a>
  51         <h2>Public Methods</h2>
  52                 <table cellspacing="0" class="member-table">
  53             <tr>
  54                 <th class="sig-header" colspan="2">Method</th>
  55                 <th class="msource-header">Defined By</th>
  56             </tr>
  57                 <tr class="method-row expandable">\r
  58         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  59         <td class="sig">\r
  60         <a id="Ext.dd.StatusProxy-StatusProxy"></a>\r
  61             <b>StatusProxy</b>(&nbsp;<code>Object config</code>&nbsp;)            <div class="mdesc">\r
  62                         <div class="short"></div>\r
  63             <div class="long">\r
  64                     <div class="mdetail-params">\r
  65         <strong>Parameters:</strong>\r
  66         <ul><li><code>config</code> : Object<div class="sub-desc"></div></li>        </ul>\r
  67         <strong>Returns:</strong>\r
  68         <ul>\r
  69             <li><code></code></li>\r
  70         </ul>\r
  71     </div>\r
  72                 </div>\r
  73                         </div>\r
  74         </td>\r
  75         <td class="msource">StatusProxy</td>\r
  76     </tr>\r
  77         <tr class="method-row alt expandable">\r
  78         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  79         <td class="sig">\r
  80         <a id="Ext.dd.StatusProxy-getEl"></a>\r
  81             <b>getEl</b>() : Ext.Layer            <div class="mdesc">\r
  82                         <div class="short">Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a></div>\r
  83             <div class="long">\r
  84                 Returns the underlying proxy <a ext:cls="Ext.Layer" href="output/Ext.Layer.html">Ext.Layer</a>    <div class="mdetail-params">\r
  85         <strong>Parameters:</strong>\r
  86         <ul><li>None.</li>        </ul>\r
  87         <strong>Returns:</strong>\r
  88         <ul>\r
  89             <li><code>Ext.Layer</code><div class="sub-desc">el</div></li>\r
  90         </ul>\r
  91     </div>\r
  92                 </div>\r
  93                         </div>\r
  94         </td>\r
  95         <td class="msource">StatusProxy</td>\r
  96     </tr>\r
  97         <tr class="method-row expandable">\r
  98         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
  99         <td class="sig">\r
 100         <a id="Ext.dd.StatusProxy-getGhost"></a>\r
 101             <b>getGhost</b>() : Ext.Element            <div class="mdesc">\r
 102                         <div class="short">Returns the ghost element</div>\r
 103             <div class="long">\r
 104                 Returns the ghost element    <div class="mdetail-params">\r
 105         <strong>Parameters:</strong>\r
 106         <ul><li>None.</li>        </ul>\r
 107         <strong>Returns:</strong>\r
 108         <ul>\r
 109             <li><code>Ext.Element</code><div class="sub-desc">el</div></li>\r
 110         </ul>\r
 111     </div>\r
 112                 </div>\r
 113                         </div>\r
 114         </td>\r
 115         <td class="msource">StatusProxy</td>\r
 116     </tr>\r
 117         <tr class="method-row alt expandable">\r
 118         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 119         <td class="sig">\r
 120         <a id="Ext.dd.StatusProxy-hide"></a>\r
 121             <b>hide</b>(&nbsp;<code>Boolean clear</code>&nbsp;) : void            <div class="mdesc">\r
 122                         <div class="short">Hides the proxy</div>\r
 123             <div class="long">\r
 124                 Hides the proxy    <div class="mdetail-params">\r
 125         <strong>Parameters:</strong>\r
 126         <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>\r
 127         <strong>Returns:</strong>\r
 128         <ul>\r
 129             <li><code>void</code></li>\r
 130         </ul>\r
 131     </div>\r
 132                 </div>\r
 133                         </div>\r
 134         </td>\r
 135         <td class="msource">StatusProxy</td>\r
 136     </tr>\r
 137         <tr class="method-row expandable">\r
 138         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 139         <td class="sig">\r
 140         <a id="Ext.dd.StatusProxy-repair"></a>\r
 141             <b>repair</b>(&nbsp;<code>Array xy</code>, <code>Function callback</code>, <code>Object scope</code>&nbsp;) : void            <div class="mdesc">\r
 142                         <div class="short">Causes the proxy to return to its position of origin via an animation.  Should be called after an
 143 invalid drop operat...</div>\r
 144             <div class="long">\r
 145                 Causes the proxy to return to its position of origin via an animation.  Should be called after an
 146 invalid drop operation by the item being dragged.    <div class="mdetail-params">\r
 147         <strong>Parameters:</strong>\r
 148         <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>\r
 149         <strong>Returns:</strong>\r
 150         <ul>\r
 151             <li><code>void</code></li>\r
 152         </ul>\r
 153     </div>\r
 154                 </div>\r
 155                         </div>\r
 156         </td>\r
 157         <td class="msource">StatusProxy</td>\r
 158     </tr>\r
 159         <tr class="method-row alt expandable">\r
 160         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 161         <td class="sig">\r
 162         <a id="Ext.dd.StatusProxy-reset"></a>\r
 163             <b>reset</b>(&nbsp;<code>Boolean clearGhost</code>&nbsp;) : void            <div class="mdesc">\r
 164                         <div class="short">Resets the status indicator to the default dropNotAllowed value</div>\r
 165             <div class="long">\r
 166                 Resets the status indicator to the default dropNotAllowed value    <div class="mdetail-params">\r
 167         <strong>Parameters:</strong>\r
 168         <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>\r
 169         <strong>Returns:</strong>\r
 170         <ul>\r
 171             <li><code>void</code></li>\r
 172         </ul>\r
 173     </div>\r
 174                 </div>\r
 175                         </div>\r
 176         </td>\r
 177         <td class="msource">StatusProxy</td>\r
 178     </tr>\r
 179         <tr class="method-row expandable">\r
 180         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 181         <td class="sig">\r
 182         <a id="Ext.dd.StatusProxy-setStatus"></a>\r
 183             <b>setStatus</b>(&nbsp;<code>String cssClass</code>&nbsp;) : void            <div class="mdesc">\r
 184                         <div class="short">Updates the proxy's visual element to indicate the status of whether or not drop is allowed
 185 over the current target e...</div>\r
 186             <div class="long">\r
 187                 Updates the proxy's visual element to indicate the status of whether or not drop is allowed
 188 over the current target element.    <div class="mdetail-params">\r
 189         <strong>Parameters:</strong>\r
 190         <ul><li><code>cssClass</code> : String<div class="sub-desc">The css class for the new drop status indicator image</div></li>        </ul>\r
 191         <strong>Returns:</strong>\r
 192         <ul>\r
 193             <li><code>void</code></li>\r
 194         </ul>\r
 195     </div>\r
 196                 </div>\r
 197                         </div>\r
 198         </td>\r
 199         <td class="msource">StatusProxy</td>\r
 200     </tr>\r
 201         <tr class="method-row alt expandable">\r
 202         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 203         <td class="sig">\r
 204         <a id="Ext.dd.StatusProxy-show"></a>\r
 205             <b>show</b>() : void            <div class="mdesc">\r
 206                         <div class="short">Displays this proxy</div>\r
 207             <div class="long">\r
 208                 Displays this proxy    <div class="mdetail-params">\r
 209         <strong>Parameters:</strong>\r
 210         <ul><li>None.</li>        </ul>\r
 211         <strong>Returns:</strong>\r
 212         <ul>\r
 213             <li><code>void</code></li>\r
 214         </ul>\r
 215     </div>\r
 216                 </div>\r
 217                         </div>\r
 218         </td>\r
 219         <td class="msource">StatusProxy</td>\r
 220     </tr>\r
 221         <tr class="method-row expandable">\r
 222         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 223         <td class="sig">\r
 224         <a id="Ext.dd.StatusProxy-stop"></a>\r
 225             <b>stop</b>() : void            <div class="mdesc">\r
 226                         <div class="short">Stops the repair animation if it's currently running</div>\r
 227             <div class="long">\r
 228                 Stops the repair animation if it's currently running    <div class="mdetail-params">\r
 229         <strong>Parameters:</strong>\r
 230         <ul><li>None.</li>        </ul>\r
 231         <strong>Returns:</strong>\r
 232         <ul>\r
 233             <li><code>void</code></li>\r
 234         </ul>\r
 235     </div>\r
 236                 </div>\r
 237                         </div>\r
 238         </td>\r
 239         <td class="msource">StatusProxy</td>\r
 240     </tr>\r
 241         <tr class="method-row alt expandable">\r
 242         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 243         <td class="sig">\r
 244         <a id="Ext.dd.StatusProxy-sync"></a>\r
 245             <b>sync</b>() : void            <div class="mdesc">\r
 246                         <div class="short">Force the Layer to sync its shadow and shim positions to the element</div>\r
 247             <div class="long">\r
 248                 Force the Layer to sync its shadow and shim positions to the element    <div class="mdetail-params">\r
 249         <strong>Parameters:</strong>\r
 250         <ul><li>None.</li>        </ul>\r
 251         <strong>Returns:</strong>\r
 252         <ul>\r
 253             <li><code>void</code></li>\r
 254         </ul>\r
 255     </div>\r
 256                 </div>\r
 257                         </div>\r
 258         </td>\r
 259         <td class="msource">StatusProxy</td>\r
 260     </tr>\r
 261         <tr class="method-row expandable">\r
 262         <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>\r
 263         <td class="sig">\r
 264         <a id="Ext.dd.StatusProxy-update"></a>\r
 265             <b>update</b>(&nbsp;<code>String/HTMLElement html</code>&nbsp;) : void            <div class="mdesc">\r
 266                         <div class="short">Updates the contents of the ghost element</div>\r
 267             <div class="long">\r
 268                 Updates the contents of the ghost element    <div class="mdetail-params">\r
 269         <strong>Parameters:</strong>\r
 270         <ul><li><code>html</code> : String/HTMLElement<div class="sub-desc">The html that will replace the current innerHTML of the ghost element, or a
 271 DOM node to append as the child of the ghost element (in which case the innerHTML will be cleared first).</div></li>        </ul>\r
 272         <strong>Returns:</strong>\r
 273         <ul>\r
 274             <li><code>void</code></li>\r
 275         </ul>\r
 276     </div>\r
 277                 </div>\r
 278                         </div>\r
 279         </td>\r
 280         <td class="msource">StatusProxy</td>\r
 281     </tr>\r
 282             </table>
 283                 <a id="Ext.dd.StatusProxy-events"></a>
 284         <h2>Public Events</h2>
 285         <div class="no-members">This class has no public events.</div>
 286         </div>