git.roojs.org Git - roojs1/blob - docs.old/symbols/Roo.dd.DragDrop.html

   1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
   2
   3
   4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   5
   6         <head>
   7                 <meta http-equiv="content-type" content="text/html; charset=undefined" />
   8                 <meta name="generator" content="JsDoc Toolkit" />
   9
  10
  11                 <title>JsDoc Reference - Roo.dd.DragDrop</title>
  12
  13
  14         <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
  15         <link rel="stylesheet" type="text/css" href="../default.css" />
  16
  17
  18         <script type="text/javascript" src="../page.js">
  19
  20         </script>
  21
  22
  23         </head>
  24
  25         <body onload="RooDocsPage.onload();">
  26
  27
  28 <div class="body-wrap">
  29
  30     <!-- ============================== links to methods. ================================= -->
  31
  32     <div class="top-tools">
  33     <!--
  34         <a class="inner-link" href="#Roo.dd.DragDrop-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DragDrop-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DragDrop-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DragDrop-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragDrop
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DragDrop
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_dd_DragDrop.js.html">Roo/dd/DragDrop.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DragDrop</td></tr>
  70
  71
  72         <tr><td class="label">Subclasses:</td><td class="hd-info">
  73                 <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>, <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>, <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>, <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>, <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>, <a href="./Roo.dd.DropTarget.html#constructor" roo:cls="Roo.dd.DropTarget.html#constructor">Roo.dd.DropTarget</a>, <a href="./Roo.dd.DropZone.html#constructor" roo:cls="Roo.dd.DropZone.html#constructor">Roo.dd.DropZone</a>
  74
  75
  76
  77         </td></tr>
  78
  79
  80
  81                 <tr><td class="label">Extends:</td><td class="hd-info">
  82                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  83
  84                 </td></tr>
  85
  86
  87     </table>
  88
  89
  90 <!-- ============================== class summary ========================== -->
  91     <div class="description">
  92         Defines the interface and base operation of items that that can be<br/>dragged or can be drop targets.  It was designed to be extended, overriding<br/>the event handlers for startDrag, onDrag, onDragOver and onDragOut.<br/>Up to three html elements can be associated with a DragDrop instance:<br/><ul><br/><li>linked element: the element that is passed into the constructor.<br/>This is the element which defines the boundaries for interaction with<br/>other DragDrop objects.</li><br/><li>handle element(s): The drag operation only occurs if the element that<br/>was clicked matches a handle element.  By default this is the linked<br/>element, but there are times that you will want only a portion of the<br/>linked element to initiate the drag operation, and the setHandleElId()<br/>method provides a way to define this.</li><br/><li>drag element: this represents the element that would be moved along<br/>with the cursor during a drag operation.  By default, this is the linked<br/>element itself as in {<b>link</b> Roo.dd.DD}.  setDragElId() lets you define<br/>a separate element that would be moved, as in {<b>link</b> Roo.dd.DDProxy}.<br/></li><br/></ul><br/>This class should not be instantiated until the onload event to ensure that<br/>the associated elements are available.<br/>The following would define a DragDrop obj that would interact with any<br/>other DragDrop obj in the "group1" group:<br/><pre><br/> dd = new Roo.dd.DragDrop("div1", "group1");<br/></pre><br/>Since none of the event handlers have been implemented, nothing would<br/>actually happen if you were to run the code above.  Normally you would<br/>override this class or one of the default implementations, but you can<br/>also override the methods you want on an instance of the class...<br/><pre><br/> dd.onDragDrop = function(e, id) {<br/> &nbsp;&nbsp;alert("dd was dropped on " + id);<br/> }<br/></pre>
  93     </div>
  94
  95
  96 <!-- ============================== Class comment block... ========================== -->
  97
  98 <div class="comments">
  99         <b>Class Comments / Notes</B> =>
 100         <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragDrop';">[Add Your comment/notes about this class]</u>
 101         <br/>
 102         <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;"
 103                 src="/blog.php/GtkDjsComments/Roo.dd.DragDrop.html"></iframe>
 104 </div>
 105
 106
 107
 108 <!-- ============================== config options ========================== -->
 109
 110
 111
 112
 113     <div class="hr"></div>
 114     <a id="Roo.dd.DragDrop-configs"></a>
 115
 116
 117
 118
 119
 120       <table cellspacing="0" class="member-table">
 121       <caption>Config Options (Usually are also Properties)</caption>
 122
 123
 124         <tr>
 125             <th class="sig-header" colspan="2">Options</th>
 126
 127             <th class="msource-header">Defined By</th>
 128         </tr>
 129
 130
 131
 132
 133
 134                 <tr class="config-row expandable config-row-alt0">
 135                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 136                     <td class="sig">
 137
 138                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 139                         <div class="fixedFont">
 140                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 141
 142
 143                         </div>
 144
 145                         <div class="mdesc">
 146                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 147                         </div>
 148
 149                         <div class="mdesc">
 150                             <div class="long">
 151                     list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre>
 152
 153                 </div>
 154                         </div>
 155
 156
 157
 158                     </td>
 159                     <td class="msource">
 160
 161                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 162
 163                     </td>
 164                 </tr>
 165
 166
 167     </table>
 168
 169
 170
 171
 172
 173
 174
 175
 176
 177   <!-- ============================== public properties ==================== -->
 178
 179
 180
 181     <a id="Roo.dd.DragDrop-props"></a>
 182
 183
 184
 185
 186
 187      <table cellspacing="0" class="member-table">
 188       <caption class="Empty">Public Properties - Has None</caption>
 189      </table>
 190
 191
 192
 193
 194   <!-- ============================== methods summary / details ======================== -->
 195
 196
 197   <a id="Roo.dd.DragDrop-methods"></a>
 198         <!-- constructor?? -->
 199
 200         <!-- static's first
 201
 202
 203         -->
 204
 205         <!-- then dynamics first -->
 206
 207
 208
 209
 210
 211
 212       <table cellspacing="0" class="member-table">
 213       <caption>Public Methods</caption>
 214         <tr>
 215             <th class="sig-header" colspan="2">Method</th>
 216             <th class="msource-header">Defined By</th>
 217
 218         </tr>
 219
 220
 221
 222
 223
 224
 225
 226           <tr class="method-row config-row-alt0 expandable notInherited">
 227             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 228
 229
 230             <td class="sig">
 231                 <a id="Roo.dd-method-DragDrop"   name=".DragDrop"></a>
 232                 <div class="fixedFont">
 233                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragDrop</b>
 234
 235                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
 236
 237
 238
 239                 </div>
 240                 <div class="mdesc">
 241
 242
 243                         <div class="short">Create a new Roo.dd.DragDrop</div>
 244
 245
 246                     <div class="long">
 247
 248
 249
 250                                 Create a new Roo.dd.DragDrop
 251
 252
 253                                 <dl class="detailList">
 254                                 <dt class="heading">Parameters:</dt>
 255
 256                                         <dt>
 257                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 258
 259                                         </dt>
 260                                         <dd>of the element that is linked to this instance</dd>
 261
 262                                         <dt>
 263                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
 264
 265                                         </dt>
 266                                         <dd>the group of related DragDrop objects</dd>
 267
 268                                         <dt>
 269                                                 <span class="fixedFont">object</span>  <b>config</b>
 270
 271                                         </dt>
 272                                         <dd>an object containing configurable attributes<br/>               Valid properties for DragDrop:<br/>                   padding, isTarget, maintainOffset, primaryButtonOnly</dd>
 273
 274                                 </dl>
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286                     </div>
 287                 </div>
 288
 289             </td>
 290             <td class="msource">
 291                 &nbsp;
 292             </td>
 293         </tr>
 294
 295
 296           <tr class="method-row config-row-alt1 expandable">
 297             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 298
 299
 300             <td class="sig">
 301                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 302                 <div class="fixedFont">
 303                         <span class="attributes"></span><b class="itemname">addEvents</b>
 304
 305                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 306
 307
 308
 309                 </div>
 310                 <div class="mdesc">
 311
 312                    <div class="short">Used to define events on this Observable</div>
 313
 314
 315
 316                     <div class="long">
 317
 318                                 Used to define events on this Observable
 319
 320
 321
 322
 323
 324
 325                                 <dl class="detailList">
 326                                 <dt class="heading">Parameters:</dt>
 327
 328                                         <dt>
 329                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 330
 331                                         </dt>
 332                                         <dd>The object with the events defined</dd>
 333
 334                                 </dl>
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346                     </div>
 347                 </div>
 348
 349             </td>
 350             <td class="msource">
 351
 352                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 353                 &nbsp;
 354             </td>
 355         </tr>
 356
 357
 358           <tr class="method-row config-row-alt0 expandable notInherited">
 359             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 360
 361
 362             <td class="sig">
 363                 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass"   name=".addInvalidHandleClass"></a>
 364                 <div class="fixedFont">
 365                         <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
 366
 367                                  (string <B><i>cssClass</i></B>)
 368
 369
 370
 371                 </div>
 372                 <div class="mdesc">
 373
 374                    <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
 375
 376
 377
 378                     <div class="long">
 379
 380                                 Lets you specify a css class of elements that will not initiate a drag
 381
 382
 383
 384
 385
 386
 387                                 <dl class="detailList">
 388                                 <dt class="heading">Parameters:</dt>
 389
 390                                         <dt>
 391                                                 <span class="fixedFont">string</span>  <b>cssClass</b>
 392
 393                                         </dt>
 394                                         <dd>the class of the elements you wish to ignore</dd>
 395
 396                                 </dl>
 397
 398
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408                     </div>
 409                 </div>
 410
 411             </td>
 412             <td class="msource">
 413
 414                         Roo.dd.DragDrop
 415                 &nbsp;
 416             </td>
 417         </tr>
 418
 419
 420           <tr class="method-row config-row-alt1 expandable notInherited">
 421             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 422
 423
 424             <td class="sig">
 425                 <a id="Roo.dd.DragDrop-method-addInvalidHandleId"   name=".addInvalidHandleId"></a>
 426                 <div class="fixedFont">
 427                         <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
 428
 429                                  (string <B><i>id</i></B>)
 430
 431
 432
 433                 </div>
 434                 <div class="mdesc">
 435
 436                    <div class="short">Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag</div>
 437
 438
 439
 440                     <div class="long">
 441
 442                                 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
 443
 444
 445
 446
 447
 448
 449                                 <dl class="detailList">
 450                                 <dt class="heading">Parameters:</dt>
 451
 452                                         <dt>
 453                                                 <span class="fixedFont">string</span>  <b>id</b>
 454
 455                                         </dt>
 456                                         <dd>the element id of the element you wish to ignore</dd>
 457
 458                                 </dl>
 459
 460
 461
 462
 463
 464
 465
 466
 467
 468
 469
 470                     </div>
 471                 </div>
 472
 473             </td>
 474             <td class="msource">
 475
 476                         Roo.dd.DragDrop
 477                 &nbsp;
 478             </td>
 479         </tr>
 480
 481
 482           <tr class="method-row config-row-alt0 expandable notInherited">
 483             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 484
 485
 486             <td class="sig">
 487                 <a id="Roo.dd.DragDrop-method-addInvalidHandleType"   name=".addInvalidHandleType"></a>
 488                 <div class="fixedFont">
 489                         <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
 490
 491                                  (string <B><i>tagName</i></B>)
 492
 493
 494
 495                 </div>
 496                 <div class="mdesc">
 497
 498                    <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
 499
 500
 501
 502                     <div class="long">
 503
 504                                 Allows you to specify a tag name that should not start a drag operation<br/>when clicked.  This is designed to facilitate embedding links within a<br/>drag handle that do something other than start the drag.
 505
 506
 507
 508
 509
 510
 511                                 <dl class="detailList">
 512                                 <dt class="heading">Parameters:</dt>
 513
 514                                         <dt>
 515                                                 <span class="fixedFont">string</span>  <b>tagName</b>
 516
 517                                         </dt>
 518                                         <dd>the type of element to exclude</dd>
 519
 520                                 </dl>
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531
 532                     </div>
 533                 </div>
 534
 535             </td>
 536             <td class="msource">
 537
 538                         Roo.dd.DragDrop
 539                 &nbsp;
 540             </td>
 541         </tr>
 542
 543
 544           <tr class="method-row config-row-alt1 expandable">
 545             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 546
 547
 548             <td class="sig">
 549                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 550                 <div class="fixedFont">
 551                         <span class="attributes"></span><b class="itemname">addListener</b>
 552
 553                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 554
 555
 556
 557                 </div>
 558                 <div class="mdesc">
 559
 560                    <div class="short">Appends an event handler to this component</div>
 561
 562
 563
 564                     <div class="long">
 565
 566                                 Appends an event handler to this component
 567
 568
 569
 570
 571
 572
 573                                 <dl class="detailList">
 574                                 <dt class="heading">Parameters:</dt>
 575
 576                                         <dt>
 577                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 578
 579                                         </dt>
 580                                         <dd>The type of event to listen for</dd>
 581
 582                                         <dt>
 583                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 584
 585                                         </dt>
 586                                         <dd>The method the event invokes</dd>
 587
 588                                         <dt>
 589                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 590
 591                                         </dt>
 592                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 593
 594                                         <dt>
 595                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 596
 597                                         </dt>
 598                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 599
 600                                 </dl>
 601
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612                     </div>
 613                 </div>
 614
 615             </td>
 616             <td class="msource">
 617
 618                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 619                 &nbsp;
 620             </td>
 621         </tr>
 622
 623
 624           <tr class="method-row config-row-alt0 expandable notInherited">
 625             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 626
 627
 628             <td class="sig">
 629                 <a id="Roo.dd.DragDrop-method-addToGroup"   name=".addToGroup"></a>
 630                 <div class="fixedFont">
 631                         <span class="attributes"></span><b class="itemname">addToGroup</b>
 632
 633                                  (<B><i>sGroup</i></B>)
 634
 635
 636
 637                 </div>
 638                 <div class="mdesc">
 639
 640                    <div class="short">Add this instance to a group of related drag/drop objects.</div>
 641
 642
 643
 644                     <div class="long">
 645
 646                                 Add this instance to a group of related drag/drop objects.  All<br/>instances belong to at least one group, and can belong to as many<br/>groups as needed.
 647
 648
 649
 650
 651
 652
 653                                 <dl class="detailList">
 654                                 <dt class="heading">Parameters:</dt>
 655
 656                                         <dt>
 657                                                  <b>sGroup</b>
 658
 659                                         </dt>
 660                                         <dd>{string} the name of the group</dd>
 661
 662                                 </dl>
 663
 664
 665
 666
 667
 668
 669
 670
 671
 672
 673
 674                     </div>
 675                 </div>
 676
 677             </td>
 678             <td class="msource">
 679
 680                         Roo.dd.DragDrop
 681                 &nbsp;
 682             </td>
 683         </tr>
 684
 685
 686           <tr class="method-row config-row-alt1 expandable notInherited">
 687             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 688
 689
 690             <td class="sig">
 691                 <a id="Roo.dd.DragDrop-method-applyConfig"   name=".applyConfig"></a>
 692                 <div class="fixedFont">
 693                         <span class="attributes"></span><b class="itemname">applyConfig</b>
 694
 695                                  ()
 696
 697
 698
 699                 </div>
 700                 <div class="mdesc">
 701
 702                    <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
 703
 704
 705
 706                     <div class="long">
 707
 708                                 Applies the configuration parameters that were passed into the constructor.<br/>This is supposed to happen at each level through the inheritance chain.  So<br/>a DDProxy implentation will execute apply config on DDProxy, DD, and<br/>DragDrop in order to get all of the parameters that are available in<br/>each object.
 709
 710
 711
 712
 713
 714
 715
 716
 717
 718
 719
 720
 721
 722
 723
 724
 725                     </div>
 726                 </div>
 727
 728             </td>
 729             <td class="msource">
 730
 731                         Roo.dd.DragDrop
 732                 &nbsp;
 733             </td>
 734         </tr>
 735
 736
 737           <tr class="method-row config-row-alt0 expandable notInherited">
 738             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 739
 740
 741             <td class="sig">
 742                 <a id="Roo.dd.DragDrop-method-clearConstraints"   name=".clearConstraints"></a>
 743                 <div class="fixedFont">
 744                         <span class="attributes"></span><b class="itemname">clearConstraints</b>
 745
 746                                  ()
 747
 748
 749
 750                 </div>
 751                 <div class="mdesc">
 752
 753                    <div class="short">Clears any constraints applied to this instance.</div>
 754
 755
 756
 757                     <div class="long">
 758
 759                                 Clears any constraints applied to this instance.  Also clears ticks<br/>since they can't exist independent of a constraint at this time.
 760
 761
 762
 763
 764
 765
 766
 767
 768
 769
 770
 771
 772
 773
 774
 775
 776                     </div>
 777                 </div>
 778
 779             </td>
 780             <td class="msource">
 781
 782                         Roo.dd.DragDrop
 783                 &nbsp;
 784             </td>
 785         </tr>
 786
 787
 788           <tr class="method-row config-row-alt1 expandable notInherited">
 789             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 790
 791
 792             <td class="sig">
 793                 <a id="Roo.dd.DragDrop-method-clearTicks"   name=".clearTicks"></a>
 794                 <div class="fixedFont">
 795                         <span class="attributes"></span><b class="itemname">clearTicks</b>
 796
 797                                  ()
 798
 799
 800
 801                 </div>
 802                 <div class="mdesc">
 803
 804                    <div class="short">Clears any tick interval defined for this instance</div>
 805
 806
 807
 808                     <div class="long">
 809
 810                                 Clears any tick interval defined for this instance
 811
 812
 813
 814
 815
 816
 817
 818
 819
 820
 821
 822
 823
 824
 825
 826
 827                     </div>
 828                 </div>
 829
 830             </td>
 831             <td class="msource">
 832
 833                         Roo.dd.DragDrop
 834                 &nbsp;
 835             </td>
 836         </tr>
 837
 838
 839           <tr class="method-row config-row-alt0 expandable notInherited">
 840             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 841
 842
 843             <td class="sig">
 844                 <a id="Roo.dd.DragDrop-method-endDrag"   name=".endDrag"></a>
 845                 <div class="fixedFont">
 846                         <span class="attributes"></span><b class="itemname">endDrag</b>
 847
 848                                  (Event <B><i>e</i></B>)
 849
 850
 851
 852                 </div>
 853                 <div class="mdesc">
 854
 855                    <div class="short">Fired when we are done dragging the object</div>
 856
 857
 858
 859                     <div class="long">
 860
 861                                 Fired when we are done dragging the object
 862
 863
 864
 865
 866
 867
 868                                 <dl class="detailList">
 869                                 <dt class="heading">Parameters:</dt>
 870
 871                                         <dt>
 872                                                 <span class="fixedFont">Event</span>  <b>e</b>
 873
 874                                         </dt>
 875                                         <dd>the mouseup event</dd>
 876
 877                                 </dl>
 878
 879
 880
 881
 882
 883
 884
 885
 886
 887
 888
 889                     </div>
 890                 </div>
 891
 892             </td>
 893             <td class="msource">
 894
 895                         Roo.dd.DragDrop
 896                 &nbsp;
 897             </td>
 898         </tr>
 899
 900
 901           <tr class="method-row config-row-alt1 expandable">
 902             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 903
 904
 905             <td class="sig">
 906                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 907                 <div class="fixedFont">
 908                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 909
 910                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 911
 912
 913                                          :
 914
 915
 916                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 917
 918
 919
 920
 921
 922                 </div>
 923                 <div class="mdesc">
 924
 925                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 926
 927
 928
 929                     <div class="long">
 930
 931                                 Fires the specified event with the passed parameters (minus the event name).
 932
 933
 934
 935
 936
 937
 938                                 <dl class="detailList">
 939                                 <dt class="heading">Parameters:</dt>
 940
 941                                         <dt>
 942                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 943
 944                                         </dt>
 945                                         <dd></dd>
 946
 947                                         <dt>
 948                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 949
 950                                         </dt>
 951                                         <dd>Variable number of parameters are passed to handlers</dd>
 952
 953                                 </dl>
 954
 955
 956
 957
 958
 959                                 <dl class="detailList">
 960                                 <dt class="heading">Returns:</dt>
 961
 962                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 963
 964                                 </dl>
 965
 966
 967
 968
 969
 970
 971
 972                     </div>
 973                 </div>
 974
 975             </td>
 976             <td class="msource">
 977
 978                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 979                 &nbsp;
 980             </td>
 981         </tr>
 982
 983
 984           <tr class="method-row config-row-alt0 expandable notInherited">
 985             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 986
 987
 988             <td class="sig">
 989                 <a id="Roo.dd.DragDrop-method-function toString() {
 990     [native code]
 991 }"   name=".function toString() {
 992     [native code]
 993 }"></a>
 994                 <div class="fixedFont">
 995                         <span class="attributes"></span><b class="itemname">function toString() {
 996     [native code]
 997 }</b>
 998
 999                                  ()
