c83a586dca17e504c7c989d3b86befa50d070aa0.svn-base 82 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425
  1. <div class="body-wrap">
  2. <div class="top-tools">
  3. <a class="inner-link" href="#Ext.dd.DropZone-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
  4. <a class="inner-link" href="#Ext.dd.DropZone-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
  5. <a class="inner-link" href="#Ext.dd.DropZone-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
  6. <a class="inner-link" href="#Ext.dd.DropZone-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.DropZone"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
  8. </div>
  9. <div class="inheritance res-block">
  10. <pre class="res-block-inner"><a ext:cls="Ext.dd.DragDrop" ext:member="" href="output/Ext.dd.DragDrop.html">DragDrop</a>
  11. <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DDTarget" ext:member="" href="output/Ext.dd.DDTarget.html">DDTarget</a>
  12. <img src="resources/elbow-end.gif"/><a ext:cls="Ext.dd.DropTarget" ext:member="" href="output/Ext.dd.DropTarget.html">DropTarget</a>
  13. <img src="resources/elbow-end.gif"/>DropZone</pre></div>
  14. <h1>Class Ext.dd.DropZone</h1>
  15. <table cellspacing="0">
  16. <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
  17. <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DropZone.js" target="_blank">DropZone.js</a></td></tr>
  18. <tr><td class="label">Class:</td><td class="hd-info">DropZone</td></tr>
  19. <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.tree.TreeDropZone" href="output/Ext.tree.TreeDropZone.html">TreeDropZone</a></td></tr>
  20. <tr><td class="label">Extends:</td><td class="hd-info"><a ext:cls="Ext.dd.DropTarget" ext:member="" href="output/Ext.dd.DropTarget.html">DropTarget</a></td></tr>
  21. </table>
  22. <div class="description">
  23. This class provides a container DD instance that proxies for multiple child node targets.<br />
  24. By default, this class requires that child nodes accepting drop are registered with <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a>. </div>
  25. <div class="hr"></div>
  26. <a id="Ext.dd.DropZone-configs"></a>
  27. <h2>Config Options</h2>
  28. <table cellspacing="0" class="member-table">
  29. <tr>
  30. <th class="sig-header" colspan="2">Config Options</th>
  31. <th class="msource-header">Defined By</th>
  32. </tr>
  33. <tr class="config-row inherited expandable">
  34. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  35. <td class="sig">
  36. <a id="Ext.dd.DropZone-ddGroup"></a>
  37. <b>ddGroup</b> : String <div class="mdesc">
  38. <div class="short">A named drag drop group to which this object belongs. If a group is specified, then this object will only interact wi...</div>
  39. <div class="long">
  40. A named drag drop group to which this object belongs. If a group is specified, then this object will only interact with other drag drop objects in the same group (defaults to undefined). </div>
  41. </div>
  42. </td>
  43. <td class="msource"><a ext:cls="Ext.dd.DropTarget" ext:member="#ddGroup" href="output/Ext.dd.DropTarget.html#ddGroup">DropTarget</a></td>
  44. </tr>
  45. <tr class="config-row inherited alt">
  46. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  47. <td class="sig">
  48. <a id="Ext.dd.DropZone-dropAllowed"></a>
  49. <b>dropAllowed</b> : String <div class="mdesc">
  50. The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok"). </div>
  51. </td>
  52. <td class="msource"><a ext:cls="Ext.dd.DropTarget" ext:member="#dropAllowed" href="output/Ext.dd.DropTarget.html#dropAllowed">DropTarget</a></td>
  53. </tr>
  54. <tr class="config-row inherited">
  55. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  56. <td class="sig">
  57. <a id="Ext.dd.DropZone-dropNotAllowed"></a>
  58. <b>dropNotAllowed</b> : String <div class="mdesc">
  59. The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop"). </div>
  60. </td>
  61. <td class="msource"><a ext:cls="Ext.dd.DropTarget" ext:member="#dropNotAllowed" href="output/Ext.dd.DropTarget.html#dropNotAllowed">DropTarget</a></td>
  62. </tr>
  63. <tr class="config-row inherited alt">
  64. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  65. <td class="sig">
  66. <a id="Ext.dd.DropZone-overClass"></a>
  67. <b>overClass</b> : String <div class="mdesc">
  68. The CSS class applied to the drop target element while the drag source is over it (defaults to ""). </div>
  69. </td>
  70. <td class="msource"><a ext:cls="Ext.dd.DropTarget" ext:member="#overClass" href="output/Ext.dd.DropTarget.html#overClass">DropTarget</a></td>
  71. </tr>
  72. </table>
  73. <a id="Ext.dd.DropZone-props"></a>
  74. <h2>Public Properties</h2>
  75. <table cellspacing="0" class="member-table">
  76. <tr>
  77. <th class="sig-header" colspan="2">Property</th>
  78. <th class="msource-header">Defined By</th>
  79. </tr>
  80. <tr class="property-row inherited">
  81. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  82. <td class="sig">
  83. <a id="Ext.dd.DropZone-available"></a>
  84. <b>available</b> : boolean <div class="mdesc">
  85. The availabe property is false until the linked dom element is accessible. </div>
  86. </td>
  87. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#available" href="output/Ext.dd.DragDrop.html#available">DragDrop</a></td>
  88. </tr>
  89. <tr class="property-row inherited alt">
  90. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  91. <td class="sig">
  92. <a id="Ext.dd.DropZone-config"></a>
  93. <b>config</b> : object <div class="mdesc">
  94. Configuration attributes passed into the constructor </div>
  95. </td>
  96. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#config" href="output/Ext.dd.DragDrop.html#config">DragDrop</a></td>
  97. </tr>
  98. <tr class="property-row inherited expandable">
  99. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  100. <td class="sig">
  101. <a id="Ext.dd.DropZone-groups"></a>
  102. <b>groups</b> : object <div class="mdesc">
  103. <div class="short">The group defines a logical collection of DragDrop objects that are
  104. related. Instances only get events when interact...</div>
  105. <div class="long">
  106. The group defines a logical collection of DragDrop objects that are
  107. related. Instances only get events when interacting with other
  108. DragDrop object in the same group. This lets us define multiple
  109. groups using a single DragDrop subclass if we want. </div>
  110. </div>
  111. </td>
  112. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#groups" href="output/Ext.dd.DragDrop.html#groups">DragDrop</a></td>
  113. </tr>
  114. <tr class="property-row inherited alt expandable">
  115. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  116. <td class="sig">
  117. <a id="Ext.dd.DropZone-hasOuterHandles"></a>
  118. <b>hasOuterHandles</b> : boolean <div class="mdesc">
  119. <div class="short">By default, drags can only be initiated if the mousedown occurs in the
  120. region the linked element is. This is done in...</div>
  121. <div class="long">
  122. By default, drags can only be initiated if the mousedown occurs in the
  123. region the linked element is. This is done in part to work around a
  124. bug in some browsers that mis-report the mousedown if the previous
  125. mouseup happened outside of the window. This property is set to true
  126. if outer handles are defined. </div>
  127. </div>
  128. </td>
  129. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#hasOuterHandles" href="output/Ext.dd.DragDrop.html#hasOuterHandles">DragDrop</a></td>
  130. </tr>
  131. <tr class="property-row inherited expandable">
  132. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  133. <td class="sig">
  134. <a id="Ext.dd.DropZone-id"></a>
  135. <b>id</b> : String <div class="mdesc">
  136. <div class="short">The id of the element associated with this object. This is what we
  137. refer to as the "linked element" because the size...</div>
  138. <div class="long">
  139. The id of the element associated with this object. This is what we
  140. refer to as the "linked element" because the size and position of
  141. this element is used to determine when the drag and drop objects have
  142. interacted. </div>
  143. </div>
  144. </td>
  145. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#id" href="output/Ext.dd.DragDrop.html#id">DragDrop</a></td>
  146. </tr>
  147. <tr class="property-row inherited alt">
  148. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  149. <td class="sig">
  150. <a id="Ext.dd.DropZone-invalidHandleClasses"></a>
  151. <b>invalidHandleClasses</b> : string[] <div class="mdesc">
  152. An indexted array of css class names for elements that will be ignored
  153. if clicked. </div>
  154. </td>
  155. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleClasses" href="output/Ext.dd.DragDrop.html#invalidHandleClasses">DragDrop</a></td>
  156. </tr>
  157. <tr class="property-row inherited">
  158. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  159. <td class="sig">
  160. <a id="Ext.dd.DropZone-invalidHandleIds"></a>
  161. <b>invalidHandleIds</b> : string: <div class="mdesc">
  162. An associative array of ids for elements that will be ignored if clicked </div>
  163. </td>
  164. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleIds" href="output/Ext.dd.DragDrop.html#invalidHandleIds">DragDrop</a></td>
  165. </tr>
  166. <tr class="property-row inherited alt">
  167. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  168. <td class="sig">
  169. <a id="Ext.dd.DropZone-invalidHandleTypes"></a>
  170. <b>invalidHandleTypes</b> : string: <div class="mdesc">
  171. An associative array of HTML tags that will be ignored if clicked. </div>
  172. </td>
  173. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#invalidHandleTypes" href="output/Ext.dd.DragDrop.html#invalidHandleTypes">DragDrop</a></td>
  174. </tr>
  175. <tr class="property-row inherited">
  176. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  177. <td class="sig">
  178. <a id="Ext.dd.DropZone-isTarget"></a>
  179. <b>isTarget</b> : boolean <div class="mdesc">
  180. By default, all insances can be a drop target. This can be disabled by
  181. setting isTarget to false. </div>
  182. </td>
  183. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isTarget" href="output/Ext.dd.DragDrop.html#isTarget">DragDrop</a></td>
  184. </tr>
  185. <tr class="property-row inherited alt expandable">
  186. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  187. <td class="sig">
  188. <a id="Ext.dd.DropZone-maintainOffset"></a>
  189. <b>maintainOffset</b> : boolean <div class="mdesc">
  190. <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
  191. the position of the element relative to its par...</div>
  192. <div class="long">
  193. Maintain offsets when we resetconstraints. Set to true when you want
  194. the position of the element relative to its parent to stay the same
  195. when the page changes </div>
  196. </div>
  197. </td>
  198. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#maintainOffset" href="output/Ext.dd.DragDrop.html#maintainOffset">DragDrop</a></td>
  199. </tr>
  200. <tr class="property-row inherited">
  201. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  202. <td class="sig">
  203. <a id="Ext.dd.DropZone-padding"></a>
  204. <b>padding</b> : int[] <div class="mdesc">
  205. The padding configured for this drag and drop object for calculating
  206. the drop zone intersection with this object. </div>
  207. </td>
  208. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#padding" href="output/Ext.dd.DragDrop.html#padding">DragDrop</a></td>
  209. </tr>
  210. <tr class="property-row inherited alt expandable">
  211. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  212. <td class="sig">
  213. <a id="Ext.dd.DropZone-primaryButtonOnly"></a>
  214. <b>primaryButtonOnly</b> : boolean <div class="mdesc">
  215. <div class="short">By default the drag and drop instance will only respond to the primary
  216. button click (left button for a right-handed m...</div>
  217. <div class="long">
  218. By default the drag and drop instance will only respond to the primary
  219. button click (left button for a right-handed mouse). Set to true to
  220. allow drag and drop to start with any mouse click that is propogated
  221. by the browser </div>
  222. </div>
  223. </td>
  224. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#primaryButtonOnly" href="output/Ext.dd.DragDrop.html#primaryButtonOnly">DragDrop</a></td>
  225. </tr>
  226. <tr class="property-row inherited expandable">
  227. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  228. <td class="sig">
  229. <a id="Ext.dd.DropZone-xTicks"></a>
  230. <b>xTicks</b> : int[] <div class="mdesc">
  231. <div class="short">Array of pixel locations the element will snap to if we specified a
  232. horizontal graduation/interval. This array is ge...</div>
  233. <div class="long">
  234. Array of pixel locations the element will snap to if we specified a
  235. horizontal graduation/interval. This array is generated automatically
  236. when you define a tick interval. </div>
  237. </div>
  238. </td>
  239. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#xTicks" href="output/Ext.dd.DragDrop.html#xTicks">DragDrop</a></td>
  240. </tr>
  241. <tr class="property-row inherited alt expandable">
  242. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  243. <td class="sig">
  244. <a id="Ext.dd.DropZone-yTicks"></a>
  245. <b>yTicks</b> : int[] <div class="mdesc">
  246. <div class="short">Array of pixel locations the element will snap to if we specified a
  247. vertical graduation/interval. This array is gene...</div>
  248. <div class="long">
  249. Array of pixel locations the element will snap to if we specified a
  250. vertical graduation/interval. This array is generated automatically
  251. when you define a tick interval. </div>
  252. </div>
  253. </td>
  254. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#yTicks" href="output/Ext.dd.DragDrop.html#yTicks">DragDrop</a></td>
  255. </tr>
  256. </table>
  257. <a id="Ext.dd.DropZone-methods"></a>
  258. <h2>Public Methods</h2>
  259. <table cellspacing="0" class="member-table">
  260. <tr>
  261. <th class="sig-header" colspan="2">Method</th>
  262. <th class="msource-header">Defined By</th>
  263. </tr>
  264. <tr class="method-row expandable">
  265. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  266. <td class="sig">
  267. <a id="Ext.dd.DropZone-DropZone"></a>
  268. <b>DropZone</b>(&nbsp;<code>Mixed el</code>, <code>Object config</code>&nbsp;) <div class="mdesc">
  269. <div class="short"></div>
  270. <div class="long">
  271. <div class="mdetail-params">
  272. <strong>Parameters:</strong>
  273. <ul><li><code>el</code> : Mixed<div class="sub-desc">The container element</div></li><li><code>config</code> : Object<div class="sub-desc"></div></li> </ul>
  274. <strong>Returns:</strong>
  275. <ul>
  276. <li><code></code></li>
  277. </ul>
  278. </div>
  279. </div>
  280. </div>
  281. </td>
  282. <td class="msource">DropZone</td>
  283. </tr>
  284. <tr class="method-row inherited alt expandable">
  285. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  286. <td class="sig">
  287. <a id="Ext.dd.DropZone-addInvalidHandleClass"></a>
  288. <b>addInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void <div class="mdesc">
  289. <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
  290. <div class="long">
  291. Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
  292. <strong>Parameters:</strong>
  293. <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
  294. <strong>Returns:</strong>
  295. <ul>
  296. <li><code>void</code></li>
  297. </ul>
  298. </div>
  299. </div>
  300. </div>
  301. </td>
  302. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleClass" href="output/Ext.dd.DragDrop.html#addInvalidHandleClass">DragDrop</a></td>
  303. </tr>
  304. <tr class="method-row inherited expandable">
  305. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  306. <td class="sig">
  307. <a id="Ext.dd.DropZone-addInvalidHandleId"></a>
  308. <b>addInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void <div class="mdesc">
  309. <div class="short">Lets you to specify an element id for a child of a drag handle
  310. that should not initiate a drag</div>
  311. <div class="long">
  312. Lets you to specify an element id for a child of a drag handle
  313. that should not initiate a drag <div class="mdetail-params">
  314. <strong>Parameters:</strong>
  315. <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element you wish to ignore</div></li> </ul>
  316. <strong>Returns:</strong>
  317. <ul>
  318. <li><code>void</code></li>
  319. </ul>
  320. </div>
  321. </div>
  322. </div>
  323. </td>
  324. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleId" href="output/Ext.dd.DragDrop.html#addInvalidHandleId">DragDrop</a></td>
  325. </tr>
  326. <tr class="method-row inherited alt expandable">
  327. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  328. <td class="sig">
  329. <a id="Ext.dd.DropZone-addInvalidHandleType"></a>
  330. <b>addInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void <div class="mdesc">
  331. <div class="short">Allows you to specify a tag name that should not start a drag operation
  332. when clicked. This is designed to facilitate...</div>
  333. <div class="long">
  334. Allows you to specify a tag name that should not start a drag operation
  335. when clicked. This is designed to facilitate embedding links within a
  336. drag handle that do something other than start the drag. <div class="mdetail-params">
  337. <strong>Parameters:</strong>
  338. <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
  339. <strong>Returns:</strong>
  340. <ul>
  341. <li><code>void</code></li>
  342. </ul>
  343. </div>
  344. </div>
  345. </div>
  346. </td>
  347. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addInvalidHandleType" href="output/Ext.dd.DragDrop.html#addInvalidHandleType">DragDrop</a></td>
  348. </tr>
  349. <tr class="method-row inherited expandable">
  350. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  351. <td class="sig">
  352. <a id="Ext.dd.DropZone-addToGroup"></a>
  353. <b>addToGroup</b>(&nbsp;<code>sGroup {string}</code>&nbsp;) : void <div class="mdesc">
  354. <div class="short">Add this instance to a group of related drag/drop objects. All
  355. instances belong to at least one group, and can belon...</div>
  356. <div class="long">
  357. Add this instance to a group of related drag/drop objects. All
  358. instances belong to at least one group, and can belong to as many
  359. groups as needed. <div class="mdetail-params">
  360. <strong>Parameters:</strong>
  361. <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
  362. <strong>Returns:</strong>
  363. <ul>
  364. <li><code>void</code></li>
  365. </ul>
  366. </div>
  367. </div>
  368. </div>
  369. </td>
  370. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#addToGroup" href="output/Ext.dd.DragDrop.html#addToGroup">DragDrop</a></td>
  371. </tr>
  372. <tr class="method-row inherited alt expandable">
  373. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  374. <td class="sig">
  375. <a id="Ext.dd.DropZone-applyConfig"></a>
  376. <b>applyConfig</b>() : void <div class="mdesc">
  377. <div class="short">Applies the configuration parameters that were passed into the constructor.
  378. This is supposed to happen at each level ...</div>
  379. <div class="long">
  380. Applies the configuration parameters that were passed into the constructor.
  381. This is supposed to happen at each level through the inheritance chain. So
  382. a DDProxy implentation will execute apply config on DDProxy, DD, and
  383. DragDrop in order to get all of the parameters that are available in
  384. each object. <div class="mdetail-params">
  385. <strong>Parameters:</strong>
  386. <ul><li>None.</li> </ul>
  387. <strong>Returns:</strong>
  388. <ul>
  389. <li><code>void</code></li>
  390. </ul>
  391. </div>
  392. </div>
  393. </div>
  394. </td>
  395. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#applyConfig" href="output/Ext.dd.DragDrop.html#applyConfig">DragDrop</a></td>
  396. </tr>
  397. <tr class="method-row inherited expandable">
  398. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  399. <td class="sig">
  400. <a id="Ext.dd.DropZone-clearConstraints"></a>
  401. <b>clearConstraints</b>() : void <div class="mdesc">
  402. <div class="short">Clears any constraints applied to this instance. Also clears ticks
  403. since they can't exist independent of a constrain...</div>
  404. <div class="long">
  405. Clears any constraints applied to this instance. Also clears ticks
  406. since they can't exist independent of a constraint at this time. <div class="mdetail-params">
  407. <strong>Parameters:</strong>
  408. <ul><li>None.</li> </ul>
  409. <strong>Returns:</strong>
  410. <ul>
  411. <li><code>void</code></li>
  412. </ul>
  413. </div>
  414. </div>
  415. </div>
  416. </td>
  417. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearConstraints" href="output/Ext.dd.DragDrop.html#clearConstraints">DragDrop</a></td>
  418. </tr>
  419. <tr class="method-row inherited alt expandable">
  420. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  421. <td class="sig">
  422. <a id="Ext.dd.DropZone-clearTicks"></a>
  423. <b>clearTicks</b>() : void <div class="mdesc">
  424. <div class="short">Clears any tick interval defined for this instance</div>
  425. <div class="long">
  426. Clears any tick interval defined for this instance <div class="mdetail-params">
  427. <strong>Parameters:</strong>
  428. <ul><li>None.</li> </ul>
  429. <strong>Returns:</strong>
  430. <ul>
  431. <li><code>void</code></li>
  432. </ul>
  433. </div>
  434. </div>
  435. </div>
  436. </td>
  437. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#clearTicks" href="output/Ext.dd.DragDrop.html#clearTicks">DragDrop</a></td>
  438. </tr>
  439. <tr class="method-row inherited expandable">
  440. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  441. <td class="sig">
  442. <a id="Ext.dd.DropZone-endDrag"></a>
  443. <b>endDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  444. <div class="short">Fired when we are done dragging the object</div>
  445. <div class="long">
  446. Fired when we are done dragging the object <div class="mdetail-params">
  447. <strong>Parameters:</strong>
  448. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  449. <strong>Returns:</strong>
  450. <ul>
  451. <li><code>void</code></li>
  452. </ul>
  453. </div>
  454. </div>
  455. </div>
  456. </td>
  457. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#endDrag" href="output/Ext.dd.DragDrop.html#endDrag">DragDrop</a></td>
  458. </tr>
  459. <tr class="method-row inherited alt expandable">
  460. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  461. <td class="sig">
  462. <a id="Ext.dd.DropZone-getDragEl"></a>
  463. <b>getDragEl</b>() : HTMLElement <div class="mdesc">
  464. <div class="short">Returns a reference to the actual element to drag. By default this is
  465. the same as the html element, but it can be as...</div>
  466. <div class="long">
  467. Returns a reference to the actual element to drag. By default this is
  468. the same as the html element, but it can be assigned to another
  469. element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
  470. <strong>Parameters:</strong>
  471. <ul><li>None.</li> </ul>
  472. <strong>Returns:</strong>
  473. <ul>
  474. <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
  475. </ul>
  476. </div>
  477. </div>
  478. </div>
  479. </td>
  480. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getDragEl" href="output/Ext.dd.DragDrop.html#getDragEl">DragDrop</a></td>
  481. </tr>
  482. <tr class="method-row inherited expandable">
  483. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  484. <td class="sig">
  485. <a id="Ext.dd.DropZone-getEl"></a>
  486. <b>getEl</b>() : HTMLElement <div class="mdesc">
  487. <div class="short">Returns a reference to the linked element</div>
  488. <div class="long">
  489. Returns a reference to the linked element <div class="mdetail-params">
  490. <strong>Parameters:</strong>
  491. <ul><li>None.</li> </ul>
  492. <strong>Returns:</strong>
  493. <ul>
  494. <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
  495. </ul>
  496. </div>
  497. </div>
  498. </div>
  499. </td>
  500. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#getEl" href="output/Ext.dd.DragDrop.html#getEl">DragDrop</a></td>
  501. </tr>
  502. <tr class="method-row alt expandable">
  503. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  504. <td class="sig">
  505. <a id="Ext.dd.DropZone-getTargetFromEvent"></a>
  506. <b>getTargetFromEvent</b>(&nbsp;<code>Event e</code>&nbsp;) : Object <div class="mdesc">
  507. <div class="short">Returns a custom data object associated with the DOM node that is the target of the event. By default
  508. this looks up ...</div>
  509. <div class="long">
  510. Returns a custom data object associated with the DOM node that is the target of the event. By default
  511. this looks up the event target in the <a ext:cls="Ext.dd.Registry" href="output/Ext.dd.Registry.html">Ext.dd.Registry</a>, although you can override this method to
  512. provide your own custom lookup. <div class="mdetail-params">
  513. <strong>Parameters:</strong>
  514. <ul><li><code>e</code> : Event<div class="sub-desc">The event</div></li> </ul>
  515. <strong>Returns:</strong>
  516. <ul>
  517. <li><code>Object</code><div class="sub-desc">data The custom data</div></li>
  518. </ul>
  519. </div>
  520. </div>
  521. </div>
  522. </td>
  523. <td class="msource">DropZone</td>
  524. </tr>
  525. <tr class="method-row inherited expandable">
  526. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  527. <td class="sig">
  528. <a id="Ext.dd.DropZone-init"></a>
  529. <b>init</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void <div class="mdesc">
  530. <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
  531. Ext.dd.DragDrop subclass</div>
  532. <div class="long">
  533. Sets up the DragDrop object. Must be called in the constructor of any
  534. Ext.dd.DragDrop subclass <div class="mdetail-params">
  535. <strong>Parameters:</strong>
  536. <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li> </ul>
  537. <strong>Returns:</strong>
  538. <ul>
  539. <li><code>void</code></li>
  540. </ul>
  541. </div>
  542. </div>
  543. </div>
  544. </td>
  545. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#init" href="output/Ext.dd.DragDrop.html#init">DragDrop</a></td>
  546. </tr>
  547. <tr class="method-row inherited alt expandable">
  548. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  549. <td class="sig">
  550. <a id="Ext.dd.DropZone-initTarget"></a>
  551. <b>initTarget</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void <div class="mdesc">
  552. <div class="short">Initializes Targeting functionality only... the object does not
  553. get a mousedown handler.</div>
  554. <div class="long">
  555. Initializes Targeting functionality only... the object does not
  556. get a mousedown handler. <div class="mdetail-params">
  557. <strong>Parameters:</strong>
  558. <ul><li><code>the</code> : id<div class="sub-desc">id of the linked element</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related items</div></li><li><code>config</code> : object<div class="sub-desc">configuration attributes</div></li> </ul>
  559. <strong>Returns:</strong>
  560. <ul>
  561. <li><code>void</code></li>
  562. </ul>
  563. </div>
  564. </div>
  565. </div>
  566. </td>
  567. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#initTarget" href="output/Ext.dd.DragDrop.html#initTarget">DragDrop</a></td>
  568. </tr>
  569. <tr class="method-row inherited expandable">
  570. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  571. <td class="sig">
  572. <a id="Ext.dd.DropZone-isLocked"></a>
  573. <b>isLocked</b>() : boolean <div class="mdesc">
  574. <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
  575. (meaning that all drag/drop is disabled on th...</div>
  576. <div class="long">
  577. Returns true if this instance is locked, or the drag drop mgr is locked
  578. (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
  579. <strong>Parameters:</strong>
  580. <ul><li>None.</li> </ul>
  581. <strong>Returns:</strong>
  582. <ul>
  583. <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
  584. </ul>
  585. </div>
  586. </div>
  587. </div>
  588. </td>
  589. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isLocked" href="output/Ext.dd.DragDrop.html#isLocked">DragDrop</a></td>
  590. </tr>
  591. <tr class="method-row inherited alt expandable">
  592. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  593. <td class="sig">
  594. <a id="Ext.dd.DropZone-isValidHandleChild"></a>
  595. <b>isValidHandleChild</b>(&nbsp;<code>HTMLElement node</code>&nbsp;) : boolean <div class="mdesc">
  596. <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
  597. <div class="long">
  598. Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
  599. <strong>Parameters:</strong>
  600. <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
  601. <strong>Returns:</strong>
  602. <ul>
  603. <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
  604. </ul>
  605. </div>
  606. </div>
  607. </div>
  608. </td>
  609. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#isValidHandleChild" href="output/Ext.dd.DragDrop.html#isValidHandleChild">DragDrop</a></td>
  610. </tr>
  611. <tr class="method-row inherited expandable">
  612. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  613. <td class="sig">
  614. <a id="Ext.dd.DropZone-lock"></a>
  615. <b>lock</b>() : void <div class="mdesc">
  616. <div class="short">Lock this instance</div>
  617. <div class="long">
  618. Lock this instance <div class="mdetail-params">
  619. <strong>Parameters:</strong>
  620. <ul><li>None.</li> </ul>
  621. <strong>Returns:</strong>
  622. <ul>
  623. <li><code>void</code></li>
  624. </ul>
  625. </div>
  626. </div>
  627. </div>
  628. </td>
  629. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#lock" href="output/Ext.dd.DragDrop.html#lock">DragDrop</a></td>
  630. </tr>
  631. <tr class="method-row alt expandable">
  632. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  633. <td class="sig">
  634. <a id="Ext.dd.DropZone-notifyDrop"></a>
  635. <b>notifyDrop</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : Boolean <div class="mdesc">
  636. <div class="short">The function a Ext.dd.DragSource calls once to notify this drop zone that the dragged item has
  637. been dropped on it. T...</div>
  638. <div class="long">
  639. The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop zone that the dragged item has
  640. been dropped on it. The drag zone will look up the target node based on the event passed in, and if there
  641. is a node registered for that event, it will delegate to <a ext:cls="Ext.dd.DropZone" ext:member="onNodeDrop" href="output/Ext.dd.DropZone.html#onNodeDrop">onNodeDrop</a> for node-specific handling,
  642. otherwise it will call <a ext:cls="Ext.dd.DropZone" ext:member="onContainerDrop" href="output/Ext.dd.DropZone.html#onContainerDrop">onContainerDrop</a>. <div class="mdetail-params">
  643. <strong>Parameters:</strong>
  644. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  645. <strong>Returns:</strong>
  646. <ul>
  647. <li><code>Boolean</code><div class="sub-desc">True if the drop was valid, else false</div></li>
  648. </ul>
  649. </div>
  650. </div>
  651. </div>
  652. </td>
  653. <td class="msource">DropZone</td>
  654. </tr>
  655. <tr class="method-row expandable">
  656. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  657. <td class="sig">
  658. <a id="Ext.dd.DropZone-notifyEnter"></a>
  659. <b>notifyEnter</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : String <div class="mdesc">
  660. <div class="short">The function a Ext.dd.DragSource calls once to notify this drop zone that the source is now over
  661. the zone. The defau...</div>
  662. <div class="long">
  663. The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop zone that the source is now over
  664. the zone. The default implementation returns this.dropNotAllowed and expects that only registered drop
  665. nodes can process drag drop operations, so if you need the drop zone itself to be able to process drops
  666. you should override this method and provide a custom implementation. <div class="mdetail-params">
  667. <strong>Parameters:</strong>
  668. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  669. <strong>Returns:</strong>
  670. <ul>
  671. <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
  672. </ul>
  673. </div>
  674. </div>
  675. </div>
  676. </td>
  677. <td class="msource">DropZone</td>
  678. </tr>
  679. <tr class="method-row alt expandable">
  680. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  681. <td class="sig">
  682. <a id="Ext.dd.DropZone-notifyOut"></a>
  683. <b>notifyOut</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : void <div class="mdesc">
  684. <div class="short">The function a Ext.dd.DragSource calls once to notify this drop zone that the source has been dragged
  685. out of the zone...</div>
  686. <div class="long">
  687. The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls once to notify this drop zone that the source has been dragged
  688. out of the zone without dropping. If the drag source is currently over a registered node, the notification
  689. will be delegated to <a ext:cls="Ext.dd.DropZone" ext:member="onNodeOut" href="output/Ext.dd.DropZone.html#onNodeOut">onNodeOut</a> for node-specific handling, otherwise it will be ignored. <div class="mdetail-params">
  690. <strong>Parameters:</strong>
  691. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop target</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag zone</div></li> </ul>
  692. <strong>Returns:</strong>
  693. <ul>
  694. <li><code>void</code></li>
  695. </ul>
  696. </div>
  697. </div>
  698. </div>
  699. </td>
  700. <td class="msource">DropZone</td>
  701. </tr>
  702. <tr class="method-row expandable">
  703. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  704. <td class="sig">
  705. <a id="Ext.dd.DropZone-notifyOver"></a>
  706. <b>notifyOver</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : String <div class="mdesc">
  707. <div class="short">The function a Ext.dd.DragSource calls continuously while it is being dragged over the drop zone.
  708. This method will be...</div>
  709. <div class="long">
  710. The function a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> calls continuously while it is being dragged over the drop zone.
  711. This method will be called on every mouse movement while the drag source is over the drop zone.
  712. It will call <a ext:cls="Ext.dd.DropZone" ext:member="onNodeOver" href="output/Ext.dd.DropZone.html#onNodeOver">onNodeOver</a> while the drag source is over a registered node, and will also automatically
  713. delegate to the appropriate node-specific methods as necessary when the drag source enters and exits
  714. registered nodes (<a ext:cls="Ext.dd.DropZone" ext:member="onNodeEnter" href="output/Ext.dd.DropZone.html#onNodeEnter">onNodeEnter</a>, <a ext:cls="Ext.dd.DropZone" ext:member="onNodeOut" href="output/Ext.dd.DropZone.html#onNodeOut">onNodeOut</a>). If the drag source is not currently over a
  715. registered node, it will call <a ext:cls="Ext.dd.DropZone" ext:member="onContainerOver" href="output/Ext.dd.DropZone.html#onContainerOver">onContainerOver</a>. <div class="mdetail-params">
  716. <strong>Parameters:</strong>
  717. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  718. <strong>Returns:</strong>
  719. <ul>
  720. <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
  721. </ul>
  722. </div>
  723. </div>
  724. </div>
  725. </td>
  726. <td class="msource">DropZone</td>
  727. </tr>
  728. <tr class="method-row inherited alt expandable">
  729. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  730. <td class="sig">
  731. <a id="Ext.dd.DropZone-onAvailable"></a>
  732. <b>onAvailable</b>() : void <div class="mdesc">
  733. <div class="short">Override the onAvailable method to do what is needed after the initial
  734. position was determined.</div>
  735. <div class="long">
  736. Override the onAvailable method to do what is needed after the initial
  737. position was determined. <div class="mdetail-params">
  738. <strong>Parameters:</strong>
  739. <ul><li>None.</li> </ul>
  740. <strong>Returns:</strong>
  741. <ul>
  742. <li><code>void</code></li>
  743. </ul>
  744. </div>
  745. </div>
  746. </div>
  747. </td>
  748. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onAvailable" href="output/Ext.dd.DragDrop.html#onAvailable">DragDrop</a></td>
  749. </tr>
  750. <tr class="method-row expandable">
  751. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  752. <td class="sig">
  753. <a id="Ext.dd.DropZone-onContainerDrop"></a>
  754. <b>onContainerDrop</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : Boolean <div class="mdesc">
  755. <div class="short">Called internally when the DropZone determines that a Ext.dd.DragSource has been dropped on it,
  756. but not on any of its...</div>
  757. <div class="long">
  758. Called internally when the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> has been dropped on it,
  759. but not on any of its registered drop nodes. The default implementation returns false, so it should be
  760. overridden to provide the appropriate processing of the drop event if you need the drop zone itself to
  761. be able to accept drops. It should return true when valid so that the drag source's repair action does not run. <div class="mdetail-params">
  762. <strong>Parameters:</strong>
  763. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  764. <strong>Returns:</strong>
  765. <ul>
  766. <li><code>Boolean</code><div class="sub-desc">True if the drop was valid, else false</div></li>
  767. </ul>
  768. </div>
  769. </div>
  770. </div>
  771. </td>
  772. <td class="msource">DropZone</td>
  773. </tr>
  774. <tr class="method-row alt expandable">
  775. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  776. <td class="sig">
  777. <a id="Ext.dd.DropZone-onContainerOver"></a>
  778. <b>onContainerOver</b>(&nbsp;<code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : String <div class="mdesc">
  779. <div class="short">Called internally while the DropZone determines that a Ext.dd.DragSource is being dragged over it,
  780. but not over any o...</div>
  781. <div class="long">
  782. Called internally while the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> is being dragged over it,
  783. but not over any of its registered drop nodes. The default implementation returns this.dropNotAllowed, so
  784. it should be overridden to provide the proper feedback if necessary. <div class="mdetail-params">
  785. <strong>Parameters:</strong>
  786. <ul><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  787. <strong>Returns:</strong>
  788. <ul>
  789. <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
  790. </ul>
  791. </div>
  792. </div>
  793. </div>
  794. </td>
  795. <td class="msource">DropZone</td>
  796. </tr>
  797. <tr class="method-row inherited expandable">
  798. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  799. <td class="sig">
  800. <a id="Ext.dd.DropZone-onDrag"></a>
  801. <b>onDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  802. <div class="short">Abstract method called during the onMouseMove event while dragging an
  803. object.</div>
  804. <div class="long">
  805. Abstract method called during the onMouseMove event while dragging an
  806. object. <div class="mdetail-params">
  807. <strong>Parameters:</strong>
  808. <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
  809. <strong>Returns:</strong>
  810. <ul>
  811. <li><code>void</code></li>
  812. </ul>
  813. </div>
  814. </div>
  815. </div>
  816. </td>
  817. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDrag" href="output/Ext.dd.DragDrop.html#onDrag">DragDrop</a></td>
  818. </tr>
  819. <tr class="method-row inherited alt expandable">
  820. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  821. <td class="sig">
  822. <a id="Ext.dd.DropZone-onDragDrop"></a>
  823. <b>onDragDrop</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  824. <div class="short">Abstract method called when this item is dropped on another DragDrop
  825. obj</div>
  826. <div class="long">
  827. Abstract method called when this item is dropped on another DragDrop
  828. obj <div class="mdetail-params">
  829. <strong>Parameters:</strong>
  830. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
  831. id this was dropped on. In INTERSECT mode, an array of dd items this
  832. was dropped on.</div></li> </ul>
  833. <strong>Returns:</strong>
  834. <ul>
  835. <li><code>void</code></li>
  836. </ul>
  837. </div>
  838. </div>
  839. </div>
  840. </td>
  841. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragDrop" href="output/Ext.dd.DragDrop.html#onDragDrop">DragDrop</a></td>
  842. </tr>
  843. <tr class="method-row inherited expandable">
  844. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  845. <td class="sig">
  846. <a id="Ext.dd.DropZone-onDragEnter"></a>
  847. <b>onDragEnter</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  848. <div class="short">Abstract method called when this element fist begins hovering over
  849. another DragDrop obj</div>
  850. <div class="long">
  851. Abstract method called when this element fist begins hovering over
  852. another DragDrop obj <div class="mdetail-params">
  853. <strong>Parameters:</strong>
  854. <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
  855. id this is hovering over. In INTERSECT mode, an array of one or more
  856. dragdrop items being hovered over.</div></li> </ul>
  857. <strong>Returns:</strong>
  858. <ul>
  859. <li><code>void</code></li>
  860. </ul>
  861. </div>
  862. </div>
  863. </div>
  864. </td>
  865. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragEnter" href="output/Ext.dd.DragDrop.html#onDragEnter">DragDrop</a></td>
  866. </tr>
  867. <tr class="method-row inherited alt expandable">
  868. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  869. <td class="sig">
  870. <a id="Ext.dd.DropZone-onDragOut"></a>
  871. <b>onDragOut</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  872. <div class="short">Abstract method called when we are no longer hovering over an element</div>
  873. <div class="long">
  874. Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
  875. <strong>Parameters:</strong>
  876. <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
  877. id this was hovering over. In INTERSECT mode, an array of dd items
  878. that the mouse is no longer over.</div></li> </ul>
  879. <strong>Returns:</strong>
  880. <ul>
  881. <li><code>void</code></li>
  882. </ul>
  883. </div>
  884. </div>
  885. </div>
  886. </td>
  887. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOut" href="output/Ext.dd.DragDrop.html#onDragOut">DragDrop</a></td>
  888. </tr>
  889. <tr class="method-row inherited expandable">
  890. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  891. <td class="sig">
  892. <a id="Ext.dd.DropZone-onDragOver"></a>
  893. <b>onDragOver</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  894. <div class="short">Abstract method called when this element is hovering over another
  895. DragDrop obj</div>
  896. <div class="long">
  897. Abstract method called when this element is hovering over another
  898. DragDrop obj <div class="mdetail-params">
  899. <strong>Parameters:</strong>
  900. <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li><li><code>id</code> : String|DragDrop[]<div class="sub-desc">In POINT mode, the element
  901. id this is hovering over. In INTERSECT mode, an array of dd items
  902. being hovered over.</div></li> </ul>
  903. <strong>Returns:</strong>
  904. <ul>
  905. <li><code>void</code></li>
  906. </ul>
  907. </div>
  908. </div>
  909. </div>
  910. </td>
  911. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onDragOver" href="output/Ext.dd.DragDrop.html#onDragOver">DragDrop</a></td>
  912. </tr>
  913. <tr class="method-row inherited alt expandable">
  914. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  915. <td class="sig">
  916. <a id="Ext.dd.DropZone-onInvalidDrop"></a>
  917. <b>onInvalidDrop</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  918. <div class="short">Abstract method called when this item is dropped on an area with no
  919. drop target</div>
  920. <div class="long">
  921. Abstract method called when this item is dropped on an area with no
  922. drop target <div class="mdetail-params">
  923. <strong>Parameters:</strong>
  924. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  925. <strong>Returns:</strong>
  926. <ul>
  927. <li><code>void</code></li>
  928. </ul>
  929. </div>
  930. </div>
  931. </div>
  932. </td>
  933. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onInvalidDrop" href="output/Ext.dd.DragDrop.html#onInvalidDrop">DragDrop</a></td>
  934. </tr>
  935. <tr class="method-row inherited expandable">
  936. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  937. <td class="sig">
  938. <a id="Ext.dd.DropZone-onMouseDown"></a>
  939. <b>onMouseDown</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  940. <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
  941. <div class="long">
  942. Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
  943. <strong>Parameters:</strong>
  944. <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
  945. <strong>Returns:</strong>
  946. <ul>
  947. <li><code>void</code></li>
  948. </ul>
  949. </div>
  950. </div>
  951. </div>
  952. </td>
  953. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseDown" href="output/Ext.dd.DragDrop.html#onMouseDown">DragDrop</a></td>
  954. </tr>
  955. <tr class="method-row inherited alt expandable">
  956. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  957. <td class="sig">
  958. <a id="Ext.dd.DropZone-onMouseUp"></a>
  959. <b>onMouseUp</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  960. <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
  961. <div class="long">
  962. Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
  963. <strong>Parameters:</strong>
  964. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  965. <strong>Returns:</strong>
  966. <ul>
  967. <li><code>void</code></li>
  968. </ul>
  969. </div>
  970. </div>
  971. </div>
  972. </td>
  973. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#onMouseUp" href="output/Ext.dd.DragDrop.html#onMouseUp">DragDrop</a></td>
  974. </tr>
  975. <tr class="method-row expandable">
  976. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  977. <td class="sig">
  978. <a id="Ext.dd.DropZone-onNodeDrop"></a>
  979. <b>onNodeDrop</b>(&nbsp;<code>Object nodeData</code>, <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : Boolean <div class="mdesc">
  980. <div class="short">Called internally when the DropZone determines that a Ext.dd.DragSource has been dropped onto
  981. the drop node. The def...</div>
  982. <div class="long">
  983. Called internally when the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> has been dropped onto
  984. the drop node. The default implementation returns false, so it should be overridden to provide the
  985. appropriate processing of the drop event and return true so that the drag source's repair action does not run. <div class="mdetail-params">
  986. <strong>Parameters:</strong>
  987. <ul><li><code>nodeData</code> : Object<div class="sub-desc">The custom data associated with the drop node (this is the same value returned from
  988. <a ext:cls="Ext.dd.DropZone" ext:member="getTargetFromEvent" href="output/Ext.dd.DropZone.html#getTargetFromEvent">getTargetFromEvent</a> for this node)</div></li><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  989. <strong>Returns:</strong>
  990. <ul>
  991. <li><code>Boolean</code><div class="sub-desc">True if the drop was valid, else false</div></li>
  992. </ul>
  993. </div>
  994. </div>
  995. </div>
  996. </td>
  997. <td class="msource">DropZone</td>
  998. </tr>
  999. <tr class="method-row alt expandable">
  1000. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1001. <td class="sig">
  1002. <a id="Ext.dd.DropZone-onNodeEnter"></a>
  1003. <b>onNodeEnter</b>(&nbsp;<code>Object nodeData</code>, <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : void <div class="mdesc">
  1004. <div class="short">Called internally when the DropZone determines that a Ext.dd.DragSource has entered a drop node
  1005. that it has registere...</div>
  1006. <div class="long">
  1007. Called internally when the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> has entered a drop node
  1008. that it has registered. This method has no default implementation and should be overridden to provide
  1009. node-specific processing if necessary. <div class="mdetail-params">
  1010. <strong>Parameters:</strong>
  1011. <ul><li><code>nodeData</code> : Object<div class="sub-desc">The custom data associated with the drop node (this is the same value returned from
  1012. <a ext:cls="Ext.dd.DropZone" ext:member="getTargetFromEvent" href="output/Ext.dd.DropZone.html#getTargetFromEvent">getTargetFromEvent</a> for this node)</div></li><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  1013. <strong>Returns:</strong>
  1014. <ul>
  1015. <li><code>void</code></li>
  1016. </ul>
  1017. </div>
  1018. </div>
  1019. </div>
  1020. </td>
  1021. <td class="msource">DropZone</td>
  1022. </tr>
  1023. <tr class="method-row expandable">
  1024. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1025. <td class="sig">
  1026. <a id="Ext.dd.DropZone-onNodeOut"></a>
  1027. <b>onNodeOut</b>(&nbsp;<code>Object nodeData</code>, <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : void <div class="mdesc">
  1028. <div class="short">Called internally when the DropZone determines that a Ext.dd.DragSource has been dragged out of
  1029. the drop node without...</div>
  1030. <div class="long">
  1031. Called internally when the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> has been dragged out of
  1032. the drop node without dropping. This method has no default implementation and should be overridden to provide
  1033. node-specific processing if necessary. <div class="mdetail-params">
  1034. <strong>Parameters:</strong>
  1035. <ul><li><code>nodeData</code> : Object<div class="sub-desc">The custom data associated with the drop node (this is the same value returned from
  1036. <a ext:cls="Ext.dd.DropZone" ext:member="getTargetFromEvent" href="output/Ext.dd.DropZone.html#getTargetFromEvent">getTargetFromEvent</a> for this node)</div></li><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  1037. <strong>Returns:</strong>
  1038. <ul>
  1039. <li><code>void</code></li>
  1040. </ul>
  1041. </div>
  1042. </div>
  1043. </div>
  1044. </td>
  1045. <td class="msource">DropZone</td>
  1046. </tr>
  1047. <tr class="method-row alt expandable">
  1048. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1049. <td class="sig">
  1050. <a id="Ext.dd.DropZone-onNodeOver"></a>
  1051. <b>onNodeOver</b>(&nbsp;<code>Object nodeData</code>, <code>Ext.dd.DragSource source</code>, <code>Event e</code>, <code>Object data</code>&nbsp;) : String <div class="mdesc">
  1052. <div class="short">Called internally while the DropZone determines that a Ext.dd.DragSource is over a drop node
  1053. that it has registered. ...</div>
  1054. <div class="long">
  1055. Called internally while the DropZone determines that a <a ext:cls="Ext.dd.DragSource" href="output/Ext.dd.DragSource.html">Ext.dd.DragSource</a> is over a drop node
  1056. that it has registered. The default implementation returns this.dropNotAllowed, so it should be
  1057. overridden to provide the proper feedback. <div class="mdetail-params">
  1058. <strong>Parameters:</strong>
  1059. <ul><li><code>nodeData</code> : Object<div class="sub-desc">The custom data associated with the drop node (this is the same value returned from
  1060. <a ext:cls="Ext.dd.DropZone" ext:member="getTargetFromEvent" href="output/Ext.dd.DropZone.html#getTargetFromEvent">getTargetFromEvent</a> for this node)</div></li><li><code>source</code> : Ext.dd.DragSource<div class="sub-desc">The drag source that was dragged over this drop zone</div></li><li><code>e</code> : Event<div class="sub-desc">The event</div></li><li><code>data</code> : Object<div class="sub-desc">An object containing arbitrary data supplied by the drag source</div></li> </ul>
  1061. <strong>Returns:</strong>
  1062. <ul>
  1063. <li><code>String</code><div class="sub-desc">status The CSS class that communicates the drop status back to the source so that the underlying {@link Ext.dd.StatusProxy} can be updated</div></li>
  1064. </ul>
  1065. </div>
  1066. </div>
  1067. </div>
  1068. </td>
  1069. <td class="msource">DropZone</td>
  1070. </tr>
  1071. <tr class="method-row inherited expandable">
  1072. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1073. <td class="sig">
  1074. <a id="Ext.dd.DropZone-removeFromGroup"></a>
  1075. <b>removeFromGroup</b>(&nbsp;<code>string sGroup</code>&nbsp;) : void <div class="mdesc">
  1076. <div class="short">Remove's this instance from the supplied interaction group</div>
  1077. <div class="long">
  1078. Remove's this instance from the supplied interaction group <div class="mdetail-params">
  1079. <strong>Parameters:</strong>
  1080. <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
  1081. <strong>Returns:</strong>
  1082. <ul>
  1083. <li><code>void</code></li>
  1084. </ul>
  1085. </div>
  1086. </div>
  1087. </div>
  1088. </td>
  1089. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeFromGroup" href="output/Ext.dd.DragDrop.html#removeFromGroup">DragDrop</a></td>
  1090. </tr>
  1091. <tr class="method-row inherited alt expandable">
  1092. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1093. <td class="sig">
  1094. <a id="Ext.dd.DropZone-removeInvalidHandleClass"></a>
  1095. <b>removeInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void <div class="mdesc">
  1096. <div class="short">Unsets an invalid css class</div>
  1097. <div class="long">
  1098. Unsets an invalid css class <div class="mdetail-params">
  1099. <strong>Parameters:</strong>
  1100. <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
  1101. re-enable</div></li> </ul>
  1102. <strong>Returns:</strong>
  1103. <ul>
  1104. <li><code>void</code></li>
  1105. </ul>
  1106. </div>
  1107. </div>
  1108. </div>
  1109. </td>
  1110. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleClass" href="output/Ext.dd.DragDrop.html#removeInvalidHandleClass">DragDrop</a></td>
  1111. </tr>
  1112. <tr class="method-row inherited expandable">
  1113. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1114. <td class="sig">
  1115. <a id="Ext.dd.DropZone-removeInvalidHandleId"></a>
  1116. <b>removeInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void <div class="mdesc">
  1117. <div class="short">Unsets an invalid handle id</div>
  1118. <div class="long">
  1119. Unsets an invalid handle id <div class="mdetail-params">
  1120. <strong>Parameters:</strong>
  1121. <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
  1122. <strong>Returns:</strong>
  1123. <ul>
  1124. <li><code>void</code></li>
  1125. </ul>
  1126. </div>
  1127. </div>
  1128. </div>
  1129. </td>
  1130. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleId" href="output/Ext.dd.DragDrop.html#removeInvalidHandleId">DragDrop</a></td>
  1131. </tr>
  1132. <tr class="method-row inherited alt expandable">
  1133. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1134. <td class="sig">
  1135. <a id="Ext.dd.DropZone-removeInvalidHandleType"></a>
  1136. <b>removeInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void <div class="mdesc">
  1137. <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
  1138. <div class="long">
  1139. Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
  1140. <strong>Parameters:</strong>
  1141. <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</div></li> </ul>
  1142. <strong>Returns:</strong>
  1143. <ul>
  1144. <li><code>void</code></li>
  1145. </ul>
  1146. </div>
  1147. </div>
  1148. </div>
  1149. </td>
  1150. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#removeInvalidHandleType" href="output/Ext.dd.DragDrop.html#removeInvalidHandleType">DragDrop</a></td>
  1151. </tr>
  1152. <tr class="method-row inherited expandable">
  1153. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1154. <td class="sig">
  1155. <a id="Ext.dd.DropZone-resetConstraints"></a>
  1156. <b>resetConstraints</b>(&nbsp;<code>boolean maintainOffset</code>&nbsp;) : void <div class="mdesc">
  1157. <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
  1158. <div class="long">
  1159. resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
  1160. <strong>Parameters:</strong>
  1161. <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
  1162. <strong>Returns:</strong>
  1163. <ul>
  1164. <li><code>void</code></li>
  1165. </ul>
  1166. </div>
  1167. </div>
  1168. </div>
  1169. </td>
  1170. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#resetConstraints" href="output/Ext.dd.DragDrop.html#resetConstraints">DragDrop</a></td>
  1171. </tr>
  1172. <tr class="method-row inherited alt expandable">
  1173. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1174. <td class="sig">
  1175. <a id="Ext.dd.DropZone-setDragElId"></a>
  1176. <b>setDragElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void <div class="mdesc">
  1177. <div class="short">Allows you to specify that an element other than the linked element
  1178. will be moved with the cursor during a drag</div>
  1179. <div class="long">
  1180. Allows you to specify that an element other than the linked element
  1181. will be moved with the cursor during a drag <div class="mdetail-params">
  1182. <strong>Parameters:</strong>
  1183. <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to initiate the drag</div></li> </ul>
  1184. <strong>Returns:</strong>
  1185. <ul>
  1186. <li><code>void</code></li>
  1187. </ul>
  1188. </div>
  1189. </div>
  1190. </div>
  1191. </td>
  1192. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setDragElId" href="output/Ext.dd.DragDrop.html#setDragElId">DragDrop</a></td>
  1193. </tr>
  1194. <tr class="method-row inherited expandable">
  1195. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1196. <td class="sig">
  1197. <a id="Ext.dd.DropZone-setHandleElId"></a>
  1198. <b>setHandleElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void <div class="mdesc">
  1199. <div class="short">Allows you to specify a child of the linked element that should be
  1200. used to initiate the drag operation. An example o...</div>
  1201. <div class="long">
  1202. Allows you to specify a child of the linked element that should be
  1203. used to initiate the drag operation. An example of this would be if
  1204. you have a content div with text and links. Clicking anywhere in the
  1205. content area would normally start the drag operation. Use this method
  1206. to specify that an element inside of the content div is the element
  1207. that starts the drag operation. <div class="mdetail-params">
  1208. <strong>Parameters:</strong>
  1209. <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
  1210. initiate the drag.</div></li> </ul>
  1211. <strong>Returns:</strong>
  1212. <ul>
  1213. <li><code>void</code></li>
  1214. </ul>
  1215. </div>
  1216. </div>
  1217. </div>
  1218. </td>
  1219. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setHandleElId" href="output/Ext.dd.DragDrop.html#setHandleElId">DragDrop</a></td>
  1220. </tr>
  1221. <tr class="method-row inherited alt expandable">
  1222. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1223. <td class="sig">
  1224. <a id="Ext.dd.DropZone-setInitialPosition"></a>
  1225. <b>setInitialPosition</b>(&nbsp;<code>int diffX</code>, <code>int diffY</code>&nbsp;) : void <div class="mdesc">
  1226. <div class="short">Stores the initial placement of the linked element.</div>
  1227. <div class="long">
  1228. Stores the initial placement of the linked element. <div class="mdetail-params">
  1229. <strong>Parameters:</strong>
  1230. <ul><li><code>diffX</code> : int<div class="sub-desc">the X offset, default 0</div></li><li><code>diffY</code> : int<div class="sub-desc">the Y offset, default 0</div></li> </ul>
  1231. <strong>Returns:</strong>
  1232. <ul>
  1233. <li><code>void</code></li>
  1234. </ul>
  1235. </div>
  1236. </div>
  1237. </div>
  1238. </td>
  1239. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setInitialPosition" href="output/Ext.dd.DragDrop.html#setInitialPosition">DragDrop</a></td>
  1240. </tr>
  1241. <tr class="method-row inherited expandable">
  1242. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1243. <td class="sig">
  1244. <a id="Ext.dd.DropZone-setOuterHandleElId"></a>
  1245. <b>setOuterHandleElId</b>(&nbsp;<code>id the</code>&nbsp;) : void <div class="mdesc">
  1246. <div class="short">Allows you to set an element outside of the linked element as a drag
  1247. handle</div>
  1248. <div class="long">
  1249. Allows you to set an element outside of the linked element as a drag
  1250. handle <div class="mdetail-params">
  1251. <strong>Parameters:</strong>
  1252. <ul><li><code>the</code> : id<div class="sub-desc">id of the element that will be used to initiate the drag</div></li> </ul>
  1253. <strong>Returns:</strong>
  1254. <ul>
  1255. <li><code>void</code></li>
  1256. </ul>
  1257. </div>
  1258. </div>
  1259. </div>
  1260. </td>
  1261. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setOuterHandleElId" href="output/Ext.dd.DragDrop.html#setOuterHandleElId">DragDrop</a></td>
  1262. </tr>
  1263. <tr class="method-row inherited alt expandable">
  1264. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1265. <td class="sig">
  1266. <a id="Ext.dd.DropZone-setPadding"></a>
  1267. <b>setPadding</b>(&nbsp;<code>int iTop</code>, <code>int iRight</code>, <code>int iBot</code>, <code>int iLeft</code>&nbsp;) : void <div class="mdesc">
  1268. <div class="short">Configures the padding for the target zone in px. Effectively expands
  1269. (or reduces) the virtual object size for targe...</div>
  1270. <div class="long">
  1271. Configures the padding for the target zone in px. Effectively expands
  1272. (or reduces) the virtual object size for targeting calculations.
  1273. Supports css-style shorthand; if only one parameter is passed, all sides
  1274. will have that padding, and if only two are passed, the top and bottom
  1275. will have the first param, the left and right the second. <div class="mdetail-params">
  1276. <strong>Parameters:</strong>
  1277. <ul><li><code>iTop</code> : int<div class="sub-desc">Top pad</div></li><li><code>iRight</code> : int<div class="sub-desc">Right pad</div></li><li><code>iBot</code> : int<div class="sub-desc">Bot pad</div></li><li><code>iLeft</code> : int<div class="sub-desc">Left pad</div></li> </ul>
  1278. <strong>Returns:</strong>
  1279. <ul>
  1280. <li><code>void</code></li>
  1281. </ul>
  1282. </div>
  1283. </div>
  1284. </div>
  1285. </td>
  1286. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setPadding" href="output/Ext.dd.DragDrop.html#setPadding">DragDrop</a></td>
  1287. </tr>
  1288. <tr class="method-row inherited expandable">
  1289. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1290. <td class="sig">
  1291. <a id="Ext.dd.DropZone-setXConstraint"></a>
  1292. <b>setXConstraint</b>(&nbsp;<code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code>&nbsp;) : void <div class="mdesc">
  1293. <div class="short">By default, the element can be dragged any place on the screen. Use
  1294. this method to limit the horizontal travel of th...</div>
  1295. <div class="long">
  1296. By default, the element can be dragged any place on the screen. Use
  1297. this method to limit the horizontal travel of the element. Pass in
  1298. 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
  1299. <strong>Parameters:</strong>
  1300. <ul><li><code>iLeft</code> : int<div class="sub-desc">the number of pixels the element can move to the left</div></li><li><code>iRight</code> : int<div class="sub-desc">the number of pixels the element can move to the
  1301. right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
  1302. element
  1303. should move iTickSize pixels at a time.</div></li> </ul>
  1304. <strong>Returns:</strong>
  1305. <ul>
  1306. <li><code>void</code></li>
  1307. </ul>
  1308. </div>
  1309. </div>
  1310. </div>
  1311. </td>
  1312. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setXConstraint" href="output/Ext.dd.DragDrop.html#setXConstraint">DragDrop</a></td>
  1313. </tr>
  1314. <tr class="method-row inherited alt expandable">
  1315. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1316. <td class="sig">
  1317. <a id="Ext.dd.DropZone-setYConstraint"></a>
  1318. <b>setYConstraint</b>(&nbsp;<code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code>&nbsp;) : void <div class="mdesc">
  1319. <div class="short">By default, the element can be dragged any place on the screen. Set
  1320. this to limit the vertical travel of the element...</div>
  1321. <div class="long">
  1322. By default, the element can be dragged any place on the screen. Set
  1323. this to limit the vertical travel of the element. Pass in 0,0 for the
  1324. parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
  1325. <strong>Parameters:</strong>
  1326. <ul><li><code>iUp</code> : int<div class="sub-desc">the number of pixels the element can move up</div></li><li><code>iDown</code> : int<div class="sub-desc">the number of pixels the element can move down</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
  1327. element should move iTickSize pixels at a time.</div></li> </ul>
  1328. <strong>Returns:</strong>
  1329. <ul>
  1330. <li><code>void</code></li>
  1331. </ul>
  1332. </div>
  1333. </div>
  1334. </div>
  1335. </td>
  1336. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#setYConstraint" href="output/Ext.dd.DragDrop.html#setYConstraint">DragDrop</a></td>
  1337. </tr>
  1338. <tr class="method-row inherited expandable">
  1339. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1340. <td class="sig">
  1341. <a id="Ext.dd.DropZone-startDrag"></a>
  1342. <b>startDrag</b>(&nbsp;<code>int X</code>, <code>int Y</code>&nbsp;) : void <div class="mdesc">
  1343. <div class="short">Abstract method called after a drag/drop object is clicked
  1344. and the drag or mousedown time thresholds have beeen met.</div>
  1345. <div class="long">
  1346. Abstract method called after a drag/drop object is clicked
  1347. and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
  1348. <strong>Parameters:</strong>
  1349. <ul><li><code>X</code> : int<div class="sub-desc">click location</div></li><li><code>Y</code> : int<div class="sub-desc">click location</div></li> </ul>
  1350. <strong>Returns:</strong>
  1351. <ul>
  1352. <li><code>void</code></li>
  1353. </ul>
  1354. </div>
  1355. </div>
  1356. </div>
  1357. </td>
  1358. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#startDrag" href="output/Ext.dd.DragDrop.html#startDrag">DragDrop</a></td>
  1359. </tr>
  1360. <tr class="method-row inherited alt expandable">
  1361. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1362. <td class="sig">
  1363. <a id="Ext.dd.DropZone-toString"></a>
  1364. <b>toString</b>() : string <div class="mdesc">
  1365. <div class="short">toString method</div>
  1366. <div class="long">
  1367. toString method <div class="mdetail-params">
  1368. <strong>Parameters:</strong>
  1369. <ul><li>None.</li> </ul>
  1370. <strong>Returns:</strong>
  1371. <ul>
  1372. <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
  1373. </ul>
  1374. </div>
  1375. </div>
  1376. </div>
  1377. </td>
  1378. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#toString" href="output/Ext.dd.DragDrop.html#toString">DragDrop</a></td>
  1379. </tr>
  1380. <tr class="method-row inherited expandable">
  1381. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1382. <td class="sig">
  1383. <a id="Ext.dd.DropZone-unlock"></a>
  1384. <b>unlock</b>() : void <div class="mdesc">
  1385. <div class="short">Unlock this instace</div>
  1386. <div class="long">
  1387. Unlock this instace <div class="mdetail-params">
  1388. <strong>Parameters:</strong>
  1389. <ul><li>None.</li> </ul>
  1390. <strong>Returns:</strong>
  1391. <ul>
  1392. <li><code>void</code></li>
  1393. </ul>
  1394. </div>
  1395. </div>
  1396. </div>
  1397. </td>
  1398. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unlock" href="output/Ext.dd.DragDrop.html#unlock">DragDrop</a></td>
  1399. </tr>
  1400. <tr class="method-row inherited alt expandable">
  1401. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1402. <td class="sig">
  1403. <a id="Ext.dd.DropZone-unreg"></a>
  1404. <b>unreg</b>() : void <div class="mdesc">
  1405. <div class="short">Remove all drag and drop hooks for this element</div>
  1406. <div class="long">
  1407. Remove all drag and drop hooks for this element <div class="mdetail-params">
  1408. <strong>Parameters:</strong>
  1409. <ul><li>None.</li> </ul>
  1410. <strong>Returns:</strong>
  1411. <ul>
  1412. <li><code>void</code></li>
  1413. </ul>
  1414. </div>
  1415. </div>
  1416. </div>
  1417. </td>
  1418. <td class="msource"><a ext:cls="Ext.dd.DragDrop" ext:member="#unreg" href="output/Ext.dd.DragDrop.html#unreg">DragDrop</a></td>
  1419. </tr>
  1420. </table>
  1421. <a id="Ext.dd.DropZone-events"></a>
  1422. <h2>Public Events</h2>
  1423. <div class="no-members">This class has no public events.</div>
  1424. </div>