ccac3b6efa440ebc20f9846d7b962be6253415d8.svn-base 13 KB

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