ffc09346d2a658b2d3b64a5301e0691107eb485c.svn-base 91 KB

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