9613462d457dca2ade2cd50cfdbd0f458f84592b.svn-base 54 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140
  1. <div class="body-wrap">
  2. <div class="top-tools">
  3. <a class="inner-link" href="#Ext.dd.DragDrop-props"><img src="../resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>
  4. <a class="inner-link" href="#Ext.dd.DragDrop-methods"><img src="../resources/images/default/s.gif" class="item-icon icon-method">Methods</a>
  5. <a class="inner-link" href="#Ext.dd.DragDrop-events"><img src="../resources/images/default/s.gif" class="item-icon icon-event">Events</a>
  6. <a class="bookmark" href="../docs/?class=Ext.dd.DragDrop"><img src="../resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>
  7. </div>
  8. <h1>Class Ext.dd.DragDrop</h1>
  9. <table cellspacing="0">
  10. <tr><td class="label">Package:</td><td class="hd-info">Ext.dd</td></tr>
  11. <tr><td class="label">Defined In:</td><td class="hd-info"><a href="../src/DDCore.js" target="_blank">DDCore.js</a></td></tr>
  12. <tr><td class="label">Class:</td><td class="hd-info">DragDrop</td></tr>
  13. <tr><td class="label">Subclasses:</td><td class="hd-info"><a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">DD</a>, <a ext:cls="Ext.dd.DDTarget" href="output/Ext.dd.DDTarget.html">DDTarget</a></td></tr>
  14. <tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr>
  15. </table>
  16. <div class="description">
  17. Defines the interface and base operation of items that that can be
  18. dragged or can be drop targets. It was designed to be extended, overriding
  19. the event handlers for startDrag, onDrag, onDragOver and onDragOut.
  20. Up to three html elements can be associated with a DragDrop instance:
  21. <ul>
  22. <li>linked element: the element that is passed into the constructor.
  23. This is the element which defines the boundaries for interaction with
  24. other DragDrop objects.</li>
  25. <li>handle element(s): The drag operation only occurs if the element that
  26. was clicked matches a handle element. By default this is the linked
  27. element, but there are times that you will want only a portion of the
  28. linked element to initiate the drag operation, and the setHandleElId()
  29. method provides a way to define this.</li>
  30. <li>drag element: this represents the element that would be moved along
  31. with the cursor during a drag operation. By default, this is the linked
  32. element itself as in <a ext:cls="Ext.dd.DD" href="output/Ext.dd.DD.html">Ext.dd.DD</a>. setDragElId() lets you define
  33. a separate element that would be moved, as in <a ext:cls="Ext.dd.DDProxy" href="output/Ext.dd.DDProxy.html">Ext.dd.DDProxy</a>.
  34. </li>
  35. </ul>
  36. This class should not be instantiated until the onload event to ensure that
  37. the associated elements are available.
  38. The following would define a DragDrop obj that would interact with any
  39. other DragDrop obj in the "group1" group:
  40. <pre>dd = new Ext.dd.DragDrop("div1", "group1");</pre>
  41. Since none of the event handlers have been implemented, nothing would
  42. actually happen if you were to run the code above. Normally you would
  43. override this class or one of the default implementations, but you can
  44. also override the methods you want on an instance of the class...
  45. <pre>dd.onDragDrop = function(e, id) {
  46. &nbsp;&nbsp;alert("dd was dropped on " + id);
  47. }</pre> </div>
  48. <div class="hr"></div>
  49. <a id="Ext.dd.DragDrop-props"></a>
  50. <h2>Public Properties</h2>
  51. <table cellspacing="0" class="member-table">
  52. <tr>
  53. <th class="sig-header" colspan="2">Property</th>
  54. <th class="msource-header">Defined By</th>
  55. </tr>
  56. <tr class="property-row">
  57. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  58. <td class="sig">
  59. <a id="Ext.dd.DragDrop-available"></a>
  60. <b>available</b> : boolean <div class="mdesc">
  61. The availabe property is false until the linked dom element is accessible. </div>
  62. </td>
  63. <td class="msource">DragDrop</td>
  64. </tr>
  65. <tr class="property-row alt">
  66. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  67. <td class="sig">
  68. <a id="Ext.dd.DragDrop-config"></a>
  69. <b>config</b> : object <div class="mdesc">
  70. Configuration attributes passed into the constructor </div>
  71. </td>
  72. <td class="msource">DragDrop</td>
  73. </tr>
  74. <tr class="property-row expandable">
  75. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  76. <td class="sig">
  77. <a id="Ext.dd.DragDrop-groups"></a>
  78. <b>groups</b> : object <div class="mdesc">
  79. <div class="short">The group defines a logical collection of DragDrop objects that are
  80. related. Instances only get events when interact...</div>
  81. <div class="long">
  82. The group defines a logical collection of DragDrop objects that are
  83. related. Instances only get events when interacting with other
  84. DragDrop object in the same group. This lets us define multiple
  85. groups using a single DragDrop subclass if we want. </div>
  86. </div>
  87. </td>
  88. <td class="msource">DragDrop</td>
  89. </tr>
  90. <tr class="property-row alt expandable">
  91. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  92. <td class="sig">
  93. <a id="Ext.dd.DragDrop-hasOuterHandles"></a>
  94. <b>hasOuterHandles</b> : boolean <div class="mdesc">
  95. <div class="short">By default, drags can only be initiated if the mousedown occurs in the
  96. region the linked element is. This is done in...</div>
  97. <div class="long">
  98. By default, drags can only be initiated if the mousedown occurs in the
  99. region the linked element is. This is done in part to work around a
  100. bug in some browsers that mis-report the mousedown if the previous
  101. mouseup happened outside of the window. This property is set to true
  102. if outer handles are defined. </div>
  103. </div>
  104. </td>
  105. <td class="msource">DragDrop</td>
  106. </tr>
  107. <tr class="property-row expandable">
  108. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  109. <td class="sig">
  110. <a id="Ext.dd.DragDrop-id"></a>
  111. <b>id</b> : String <div class="mdesc">
  112. <div class="short">The id of the element associated with this object. This is what we
  113. refer to as the "linked element" because the size...</div>
  114. <div class="long">
  115. The id of the element associated with this object. This is what we
  116. refer to as the "linked element" because the size and position of
  117. this element is used to determine when the drag and drop objects have
  118. interacted. </div>
  119. </div>
  120. </td>
  121. <td class="msource">DragDrop</td>
  122. </tr>
  123. <tr class="property-row alt">
  124. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  125. <td class="sig">
  126. <a id="Ext.dd.DragDrop-invalidHandleClasses"></a>
  127. <b>invalidHandleClasses</b> : string[] <div class="mdesc">
  128. An indexted array of css class names for elements that will be ignored
  129. if clicked. </div>
  130. </td>
  131. <td class="msource">DragDrop</td>
  132. </tr>
  133. <tr class="property-row">
  134. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  135. <td class="sig">
  136. <a id="Ext.dd.DragDrop-invalidHandleIds"></a>
  137. <b>invalidHandleIds</b> : string: <div class="mdesc">
  138. An associative array of ids for elements that will be ignored if clicked </div>
  139. </td>
  140. <td class="msource">DragDrop</td>
  141. </tr>
  142. <tr class="property-row alt">
  143. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  144. <td class="sig">
  145. <a id="Ext.dd.DragDrop-invalidHandleTypes"></a>
  146. <b>invalidHandleTypes</b> : string: <div class="mdesc">
  147. An associative array of HTML tags that will be ignored if clicked. </div>
  148. </td>
  149. <td class="msource">DragDrop</td>
  150. </tr>
  151. <tr class="property-row">
  152. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  153. <td class="sig">
  154. <a id="Ext.dd.DragDrop-isTarget"></a>
  155. <b>isTarget</b> : boolean <div class="mdesc">
  156. By default, all insances can be a drop target. This can be disabled by
  157. setting isTarget to false. </div>
  158. </td>
  159. <td class="msource">DragDrop</td>
  160. </tr>
  161. <tr class="property-row alt expandable">
  162. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  163. <td class="sig">
  164. <a id="Ext.dd.DragDrop-maintainOffset"></a>
  165. <b>maintainOffset</b> : boolean <div class="mdesc">
  166. <div class="short">Maintain offsets when we resetconstraints. Set to true when you want
  167. the position of the element relative to its par...</div>
  168. <div class="long">
  169. Maintain offsets when we resetconstraints. Set to true when you want
  170. the position of the element relative to its parent to stay the same
  171. when the page changes </div>
  172. </div>
  173. </td>
  174. <td class="msource">DragDrop</td>
  175. </tr>
  176. <tr class="property-row">
  177. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  178. <td class="sig">
  179. <a id="Ext.dd.DragDrop-padding"></a>
  180. <b>padding</b> : int[] <div class="mdesc">
  181. The padding configured for this drag and drop object for calculating
  182. the drop zone intersection with this object. </div>
  183. </td>
  184. <td class="msource">DragDrop</td>
  185. </tr>
  186. <tr class="property-row alt expandable">
  187. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  188. <td class="sig">
  189. <a id="Ext.dd.DragDrop-primaryButtonOnly"></a>
  190. <b>primaryButtonOnly</b> : boolean <div class="mdesc">
  191. <div class="short">By default the drag and drop instance will only respond to the primary
  192. button click (left button for a right-handed m...</div>
  193. <div class="long">
  194. By default the drag and drop instance will only respond to the primary
  195. button click (left button for a right-handed mouse). Set to true to
  196. allow drag and drop to start with any mouse click that is propogated
  197. by the browser </div>
  198. </div>
  199. </td>
  200. <td class="msource">DragDrop</td>
  201. </tr>
  202. <tr class="property-row expandable">
  203. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  204. <td class="sig">
  205. <a id="Ext.dd.DragDrop-xTicks"></a>
  206. <b>xTicks</b> : int[] <div class="mdesc">
  207. <div class="short">Array of pixel locations the element will snap to if we specified a
  208. horizontal graduation/interval. This array is ge...</div>
  209. <div class="long">
  210. Array of pixel locations the element will snap to if we specified a
  211. horizontal graduation/interval. This array is generated automatically
  212. when you define a tick interval. </div>
  213. </div>
  214. </td>
  215. <td class="msource">DragDrop</td>
  216. </tr>
  217. <tr class="property-row alt expandable">
  218. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  219. <td class="sig">
  220. <a id="Ext.dd.DragDrop-yTicks"></a>
  221. <b>yTicks</b> : int[] <div class="mdesc">
  222. <div class="short">Array of pixel locations the element will snap to if we specified a
  223. vertical graduation/interval. This array is gene...</div>
  224. <div class="long">
  225. Array of pixel locations the element will snap to if we specified a
  226. vertical graduation/interval. This array is generated automatically
  227. when you define a tick interval. </div>
  228. </div>
  229. </td>
  230. <td class="msource">DragDrop</td>
  231. </tr>
  232. </table>
  233. <a id="Ext.dd.DragDrop-methods"></a>
  234. <h2>Public Methods</h2>
  235. <table cellspacing="0" class="member-table">
  236. <tr>
  237. <th class="sig-header" colspan="2">Method</th>
  238. <th class="msource-header">Defined By</th>
  239. </tr>
  240. <tr class="method-row expandable">
  241. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  242. <td class="sig">
  243. <a id="Ext.dd.DragDrop-DragDrop"></a>
  244. <b>DragDrop</b>(&nbsp;<code>String id</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) <div class="mdesc">
  245. <div class="short"></div>
  246. <div class="long">
  247. <div class="mdetail-params">
  248. <strong>Parameters:</strong>
  249. <ul><li><code>id</code> : String<div class="sub-desc">of the element that is linked to this instance</div></li><li><code>sGroup</code> : String<div class="sub-desc">the group of related DragDrop objects</div></li><li><code>config</code> : object<div class="sub-desc">an object containing configurable attributes
  250. Valid properties for DragDrop:
  251. padding, isTarget, maintainOffset, primaryButtonOnly</div></li> </ul>
  252. <strong>Returns:</strong>
  253. <ul>
  254. <li><code></code></li>
  255. </ul>
  256. </div>
  257. </div>
  258. </div>
  259. </td>
  260. <td class="msource">DragDrop</td>
  261. </tr>
  262. <tr class="method-row alt expandable">
  263. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  264. <td class="sig">
  265. <a id="Ext.dd.DragDrop-addInvalidHandleClass"></a>
  266. <b>addInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void <div class="mdesc">
  267. <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
  268. <div class="long">
  269. Lets you specify a css class of elements that will not initiate a drag <div class="mdetail-params">
  270. <strong>Parameters:</strong>
  271. <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the elements you wish to ignore</div></li> </ul>
  272. <strong>Returns:</strong>
  273. <ul>
  274. <li><code>void</code></li>
  275. </ul>
  276. </div>
  277. </div>
  278. </div>
  279. </td>
  280. <td class="msource">DragDrop</td>
  281. </tr>
  282. <tr class="method-row expandable">
  283. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  284. <td class="sig">
  285. <a id="Ext.dd.DragDrop-addInvalidHandleId"></a>
  286. <b>addInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void <div class="mdesc">
  287. <div class="short">Lets you to specify an element id for a child of a drag handle
  288. that should not initiate a drag</div>
  289. <div class="long">
  290. Lets you to specify an element id for a child of a drag handle
  291. that should not initiate a drag <div class="mdetail-params">
  292. <strong>Parameters:</strong>
  293. <ul><li><code>id</code> : string<div class="sub-desc">the element id of the element 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">DragDrop</td>
  303. </tr>
  304. <tr class="method-row alt expandable">
  305. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  306. <td class="sig">
  307. <a id="Ext.dd.DragDrop-addInvalidHandleType"></a>
  308. <b>addInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void <div class="mdesc">
  309. <div class="short">Allows you to specify a tag name that should not start a drag operation
  310. when clicked. This is designed to facilitate...</div>
  311. <div class="long">
  312. Allows you to specify a tag name that should not start a drag operation
  313. when clicked. This is designed to facilitate embedding links within a
  314. drag handle that do something other than start the drag. <div class="mdetail-params">
  315. <strong>Parameters:</strong>
  316. <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to exclude</div></li> </ul>
  317. <strong>Returns:</strong>
  318. <ul>
  319. <li><code>void</code></li>
  320. </ul>
  321. </div>
  322. </div>
  323. </div>
  324. </td>
  325. <td class="msource">DragDrop</td>
  326. </tr>
  327. <tr class="method-row expandable">
  328. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  329. <td class="sig">
  330. <a id="Ext.dd.DragDrop-addToGroup"></a>
  331. <b>addToGroup</b>(&nbsp;<code>sGroup {string}</code>&nbsp;) : void <div class="mdesc">
  332. <div class="short">Add this instance to a group of related drag/drop objects. All
  333. instances belong to at least one group, and can belon...</div>
  334. <div class="long">
  335. Add this instance to a group of related drag/drop objects. All
  336. instances belong to at least one group, and can belong to as many
  337. groups as needed. <div class="mdetail-params">
  338. <strong>Parameters:</strong>
  339. <ul><li><code>{string}</code> : sGroup<div class="sub-desc">the name of the group</div></li> </ul>
  340. <strong>Returns:</strong>
  341. <ul>
  342. <li><code>void</code></li>
  343. </ul>
  344. </div>
  345. </div>
  346. </div>
  347. </td>
  348. <td class="msource">DragDrop</td>
  349. </tr>
  350. <tr class="method-row alt expandable">
  351. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  352. <td class="sig">
  353. <a id="Ext.dd.DragDrop-applyConfig"></a>
  354. <b>applyConfig</b>() : void <div class="mdesc">
  355. <div class="short">Applies the configuration parameters that were passed into the constructor.
  356. This is supposed to happen at each level ...</div>
  357. <div class="long">
  358. Applies the configuration parameters that were passed into the constructor.
  359. This is supposed to happen at each level through the inheritance chain. So
  360. a DDProxy implentation will execute apply config on DDProxy, DD, and
  361. DragDrop in order to get all of the parameters that are available in
  362. each object. <div class="mdetail-params">
  363. <strong>Parameters:</strong>
  364. <ul><li>None.</li> </ul>
  365. <strong>Returns:</strong>
  366. <ul>
  367. <li><code>void</code></li>
  368. </ul>
  369. </div>
  370. </div>
  371. </div>
  372. </td>
  373. <td class="msource">DragDrop</td>
  374. </tr>
  375. <tr class="method-row expandable">
  376. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  377. <td class="sig">
  378. <a id="Ext.dd.DragDrop-clearConstraints"></a>
  379. <b>clearConstraints</b>() : void <div class="mdesc">
  380. <div class="short">Clears any constraints applied to this instance. Also clears ticks
  381. since they can't exist independent of a constrain...</div>
  382. <div class="long">
  383. Clears any constraints applied to this instance. Also clears ticks
  384. since they can't exist independent of a constraint at this time. <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">DragDrop</td>
  396. </tr>
  397. <tr class="method-row alt expandable">
  398. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  399. <td class="sig">
  400. <a id="Ext.dd.DragDrop-clearTicks"></a>
  401. <b>clearTicks</b>() : void <div class="mdesc">
  402. <div class="short">Clears any tick interval defined for this instance</div>
  403. <div class="long">
  404. Clears any tick interval defined for this instance <div class="mdetail-params">
  405. <strong>Parameters:</strong>
  406. <ul><li>None.</li> </ul>
  407. <strong>Returns:</strong>
  408. <ul>
  409. <li><code>void</code></li>
  410. </ul>
  411. </div>
  412. </div>
  413. </div>
  414. </td>
  415. <td class="msource">DragDrop</td>
  416. </tr>
  417. <tr class="method-row expandable">
  418. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  419. <td class="sig">
  420. <a id="Ext.dd.DragDrop-endDrag"></a>
  421. <b>endDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  422. <div class="short">Fired when we are done dragging the object</div>
  423. <div class="long">
  424. Fired when we are done dragging the object <div class="mdetail-params">
  425. <strong>Parameters:</strong>
  426. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  427. <strong>Returns:</strong>
  428. <ul>
  429. <li><code>void</code></li>
  430. </ul>
  431. </div>
  432. </div>
  433. </div>
  434. </td>
  435. <td class="msource">DragDrop</td>
  436. </tr>
  437. <tr class="method-row alt expandable">
  438. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  439. <td class="sig">
  440. <a id="Ext.dd.DragDrop-getDragEl"></a>
  441. <b>getDragEl</b>() : HTMLElement <div class="mdesc">
  442. <div class="short">Returns a reference to the actual element to drag. By default this is
  443. the same as the html element, but it can be as...</div>
  444. <div class="long">
  445. Returns a reference to the actual element to drag. By default this is
  446. the same as the html element, but it can be assigned to another
  447. element. An example of this can be found in Ext.dd.DDProxy <div class="mdetail-params">
  448. <strong>Parameters:</strong>
  449. <ul><li>None.</li> </ul>
  450. <strong>Returns:</strong>
  451. <ul>
  452. <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
  453. </ul>
  454. </div>
  455. </div>
  456. </div>
  457. </td>
  458. <td class="msource">DragDrop</td>
  459. </tr>
  460. <tr class="method-row expandable">
  461. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  462. <td class="sig">
  463. <a id="Ext.dd.DragDrop-getEl"></a>
  464. <b>getEl</b>() : HTMLElement <div class="mdesc">
  465. <div class="short">Returns a reference to the linked element</div>
  466. <div class="long">
  467. Returns a reference to the linked element <div class="mdetail-params">
  468. <strong>Parameters:</strong>
  469. <ul><li>None.</li> </ul>
  470. <strong>Returns:</strong>
  471. <ul>
  472. <li><code>HTMLElement</code><div class="sub-desc">the html element</div></li>
  473. </ul>
  474. </div>
  475. </div>
  476. </div>
  477. </td>
  478. <td class="msource">DragDrop</td>
  479. </tr>
  480. <tr class="method-row alt expandable">
  481. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  482. <td class="sig">
  483. <a id="Ext.dd.DragDrop-init"></a>
  484. <b>init</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void <div class="mdesc">
  485. <div class="short">Sets up the DragDrop object. Must be called in the constructor of any
  486. Ext.dd.DragDrop subclass</div>
  487. <div class="long">
  488. Sets up the DragDrop object. Must be called in the constructor of any
  489. Ext.dd.DragDrop subclass <div class="mdetail-params">
  490. <strong>Parameters:</strong>
  491. <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>
  492. <strong>Returns:</strong>
  493. <ul>
  494. <li><code>void</code></li>
  495. </ul>
  496. </div>
  497. </div>
  498. </div>
  499. </td>
  500. <td class="msource">DragDrop</td>
  501. </tr>
  502. <tr class="method-row expandable">
  503. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  504. <td class="sig">
  505. <a id="Ext.dd.DragDrop-initTarget"></a>
  506. <b>initTarget</b>(&nbsp;<code>id the</code>, <code>String sGroup</code>, <code>object config</code>&nbsp;) : void <div class="mdesc">
  507. <div class="short">Initializes Targeting functionality only... the object does not
  508. get a mousedown handler.</div>
  509. <div class="long">
  510. Initializes Targeting functionality only... the object does not
  511. get a mousedown handler. <div class="mdetail-params">
  512. <strong>Parameters:</strong>
  513. <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>
  514. <strong>Returns:</strong>
  515. <ul>
  516. <li><code>void</code></li>
  517. </ul>
  518. </div>
  519. </div>
  520. </div>
  521. </td>
  522. <td class="msource">DragDrop</td>
  523. </tr>
  524. <tr class="method-row alt expandable">
  525. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  526. <td class="sig">
  527. <a id="Ext.dd.DragDrop-isLocked"></a>
  528. <b>isLocked</b>() : boolean <div class="mdesc">
  529. <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked
  530. (meaning that all drag/drop is disabled on th...</div>
  531. <div class="long">
  532. Returns true if this instance is locked, or the drag drop mgr is locked
  533. (meaning that all drag/drop is disabled on the page.) <div class="mdetail-params">
  534. <strong>Parameters:</strong>
  535. <ul><li>None.</li> </ul>
  536. <strong>Returns:</strong>
  537. <ul>
  538. <li><code>boolean</code><div class="sub-desc">true if this obj or all drag/drop is locked, else false</div></li>
  539. </ul>
  540. </div>
  541. </div>
  542. </div>
  543. </td>
  544. <td class="msource">DragDrop</td>
  545. </tr>
  546. <tr class="method-row expandable">
  547. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  548. <td class="sig">
  549. <a id="Ext.dd.DragDrop-isValidHandleChild"></a>
  550. <b>isValidHandleChild</b>(&nbsp;<code>HTMLElement node</code>&nbsp;) : boolean <div class="mdesc">
  551. <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
  552. <div class="long">
  553. Checks the tag exclusion list to see if this click should be ignored <div class="mdetail-params">
  554. <strong>Parameters:</strong>
  555. <ul><li><code>node</code> : HTMLElement<div class="sub-desc">the HTMLElement to evaluate</div></li> </ul>
  556. <strong>Returns:</strong>
  557. <ul>
  558. <li><code>boolean</code><div class="sub-desc">true if this is a valid tag type, false if not</div></li>
  559. </ul>
  560. </div>
  561. </div>
  562. </div>
  563. </td>
  564. <td class="msource">DragDrop</td>
  565. </tr>
  566. <tr class="method-row alt expandable">
  567. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  568. <td class="sig">
  569. <a id="Ext.dd.DragDrop-lock"></a>
  570. <b>lock</b>() : void <div class="mdesc">
  571. <div class="short">Lock this instance</div>
  572. <div class="long">
  573. Lock this instance <div class="mdetail-params">
  574. <strong>Parameters:</strong>
  575. <ul><li>None.</li> </ul>
  576. <strong>Returns:</strong>
  577. <ul>
  578. <li><code>void</code></li>
  579. </ul>
  580. </div>
  581. </div>
  582. </div>
  583. </td>
  584. <td class="msource">DragDrop</td>
  585. </tr>
  586. <tr class="method-row expandable">
  587. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  588. <td class="sig">
  589. <a id="Ext.dd.DragDrop-onAvailable"></a>
  590. <b>onAvailable</b>() : void <div class="mdesc">
  591. <div class="short">Override the onAvailable method to do what is needed after the initial
  592. position was determined.</div>
  593. <div class="long">
  594. Override the onAvailable method to do what is needed after the initial
  595. position was determined. <div class="mdetail-params">
  596. <strong>Parameters:</strong>
  597. <ul><li>None.</li> </ul>
  598. <strong>Returns:</strong>
  599. <ul>
  600. <li><code>void</code></li>
  601. </ul>
  602. </div>
  603. </div>
  604. </div>
  605. </td>
  606. <td class="msource">DragDrop</td>
  607. </tr>
  608. <tr class="method-row alt expandable">
  609. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  610. <td class="sig">
  611. <a id="Ext.dd.DragDrop-onDrag"></a>
  612. <b>onDrag</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  613. <div class="short">Abstract method called during the onMouseMove event while dragging an
  614. object.</div>
  615. <div class="long">
  616. Abstract method called during the onMouseMove event while dragging an
  617. object. <div class="mdetail-params">
  618. <strong>Parameters:</strong>
  619. <ul><li><code>e</code> : Event<div class="sub-desc">the mousemove event</div></li> </ul>
  620. <strong>Returns:</strong>
  621. <ul>
  622. <li><code>void</code></li>
  623. </ul>
  624. </div>
  625. </div>
  626. </div>
  627. </td>
  628. <td class="msource">DragDrop</td>
  629. </tr>
  630. <tr class="method-row expandable">
  631. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  632. <td class="sig">
  633. <a id="Ext.dd.DragDrop-onDragDrop"></a>
  634. <b>onDragDrop</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  635. <div class="short">Abstract method called when this item is dropped on another DragDrop
  636. obj</div>
  637. <div class="long">
  638. Abstract method called when this item is dropped on another DragDrop
  639. obj <div class="mdetail-params">
  640. <strong>Parameters:</strong>
  641. <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
  642. id this was dropped on. In INTERSECT mode, an array of dd items this
  643. was dropped on.</div></li> </ul>
  644. <strong>Returns:</strong>
  645. <ul>
  646. <li><code>void</code></li>
  647. </ul>
  648. </div>
  649. </div>
  650. </div>
  651. </td>
  652. <td class="msource">DragDrop</td>
  653. </tr>
  654. <tr class="method-row alt expandable">
  655. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  656. <td class="sig">
  657. <a id="Ext.dd.DragDrop-onDragEnter"></a>
  658. <b>onDragEnter</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  659. <div class="short">Abstract method called when this element fist begins hovering over
  660. another DragDrop obj</div>
  661. <div class="long">
  662. Abstract method called when this element fist begins hovering over
  663. another DragDrop obj <div class="mdetail-params">
  664. <strong>Parameters:</strong>
  665. <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
  666. id this is hovering over. In INTERSECT mode, an array of one or more
  667. dragdrop items being hovered over.</div></li> </ul>
  668. <strong>Returns:</strong>
  669. <ul>
  670. <li><code>void</code></li>
  671. </ul>
  672. </div>
  673. </div>
  674. </div>
  675. </td>
  676. <td class="msource">DragDrop</td>
  677. </tr>
  678. <tr class="method-row expandable">
  679. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  680. <td class="sig">
  681. <a id="Ext.dd.DragDrop-onDragOut"></a>
  682. <b>onDragOut</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  683. <div class="short">Abstract method called when we are no longer hovering over an element</div>
  684. <div class="long">
  685. Abstract method called when we are no longer hovering over an element <div class="mdetail-params">
  686. <strong>Parameters:</strong>
  687. <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
  688. id this was hovering over. In INTERSECT mode, an array of dd items
  689. that the mouse is no longer over.</div></li> </ul>
  690. <strong>Returns:</strong>
  691. <ul>
  692. <li><code>void</code></li>
  693. </ul>
  694. </div>
  695. </div>
  696. </div>
  697. </td>
  698. <td class="msource">DragDrop</td>
  699. </tr>
  700. <tr class="method-row alt expandable">
  701. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  702. <td class="sig">
  703. <a id="Ext.dd.DragDrop-onDragOver"></a>
  704. <b>onDragOver</b>(&nbsp;<code>Event e</code>, <code>String|DragDrop[] id</code>&nbsp;) : void <div class="mdesc">
  705. <div class="short">Abstract method called when this element is hovering over another
  706. DragDrop obj</div>
  707. <div class="long">
  708. Abstract method called when this element is hovering over another
  709. DragDrop obj <div class="mdetail-params">
  710. <strong>Parameters:</strong>
  711. <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
  712. id this is hovering over. In INTERSECT mode, an array of dd items
  713. being hovered over.</div></li> </ul>
  714. <strong>Returns:</strong>
  715. <ul>
  716. <li><code>void</code></li>
  717. </ul>
  718. </div>
  719. </div>
  720. </div>
  721. </td>
  722. <td class="msource">DragDrop</td>
  723. </tr>
  724. <tr class="method-row expandable">
  725. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  726. <td class="sig">
  727. <a id="Ext.dd.DragDrop-onInvalidDrop"></a>
  728. <b>onInvalidDrop</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  729. <div class="short">Abstract method called when this item is dropped on an area with no
  730. drop target</div>
  731. <div class="long">
  732. Abstract method called when this item is dropped on an area with no
  733. drop target <div class="mdetail-params">
  734. <strong>Parameters:</strong>
  735. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  736. <strong>Returns:</strong>
  737. <ul>
  738. <li><code>void</code></li>
  739. </ul>
  740. </div>
  741. </div>
  742. </div>
  743. </td>
  744. <td class="msource">DragDrop</td>
  745. </tr>
  746. <tr class="method-row alt expandable">
  747. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  748. <td class="sig">
  749. <a id="Ext.dd.DragDrop-onMouseDown"></a>
  750. <b>onMouseDown</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  751. <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
  752. <div class="long">
  753. Event handler that fires when a drag/drop obj gets a mousedown <div class="mdetail-params">
  754. <strong>Parameters:</strong>
  755. <ul><li><code>e</code> : Event<div class="sub-desc">the mousedown event</div></li> </ul>
  756. <strong>Returns:</strong>
  757. <ul>
  758. <li><code>void</code></li>
  759. </ul>
  760. </div>
  761. </div>
  762. </div>
  763. </td>
  764. <td class="msource">DragDrop</td>
  765. </tr>
  766. <tr class="method-row expandable">
  767. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  768. <td class="sig">
  769. <a id="Ext.dd.DragDrop-onMouseUp"></a>
  770. <b>onMouseUp</b>(&nbsp;<code>Event e</code>&nbsp;) : void <div class="mdesc">
  771. <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
  772. <div class="long">
  773. Event handler that fires when a drag/drop obj gets a mouseup <div class="mdetail-params">
  774. <strong>Parameters:</strong>
  775. <ul><li><code>e</code> : Event<div class="sub-desc">the mouseup event</div></li> </ul>
  776. <strong>Returns:</strong>
  777. <ul>
  778. <li><code>void</code></li>
  779. </ul>
  780. </div>
  781. </div>
  782. </div>
  783. </td>
  784. <td class="msource">DragDrop</td>
  785. </tr>
  786. <tr class="method-row alt expandable">
  787. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  788. <td class="sig">
  789. <a id="Ext.dd.DragDrop-removeFromGroup"></a>
  790. <b>removeFromGroup</b>(&nbsp;<code>string sGroup</code>&nbsp;) : void <div class="mdesc">
  791. <div class="short">Remove's this instance from the supplied interaction group</div>
  792. <div class="long">
  793. Remove's this instance from the supplied interaction group <div class="mdetail-params">
  794. <strong>Parameters:</strong>
  795. <ul><li><code>sGroup</code> : string<div class="sub-desc">The group to drop</div></li> </ul>
  796. <strong>Returns:</strong>
  797. <ul>
  798. <li><code>void</code></li>
  799. </ul>
  800. </div>
  801. </div>
  802. </div>
  803. </td>
  804. <td class="msource">DragDrop</td>
  805. </tr>
  806. <tr class="method-row expandable">
  807. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  808. <td class="sig">
  809. <a id="Ext.dd.DragDrop-removeInvalidHandleClass"></a>
  810. <b>removeInvalidHandleClass</b>(&nbsp;<code>string cssClass</code>&nbsp;) : void <div class="mdesc">
  811. <div class="short">Unsets an invalid css class</div>
  812. <div class="long">
  813. Unsets an invalid css class <div class="mdetail-params">
  814. <strong>Parameters:</strong>
  815. <ul><li><code>cssClass</code> : string<div class="sub-desc">the class of the element(s) you wish to
  816. re-enable</div></li> </ul>
  817. <strong>Returns:</strong>
  818. <ul>
  819. <li><code>void</code></li>
  820. </ul>
  821. </div>
  822. </div>
  823. </div>
  824. </td>
  825. <td class="msource">DragDrop</td>
  826. </tr>
  827. <tr class="method-row alt expandable">
  828. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  829. <td class="sig">
  830. <a id="Ext.dd.DragDrop-removeInvalidHandleId"></a>
  831. <b>removeInvalidHandleId</b>(&nbsp;<code>string id</code>&nbsp;) : void <div class="mdesc">
  832. <div class="short">Unsets an invalid handle id</div>
  833. <div class="long">
  834. Unsets an invalid handle id <div class="mdetail-params">
  835. <strong>Parameters:</strong>
  836. <ul><li><code>id</code> : string<div class="sub-desc">the id of the element to re-enable</div></li> </ul>
  837. <strong>Returns:</strong>
  838. <ul>
  839. <li><code>void</code></li>
  840. </ul>
  841. </div>
  842. </div>
  843. </div>
  844. </td>
  845. <td class="msource">DragDrop</td>
  846. </tr>
  847. <tr class="method-row expandable">
  848. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  849. <td class="sig">
  850. <a id="Ext.dd.DragDrop-removeInvalidHandleType"></a>
  851. <b>removeInvalidHandleType</b>(&nbsp;<code>string tagName</code>&nbsp;) : void <div class="mdesc">
  852. <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
  853. <div class="long">
  854. Unsets an excluded tag name set by addInvalidHandleType <div class="mdetail-params">
  855. <strong>Parameters:</strong>
  856. <ul><li><code>tagName</code> : string<div class="sub-desc">the type of element to unexclude</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">DragDrop</td>
  866. </tr>
  867. <tr class="method-row alt expandable">
  868. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  869. <td class="sig">
  870. <a id="Ext.dd.DragDrop-resetConstraints"></a>
  871. <b>resetConstraints</b>(&nbsp;<code>boolean maintainOffset</code>&nbsp;) : void <div class="mdesc">
  872. <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
  873. <div class="long">
  874. resetConstraints must be called if you manually reposition a dd element. <div class="mdetail-params">
  875. <strong>Parameters:</strong>
  876. <ul><li><code>maintainOffset</code> : boolean<div class="sub-desc"></div></li> </ul>
  877. <strong>Returns:</strong>
  878. <ul>
  879. <li><code>void</code></li>
  880. </ul>
  881. </div>
  882. </div>
  883. </div>
  884. </td>
  885. <td class="msource">DragDrop</td>
  886. </tr>
  887. <tr class="method-row expandable">
  888. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  889. <td class="sig">
  890. <a id="Ext.dd.DragDrop-setDragElId"></a>
  891. <b>setDragElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void <div class="mdesc">
  892. <div class="short">Allows you to specify that an element other than the linked element
  893. will be moved with the cursor during a drag</div>
  894. <div class="long">
  895. Allows you to specify that an element other than the linked element
  896. will be moved with the cursor during a drag <div class="mdetail-params">
  897. <strong>Parameters:</strong>
  898. <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>
  899. <strong>Returns:</strong>
  900. <ul>
  901. <li><code>void</code></li>
  902. </ul>
  903. </div>
  904. </div>
  905. </div>
  906. </td>
  907. <td class="msource">DragDrop</td>
  908. </tr>
  909. <tr class="method-row alt expandable">
  910. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  911. <td class="sig">
  912. <a id="Ext.dd.DragDrop-setHandleElId"></a>
  913. <b>setHandleElId</b>(&nbsp;<code>id {string}</code>&nbsp;) : void <div class="mdesc">
  914. <div class="short">Allows you to specify a child of the linked element that should be
  915. used to initiate the drag operation. An example o...</div>
  916. <div class="long">
  917. Allows you to specify a child of the linked element that should be
  918. used to initiate the drag operation. An example of this would be if
  919. you have a content div with text and links. Clicking anywhere in the
  920. content area would normally start the drag operation. Use this method
  921. to specify that an element inside of the content div is the element
  922. that starts the drag operation. <div class="mdetail-params">
  923. <strong>Parameters:</strong>
  924. <ul><li><code>{string}</code> : id<div class="sub-desc">the id of the element that will be used to
  925. initiate the drag.</div></li> </ul>
  926. <strong>Returns:</strong>
  927. <ul>
  928. <li><code>void</code></li>
  929. </ul>
  930. </div>
  931. </div>
  932. </div>
  933. </td>
  934. <td class="msource">DragDrop</td>
  935. </tr>
  936. <tr class="method-row expandable">
  937. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  938. <td class="sig">
  939. <a id="Ext.dd.DragDrop-setInitialPosition"></a>
  940. <b>setInitialPosition</b>(&nbsp;<code>int diffX</code>, <code>int diffY</code>&nbsp;) : void <div class="mdesc">
  941. <div class="short">Stores the initial placement of the linked element.</div>
  942. <div class="long">
  943. Stores the initial placement of the linked element. <div class="mdetail-params">
  944. <strong>Parameters:</strong>
  945. <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>
  946. <strong>Returns:</strong>
  947. <ul>
  948. <li><code>void</code></li>
  949. </ul>
  950. </div>
  951. </div>
  952. </div>
  953. </td>
  954. <td class="msource">DragDrop</td>
  955. </tr>
  956. <tr class="method-row alt expandable">
  957. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  958. <td class="sig">
  959. <a id="Ext.dd.DragDrop-setOuterHandleElId"></a>
  960. <b>setOuterHandleElId</b>(&nbsp;<code>id the</code>&nbsp;) : void <div class="mdesc">
  961. <div class="short">Allows you to set an element outside of the linked element as a drag
  962. handle</div>
  963. <div class="long">
  964. Allows you to set an element outside of the linked element as a drag
  965. handle <div class="mdetail-params">
  966. <strong>Parameters:</strong>
  967. <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>
  968. <strong>Returns:</strong>
  969. <ul>
  970. <li><code>void</code></li>
  971. </ul>
  972. </div>
  973. </div>
  974. </div>
  975. </td>
  976. <td class="msource">DragDrop</td>
  977. </tr>
  978. <tr class="method-row expandable">
  979. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  980. <td class="sig">
  981. <a id="Ext.dd.DragDrop-setPadding"></a>
  982. <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">
  983. <div class="short">Configures the padding for the target zone in px. Effectively expands
  984. (or reduces) the virtual object size for targe...</div>
  985. <div class="long">
  986. Configures the padding for the target zone in px. Effectively expands
  987. (or reduces) the virtual object size for targeting calculations.
  988. Supports css-style shorthand; if only one parameter is passed, all sides
  989. will have that padding, and if only two are passed, the top and bottom
  990. will have the first param, the left and right the second. <div class="mdetail-params">
  991. <strong>Parameters:</strong>
  992. <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>
  993. <strong>Returns:</strong>
  994. <ul>
  995. <li><code>void</code></li>
  996. </ul>
  997. </div>
  998. </div>
  999. </div>
  1000. </td>
  1001. <td class="msource">DragDrop</td>
  1002. </tr>
  1003. <tr class="method-row alt expandable">
  1004. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1005. <td class="sig">
  1006. <a id="Ext.dd.DragDrop-setXConstraint"></a>
  1007. <b>setXConstraint</b>(&nbsp;<code>int iLeft</code>, <code>int iRight</code>, <code>int iTickSize</code>&nbsp;) : void <div class="mdesc">
  1008. <div class="short">By default, the element can be dragged any place on the screen. Use
  1009. this method to limit the horizontal travel of th...</div>
  1010. <div class="long">
  1011. By default, the element can be dragged any place on the screen. Use
  1012. this method to limit the horizontal travel of the element. Pass in
  1013. 0,0 for the parameters if you want to lock the drag to the y axis. <div class="mdetail-params">
  1014. <strong>Parameters:</strong>
  1015. <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
  1016. right</div></li><li><code>iTickSize</code> : int<div class="sub-desc">optional parameter for specifying that the
  1017. element
  1018. should move iTickSize pixels at a time.</div></li> </ul>
  1019. <strong>Returns:</strong>
  1020. <ul>
  1021. <li><code>void</code></li>
  1022. </ul>
  1023. </div>
  1024. </div>
  1025. </div>
  1026. </td>
  1027. <td class="msource">DragDrop</td>
  1028. </tr>
  1029. <tr class="method-row expandable">
  1030. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1031. <td class="sig">
  1032. <a id="Ext.dd.DragDrop-setYConstraint"></a>
  1033. <b>setYConstraint</b>(&nbsp;<code>int iUp</code>, <code>int iDown</code>, <code>int iTickSize</code>&nbsp;) : void <div class="mdesc">
  1034. <div class="short">By default, the element can be dragged any place on the screen. Set
  1035. this to limit the vertical travel of the element...</div>
  1036. <div class="long">
  1037. By default, the element can be dragged any place on the screen. Set
  1038. this to limit the vertical travel of the element. Pass in 0,0 for the
  1039. parameters if you want to lock the drag to the x axis. <div class="mdetail-params">
  1040. <strong>Parameters:</strong>
  1041. <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
  1042. element should move iTickSize pixels at a time.</div></li> </ul>
  1043. <strong>Returns:</strong>
  1044. <ul>
  1045. <li><code>void</code></li>
  1046. </ul>
  1047. </div>
  1048. </div>
  1049. </div>
  1050. </td>
  1051. <td class="msource">DragDrop</td>
  1052. </tr>
  1053. <tr class="method-row alt expandable">
  1054. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1055. <td class="sig">
  1056. <a id="Ext.dd.DragDrop-startDrag"></a>
  1057. <b>startDrag</b>(&nbsp;<code>int X</code>, <code>int Y</code>&nbsp;) : void <div class="mdesc">
  1058. <div class="short">Abstract method called after a drag/drop object is clicked
  1059. and the drag or mousedown time thresholds have beeen met.</div>
  1060. <div class="long">
  1061. Abstract method called after a drag/drop object is clicked
  1062. and the drag or mousedown time thresholds have beeen met. <div class="mdetail-params">
  1063. <strong>Parameters:</strong>
  1064. <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>
  1065. <strong>Returns:</strong>
  1066. <ul>
  1067. <li><code>void</code></li>
  1068. </ul>
  1069. </div>
  1070. </div>
  1071. </div>
  1072. </td>
  1073. <td class="msource">DragDrop</td>
  1074. </tr>
  1075. <tr class="method-row expandable">
  1076. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1077. <td class="sig">
  1078. <a id="Ext.dd.DragDrop-toString"></a>
  1079. <b>toString</b>() : string <div class="mdesc">
  1080. <div class="short">toString method</div>
  1081. <div class="long">
  1082. toString method <div class="mdetail-params">
  1083. <strong>Parameters:</strong>
  1084. <ul><li>None.</li> </ul>
  1085. <strong>Returns:</strong>
  1086. <ul>
  1087. <li><code>string</code><div class="sub-desc">string representation of the dd obj</div></li>
  1088. </ul>
  1089. </div>
  1090. </div>
  1091. </div>
  1092. </td>
  1093. <td class="msource">DragDrop</td>
  1094. </tr>
  1095. <tr class="method-row alt expandable">
  1096. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1097. <td class="sig">
  1098. <a id="Ext.dd.DragDrop-unlock"></a>
  1099. <b>unlock</b>() : void <div class="mdesc">
  1100. <div class="short">Unlock this instace</div>
  1101. <div class="long">
  1102. Unlock this instace <div class="mdetail-params">
  1103. <strong>Parameters:</strong>
  1104. <ul><li>None.</li> </ul>
  1105. <strong>Returns:</strong>
  1106. <ul>
  1107. <li><code>void</code></li>
  1108. </ul>
  1109. </div>
  1110. </div>
  1111. </div>
  1112. </td>
  1113. <td class="msource">DragDrop</td>
  1114. </tr>
  1115. <tr class="method-row expandable">
  1116. <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
  1117. <td class="sig">
  1118. <a id="Ext.dd.DragDrop-unreg"></a>
  1119. <b>unreg</b>() : void <div class="mdesc">
  1120. <div class="short">Remove all drag and drop hooks for this element</div>
  1121. <div class="long">
  1122. Remove all drag and drop hooks for this element <div class="mdetail-params">
  1123. <strong>Parameters:</strong>
  1124. <ul><li>None.</li> </ul>
  1125. <strong>Returns:</strong>
  1126. <ul>
  1127. <li><code>void</code></li>
  1128. </ul>
  1129. </div>
  1130. </div>
  1131. </div>
  1132. </td>
  1133. <td class="msource">DragDrop</td>
  1134. </tr>
  1135. </table>
  1136. <a id="Ext.dd.DragDrop-events"></a>
  1137. <h2>Public Events</h2>
  1138. <div class="no-members">This class has no public events.</div>
  1139. </div>