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