1000
1001
1002                                          :
1003
1004
1005                                                 string
1006
1007
1008
1009
1010
1011                 </div>
1012                 <div class="mdesc">
1013
1014                    <div class="short">toString method</div>
1015
1016
1017
1018                     <div class="long">
1019
1020                                 toString method
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031                                 <dl class="detailList">
1032                                 <dt class="heading">Returns:</dt>
1033
1034                                         <dd><span class="fixedFont">string</span>  string representation of the dd obj</dd>
1035
1036                                 </dl>
1037
1038
1039
1040
1041
1042
1043
1044                     </div>
1045                 </div>
1046
1047             </td>
1048             <td class="msource">
1049
1050                         Roo.dd.DragDrop
1051                 &nbsp;
1052             </td>
1053         </tr>
1054
1055
1056           <tr class="method-row config-row-alt1 expandable notInherited">
1057             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1058
1059
1060             <td class="sig">
1061                 <a id="Roo.dd.DragDrop-method-getDragEl"   name=".getDragEl"></a>
1062                 <div class="fixedFont">
1063                         <span class="attributes"></span><b class="itemname">getDragEl</b>
1064
1065                                  ()
1066
1067
1068                                          :
1069
1070
1071                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1072
1073
1074
1075
1076
1077                 </div>
1078                 <div class="mdesc">
1079
1080                    <div class="short">Returns a reference to the actual element to drag.</div>
1081
1082
1083
1084                     <div class="long">
1085
1086                                 Returns a reference to the actual element to drag.  By default this is<br/>the same as the html element, but it can be assigned to another<br/>element. An example of this can be found in Roo.dd.DDProxy
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097                                 <dl class="detailList">
1098                                 <dt class="heading">Returns:</dt>
1099
1100                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  the html element</dd>
1101
1102                                 </dl>
1103
1104
1105
1106
1107
1108
1109
1110                     </div>
1111                 </div>
1112
1113             </td>
1114             <td class="msource">
1115
1116                         Roo.dd.DragDrop
1117                 &nbsp;
1118             </td>
1119         </tr>
1120
1121
1122           <tr class="method-row config-row-alt0 expandable notInherited">
1123             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1124
1125
1126             <td class="sig">
1127                 <a id="Roo.dd.DragDrop-method-getEl"   name=".getEl"></a>
1128                 <div class="fixedFont">
1129                         <span class="attributes"></span><b class="itemname">getEl</b>
1130
1131                                  ()
1132
1133
1134                                          :
1135
1136
1137                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1138
1139
1140
1141
1142
1143                 </div>
1144                 <div class="mdesc">
1145
1146                    <div class="short">Returns a reference to the linked element</div>
1147
1148
1149
1150                     <div class="long">
1151
1152                                 Returns a reference to the linked element
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163                                 <dl class="detailList">
1164                                 <dt class="heading">Returns:</dt>
1165
1166                                         <dd><span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  the html element</dd>
1167
1168                                 </dl>
1169
1170
1171
1172
1173
1174
1175
1176                     </div>
1177                 </div>
1178
1179             </td>
1180             <td class="msource">
1181
1182                         Roo.dd.DragDrop
1183                 &nbsp;
1184             </td>
1185         </tr>
1186
1187
1188           <tr class="method-row config-row-alt1 expandable">
1189             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1190
1191
1192             <td class="sig">
1193                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1194                 <div class="fixedFont">
1195                         <span class="attributes"></span><b class="itemname">hasListener</b>
1196
1197                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1198
1199
1200                                          :
1201
1202
1203                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1204
1205
1206
1207
1208
1209                 </div>
1210                 <div class="mdesc">
1211
1212                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1213
1214
1215
1216                     <div class="long">
1217
1218                                 Checks to see if this object has any listeners for a specified event
1219
1220
1221
1222
1223
1224
1225                                 <dl class="detailList">
1226                                 <dt class="heading">Parameters:</dt>
1227
1228                                         <dt>
1229                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1230
1231                                         </dt>
1232                                         <dd>The name of the event to check for</dd>
1233
1234                                 </dl>
1235
1236
1237
1238
1239
1240                                 <dl class="detailList">
1241                                 <dt class="heading">Returns:</dt>
1242
1243                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
1244
1245                                 </dl>
1246
1247
1248
1249
1250
1251
1252
1253                     </div>
1254                 </div>
1255
1256             </td>
1257             <td class="msource">
1258
1259                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1260                 &nbsp;
1261             </td>
1262         </tr>
1263
1264
1265           <tr class="method-row config-row-alt0 expandable notInherited">
1266             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1267
1268
1269             <td class="sig">
1270                 <a id="Roo.dd.DragDrop-method-init"   name=".init"></a>
1271                 <div class="fixedFont">
1272                         <span class="attributes"></span><b class="itemname">init</b>
1273
1274                                  (<B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
1275
1276
1277
1278                 </div>
1279                 <div class="mdesc">
1280
1281                    <div class="short">Sets up the DragDrop object.</div>
1282
1283
1284
1285                     <div class="long">
1286
1287                                 Sets up the DragDrop object.  Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1288
1289
1290
1291
1292
1293
1294                                 <dl class="detailList">
1295                                 <dt class="heading">Parameters:</dt>
1296
1297                                         <dt>
1298                                                  <b>id</b>
1299
1300                                         </dt>
1301                                         <dd>the id of the linked element</dd>
1302
1303                                         <dt>
1304                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
1305
1306                                         </dt>
1307                                         <dd>the group of related items</dd>
1308
1309                                         <dt>
1310                                                 <span class="fixedFont">object</span>  <b>config</b>
1311
1312                                         </dt>
1313                                         <dd>configuration attributes</dd>
1314
1315                                 </dl>
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327                     </div>
1328                 </div>
1329
1330             </td>
1331             <td class="msource">
1332
1333                         Roo.dd.DragDrop
1334                 &nbsp;
1335             </td>
1336         </tr>
1337
1338
1339           <tr class="method-row config-row-alt1 expandable notInherited">
1340             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1341
1342
1343             <td class="sig">
1344                 <a id="Roo.dd.DragDrop-method-initTarget"   name=".initTarget"></a>
1345                 <div class="fixedFont">
1346                         <span class="attributes"></span><b class="itemname">initTarget</b>
1347
1348                                  (<B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
1349
1350
1351
1352                 </div>
1353                 <div class="mdesc">
1354
1355                    <div class="short">Initializes Targeting functionality only.</div>
1356
1357
1358
1359                     <div class="long">
1360
1361                                 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
1362
1363
1364
1365
1366
1367
1368                                 <dl class="detailList">
1369                                 <dt class="heading">Parameters:</dt>
1370
1371                                         <dt>
1372                                                  <b>id</b>
1373
1374                                         </dt>
1375                                         <dd>the id of the linked element</dd>
1376
1377                                         <dt>
1378                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
1379
1380                                         </dt>
1381                                         <dd>the group of related items</dd>
1382
1383                                         <dt>
1384                                                 <span class="fixedFont">object</span>  <b>config</b>
1385
1386                                         </dt>
1387                                         <dd>configuration attributes</dd>
1388
1389                                 </dl>
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401                     </div>
1402                 </div>
1403
1404             </td>
1405             <td class="msource">
1406
1407                         Roo.dd.DragDrop
1408                 &nbsp;
1409             </td>
1410         </tr>
1411
1412
1413           <tr class="method-row config-row-alt0 expandable notInherited">
1414             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1415
1416
1417             <td class="sig">
1418                 <a id="Roo.dd.DragDrop-method-isLocked"   name=".isLocked"></a>
1419                 <div class="fixedFont">
1420                         <span class="attributes"></span><b class="itemname">isLocked</b>
1421
1422                                  ()
1423
1424
1425                                          :
1426
1427
1428                                                 boolean
1429
1430
1431
1432
1433
1434                 </div>
1435                 <div class="mdesc">
1436
1437                    <div class="short">Returns true if this instance is locked, or the drag drop mgr is locked<br/>(meaning that all drag/drop is disabled on the page.</div>
1438
1439
1440
1441                     <div class="long">
1442
1443                                 Returns true if this instance is locked, or the drag drop mgr is locked<br/>(meaning that all drag/drop is disabled on the page.)
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454                                 <dl class="detailList">
1455                                 <dt class="heading">Returns:</dt>
1456
1457                                         <dd><span class="fixedFont">boolean</span>  true if this obj or all drag/drop is locked, else<br/>false</dd>
1458
1459                                 </dl>
1460
1461
1462
1463
1464
1465
1466
1467                     </div>
1468                 </div>
1469
1470             </td>
1471             <td class="msource">
1472
1473                         Roo.dd.DragDrop
1474                 &nbsp;
1475             </td>
1476         </tr>
1477
1478
1479           <tr class="method-row config-row-alt1 expandable notInherited">
1480             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1481
1482
1483             <td class="sig">
1484                 <a id="Roo.dd.DragDrop-method-isTarget"   name=".isTarget"></a>
1485                 <div class="fixedFont">
1486                         <span class="attributes"></span><b class="itemname">isTarget</b>
1487
1488                                  ()
1489
1490
1491
1492                 </div>
1493                 <div class="mdesc">
1494
1495                    <div class="short">By default, all insances can be a drop target.</div>
1496
1497
1498
1499                     <div class="long">
1500
1501                                 By default, all insances can be a drop target.  This can be disabled by<br/>setting isTarget to false.
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518                     </div>
1519                 </div>
1520
1521             </td>
1522             <td class="msource">
1523
1524                         Roo.dd.DragDrop
1525                 &nbsp;
1526             </td>
1527         </tr>
1528
1529
1530           <tr class="method-row config-row-alt0 expandable notInherited">
1531             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1532
1533
1534             <td class="sig">
1535                 <a id="Roo.dd.DragDrop-method-isValidHandleChild"   name=".isValidHandleChild"></a>
1536                 <div class="fixedFont">
1537                         <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
1538
1539                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
1540
1541
1542                                          :
1543
1544
1545                                                 boolean
1546
1547
1548
1549
1550
1551                 </div>
1552                 <div class="mdesc">
1553
1554                    <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
1555
1556
1557
1558                     <div class="long">
1559
1560                                 Checks the tag exclusion list to see if this click should be ignored
1561
1562
1563
1564
1565
1566
1567                                 <dl class="detailList">
1568                                 <dt class="heading">Parameters:</dt>
1569
1570                                         <dt>
1571                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>node</b>
1572
1573                                         </dt>
1574                                         <dd>the HTMLElement to evaluate</dd>
1575
1576                                 </dl>
1577
1578
1579
1580
1581
1582                                 <dl class="detailList">
1583                                 <dt class="heading">Returns:</dt>
1584
1585                                         <dd><span class="fixedFont">boolean</span>  true if this is a valid tag type, false if not</dd>
1586
1587                                 </dl>
1588
1589
1590
1591
1592
1593
1594
1595                     </div>
1596                 </div>
1597
1598             </td>
1599             <td class="msource">
1600
1601                         Roo.dd.DragDrop
1602                 &nbsp;
1603             </td>
1604         </tr>
1605
1606
1607           <tr class="method-row config-row-alt1 expandable notInherited">
1608             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1609
1610
1611             <td class="sig">
1612                 <a id="Roo.dd.DragDrop-method-lock"   name=".lock"></a>
1613                 <div class="fixedFont">
1614                         <span class="attributes"></span><b class="itemname">lock</b>
1615
1616                                  ()
1617
1618
1619
1620                 </div>
1621                 <div class="mdesc">
1622
1623                    <div class="short">Lock this instance</div>
1624
1625
1626
1627                     <div class="long">
1628
1629                                 Lock this instance
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646                     </div>
1647                 </div>
1648
1649             </td>
1650             <td class="msource">
1651
1652                         Roo.dd.DragDrop
1653                 &nbsp;
1654             </td>
1655         </tr>
1656
1657
1658           <tr class="method-row config-row-alt0 expandable">
1659             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1660
1661
1662             <td class="sig">
1663                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1664                 <div class="fixedFont">
1665                         <span class="attributes"></span><b class="itemname">on</b>
1666
1667                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1668
1669
1670
1671                 </div>
1672                 <div class="mdesc">
1673
1674                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1675
1676
1677
1678                     <div class="long">
1679
1680                                 Appends an event handler to this element (shorthand for addListener)
1681
1682
1683
1684
1685
1686
1687                                 <dl class="detailList">
1688                                 <dt class="heading">Parameters:</dt>
1689
1690                                         <dt>
1691                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1692
1693                                         </dt>
1694                                         <dd>The type of event to listen for</dd>
1695
1696                                         <dt>
1697                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1698
1699                                         </dt>
1700                                         <dd>The method the event invokes</dd>
1701
1702                                         <dt>
1703                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
1704
1705                                         </dt>
1706                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1707
1708                                         <dt>
1709                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1710
1711                                         </dt>
1712                                         <dd>(optional)</dd>
1713
1714                                 </dl>
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726                     </div>
1727                 </div>
1728
1729             </td>
1730             <td class="msource">
1731
1732                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1733                 &nbsp;
1734             </td>
1735         </tr>
1736
1737
1738           <tr class="method-row config-row-alt1 expandable notInherited">
1739             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1740
1741
1742             <td class="sig">
1743                 <a id="Roo.dd.DragDrop-method-onAvailable"   name=".onAvailable"></a>
1744                 <div class="fixedFont">
1745                         <span class="attributes"></span><b class="itemname">onAvailable</b>
1746
1747                                  ()
1748
1749
1750
1751                 </div>
1752                 <div class="mdesc">
1753
1754                    <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
1755
1756
1757
1758                     <div class="long">
1759
1760                                 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777                     </div>
1778                 </div>
1779
1780             </td>
1781             <td class="msource">
1782
1783                         Roo.dd.DragDrop
1784                 &nbsp;
1785             </td>
1786         </tr>
1787
1788
1789           <tr class="method-row config-row-alt0 expandable notInherited">
1790             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1791
1792
1793             <td class="sig">
1794                 <a id="Roo.dd.DragDrop-method-onDrag"   name=".onDrag"></a>
1795                 <div class="fixedFont">
1796                         <span class="attributes"></span><b class="itemname">onDrag</b>
1797
1798                                  (Event <B><i>e</i></B>)
1799
1800
1801
1802                 </div>
1803                 <div class="mdesc">
1804
1805                    <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
1806
1807
1808
1809                     <div class="long">
1810
1811                                 Abstract method called during the onMouseMove event while dragging an<br/>object.
1812
1813
1814
1815
1816
1817
1818                                 <dl class="detailList">
1819                                 <dt class="heading">Parameters:</dt>
1820
1821                                         <dt>
1822                                                 <span class="fixedFont">Event</span>  <b>e</b>
1823
1824                                         </dt>
1825                                         <dd>the mousemove event</dd>
1826
1827                                 </dl>
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839                     </div>
1840                 </div>
1841
1842             </td>
1843             <td class="msource">
1844
1845                         Roo.dd.DragDrop
1846                 &nbsp;
1847             </td>
1848         </tr>
1849
1850
1851           <tr class="method-row config-row-alt1 expandable notInherited">
1852             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1853
1854
1855             <td class="sig">
1856                 <a id="Roo.dd.DragDrop-method-onDragDrop"   name=".onDragDrop"></a>
1857                 <div class="fixedFont">
1858                         <span class="attributes"></span><b class="itemname">onDragDrop</b>
1859
1860                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1861
1862
1863
1864                 </div>
1865                 <div class="mdesc">
1866
1867                    <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
1868
1869
1870
1871                     <div class="long">
1872
1873                                 Abstract method called when this item is dropped on another DragDrop<br/>obj
1874
1875
1876
1877
1878
1879
1880                                 <dl class="detailList">
1881                                 <dt class="heading">Parameters:</dt>
1882
1883                                         <dt>
1884                                                 <span class="fixedFont">Event</span>  <b>e</b>
1885
1886                                         </dt>
1887                                         <dd>the mouseup event</dd>
1888
1889                                         <dt>
1890                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
1891
1892                                         </dt>
1893                                         <dd>In POINT mode, the element<br/>id this was dropped on.  In INTERSECT mode, an array of dd items this<br/>was dropped on.</dd>
1894
1895                                 </dl>
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907                     </div>
1908                 </div>
1909
1910             </td>
1911             <td class="msource">
1912
1913                         Roo.dd.DragDrop
1914                 &nbsp;
1915             </td>
1916         </tr>
1917
1918
1919           <tr class="method-row config-row-alt0 expandable notInherited">
1920             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1921
1922
1923             <td class="sig">
1924                 <a id="Roo.dd.DragDrop-method-onDragEnter"   name=".onDragEnter"></a>
1925                 <div class="fixedFont">
1926                         <span class="attributes"></span><b class="itemname">onDragEnter</b>
1927
1928                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1929
1930
1931
1932                 </div>
1933                 <div class="mdesc">
1934
1935                    <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
1936
1937
1938
1939                     <div class="long">
1940
1941                                 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
1942
1943
1944
1945
1946
1947
1948                                 <dl class="detailList">
1949                                 <dt class="heading">Parameters:</dt>
1950
1951                                         <dt>
1952                                                 <span class="fixedFont">Event</span>  <b>e</b>
1953
1954                                         </dt>
1955                                         <dd>the mousemove event</dd>
1956
1957                                         <dt>
1958                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
1959
1960                                         </dt>
1961                                         <dd>In POINT mode, the element<br/>id this is hovering over.  In INTERSECT mode, an array of one or more<br/>dragdrop items being hovered over.</dd>
1962
1963                                 </dl>
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975                     </div>
1976                 </div>
1977
1978             </td>
1979             <td class="msource">
1980
1981                         Roo.dd.DragDrop
1982                 &nbsp;
1983             </td>
1984         </tr>
1985
1986
1987           <tr class="method-row config-row-alt1 expandable notInherited">
1988             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1989
1990
1991             <td class="sig">
1992                 <a id="Roo.dd.DragDrop-method-onDragOut"   name=".onDragOut"></a>
1993                 <div class="fixedFont">
1994                         <span class="attributes"></span><b class="itemname">onDragOut</b>
1995
1996                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
1997
1998
1999
2000                 </div>
2001                 <div class="mdesc">
2002
2003                    <div class="short">Abstract method called when we are no longer hovering over an element</div>
2004
2005
2006
2007                     <div class="long">
2008
2009                                 Abstract method called when we are no longer hovering over an element
2010
2011
2012
2013
2014
2015
2016                                 <dl class="detailList">
2017                                 <dt class="heading">Parameters:</dt>
2018
2019                                         <dt>
2020                                                 <span class="fixedFont">Event</span>  <b>e</b>
2021
2022                                         </dt>
2023                                         <dd>the mousemove event</dd>
2024
2025                                         <dt>
2026                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2027
2028                                         </dt>
2029                                         <dd>In POINT mode, the element<br/>id this was hovering over.  In INTERSECT mode, an array of dd items<br/>that the mouse is no longer over.</dd>
2030
2031                                 </dl>
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043                     </div>
2044                 </div>
2045
2046             </td>
2047             <td class="msource">
2048
2049                         Roo.dd.DragDrop
2050                 &nbsp;
2051             </td>
2052         </tr>
2053
2054
2055           <tr class="method-row config-row-alt0 expandable notInherited">
2056             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2057
2058
2059             <td class="sig">
2060                 <a id="Roo.dd.DragDrop-method-onDragOver"   name=".onDragOver"></a>
2061                 <div class="fixedFont">
2062                         <span class="attributes"></span><b class="itemname">onDragOver</b>
2063
2064                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2065
2066
2067
2068                 </div>
2069                 <div class="mdesc">
2070
2071                    <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2072
2073
2074
2075                     <div class="long">
2076
2077                                 Abstract method called when this element is hovering over another<br/>DragDrop obj
2078
2079
2080
2081
2082
2083
2084                                 <dl class="detailList">
2085                                 <dt class="heading">Parameters:</dt>
2086
2087                                         <dt>
2088                                                 <span class="fixedFont">Event</span>  <b>e</b>
2089
2090                                         </dt>
2091                                         <dd>the mousemove event</dd>
2092
2093                                         <dt>
2094                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2095
2096                                         </dt>
2097                                         <dd>In POINT mode, the element<br/>id this is hovering over.  In INTERSECT mode, an array of dd items<br/>being hovered over.</dd>
2098
2099                                 </dl>
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111                     </div>
2112                 </div>
2113
2114             </td>
2115             <td class="msource">
2116
2117                         Roo.dd.DragDrop
2118                 &nbsp;
2119             </td>
2120         </tr>
2121
2122
2123           <tr class="method-row config-row-alt1 expandable notInherited">
2124             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2125
2126
2127             <td class="sig">
2128                 <a id="Roo.dd.DragDrop-method-onInvalidDrop"   name=".onInvalidDrop"></a>
2129                 <div class="fixedFont">
2130                         <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2131
2132                                  (Event <B><i>e</i></B>)
2133
2134
2135
2136                 </div>
2137                 <div class="mdesc">
2138
2139                    <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2140
2141
2142
2143                     <div class="long">
2144
2145                                 Abstract method called when this item is dropped on an area with no<br/>drop target
2146
2147
2148
2149
2150
2151
2152                                 <dl class="detailList">
2153                                 <dt class="heading">Parameters:</dt>
2154
2155                                         <dt>
2156                                                 <span class="fixedFont">Event</span>  <b>e</b>
2157
2158                                         </dt>
2159                                         <dd>the mouseup event</dd>
2160
2161                                 </dl>
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173                     </div>
2174                 </div>
2175
2176             </td>
2177             <td class="msource">
2178
2179                         Roo.dd.DragDrop
2180                 &nbsp;
2181             </td>
2182         </tr>
2183
2184
2185           <tr class="method-row config-row-alt0 expandable notInherited">
2186             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2187
2188
2189             <td class="sig">
2190                 <a id="Roo.dd.DragDrop-method-onMouseDown"   name=".onMouseDown"></a>
2191                 <div class="fixedFont">
2192                         <span class="attributes"></span><b class="itemname">onMouseDown</b>
2193
2194                                  (Event <B><i>e</i></B>)
2195
2196
2197
2198                 </div>
2199                 <div class="mdesc">
2200
2201                    <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2202
2203
2204
2205                     <div class="long">
2206
2207                                 Event handler that fires when a drag/drop obj gets a mousedown
2208
2209
2210
2211
2212
2213
2214                                 <dl class="detailList">
2215                                 <dt class="heading">Parameters:</dt>
2216
2217                                         <dt>
2218                                                 <span class="fixedFont">Event</span>  <b>e</b>
2219
2220                                         </dt>
2221                                         <dd>the mousedown event</dd>
2222
2223                                 </dl>
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235                     </div>
2236                 </div>
2237
2238             </td>
2239             <td class="msource">
2240
2241                         Roo.dd.DragDrop
2242                 &nbsp;
2243             </td>
2244         </tr>
2245
2246
2247           <tr class="method-row config-row-alt1 expandable notInherited">
2248             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2249
2250
2251             <td class="sig">
2252                 <a id="Roo.dd.DragDrop-method-onMouseUp"   name=".onMouseUp"></a>
2253                 <div class="fixedFont">
2254                         <span class="attributes"></span><b class="itemname">onMouseUp</b>
2255
2256                                  (Event <B><i>e</i></B>)
2257
2258
2259
2260                 </div>
2261                 <div class="mdesc">
2262
2263                    <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2264
2265
2266
2267                     <div class="long">
2268
2269                                 Event handler that fires when a drag/drop obj gets a mouseup
2270
2271
2272
2273
2274
2275
2276                                 <dl class="detailList">
2277                                 <dt class="heading">Parameters:</dt>
2278
2279                                         <dt>
2280                                                 <span class="fixedFont">Event</span>  <b>e</b>
2281
2282                                         </dt>
2283                                         <dd>the mouseup event</dd>
2284
2285                                 </dl>
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297                     </div>
2298                 </div>
2299
2300             </td>
2301             <td class="msource">
2302
2303                         Roo.dd.DragDrop
2304                 &nbsp;
2305             </td>
2306         </tr>
2307
2308
2309           <tr class="method-row config-row-alt0 expandable notInherited">
2310             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2311
2312
2313             <td class="sig">
2314                 <a id="Roo.dd.DragDrop-method-padding"   name=".padding"></a>
2315                 <div class="fixedFont">
2316                         <span class="attributes"></span><b class="itemname">padding</b>
2317
2318                                  ()
2319
2320
2321
2322                 </div>
2323                 <div class="mdesc">
2324
2325                    <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
2326
2327
2328
2329                     <div class="long">
2330
2331                                 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348                     </div>
2349                 </div>
2350
2351             </td>
2352             <td class="msource">
2353
2354                         Roo.dd.DragDrop
2355                 &nbsp;
2356             </td>
2357         </tr>
2358
2359
2360           <tr class="method-row config-row-alt1 expandable">
2361             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2362
2363
2364             <td class="sig">
2365                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
2366                 <div class="fixedFont">
2367                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
2368
2369                                  ()
2370
2371
2372
2373                 </div>
2374                 <div class="mdesc">
2375
2376                    <div class="short">Removes all listeners for this object</div>
2377
2378
2379
2380                     <div class="long">
2381
2382                                 Removes all listeners for this object
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399                     </div>
2400                 </div>
2401
2402             </td>
2403             <td class="msource">
2404
2405                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2406                 &nbsp;
2407             </td>
2408         </tr>
2409
2410
2411           <tr class="method-row config-row-alt0 expandable notInherited">
2412             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2413
2414
2415             <td class="sig">
2416                 <a id="Roo.dd.DragDrop-method-removeFromGroup"   name=".removeFromGroup"></a>
2417                 <div class="fixedFont">
2418                         <span class="attributes"></span><b class="itemname">removeFromGroup</b>
2419
2420                                  (string <B><i>sGroup</i></B>)
2421
2422
2423
2424                 </div>
2425                 <div class="mdesc">
2426
2427                    <div class="short">Remove's this instance from the supplied interaction group</div>
2428
2429
2430
2431                     <div class="long">
2432
2433                                 Remove's this instance from the supplied interaction group
2434
2435
2436
2437
2438
2439
2440                                 <dl class="detailList">
2441                                 <dt class="heading">Parameters:</dt>
2442
2443                                         <dt>
2444                                                 <span class="fixedFont">string</span>  <b>sGroup</b>
2445
2446                                         </dt>
2447                                         <dd>The group to drop</dd>
2448
2449                                 </dl>
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461                     </div>
2462                 </div>
2463
2464             </td>
2465             <td class="msource">
2466
2467                         Roo.dd.DragDrop
2468                 &nbsp;
2469             </td>
2470         </tr>
2471
2472
2473           <tr class="method-row config-row-alt1 expandable notInherited">
2474             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2475
2476
2477             <td class="sig">
2478                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass"   name=".removeInvalidHandleClass"></a>
2479                 <div class="fixedFont">
2480                         <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
2481
2482                                  (string <B><i>cssClass</i></B>)
2483
2484
2485
2486                 </div>
2487                 <div class="mdesc">
2488
2489                    <div class="short">Unsets an invalid css class</div>
2490
2491
2492
2493                     <div class="long">
2494
2495                                 Unsets an invalid css class
2496
2497
2498
2499
2500
2501
2502                                 <dl class="detailList">
2503                                 <dt class="heading">Parameters:</dt>
2504
2505                                         <dt>
2506                                                 <span class="fixedFont">string</span>  <b>cssClass</b>
2507
2508                                         </dt>
2509                                         <dd>the class of the element(s) you wish to<br/>re-enable</dd>
2510
2511                                 </dl>
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523                     </div>
2524                 </div>
2525
2526             </td>
2527             <td class="msource">
2528
2529                         Roo.dd.DragDrop
2530                 &nbsp;
2531             </td>
2532         </tr>
2533
2534
2535           <tr class="method-row config-row-alt0 expandable notInherited">
2536             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2537
2538
2539             <td class="sig">
2540                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId"   name=".removeInvalidHandleId"></a>
2541                 <div class="fixedFont">
2542                         <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
2543
2544                                  (string <B><i>id</i></B>)
2545
2546
2547
2548                 </div>
2549                 <div class="mdesc">
2550
2551                    <div class="short">Unsets an invalid handle id</div>
2552
2553
2554
2555                     <div class="long">
2556
2557                                 Unsets an invalid handle id
2558
2559
2560
2561
2562
2563
2564                                 <dl class="detailList">
2565                                 <dt class="heading">Parameters:</dt>
2566
2567                                         <dt>
2568                                                 <span class="fixedFont">string</span>  <b>id</b>
2569
2570                                         </dt>
2571                                         <dd>the id of the element to re-enable</dd>
2572
2573                                 </dl>
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585                     </div>
2586                 </div>
2587
2588             </td>
2589             <td class="msource">
2590
2591                         Roo.dd.DragDrop
2592                 &nbsp;
2593             </td>
2594         </tr>
2595
2596
2597           <tr class="method-row config-row-alt1 expandable notInherited">
2598             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2599
2600
2601             <td class="sig">
2602                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType"   name=".removeInvalidHandleType"></a>
2603                 <div class="fixedFont">
2604                         <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
2605
2606                                  (string <B><i>tagName</i></B>)
2607
2608
2609
2610                 </div>
2611                 <div class="mdesc">
2612
2613                    <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
2614
2615
2616
2617                     <div class="long">
2618
2619                                 Unsets an excluded tag name set by addInvalidHandleType
2620
2621
2622
2623
2624
2625
2626                                 <dl class="detailList">
2627                                 <dt class="heading">Parameters:</dt>
2628
2629                                         <dt>
2630                                                 <span class="fixedFont">string</span>  <b>tagName</b>
2631
2632                                         </dt>
2633                                         <dd>the type of element to unexclude</dd>
2634
2635                                 </dl>
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647                     </div>
2648                 </div>
2649
2650             </td>
2651             <td class="msource">
2652
2653                         Roo.dd.DragDrop
2654                 &nbsp;
2655             </td>
2656         </tr>
2657
2658
2659           <tr class="method-row config-row-alt0 expandable">
2660             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2661
2662
2663             <td class="sig">
2664                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
2665                 <div class="fixedFont">
2666                         <span class="attributes"></span><b class="itemname">removeListener</b>
2667
2668                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
2669
2670
2671
2672                 </div>
2673                 <div class="mdesc">
2674
2675                    <div class="short">Removes a listener</div>
2676
2677
2678
2679                     <div class="long">
2680
2681                                 Removes a listener
2682
2683
2684
2685
2686
2687
2688                                 <dl class="detailList">
2689                                 <dt class="heading">Parameters:</dt>
2690
2691                                         <dt>
2692                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
2693
2694                                         </dt>
2695                                         <dd>The type of event to listen for</dd>
2696
2697                                         <dt>
2698                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
2699
2700                                         </dt>
2701                                         <dd>The handler to remove</dd>
2702
2703                                         <dt>
2704                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
2705
2706                                         </dt>
2707                                         <dd>(optional) The scope (this object) for the handler</dd>
2708
2709                                 </dl>
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721                     </div>
2722                 </div>
2723
2724             </td>
2725             <td class="msource">
2726
2727                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2728                 &nbsp;
2729             </td>
2730         </tr>
2731
2732
2733           <tr class="method-row config-row-alt1 expandable notInherited">
2734             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2735
2736
2737             <td class="sig">
2738                 <a id="Roo.dd.DragDrop-method-resetConstraints"   name=".resetConstraints"></a>
2739                 <div class="fixedFont">
2740                         <span class="attributes"></span><b class="itemname">resetConstraints</b>
2741
2742                                  (boolean <B><i>maintainOffset</i></B>)
2743
2744
2745
2746                 </div>
2747                 <div class="mdesc">
2748
2749                    <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
2750
2751
2752
2753                     <div class="long">
2754
2755                                 resetConstraints must be called if you manually reposition a dd element.
2756
2757
2758
2759
2760
2761
2762                                 <dl class="detailList">
2763                                 <dt class="heading">Parameters:</dt>
2764
2765                                         <dt>
2766                                                 <span class="fixedFont">boolean</span>  <b>maintainOffset</b>
2767
2768                                         </dt>
2769                                         <dd></dd>
2770
2771                                 </dl>
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783                     </div>
2784                 </div>
2785
2786             </td>
2787             <td class="msource">
2788
2789                         Roo.dd.DragDrop
2790                 &nbsp;
2791             </td>
2792         </tr>
2793
2794
2795           <tr class="method-row config-row-alt0 expandable notInherited">
2796             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2797
2798
2799             <td class="sig">
2800                 <a id="Roo.dd.DragDrop-method-setDragElId"   name=".setDragElId"></a>
2801                 <div class="fixedFont">
2802                         <span class="attributes"></span><b class="itemname">setDragElId</b>
2803
2804                                  (<B><i>id</i></B>)
2805
2806
2807
2808                 </div>
2809                 <div class="mdesc">
2810
2811                    <div class="short">Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag</div>
2812
2813
2814
2815                     <div class="long">
2816
2817                                 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
2818
2819
2820
2821
2822
2823
2824                                 <dl class="detailList">
2825                                 <dt class="heading">Parameters:</dt>
2826
2827                                         <dt>
2828                                                  <b>id</b>
2829
2830                                         </dt>
2831                                         <dd>{string} the id of the element that will be used to initiate the drag</dd>
2832
2833                                 </dl>
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845                     </div>
2846                 </div>
2847
2848             </td>
2849             <td class="msource">
2850
2851                         Roo.dd.DragDrop
2852                 &nbsp;
2853             </td>
2854         </tr>
2855
2856
2857           <tr class="method-row config-row-alt1 expandable notInherited">
2858             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2859
2860
2861             <td class="sig">
2862                 <a id="Roo.dd.DragDrop-method-setHandleElId"   name=".setHandleElId"></a>
2863                 <div class="fixedFont">
2864                         <span class="attributes"></span><b class="itemname">setHandleElId</b>
2865
2866                                  (<B><i>id</i></B>)
2867
2868
2869
2870                 </div>
2871                 <div class="mdesc">
2872
2873                    <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
2874
2875
2876
2877                     <div class="long">
2878
2879                                 Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.  An example of this would be if<br/>you have a content div with text and links.  Clicking anywhere in the<br/>content area would normally start the drag operation.  Use this method<br/>to specify that an element inside of the content div is the element<br/>that starts the drag operation.
2880
2881
2882
2883
2884
2885
2886                                 <dl class="detailList">
2887                                 <dt class="heading">Parameters:</dt>
2888
2889                                         <dt>
2890                                                  <b>id</b>
2891
2892                                         </dt>
2893                                         <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
2894
2895                                 </dl>
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907                     </div>
2908                 </div>
2909
2910             </td>
2911             <td class="msource">
2912
2913                         Roo.dd.DragDrop
2914                 &nbsp;
2915             </td>
2916         </tr>
2917
2918
2919           <tr class="method-row config-row-alt0 expandable notInherited">
2920             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2921
2922
2923             <td class="sig">
2924                 <a id="Roo.dd.DragDrop-method-setInitPosition"   name=".setInitPosition"></a>
2925                 <div class="fixedFont">
2926                         <span class="attributes"></span><b class="itemname">setInitPosition</b>
2927
2928                                  (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
2929
2930
2931
2932                 </div>
2933                 <div class="mdesc">
2934
2935                    <div class="short">Stores the initial placement of the linked element.</div>
2936
2937
2938
2939                     <div class="long">
2940
2941                                 Stores the initial placement of the linked element.
2942
2943
2944
2945
2946
2947
2948                                 <dl class="detailList">
2949                                 <dt class="heading">Parameters:</dt>
2950
2951                                         <dt>
2952                                                 <span class="fixedFont">int</span>  <b>diffX</b>
2953
2954                                         </dt>
2955                                         <dd>the X offset, default 0</dd>
2956
2957                                         <dt>
2958                                                 <span class="fixedFont">int</span>  <b>diffY</b>
2959
2960                                         </dt>
2961                                         <dd>the Y offset, default 0</dd>
2962
2963                                 </dl>
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975                     </div>
2976                 </div>
2977
2978             </td>
2979             <td class="msource">
2980
2981                         Roo.dd.DragDrop
2982                 &nbsp;
2983             </td>
2984         </tr>
2985
2986
2987           <tr class="method-row config-row-alt1 expandable notInherited">
2988             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2989
2990
2991             <td class="sig">
2992                 <a id="Roo.dd.DragDrop-method-setOuterHandleElId"   name=".setOuterHandleElId"></a>
2993                 <div class="fixedFont">
2994                         <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
2995
2996                                  (<B><i>id</i></B>)
2997
2998
2999
3000                 </div>
3001                 <div class="mdesc">
3002
3003                    <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3004
3005
3006
3007                     <div class="long">
3008
3009                                 Allows you to set an element outside of the linked element as a drag<br/>handle
3010
3011
3012
3013
3014
3015
3016                                 <dl class="detailList">
3017                                 <dt class="heading">Parameters:</dt>
3018
3019                                         <dt>
3020                                                  <b>id</b>
3021
3022                                         </dt>
3023                                         <dd>the id of the element that will be used to initiate the drag</dd>
3024
3025                                 </dl>
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037                     </div>
3038                 </div>
3039
3040             </td>
3041             <td class="msource">
3042
3043                         Roo.dd.DragDrop
3044                 &nbsp;
3045             </td>
3046         </tr>
3047
3048
3049           <tr class="method-row config-row-alt0 expandable notInherited">
3050             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3051
3052
3053             <td class="sig">
3054                 <a id="Roo.dd.DragDrop-method-setPadding"   name=".setPadding"></a>
3055                 <div class="fixedFont">
3056                         <span class="attributes"></span><b class="itemname">setPadding</b>
3057
3058                                  (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3059
3060
3061
3062                 </div>
3063                 <div class="mdesc">
3064
3065                    <div class="short">Configures the padding for the target zone in px.</div>
3066
3067
3068
3069                     <div class="long">
3070
3071                                 Configures the padding for the target zone in px.  Effectively expands<br/>(or reduces) the virtual object size for targeting calculations.<br/>Supports css-style shorthand; if only one parameter is passed, all sides<br/>will have that padding, and if only two are passed, the top and bottom<br/>will have the first param, the left and right the second.
3072
3073
3074
3075
3076
3077
3078                                 <dl class="detailList">
3079                                 <dt class="heading">Parameters:</dt>
3080
3081                                         <dt>
3082                                                 <span class="fixedFont">int</span>  <b>iTop</b>
3083
3084                                         </dt>
3085                                         <dd>Top pad</dd>
3086
3087                                         <dt>
3088                                                 <span class="fixedFont">int</span>  <b>iRight</b>
3089
3090                                         </dt>
3091                                         <dd>Right pad</dd>
3092
3093                                         <dt>
3094                                                 <span class="fixedFont">int</span>  <b>iBot</b>
3095
3096                                         </dt>
3097                                         <dd>Bot pad</dd>
3098
3099                                         <dt>
3100                                                 <span class="fixedFont">int</span>  <b>iLeft</b>
3101
3102                                         </dt>
3103                                         <dd>Left pad</dd>
3104
3105                                 </dl>
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117                     </div>
3118                 </div>
3119
3120             </td>
3121             <td class="msource">
3122
3123                         Roo.dd.DragDrop
3124                 &nbsp;
3125             </td>
3126         </tr>
3127
3128
3129           <tr class="method-row config-row-alt1 expandable notInherited">
3130             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3131
3132
3133             <td class="sig">
3134                 <a id="Roo.dd.DragDrop-method-setXConstraint"   name=".setXConstraint"></a>
3135                 <div class="fixedFont">
3136                         <span class="attributes"></span><b class="itemname">setXConstraint</b>
3137
3138                                  (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3139
3140
3141
3142                 </div>
3143                 <div class="mdesc">
3144
3145                    <div class="short">By default, the element can be dragged any place on the screen.</div>
3146
3147
3148
3149                     <div class="long">
3150
3151                                 By default, the element can be dragged any place on the screen.  Use<br/>this method to limit the horizontal travel of the element.  Pass in<br/>0,0 for the parameters if you want to lock the drag to the y axis.
3152
3153
3154
3155
3156
3157
3158                                 <dl class="detailList">
3159                                 <dt class="heading">Parameters:</dt>
3160
3161                                         <dt>
3162                                                 <span class="fixedFont">int</span>  <b>iLeft</b>
3163
3164                                         </dt>
3165                                         <dd>the number of pixels the element can move to the left</dd>
3166
3167                                         <dt>
3168                                                 <span class="fixedFont">int</span>  <b>iRight</b>
3169
3170                                         </dt>
3171                                         <dd>the number of pixels the element can move to the<br/>right</dd>
3172
3173                                         <dt>
3174                                                 <span class="fixedFont">int</span>  <b>iTickSize</b>
3175
3176                                         </dt>
3177                                         <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3178
3179                                 </dl>
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191                     </div>
3192                 </div>
3193
3194             </td>
3195             <td class="msource">
3196
3197                         Roo.dd.DragDrop
3198                 &nbsp;
3199             </td>
3200         </tr>
3201
3202
3203           <tr class="method-row config-row-alt0 expandable notInherited">
3204             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3205
3206
3207             <td class="sig">
3208                 <a id="Roo.dd.DragDrop-method-setYConstraint"   name=".setYConstraint"></a>
3209                 <div class="fixedFont">
3210                         <span class="attributes"></span><b class="itemname">setYConstraint</b>
3211
3212                                  (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
3213
3214
3215
3216                 </div>
3217                 <div class="mdesc">
3218
3219                    <div class="short">By default, the element can be dragged any place on the screen.</div>
3220
3221
3222
3223                     <div class="long">
3224
3225                                 By default, the element can be dragged any place on the screen.  Set<br/>this to limit the vertical travel of the element.  Pass in 0,0 for the<br/>parameters if you want to lock the drag to the x axis.
3226
3227
3228
3229
3230
3231
3232                                 <dl class="detailList">
3233                                 <dt class="heading">Parameters:</dt>
3234
3235                                         <dt>
3236                                                 <span class="fixedFont">int</span>  <b>iUp</b>
3237
3238                                         </dt>
3239                                         <dd>the number of pixels the element can move up</dd>
3240
3241                                         <dt>
3242                                                 <span class="fixedFont">int</span>  <b>iDown</b>
3243
3244                                         </dt>
3245                                         <dd>the number of pixels the element can move down</dd>
3246
3247                                         <dt>
3248                                                 <span class="fixedFont">int</span>  <b>iTickSize</b>
3249
3250                                         </dt>
3251                                         <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
3252
3253                                 </dl>
3254
3255
3256
3257
3258
3259
3260
3261
3262
3263
3264
3265                     </div>
3266                 </div>
3267
3268             </td>
3269             <td class="msource">
3270
3271                         Roo.dd.DragDrop
3272                 &nbsp;
3273             </td>
3274         </tr>
3275
3276
3277           <tr class="method-row config-row-alt1 expandable notInherited">
3278             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3279
3280
3281             <td class="sig">
3282                 <a id="Roo.dd.DragDrop-method-startDrag"   name=".startDrag"></a>
3283                 <div class="fixedFont">
3284                         <span class="attributes"></span><b class="itemname">startDrag</b>
3285
3286                                  (int <B><i>X</i></B>, int <B><i>Y</i></B>)
3287
3288
3289
3290                 </div>
3291                 <div class="mdesc">
3292
3293                    <div class="short">Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.</div>
3294
3295
3296
3297                     <div class="long">
3298
3299                                 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
3300
3301
3302
3303
3304
3305
3306                                 <dl class="detailList">
3307                                 <dt class="heading">Parameters:</dt>
3308
3309                                         <dt>
3310                                                 <span class="fixedFont">int</span>  <b>X</b>
3311
3312                                         </dt>
3313                                         <dd>click location</dd>
3314
3315                                         <dt>
3316                                                 <span class="fixedFont">int</span>  <b>Y</b>
3317
3318                                         </dt>
3319                                         <dd>click location</dd>
3320
3321                                 </dl>
3322
3323
3324
3325
3326
3327
3328
3329
3330
3331
3332
3333                     </div>
3334                 </div>
3335
3336             </td>
3337             <td class="msource">
3338
3339                         Roo.dd.DragDrop
3340                 &nbsp;
3341             </td>
3342         </tr>
3343
3344
3345           <tr class="method-row config-row-alt0 expandable">
3346             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3347
3348
3349             <td class="sig">
3350                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
3351                 <div class="fixedFont">
3352                         <span class="attributes"></span><b class="itemname">un</b>
3353
3354                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
3355
3356
3357
3358                 </div>
3359                 <div class="mdesc">
3360
3361                    <div class="short">Removes a listener (shorthand for removeListener)</div>
3362
3363
3364
3365                     <div class="long">
3366
3367                                 Removes a listener (shorthand for removeListener)
3368
3369
3370
3371
3372
3373
3374                                 <dl class="detailList">
3375                                 <dt class="heading">Parameters:</dt>
3376
3377                                         <dt>
3378                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
3379
3380                                         </dt>
3381                                         <dd>The type of event to listen for</dd>
3382
3383                                         <dt>
3384                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
3385
3386                                         </dt>
3387                                         <dd>The handler to remove</dd>
3388
3389                                         <dt>
3390                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
3391
3392                                         </dt>
3393                                         <dd>(optional) The scope (this object) for the handler</dd>
3394
3395                                 </dl>
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407                     </div>
3408                 </div>
3409
3410             </td>
3411             <td class="msource">
3412
3413                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
3414                 &nbsp;
3415             </td>
3416         </tr>
3417
3418
3419           <tr class="method-row config-row-alt1 expandable notInherited">
3420             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3421
3422
3423             <td class="sig">
3424                 <a id="Roo.dd.DragDrop-method-unlock"   name=".unlock"></a>
3425                 <div class="fixedFont">
3426                         <span class="attributes"></span><b class="itemname">unlock</b>
3427
3428                                  ()
3429
3430
3431
3432                 </div>
3433                 <div class="mdesc">
3434
3435                    <div class="short">Unlock this instace</div>
3436
3437
3438
3439                     <div class="long">
3440
3441                                 Unlock this instace
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458                     </div>
3459                 </div>
3460
3461             </td>
3462             <td class="msource">
3463
3464                         Roo.dd.DragDrop
3465                 &nbsp;
3466             </td>
3467         </tr>
3468
3469
3470           <tr class="method-row config-row-alt0 expandable notInherited">
3471             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3472
3473
3474             <td class="sig">
3475                 <a id="Roo.dd.DragDrop-method-unreg"   name=".unreg"></a>
3476                 <div class="fixedFont">
3477                         <span class="attributes"></span><b class="itemname">unreg</b>
3478
3479                                  ()
3480
3481
3482
3483                 </div>
3484                 <div class="mdesc">
3485
3486                    <div class="short">Remove all drag and drop hooks for this element</div>
3487
3488
3489
3490                     <div class="long">
3491
3492                                 Remove all drag and drop hooks for this element
3493
3494
3495
3496
3497
3498
3499
3500
3501
3502
3503
3504
3505
3506
3507
3508
3509                     </div>
3510                 </div>
3511
3512             </td>
3513             <td class="msource">
3514
3515                         Roo.dd.DragDrop
3516                 &nbsp;
3517             </td>
3518         </tr>
3519
3520
3521     </table>
3522
3523
3524   <!-- ============================== events summary / details ======================== -->
3525
3526
3527   <a id="Roo.dd.DragDrop-events"></a>
3528
3529
3530
3531
3532
3533      <table cellspacing="0" class="member-table">
3534       <caption class="Empty">Events - Has None</caption>
3535      </table>
3536
3537
3538
3539
3540
3541
3542
3543
3544
3545 <!-- ============================== footer ================================= -->
3546                 <div class="fineprint" style="clear:both">
3547
3548                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 13 2018 14:10:54 GMT+0800 (HKT)
3549                         Based on
3550                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
3551                 </div>
3552         </body>
3553 </html>