git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.DragSource.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.DragSource</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.DragSource-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DragSource-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DragSource-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DragSource-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.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
  47 <img src="../../images/default/s.gif" height="1" width="20"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
  48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
  49 <img src="../../images/default/s.gif" height="1"  width="60"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragSource
  50
  51                    </pre>
  52                 </div>
  53
  54 <!-- ============================== class title / details ============================ -->
  55
  56
  57     <h1 class="classTitle">
  58
  59                                 Class Roo.dd.DragSource
  60                         </h1>
  61
  62     <table cellspacing="0" class="class-summary-table">
  63
  64                 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
  65
  66         <tr><td class="label">Defined In:</td><td class="hd-info">
  67
  68                                         <a href="./src/Roo_dd_DragSource.js.html">Roo/dd/DragSource.js</a>.
  69
  70         </td></tr>
  71         <tr><td class="label">Class:</td><td class="hd-info">DragSource</td></tr>
  72
  73
  74         <tr><td class="label">Subclasses:</td><td class="hd-info">
  75                 <a href="./Roo.dd.DragZone.html#constructor" roo:cls="Roo.dd.DragZone.html#constructor">Roo.dd.DragZone</a>
  76
  77
  78
  79         </td></tr>
  80
  81
  82
  83                 <tr><td class="label">Extends:</td><td class="hd-info">
  84                         <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
  85
  86                 </td></tr>
  87
  88
  89     </table>
  90
  91
  92 <!-- ============================== class summary ========================== -->
  93     <div class="description">
  94         A simple class that provides the basic implementation needed to make any element draggable.
  95     </div>
  96
  97
  98 <!-- ============================== Class comment block... ========================== -->
  99
 100 <div class="comments">
 101         <b>Class Comments / Notes</B> =>
 102         <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragSource';">[Add Your comment/notes about this class]</u>
 103         <br/>
 104         <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;"
 105                 src="/blog.php/GtkDjsComments/Roo.dd.DragSource.html"></iframe>
 106 </div>
 107
 108
 109
 110 <!-- ============================== config options ========================== -->
 111
 112
 113
 114
 115     <div class="hr"></div>
 116     <a id="Roo.dd.DragSource-configs"></a>
 117
 118
 119
 120
 121
 122       <table cellspacing="0" class="member-table">
 123       <caption>Config Options (Usually are also Properties)</caption>
 124
 125
 126         <tr>
 127             <th class="sig-header" colspan="2">Options</th>
 128
 129             <th class="msource-header">Defined By</th>
 130         </tr>
 131
 132
 133
 134
 135
 136                 <tr class="config-row expandable config-row-alt0 notInherited">
 137                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 138                     <td class="sig">
 139
 140                         <a id="Roo.dd.DragSource-cfg-dropAllowed" name=".dropAllowed"></a>
 141                         <div class="fixedFont">
 142                                 <b  class="itemname">dropAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 143
 144
 145                         </div>
 146
 147                         <div class="mdesc">
 148                             <div class="short">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
 149                         </div>
 150
 151                         <div class="mdesc">
 152                             <div class="long">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
 153                         </div>
 154
 155
 156
 157                     </td>
 158                     <td class="msource">
 159
 160                         Roo.dd.DragSource
 161
 162                     </td>
 163                 </tr>
 164
 165
 166                 <tr class="config-row expandable config-row-alt1 notInherited">
 167                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 168                     <td class="sig">
 169
 170                         <a id="Roo.dd.DragSource-cfg-dropNotAllowed" name=".dropNotAllowed"></a>
 171                         <div class="fixedFont">
 172                                 <b  class="itemname">dropNotAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 173
 174
 175                         </div>
 176
 177                         <div class="mdesc">
 178                             <div class="short">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
 179                         </div>
 180
 181                         <div class="mdesc">
 182                             <div class="long">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
 183                         </div>
 184
 185
 186
 187                     </td>
 188                     <td class="msource">
 189
 190                         Roo.dd.DragSource
 191
 192                     </td>
 193                 </tr>
 194
 195
 196     </table>
 197
 198
 199
 200
 201
 202
 203
 204
 205
 206   <!-- ============================== public properties ==================== -->
 207
 208
 209
 210     <a id="Roo.dd.DragSource-props"></a>
 211
 212
 213
 214
 215
 216
 217
 218       <table cellspacing="0" class="member-table">
 219       <caption>Public Properties </caption>
 220         <tr>
 221             <th class="sig-header" colspan="2">Property</th>
 222             <th class="sig-header">Description</th>
 223             <th class="msource-header">Defined By</th>
 224         </tr>
 225
 226
 227
 228
 229
 230
 231
 232
 233           <tr class="property-row config-row-alt0">
 234             <td class="micon">
 235                 <a class="exi" href="#expand">&nbsp;</a>
 236             </td>
 237             <td class="sig">
 238                <a id="Roo.dd.DDProxy-prop-dragElId" name=".dragElId"></a>
 239                <div class="fixedFont">
 240                     <span class="attributes">Roo.dd.DragSource.</span><b  class="itemname">dragElId</b> :
 241                      <span type="etype"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>
 242                      </div>
 243             </td>
 244             <td class="sig">
 245                 <div class="mdesc">
 246
 247
 248                    <div class="short">
 249                         The default drag frame div id
 250
 251
 252
 253                    </div>
 254
 255                     <div class="long">
 256
 257                         The default drag frame div id
 258
 259                 </div>
 260                 </div>
 261             </td>
 262
 263             <td class="msource">
 264             <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
 265             </td>
 266
 267           </tr>
 268
 269
 270
 271
 272
 273         <!-- TODO: implement this alt row.  also notice non-linked "Defined by" when property is a part of this class.
 274         <tr class="property-row alt">
 275
 276         -->
 277
 278     </table>
 279
 280
 281   <!-- ============================== methods summary / details ======================== -->
 282
 283
 284   <a id="Roo.dd.DragSource-methods"></a>
 285         <!-- constructor?? -->
 286
 287         <!-- static's first
 288
 289
 290         -->
 291
 292         <!-- then dynamics first -->
 293
 294
 295
 296
 297
 298
 299       <table cellspacing="0" class="member-table">
 300       <caption>Public Methods</caption>
 301         <tr>
 302             <th class="sig-header" colspan="2">Method</th>
 303             <th class="msource-header">Defined By</th>
 304
 305         </tr>
 306
 307
 308
 309
 310
 311
 312
 313           <tr class="method-row config-row-alt0 expandable notInherited">
 314             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 315
 316
 317             <td class="sig">
 318                 <a id="Roo.dd-method-DragSource"   name=".DragSource"></a>
 319                 <div class="fixedFont">
 320                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragSource</b>
 321
 322                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>el</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
 323
 324
 325
 326                 </div>
 327                 <div class="mdesc">
 328
 329
 330                         <div class="short">Create a new Roo.dd.DragSource</div>
 331
 332
 333                     <div class="long">
 334
 335
 336
 337                                 Create a new Roo.dd.DragSource
 338
 339
 340                                 <dl class="detailList">
 341                                 <dt class="heading">Parameters:</dt>
 342
 343                                         <dt>
 344                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 345
 346                                         </dt>
 347                                         <dd>The container element</dd>
 348
 349                                         <dt>
 350                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>config</b>
 351
 352                                         </dt>
 353                                         <dd></dd>
 354
 355                                 </dl>
 356
 357
 358
 359
 360
 361
 362
 363
 364
 365
 366
 367                     </div>
 368                 </div>
 369
 370             </td>
 371             <td class="msource">
 372                 &nbsp;
 373             </td>
 374         </tr>
 375
 376
 377           <tr class="method-row config-row-alt1 expandable">
 378             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 379
 380
 381             <td class="sig">
 382                 <a id="Roo.dd.DragDrop-method-addInvalidHandleClass"   name=".addInvalidHandleClass"></a>
 383                 <div class="fixedFont">
 384                         <span class="attributes"></span><b class="itemname">addInvalidHandleClass</b>
 385
 386                                  (string <B><i>cssClass</i></B>)
 387
 388
 389
 390                 </div>
 391                 <div class="mdesc">
 392
 393                    <div class="short">Lets you specify a css class of elements that will not initiate a drag</div>
 394
 395
 396
 397                     <div class="long">
 398
 399                                 Lets you specify a css class of elements that will not initiate a drag
 400
 401
 402
 403
 404
 405
 406                                 <dl class="detailList">
 407                                 <dt class="heading">Parameters:</dt>
 408
 409                                         <dt>
 410                                                 <span class="fixedFont">string</span>  <b>cssClass</b>
 411
 412                                         </dt>
 413                                         <dd>the class of the elements you wish to ignore</dd>
 414
 415                                 </dl>
 416
 417
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427                     </div>
 428                 </div>
 429
 430             </td>
 431             <td class="msource">
 432
 433                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
 434                 &nbsp;
 435             </td>
 436         </tr>
 437
 438
 439           <tr class="method-row config-row-alt0 expandable">
 440             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 441
 442
 443             <td class="sig">
 444                 <a id="Roo.dd.DragDrop-method-addInvalidHandleId"   name=".addInvalidHandleId"></a>
 445                 <div class="fixedFont">
 446                         <span class="attributes"></span><b class="itemname">addInvalidHandleId</b>
 447
 448                                  (string <B><i>id</i></B>)
 449
 450
 451
 452                 </div>
 453                 <div class="mdesc">
 454
 455                    <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>
 456
 457
 458
 459                     <div class="long">
 460
 461                                 Lets you to specify an element id for a child of a drag handle<br/>that should not initiate a drag
 462
 463
 464
 465
 466
 467
 468                                 <dl class="detailList">
 469                                 <dt class="heading">Parameters:</dt>
 470
 471                                         <dt>
 472                                                 <span class="fixedFont">string</span>  <b>id</b>
 473
 474                                         </dt>
 475                                         <dd>the element id of the element you wish to ignore</dd>
 476
 477                                 </dl>
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489                     </div>
 490                 </div>
 491
 492             </td>
 493             <td class="msource">
 494
 495                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
 496                 &nbsp;
 497             </td>
 498         </tr>
 499
 500
 501           <tr class="method-row config-row-alt1 expandable">
 502             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 503
 504
 505             <td class="sig">
 506                 <a id="Roo.dd.DragDrop-method-addInvalidHandleType"   name=".addInvalidHandleType"></a>
 507                 <div class="fixedFont">
 508                         <span class="attributes"></span><b class="itemname">addInvalidHandleType</b>
 509
 510                                  (string <B><i>tagName</i></B>)
 511
 512
 513
 514                 </div>
 515                 <div class="mdesc">
 516
 517                    <div class="short">Allows you to specify a tag name that should not start a drag operation<br/>when clicked.</div>
 518
 519
 520
 521                     <div class="long">
 522
 523                                 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.
 524
 525
 526
 527
 528
 529
 530                                 <dl class="detailList">
 531                                 <dt class="heading">Parameters:</dt>
 532
 533                                         <dt>
 534                                                 <span class="fixedFont">string</span>  <b>tagName</b>
 535
 536                                         </dt>
 537                                         <dd>the type of element to exclude</dd>
 538
 539                                 </dl>
 540
 541
 542
 543
 544
 545
 546
 547
 548
 549
 550
 551                     </div>
 552                 </div>
 553
 554             </td>
 555             <td class="msource">
 556
 557                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
 558                 &nbsp;
 559             </td>
 560         </tr>
 561
 562
 563           <tr class="method-row config-row-alt0 expandable">
 564             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 565
 566
 567             <td class="sig">
 568                 <a id="Roo.dd.DragDrop-method-addToGroup"   name=".addToGroup"></a>
 569                 <div class="fixedFont">
 570                         <span class="attributes"></span><b class="itemname">addToGroup</b>
 571
 572                                  (<B><i>sGroup</i></B>)
 573
 574
 575
 576                 </div>
 577                 <div class="mdesc">
 578
 579                    <div class="short">Add this instance to a group of related drag/drop objects.</div>
 580
 581
 582
 583                     <div class="long">
 584
 585                                 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.
 586
 587
 588
 589
 590
 591
 592                                 <dl class="detailList">
 593                                 <dt class="heading">Parameters:</dt>
 594
 595                                         <dt>
 596                                                  <b>sGroup</b>
 597
 598                                         </dt>
 599                                         <dd>{string} the name of the group</dd>
 600
 601                                 </dl>
 602
 603
 604
 605
 606
 607
 608
 609
 610
 611
 612
 613                     </div>
 614                 </div>
 615
 616             </td>
 617             <td class="msource">
 618
 619                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
 620                 &nbsp;
 621             </td>
 622         </tr>
 623
 624
 625           <tr class="method-row config-row-alt1 expandable">
 626             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 627
 628
 629             <td class="sig">
 630                 <a id="Roo.dd.DD-method-alignElWithMouse"   name=".alignElWithMouse"></a>
 631                 <div class="fixedFont">
 632                         <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
 633
 634                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>el</i></B>, int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
 635
 636
 637
 638                 </div>
 639                 <div class="mdesc">
 640
 641                    <div class="short">Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
 642
 643
 644
 645                     <div class="long">
 646
 647                                 Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.  Override this if you want to place the element in a<br/>location other than where the cursor is.
 648
 649
 650
 651
 652
 653
 654                                 <dl class="detailList">
 655                                 <dt class="heading">Parameters:</dt>
 656
 657                                         <dt>
 658                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>el</b>
 659
 660                                         </dt>
 661                                         <dd>the element to move</dd>
 662
 663                                         <dt>
 664                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
 665
 666                                         </dt>
 667                                         <dd>the X coordinate of the mousedown or drag event</dd>
 668
 669                                         <dt>
 670                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
 671
 672                                         </dt>
 673                                         <dd>the Y coordinate of the mousedown or drag event</dd>
 674
 675                                 </dl>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687                     </div>
 688                 </div>
 689
 690             </td>
 691             <td class="msource">
 692
 693                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
 694                 &nbsp;
 695             </td>
 696         </tr>
 697
 698
 699           <tr class="method-row config-row-alt0 expandable">
 700             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 701
 702
 703             <td class="sig">
 704                 <a id="Roo.dd.DragDrop-method-applyConfig"   name=".applyConfig"></a>
 705                 <div class="fixedFont">
 706                         <span class="attributes"></span><b class="itemname">applyConfig</b>
 707
 708                                  ()
 709
 710
 711
 712                 </div>
 713                 <div class="mdesc">
 714
 715                    <div class="short">Applies the configuration parameters that were passed into the constructor.</div>
 716
 717
 718
 719                     <div class="long">
 720
 721                                 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.
 722
 723
 724
 725
 726
 727
 728
 729
 730
 731
 732
 733
 734
 735
 736
 737
 738                     </div>
 739                 </div>
 740
 741             </td>
 742             <td class="msource">
 743
 744                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
 745                 &nbsp;
 746             </td>
 747         </tr>
 748
 749
 750           <tr class="method-row config-row-alt1 expandable">
 751             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 752
 753
 754             <td class="sig">
 755                 <a id="Roo.dd.DD-method-autoOffset"   name=".autoOffset"></a>
 756                 <div class="fixedFont">
 757                         <span class="attributes"></span><b class="itemname">autoOffset</b>
 758
 759                                  (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
 760
 761
 762
 763                 </div>
 764                 <div class="mdesc">
 765
 766                    <div class="short">Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked</div>
 767
 768
 769
 770                     <div class="long">
 771
 772                                 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
 773
 774
 775
 776
 777
 778
 779                                 <dl class="detailList">
 780                                 <dt class="heading">Parameters:</dt>
 781
 782                                         <dt>
 783                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
 784
 785                                         </dt>
 786                                         <dd>the X coordinate of the click</dd>
 787
 788                                         <dt>
 789                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
 790
 791                                         </dt>
 792                                         <dd>the Y coordinate of the click</dd>
 793
 794                                 </dl>
 795
 796
 797
 798
 799
 800
 801
 802
 803
 804
 805
 806                     </div>
 807                 </div>
 808
 809             </td>
 810             <td class="msource">
 811
 812                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
 813                 &nbsp;
 814             </td>
 815         </tr>
 816
 817
 818           <tr class="method-row config-row-alt0 expandable notInherited">
 819             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 820
 821
 822             <td class="sig">
 823                 <a id="Roo.dd.DragSource-method-beforeDragDrop"   name=".beforeDragDrop"></a>
 824                 <div class="fixedFont">
 825                         <span class="attributes"></span><b class="itemname">beforeDragDrop</b>
 826
 827                                  (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
 828
 829
 830                                          :
 831
 832
 833                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 834
 835
 836
 837
 838
 839                 </div>
 840                 <div class="mdesc">
 841
 842                    <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dropped onto the target and optionally cancel the onDragDrop.</div>
 843
 844
 845
 846                     <div class="long">
 847
 848                                 An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dropped onto the target and optionally cancel the onDragDrop.
 849
 850
 851
 852
 853
 854
 855                                 <dl class="detailList">
 856                                 <dt class="heading">Parameters:</dt>
 857
 858                                         <dt>
 859                                                 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span>  <b>target</b>
 860
 861                                         </dt>
 862                                         <dd>The drop target</dd>
 863
 864                                         <dt>
 865                                                 <span class="fixedFont">Event</span>  <b>e</b>
 866
 867                                         </dt>
 868                                         <dd>The event object</dd>
 869
 870                                         <dt>
 871                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 872
 873                                         </dt>
 874                                         <dd>The id of the dragged element</dd>
 875
 876                                 </dl>
 877
 878
 879
 880
 881
 882                                 <dl class="detailList">
 883                                 <dt class="heading">Returns:</dt>
 884
 885                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the drag drop event is valid, else false to cancel</dd>
 886
 887                                 </dl>
 888
 889
 890
 891
 892
 893
 894
 895                     </div>
 896                 </div>
 897
 898             </td>
 899             <td class="msource">
 900
 901                         Roo.dd.DragSource
 902                 &nbsp;
 903             </td>
 904         </tr>
 905
 906
 907           <tr class="method-row config-row-alt1 expandable notInherited">
 908             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 909
 910
 911             <td class="sig">
 912                 <a id="Roo.dd.DragSource-method-beforeDragEnter"   name=".beforeDragEnter"></a>
 913                 <div class="fixedFont">
 914                         <span class="attributes"></span><b class="itemname">beforeDragEnter</b>
 915
 916                                  (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
 917
 918
 919                                          :
 920
 921
 922                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 923
 924
 925
 926
 927
 928                 </div>
 929                 <div class="mdesc">
 930
 931                    <div class="short">An empty function by default, but provided so that you can perform a custom action<br/>before the dragged item enters the drop target and optionally cancel the onDragEnter.</div>
 932
 933
 934
 935                     <div class="long">
 936
 937                                 An empty function by default, but provided so that you can perform a custom action<br/>before the dragged item enters the drop target and optionally cancel the onDragEnter.
 938
 939
 940
 941
 942
 943
 944                                 <dl class="detailList">
 945                                 <dt class="heading">Parameters:</dt>
 946
 947                                         <dt>
 948                                                 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span>  <b>target</b>
 949
 950                                         </dt>
 951                                         <dd>The drop target</dd>
 952
 953                                         <dt>
 954                                                 <span class="fixedFont">Event</span>  <b>e</b>
 955
 956                                         </dt>
 957                                         <dd>The event object</dd>
 958
 959                                         <dt>
 960                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 961
 962                                         </dt>
 963                                         <dd>The id of the dragged element</dd>
 964
 965                                 </dl>
 966
 967
 968
 969
 970
 971                                 <dl class="detailList">
 972                                 <dt class="heading">Returns:</dt>
 973
 974                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the drag event is valid, else false to cancel</dd>
 975
 976                                 </dl>
 977
 978
 979
 980
 981
 982
 983
 984                     </div>
 985                 </div>
 986
 987             </td>
 988             <td class="msource">
 989
 990                         Roo.dd.DragSource
 991                 &nbsp;
 992             </td>
 993         </tr>
 994
 995
 996           <tr class="method-row config-row-alt0 expandable notInherited">
 997             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 998
 999
1000             <td class="sig">
1001                 <a id="Roo.dd.DragSource-method-beforeDragOut"   name=".beforeDragOut"></a>
1002                 <div class="fixedFont">
1003                         <span class="attributes"></span><b class="itemname">beforeDragOut</b>
1004
1005                                  (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1006
1007
1008                                          :
1009
1010
1011                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1012
1013
1014
1015
1016
1017                 </div>
1018                 <div class="mdesc">
1019
1020                    <div class="short">An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dragged out of the target without dropping, and optionally cancel the onDragOut.</div>
1021
1022
1023
1024                     <div class="long">
1025
1026                                 An empty function by default, but provided so that you can perform a custom action before the dragged<br/>item is dragged out of the target without dropping, and optionally cancel the onDragOut.
1027
1028
1029
1030
1031
1032
1033                                 <dl class="detailList">
1034                                 <dt class="heading">Parameters:</dt>
1035
1036                                         <dt>
1037                                                 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span>  <b>target</b>
1038
1039                                         </dt>
1040                                         <dd>The drop target</dd>
1041
1042                                         <dt>
1043                                                 <span class="fixedFont">Event</span>  <b>e</b>
1044
1045                                         </dt>
1046                                         <dd>The event object</dd>
1047
1048                                         <dt>
1049                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1050
1051                                         </dt>
1052                                         <dd>The id of the dragged element</dd>
1053
1054                                 </dl>
1055
1056
1057
1058
1059
1060                                 <dl class="detailList">
1061                                 <dt class="heading">Returns:</dt>
1062
1063                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the drag event is valid, else false to cancel</dd>
1064
1065                                 </dl>
1066
1067
1068
1069
1070
1071
1072
1073                     </div>
1074                 </div>
1075
1076             </td>
1077             <td class="msource">
1078
1079                         Roo.dd.DragSource
1080                 &nbsp;
1081             </td>
1082         </tr>
1083
1084
1085           <tr class="method-row config-row-alt1 expandable notInherited">
1086             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1087
1088
1089             <td class="sig">
1090                 <a id="Roo.dd.DragSource-method-beforeDragOver"   name=".beforeDragOver"></a>
1091                 <div class="fixedFont">
1092                         <span class="attributes"></span><b class="itemname">beforeDragOver</b>
1093
1094                                  (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1095
1096
1097                                          :
1098
1099
1100                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1101
1102
1103
1104
1105
1106                 </div>
1107                 <div class="mdesc">
1108
1109                    <div class="short">An empty function by default, but provided so that you can perform a custom action<br/>while the dragged item is over the drop target and optionally cancel the onDragOver.</div>
1110
1111
1112
1113                     <div class="long">
1114
1115                                 An empty function by default, but provided so that you can perform a custom action<br/>while the dragged item is over the drop target and optionally cancel the onDragOver.
1116
1117
1118
1119
1120
1121
1122                                 <dl class="detailList">
1123                                 <dt class="heading">Parameters:</dt>
1124
1125                                         <dt>
1126                                                 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span>  <b>target</b>
1127
1128                                         </dt>
1129                                         <dd>The drop target</dd>
1130
1131                                         <dt>
1132                                                 <span class="fixedFont">Event</span>  <b>e</b>
1133
1134                                         </dt>
1135                                         <dd>The event object</dd>
1136
1137                                         <dt>
1138                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1139
1140                                         </dt>
1141                                         <dd>The id of the dragged element</dd>
1142
1143                                 </dl>
1144
1145
1146
1147
1148
1149                                 <dl class="detailList">
1150                                 <dt class="heading">Returns:</dt>
1151
1152                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the drag event is valid, else false to cancel</dd>
1153
1154                                 </dl>
1155
1156
1157
1158
1159
1160
1161
1162                     </div>
1163                 </div>
1164
1165             </td>
1166             <td class="msource">
1167
1168                         Roo.dd.DragSource
1169                 &nbsp;
1170             </td>
1171         </tr>
1172
1173
1174           <tr class="method-row config-row-alt0 expandable notInherited">
1175             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1176
1177
1178             <td class="sig">
1179                 <a id="Roo.dd.DragSource-method-beforeInvalidDrop"   name=".beforeInvalidDrop"></a>
1180                 <div class="fixedFont">
1181                         <span class="attributes"></span><b class="itemname">beforeInvalidDrop</b>
1182
1183                                  (<a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a> <B><i>target</i></B>, Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
1184
1185
1186                                          :
1187
1188
1189                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1190
1191
1192
1193
1194
1195                 </div>
1196                 <div class="mdesc">
1197
1198                    <div class="short">An empty function by default, but provided so that you can perform a custom action after an invalid<br/>drop has occurred.</div>
1199
1200
1201
1202                     <div class="long">
1203
1204                                 An empty function by default, but provided so that you can perform a custom action after an invalid<br/>drop has occurred.
1205
1206
1207
1208
1209
1210
1211                                 <dl class="detailList">
1212                                 <dt class="heading">Parameters:</dt>
1213
1214                                         <dt>
1215                                                 <span class="fixedFont"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a></span>  <b>target</b>
1216
1217                                         </dt>
1218                                         <dd>The drop target</dd>
1219
1220                                         <dt>
1221                                                 <span class="fixedFont">Event</span>  <b>e</b>
1222
1223                                         </dt>
1224                                         <dd>The event object</dd>
1225
1226                                         <dt>
1227                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
1228
1229                                         </dt>
1230                                         <dd>The id of the dragged element</dd>
1231
1232                                 </dl>
1233
1234
1235
1236
1237
1238                                 <dl class="detailList">
1239                                 <dt class="heading">Returns:</dt>
1240
1241                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the invalid drop should proceed, else false to cancel</dd>
1242
1243                                 </dl>
1244
1245
1246
1247
1248
1249
1250
1251                     </div>
1252                 </div>
1253
1254             </td>
1255             <td class="msource">
1256
1257                         Roo.dd.DragSource
1258                 &nbsp;
1259             </td>
1260         </tr>
1261
1262
1263           <tr class="method-row config-row-alt1 expandable">
1264             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1265
1266
1267             <td class="sig">
1268                 <a id="Roo.dd.DD-method-cachePosition"   name=".cachePosition"></a>
1269                 <div class="fixedFont">
1270                         <span class="attributes"></span><b class="itemname">cachePosition</b>
1271
1272                                  (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
1273
1274
1275
1276                 </div>
1277                 <div class="mdesc">
1278
1279                    <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
1280
1281
1282
1283                     <div class="long">
1284
1285                                 Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.  We need to know this so that we can calculate the<br/>number of pixels the element is offset from its original position.
1286
1287
1288
1289
1290
1291
1292                                 <dl class="detailList">
1293                                 <dt class="heading">Parameters:</dt>
1294
1295                                         <dt>
1296                                                  <b>iPageX</b>
1297
1298                                         </dt>
1299                                         <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
1300
1301                                         <dt>
1302                                                  <b>iPageY</b>
1303
1304                                         </dt>
1305                                         <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
1306
1307                                 </dl>
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319                     </div>
1320                 </div>
1321
1322             </td>
1323             <td class="msource">
1324
1325                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
1326                 &nbsp;
1327             </td>
1328         </tr>
1329
1330
1331           <tr class="method-row config-row-alt0 expandable">
1332             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1333
1334
1335             <td class="sig">
1336                 <a id="Roo.dd.DragDrop-method-clearConstraints"   name=".clearConstraints"></a>
1337                 <div class="fixedFont">
1338                         <span class="attributes"></span><b class="itemname">clearConstraints</b>
1339
1340                                  ()
1341
1342
1343
1344                 </div>
1345                 <div class="mdesc">
1346
1347                    <div class="short">Clears any constraints applied to this instance.</div>
1348
1349
1350
1351                     <div class="long">
1352
1353                                 Clears any constraints applied to this instance.  Also clears ticks<br/>since they can't exist independent of a constraint at this time.
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370                     </div>
1371                 </div>
1372
1373             </td>
1374             <td class="msource">
1375
1376                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1377                 &nbsp;
1378             </td>
1379         </tr>
1380
1381
1382           <tr class="method-row config-row-alt1 expandable">
1383             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1384
1385
1386             <td class="sig">
1387                 <a id="Roo.dd.DragDrop-method-clearTicks"   name=".clearTicks"></a>
1388                 <div class="fixedFont">
1389                         <span class="attributes"></span><b class="itemname">clearTicks</b>
1390
1391                                  ()
1392
1393
1394
1395                 </div>
1396                 <div class="mdesc">
1397
1398                    <div class="short">Clears any tick interval defined for this instance</div>
1399
1400
1401
1402                     <div class="long">
1403
1404                                 Clears any tick interval defined for this instance
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421                     </div>
1422                 </div>
1423
1424             </td>
1425             <td class="msource">
1426
1427                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1428                 &nbsp;
1429             </td>
1430         </tr>
1431
1432
1433           <tr class="method-row config-row-alt0 expandable">
1434             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1435
1436
1437             <td class="sig">
1438                 <a id="Roo.dd.DDProxy-method-createFrame"   name=".createFrame"></a>
1439                 <div class="fixedFont">
1440                         <span class="attributes"></span><b class="itemname">createFrame</b>
1441
1442                                  ()
1443
1444
1445
1446                 </div>
1447                 <div class="mdesc">
1448
1449                    <div class="short">Creates the proxy element if it does not yet exist</div>
1450
1451
1452
1453                     <div class="long">
1454
1455                                 Creates the proxy element if it does not yet exist
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472                     </div>
1473                 </div>
1474
1475             </td>
1476             <td class="msource">
1477
1478                         <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
1479                 &nbsp;
1480             </td>
1481         </tr>
1482
1483
1484           <tr class="method-row config-row-alt1 expandable">
1485             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1486
1487
1488             <td class="sig">
1489                 <a id="Roo.dd.DragDrop-method-endDrag"   name=".endDrag"></a>
1490                 <div class="fixedFont">
1491                         <span class="attributes"></span><b class="itemname">endDrag</b>
1492
1493                                  (Event <B><i>e</i></B>)
1494
1495
1496
1497                 </div>
1498                 <div class="mdesc">
1499
1500                    <div class="short">Fired when we are done dragging the object</div>
1501
1502
1503
1504                     <div class="long">
1505
1506                                 Fired when we are done dragging the object
1507
1508
1509
1510
1511
1512
1513                                 <dl class="detailList">
1514                                 <dt class="heading">Parameters:</dt>
1515
1516                                         <dt>
1517                                                 <span class="fixedFont">Event</span>  <b>e</b>
1518
1519                                         </dt>
1520                                         <dd>the mouseup event</dd>
1521
1522                                 </dl>
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534                     </div>
1535                 </div>
1536
1537             </td>
1538             <td class="msource">
1539
1540                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1541                 &nbsp;
1542             </td>
1543         </tr>
1544
1545
1546           <tr class="method-row config-row-alt0 expandable">
1547             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1548
1549
1550             <td class="sig">
1551                 <a id="Roo.dd.DragDrop-method-function toString() {
1552     [native code]
1553 }"   name=".function toString() {
1554     [native code]
1555 }"></a>
1556                 <div class="fixedFont">
1557                         <span class="attributes"></span><b class="itemname">function toString() {
1558     [native code]
1559 }</b>
1560
1561                                  ()
1562
1563
1564                                          :
1565
1566
1567                                                 string
1568
1569
1570
1571
1572
1573                 </div>
1574                 <div class="mdesc">
1575
1576                    <div class="short">toString method</div>
1577
1578
1579
1580                     <div class="long">
1581
1582                                 toString method
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593                                 <dl class="detailList">
1594                                 <dt class="heading">Returns:</dt>
1595
1596                                         <dd><span class="fixedFont">string</span>  string representation of the dd obj</dd>
1597
1598                                 </dl>
1599
1600
1601
1602
1603
1604
1605
1606                     </div>
1607                 </div>
1608
1609             </td>
1610             <td class="msource">
1611
1612                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1613                 &nbsp;
1614             </td>
1615         </tr>
1616
1617
1618           <tr class="method-row config-row-alt1 expandable notInherited">
1619             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1620
1621
1622             <td class="sig">
1623                 <a id="Roo.dd.DragSource-method-getDragData"   name=".getDragData"></a>
1624                 <div class="fixedFont">
1625                         <span class="attributes"></span><b class="itemname">getDragData</b>
1626
1627                                  ()
1628
1629
1630                                          :
1631
1632
1633                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1634
1635
1636
1637
1638
1639                 </div>
1640                 <div class="mdesc">
1641
1642                    <div class="short">Returns the data object associated with this drag source</div>
1643
1644
1645
1646                     <div class="long">
1647
1648                                 Returns the data object associated with this drag source
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659                                 <dl class="detailList">
1660                                 <dt class="heading">Returns:</dt>
1661
1662                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  data An object containing arbitrary data</dd>
1663
1664                                 </dl>
1665
1666
1667
1668
1669
1670
1671
1672                     </div>
1673                 </div>
1674
1675             </td>
1676             <td class="msource">
1677
1678                         Roo.dd.DragSource
1679                 &nbsp;
1680             </td>
1681         </tr>
1682
1683
1684           <tr class="method-row config-row-alt0 expandable">
1685             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1686
1687
1688             <td class="sig">
1689                 <a id="Roo.dd.DragDrop-method-getDragEl"   name=".getDragEl"></a>
1690                 <div class="fixedFont">
1691                         <span class="attributes"></span><b class="itemname">getDragEl</b>
1692
1693                                  ()
1694
1695
1696                                          :
1697
1698
1699                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1700
1701
1702
1703
1704
1705                 </div>
1706                 <div class="mdesc">
1707
1708                    <div class="short">Returns a reference to the actual element to drag.</div>
1709
1710
1711
1712                     <div class="long">
1713
1714                                 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
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725                                 <dl class="detailList">
1726                                 <dt class="heading">Returns:</dt>
1727
1728                                         <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>
1729
1730                                 </dl>
1731
1732
1733
1734
1735
1736
1737
1738                     </div>
1739                 </div>
1740
1741             </td>
1742             <td class="msource">
1743
1744                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1745                 &nbsp;
1746             </td>
1747         </tr>
1748
1749
1750           <tr class="method-row config-row-alt1 expandable">
1751             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1752
1753
1754             <td class="sig">
1755                 <a id="Roo.dd.DragDrop-method-getEl"   name=".getEl"></a>
1756                 <div class="fixedFont">
1757                         <span class="attributes"></span><b class="itemname">getEl</b>
1758
1759                                  ()
1760
1761
1762                                          :
1763
1764
1765                                                 <a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a>
1766
1767
1768
1769
1770
1771                 </div>
1772                 <div class="mdesc">
1773
1774                    <div class="short">Returns a reference to the linked element</div>
1775
1776
1777
1778                     <div class="long">
1779
1780                                 Returns a reference to the linked element
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791                                 <dl class="detailList">
1792                                 <dt class="heading">Returns:</dt>
1793
1794                                         <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>
1795
1796                                 </dl>
1797
1798
1799
1800
1801
1802
1803
1804                     </div>
1805                 </div>
1806
1807             </td>
1808             <td class="msource">
1809
1810                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
1811                 &nbsp;
1812             </td>
1813         </tr>
1814
1815
1816           <tr class="method-row config-row-alt0 expandable notInherited">
1817             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1818
1819
1820             <td class="sig">
1821                 <a id="Roo.dd.DragSource-method-getProxy"   name=".getProxy"></a>
1822                 <div class="fixedFont">
1823                         <span class="attributes"></span><b class="itemname">getProxy</b>
1824
1825                                  ()
1826
1827
1828                                          :
1829
1830
1831                                                 <a href="./Roo.dd.StatusProxy.html#constructor" roo:cls="Roo.dd.StatusProxy.html#constructor">Roo.dd.StatusProxy</a>
1832
1833
1834
1835
1836
1837                 </div>
1838                 <div class="mdesc">
1839
1840                    <div class="short">Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}</div>
1841
1842
1843
1844                     <div class="long">
1845
1846                                 Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857                                 <dl class="detailList">
1858                                 <dt class="heading">Returns:</dt>
1859
1860                                         <dd><span class="fixedFont"><a href="./Roo.dd.StatusProxy.html#constructor" roo:cls="Roo.dd.StatusProxy.html#constructor">Roo.dd.StatusProxy</a></span>  proxy The StatusProxy</dd>
1861
1862                                 </dl>
1863
1864
1865
1866
1867
1868
1869
1870                     </div>
1871                 </div>
1872
1873             </td>
1874             <td class="msource">
1875
1876                         Roo.dd.DragSource
1877                 &nbsp;
1878             </td>
1879         </tr>
1880
1881
1882           <tr class="method-row config-row-alt1 expandable notInherited">
1883             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1884
1885
1886             <td class="sig">
1887                 <a id="Roo.dd.DragSource-method-hideProxy"   name=".hideProxy"></a>
1888                 <div class="fixedFont">
1889                         <span class="attributes"></span><b class="itemname">hideProxy</b>
1890
1891                                  ()
1892
1893
1894
1895                 </div>
1896                 <div class="mdesc">
1897
1898                    <div class="short">Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}</div>
1899
1900
1901
1902                     <div class="long">
1903
1904                                 Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921                     </div>
1922                 </div>
1923
1924             </td>
1925             <td class="msource">
1926
1927                         Roo.dd.DragSource
1928                 &nbsp;
1929             </td>
1930         </tr>
1931
1932
1933           <tr class="method-row config-row-alt0 expandable">
1934             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1935
1936
1937             <td class="sig">
1938                 <a id="Roo.dd.DragDrop-method-init"   name=".init"></a>
1939                 <div class="fixedFont">
1940                         <span class="attributes"></span><b class="itemname">init</b>
1941
1942                                  (<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>)
1943
1944
1945
1946                 </div>
1947                 <div class="mdesc">
1948
1949                    <div class="short">Sets up the DragDrop object.</div>
1950
1951
1952
1953                     <div class="long">
1954
1955                                 Sets up the DragDrop object.  Must be called in the constructor of any<br/>Roo.dd.DragDrop subclass
1956
1957
1958
1959
1960
1961
1962                                 <dl class="detailList">
1963                                 <dt class="heading">Parameters:</dt>
1964
1965                                         <dt>
1966                                                  <b>id</b>
1967
1968                                         </dt>
1969                                         <dd>the id of the linked element</dd>
1970
1971                                         <dt>
1972                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
1973
1974                                         </dt>
1975                                         <dd>the group of related items</dd>
1976
1977                                         <dt>
1978                                                 <span class="fixedFont">object</span>  <b>config</b>
1979
1980                                         </dt>
1981                                         <dd>configuration attributes</dd>
1982
1983                                 </dl>
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995                     </div>
1996                 </div>
1997
1998             </td>
1999             <td class="msource">
2000
2001                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2002                 &nbsp;
2003             </td>
2004         </tr>
2005
2006
2007           <tr class="method-row config-row-alt1 expandable">
2008             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2009
2010
2011             <td class="sig">
2012                 <a id="Roo.dd.DDProxy-method-initFrame"   name=".initFrame"></a>
2013                 <div class="fixedFont">
2014                         <span class="attributes"></span><b class="itemname">initFrame</b>
2015
2016                                  ()
2017
2018
2019
2020                 </div>
2021                 <div class="mdesc">
2022
2023                    <div class="short">Initialization for the drag frame element.</div>
2024
2025
2026
2027                     <div class="long">
2028
2029                                 Initialization for the drag frame element.  Must be called in the<br/>constructor of all subclasses
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046                     </div>
2047                 </div>
2048
2049             </td>
2050             <td class="msource">
2051
2052                         <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
2053                 &nbsp;
2054             </td>
2055         </tr>
2056
2057
2058           <tr class="method-row config-row-alt0 expandable">
2059             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2060
2061
2062             <td class="sig">
2063                 <a id="Roo.dd.DragDrop-method-initTarget"   name=".initTarget"></a>
2064                 <div class="fixedFont">
2065                         <span class="attributes"></span><b class="itemname">initTarget</b>
2066
2067                                  (<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>)
2068
2069
2070
2071                 </div>
2072                 <div class="mdesc">
2073
2074                    <div class="short">Initializes Targeting functionality only.</div>
2075
2076
2077
2078                     <div class="long">
2079
2080                                 Initializes Targeting functionality only... the object does not<br/>get a mousedown handler.
2081
2082
2083
2084
2085
2086
2087                                 <dl class="detailList">
2088                                 <dt class="heading">Parameters:</dt>
2089
2090                                         <dt>
2091                                                  <b>id</b>
2092
2093                                         </dt>
2094                                         <dd>the id of the linked element</dd>
2095
2096                                         <dt>
2097                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
2098
2099                                         </dt>
2100                                         <dd>the group of related items</dd>
2101
2102                                         <dt>
2103                                                 <span class="fixedFont">object</span>  <b>config</b>
2104
2105                                         </dt>
2106                                         <dd>configuration attributes</dd>
2107
2108                                 </dl>
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120                     </div>
2121                 </div>
2122
2123             </td>
2124             <td class="msource">
2125
2126                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2127                 &nbsp;
2128             </td>
2129         </tr>
2130
2131
2132           <tr class="method-row config-row-alt1 expandable">
2133             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2134
2135
2136             <td class="sig">
2137                 <a id="Roo.dd.DragDrop-method-isLocked"   name=".isLocked"></a>
2138                 <div class="fixedFont">
2139                         <span class="attributes"></span><b class="itemname">isLocked</b>
2140
2141                                  ()
2142
2143
2144                                          :
2145
2146
2147                                                 boolean
2148
2149
2150
2151
2152
2153                 </div>
2154                 <div class="mdesc">
2155
2156                    <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>
2157
2158
2159
2160                     <div class="long">
2161
2162                                 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.)
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173                                 <dl class="detailList">
2174                                 <dt class="heading">Returns:</dt>
2175
2176                                         <dd><span class="fixedFont">boolean</span>  true if this obj or all drag/drop is locked, else<br/>false</dd>
2177
2178                                 </dl>
2179
2180
2181
2182
2183
2184
2185
2186                     </div>
2187                 </div>
2188
2189             </td>
2190             <td class="msource">
2191
2192                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2193                 &nbsp;
2194             </td>
2195         </tr>
2196
2197
2198           <tr class="method-row config-row-alt0 expandable">
2199             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2200
2201
2202             <td class="sig">
2203                 <a id="Roo.dd.DragDrop-method-isTarget"   name=".isTarget"></a>
2204                 <div class="fixedFont">
2205                         <span class="attributes"></span><b class="itemname">isTarget</b>
2206
2207                                  ()
2208
2209
2210
2211                 </div>
2212                 <div class="mdesc">
2213
2214                    <div class="short">By default, all insances can be a drop target.</div>
2215
2216
2217
2218                     <div class="long">
2219
2220                                 By default, all insances can be a drop target.  This can be disabled by<br/>setting isTarget to false.
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237                     </div>
2238                 </div>
2239
2240             </td>
2241             <td class="msource">
2242
2243                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2244                 &nbsp;
2245             </td>
2246         </tr>
2247
2248
2249           <tr class="method-row config-row-alt1 expandable">
2250             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2251
2252
2253             <td class="sig">
2254                 <a id="Roo.dd.DragDrop-method-isValidHandleChild"   name=".isValidHandleChild"></a>
2255                 <div class="fixedFont">
2256                         <span class="attributes"></span><b class="itemname">isValidHandleChild</b>
2257
2258                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>node</i></B>)
2259
2260
2261                                          :
2262
2263
2264                                                 boolean
2265
2266
2267
2268
2269
2270                 </div>
2271                 <div class="mdesc">
2272
2273                    <div class="short">Checks the tag exclusion list to see if this click should be ignored</div>
2274
2275
2276
2277                     <div class="long">
2278
2279                                 Checks the tag exclusion list to see if this click should be ignored
2280
2281
2282
2283
2284
2285
2286                                 <dl class="detailList">
2287                                 <dt class="heading">Parameters:</dt>
2288
2289                                         <dt>
2290                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>node</b>
2291
2292                                         </dt>
2293                                         <dd>the HTMLElement to evaluate</dd>
2294
2295                                 </dl>
2296
2297
2298
2299
2300
2301                                 <dl class="detailList">
2302                                 <dt class="heading">Returns:</dt>
2303
2304                                         <dd><span class="fixedFont">boolean</span>  true if this is a valid tag type, false if not</dd>
2305
2306                                 </dl>
2307
2308
2309
2310
2311
2312
2313
2314                     </div>
2315                 </div>
2316
2317             </td>
2318             <td class="msource">
2319
2320                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2321                 &nbsp;
2322             </td>
2323         </tr>
2324
2325
2326           <tr class="method-row config-row-alt0 expandable">
2327             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2328
2329
2330             <td class="sig">
2331                 <a id="Roo.dd.DragDrop-method-lock"   name=".lock"></a>
2332                 <div class="fixedFont">
2333                         <span class="attributes"></span><b class="itemname">lock</b>
2334
2335                                  ()
2336
2337
2338
2339                 </div>
2340                 <div class="mdesc">
2341
2342                    <div class="short">Lock this instance</div>
2343
2344
2345
2346                     <div class="long">
2347
2348                                 Lock this instance
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365                     </div>
2366                 </div>
2367
2368             </td>
2369             <td class="msource">
2370
2371                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2372                 &nbsp;
2373             </td>
2374         </tr>
2375
2376
2377           <tr class="method-row config-row-alt1 expandable">
2378             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2379
2380
2381             <td class="sig">
2382                 <a id="Roo.dd.DragDrop-method-onAvailable"   name=".onAvailable"></a>
2383                 <div class="fixedFont">
2384                         <span class="attributes"></span><b class="itemname">onAvailable</b>
2385
2386                                  ()
2387
2388
2389
2390                 </div>
2391                 <div class="mdesc">
2392
2393                    <div class="short">Override the onAvailable method to do what is needed after the initial<br/>position was determined.</div>
2394
2395
2396
2397                     <div class="long">
2398
2399                                 Override the onAvailable method to do what is needed after the initial<br/>position was determined.
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
2412
2413
2414
2415
2416                     </div>
2417                 </div>
2418
2419             </td>
2420             <td class="msource">
2421
2422                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2423                 &nbsp;
2424             </td>
2425         </tr>
2426
2427
2428           <tr class="method-row config-row-alt0 expandable notInherited">
2429             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2430
2431
2432             <td class="sig">
2433                 <a id="Roo.dd.DragSource-method-onBeforeDrag"   name=".onBeforeDrag"></a>
2434                 <div class="fixedFont">
2435                         <span class="attributes"></span><b class="itemname">onBeforeDrag</b>
2436
2437                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>, Event <B><i>e</i></B>)
2438
2439
2440                                          :
2441
2442
2443                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
2444
2445
2446
2447
2448
2449                 </div>
2450                 <div class="mdesc">
2451
2452                    <div class="short">An empty function by default, but provided so that you can perform a custom action before the initial<br/>drag event begins and optionally cancel it.</div>
2453
2454
2455
2456                     <div class="long">
2457
2458                                 An empty function by default, but provided so that you can perform a custom action before the initial<br/>drag event begins and optionally cancel it.
2459
2460
2461
2462
2463
2464
2465                                 <dl class="detailList">
2466                                 <dt class="heading">Parameters:</dt>
2467
2468                                         <dt>
2469                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>data</b>
2470
2471                                         </dt>
2472                                         <dd>An object containing arbitrary data to be shared with drop targets</dd>
2473
2474                                         <dt>
2475                                                 <span class="fixedFont">Event</span>  <b>e</b>
2476
2477                                         </dt>
2478                                         <dd>The event object</dd>
2479
2480                                 </dl>
2481
2482
2483
2484
2485
2486                                 <dl class="detailList">
2487                                 <dt class="heading">Returns:</dt>
2488
2489                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  isValid True if the drag event is valid, else false to cancel</dd>
2490
2491                                 </dl>
2492
2493
2494
2495
2496
2497
2498
2499                     </div>
2500                 </div>
2501
2502             </td>
2503             <td class="msource">
2504
2505                         Roo.dd.DragSource
2506                 &nbsp;
2507             </td>
2508         </tr>
2509
2510
2511           <tr class="method-row config-row-alt1 expandable">
2512             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2513
2514
2515             <td class="sig">
2516                 <a id="Roo.dd.DragDrop-method-onDrag"   name=".onDrag"></a>
2517                 <div class="fixedFont">
2518                         <span class="attributes"></span><b class="itemname">onDrag</b>
2519
2520                                  (Event <B><i>e</i></B>)
2521
2522
2523
2524                 </div>
2525                 <div class="mdesc">
2526
2527                    <div class="short">Abstract method called during the onMouseMove event while dragging an<br/>object.</div>
2528
2529
2530
2531                     <div class="long">
2532
2533                                 Abstract method called during the onMouseMove event while dragging an<br/>object.
2534
2535
2536
2537
2538
2539
2540                                 <dl class="detailList">
2541                                 <dt class="heading">Parameters:</dt>
2542
2543                                         <dt>
2544                                                 <span class="fixedFont">Event</span>  <b>e</b>
2545
2546                                         </dt>
2547                                         <dd>the mousemove event</dd>
2548
2549                                 </dl>
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561                     </div>
2562                 </div>
2563
2564             </td>
2565             <td class="msource">
2566
2567                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2568                 &nbsp;
2569             </td>
2570         </tr>
2571
2572
2573           <tr class="method-row config-row-alt0 expandable">
2574             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2575
2576
2577             <td class="sig">
2578                 <a id="Roo.dd.DragDrop-method-onDragDrop"   name=".onDragDrop"></a>
2579                 <div class="fixedFont">
2580                         <span class="attributes"></span><b class="itemname">onDragDrop</b>
2581
2582                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2583
2584
2585
2586                 </div>
2587                 <div class="mdesc">
2588
2589                    <div class="short">Abstract method called when this item is dropped on another DragDrop<br/>obj</div>
2590
2591
2592
2593                     <div class="long">
2594
2595                                 Abstract method called when this item is dropped on another DragDrop<br/>obj
2596
2597
2598
2599
2600
2601
2602                                 <dl class="detailList">
2603                                 <dt class="heading">Parameters:</dt>
2604
2605                                         <dt>
2606                                                 <span class="fixedFont">Event</span>  <b>e</b>
2607
2608                                         </dt>
2609                                         <dd>the mouseup event</dd>
2610
2611                                         <dt>
2612                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2613
2614                                         </dt>
2615                                         <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>
2616
2617                                 </dl>
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629                     </div>
2630                 </div>
2631
2632             </td>
2633             <td class="msource">
2634
2635                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2636                 &nbsp;
2637             </td>
2638         </tr>
2639
2640
2641           <tr class="method-row config-row-alt1 expandable">
2642             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2643
2644
2645             <td class="sig">
2646                 <a id="Roo.dd.DragDrop-method-onDragEnter"   name=".onDragEnter"></a>
2647                 <div class="fixedFont">
2648                         <span class="attributes"></span><b class="itemname">onDragEnter</b>
2649
2650                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2651
2652
2653
2654                 </div>
2655                 <div class="mdesc">
2656
2657                    <div class="short">Abstract method called when this element fist begins hovering over<br/>another DragDrop obj</div>
2658
2659
2660
2661                     <div class="long">
2662
2663                                 Abstract method called when this element fist begins hovering over<br/>another DragDrop obj
2664
2665
2666
2667
2668
2669
2670                                 <dl class="detailList">
2671                                 <dt class="heading">Parameters:</dt>
2672
2673                                         <dt>
2674                                                 <span class="fixedFont">Event</span>  <b>e</b>
2675
2676                                         </dt>
2677                                         <dd>the mousemove event</dd>
2678
2679                                         <dt>
2680                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2681
2682                                         </dt>
2683                                         <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>
2684
2685                                 </dl>
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697                     </div>
2698                 </div>
2699
2700             </td>
2701             <td class="msource">
2702
2703                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2704                 &nbsp;
2705             </td>
2706         </tr>
2707
2708
2709           <tr class="method-row config-row-alt0 expandable">
2710             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2711
2712
2713             <td class="sig">
2714                 <a id="Roo.dd.DragDrop-method-onDragOut"   name=".onDragOut"></a>
2715                 <div class="fixedFont">
2716                         <span class="attributes"></span><b class="itemname">onDragOut</b>
2717
2718                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2719
2720
2721
2722                 </div>
2723                 <div class="mdesc">
2724
2725                    <div class="short">Abstract method called when we are no longer hovering over an element</div>
2726
2727
2728
2729                     <div class="long">
2730
2731                                 Abstract method called when we are no longer hovering over an element
2732
2733
2734
2735
2736
2737
2738                                 <dl class="detailList">
2739                                 <dt class="heading">Parameters:</dt>
2740
2741                                         <dt>
2742                                                 <span class="fixedFont">Event</span>  <b>e</b>
2743
2744                                         </dt>
2745                                         <dd>the mousemove event</dd>
2746
2747                                         <dt>
2748                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2749
2750                                         </dt>
2751                                         <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>
2752
2753                                 </dl>
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765                     </div>
2766                 </div>
2767
2768             </td>
2769             <td class="msource">
2770
2771                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2772                 &nbsp;
2773             </td>
2774         </tr>
2775
2776
2777           <tr class="method-row config-row-alt1 expandable">
2778             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2779
2780
2781             <td class="sig">
2782                 <a id="Roo.dd.DragDrop-method-onDragOver"   name=".onDragOver"></a>
2783                 <div class="fixedFont">
2784                         <span class="attributes"></span><b class="itemname">onDragOver</b>
2785
2786                                  (Event <B><i>e</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[] <B><i>id</i></B>)
2787
2788
2789
2790                 </div>
2791                 <div class="mdesc">
2792
2793                    <div class="short">Abstract method called when this element is hovering over another<br/>DragDrop obj</div>
2794
2795
2796
2797                     <div class="long">
2798
2799                                 Abstract method called when this element is hovering over another<br/>DragDrop obj
2800
2801
2802
2803
2804
2805
2806                                 <dl class="detailList">
2807                                 <dt class="heading">Parameters:</dt>
2808
2809                                         <dt>
2810                                                 <span class="fixedFont">Event</span>  <b>e</b>
2811
2812                                         </dt>
2813                                         <dd>the mousemove event</dd>
2814
2815                                         <dt>
2816                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|DragDrop[]</span>  <b>id</b>
2817
2818                                         </dt>
2819                                         <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>
2820
2821                                 </dl>
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833                     </div>
2834                 </div>
2835
2836             </td>
2837             <td class="msource">
2838
2839                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2840                 &nbsp;
2841             </td>
2842         </tr>
2843
2844
2845           <tr class="method-row config-row-alt0 expandable">
2846             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2847
2848
2849             <td class="sig">
2850                 <a id="Roo.dd.DragDrop-method-onInvalidDrop"   name=".onInvalidDrop"></a>
2851                 <div class="fixedFont">
2852                         <span class="attributes"></span><b class="itemname">onInvalidDrop</b>
2853
2854                                  (Event <B><i>e</i></B>)
2855
2856
2857
2858                 </div>
2859                 <div class="mdesc">
2860
2861                    <div class="short">Abstract method called when this item is dropped on an area with no<br/>drop target</div>
2862
2863
2864
2865                     <div class="long">
2866
2867                                 Abstract method called when this item is dropped on an area with no<br/>drop target
2868
2869
2870
2871
2872
2873
2874                                 <dl class="detailList">
2875                                 <dt class="heading">Parameters:</dt>
2876
2877                                         <dt>
2878                                                 <span class="fixedFont">Event</span>  <b>e</b>
2879
2880                                         </dt>
2881                                         <dd>the mouseup event</dd>
2882
2883                                 </dl>
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895                     </div>
2896                 </div>
2897
2898             </td>
2899             <td class="msource">
2900
2901                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2902                 &nbsp;
2903             </td>
2904         </tr>
2905
2906
2907           <tr class="method-row config-row-alt1 expandable">
2908             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2909
2910
2911             <td class="sig">
2912                 <a id="Roo.dd.DragDrop-method-onMouseDown"   name=".onMouseDown"></a>
2913                 <div class="fixedFont">
2914                         <span class="attributes"></span><b class="itemname">onMouseDown</b>
2915
2916                                  (Event <B><i>e</i></B>)
2917
2918
2919
2920                 </div>
2921                 <div class="mdesc">
2922
2923                    <div class="short">Event handler that fires when a drag/drop obj gets a mousedown</div>
2924
2925
2926
2927                     <div class="long">
2928
2929                                 Event handler that fires when a drag/drop obj gets a mousedown
2930
2931
2932
2933
2934
2935
2936                                 <dl class="detailList">
2937                                 <dt class="heading">Parameters:</dt>
2938
2939                                         <dt>
2940                                                 <span class="fixedFont">Event</span>  <b>e</b>
2941
2942                                         </dt>
2943                                         <dd>the mousedown event</dd>
2944
2945                                 </dl>
2946
2947
2948
2949
2950
2951
2952
2953
2954
2955
2956
2957                     </div>
2958                 </div>
2959
2960             </td>
2961             <td class="msource">
2962
2963                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
2964                 &nbsp;
2965             </td>
2966         </tr>
2967
2968
2969           <tr class="method-row config-row-alt0 expandable">
2970             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2971
2972
2973             <td class="sig">
2974                 <a id="Roo.dd.DragDrop-method-onMouseUp"   name=".onMouseUp"></a>
2975                 <div class="fixedFont">
2976                         <span class="attributes"></span><b class="itemname">onMouseUp</b>
2977
2978                                  (Event <B><i>e</i></B>)
2979
2980
2981
2982                 </div>
2983                 <div class="mdesc">
2984
2985                    <div class="short">Event handler that fires when a drag/drop obj gets a mouseup</div>
2986
2987
2988
2989                     <div class="long">
2990
2991                                 Event handler that fires when a drag/drop obj gets a mouseup
2992
2993
2994
2995
2996
2997
2998                                 <dl class="detailList">
2999                                 <dt class="heading">Parameters:</dt>
3000
3001                                         <dt>
3002                                                 <span class="fixedFont">Event</span>  <b>e</b>
3003
3004                                         </dt>
3005                                         <dd>the mouseup event</dd>
3006
3007                                 </dl>
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019                     </div>
3020                 </div>
3021
3022             </td>
3023             <td class="msource">
3024
3025                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3026                 &nbsp;
3027             </td>
3028         </tr>
3029
3030
3031           <tr class="method-row config-row-alt1 expandable notInherited">
3032             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3033
3034
3035             <td class="sig">
3036                 <a id="Roo.dd.DragSource-method-onStartDrag"   name=".onStartDrag"></a>
3037                 <div class="fixedFont">
3038                         <span class="attributes"></span><b class="itemname">onStartDrag</b>
3039
3040                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>x</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>y</i></B>)
3041
3042
3043
3044                 </div>
3045                 <div class="mdesc">
3046
3047                    <div class="short">An empty function by default, but provided so that you can perform a custom action once the initial<br/>drag event has begun.</div>
3048
3049
3050
3051                     <div class="long">
3052
3053                                 An empty function by default, but provided so that you can perform a custom action once the initial<br/>drag event has begun.  The drag cannot be canceled from this function.
3054
3055
3056
3057
3058
3059
3060                                 <dl class="detailList">
3061                                 <dt class="heading">Parameters:</dt>
3062
3063                                         <dt>
3064                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>x</b>
3065
3066                                         </dt>
3067                                         <dd>The x position of the click on the dragged object</dd>
3068
3069                                         <dt>
3070                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>y</b>
3071
3072                                         </dt>
3073                                         <dd>The y position of the click on the dragged object</dd>
3074
3075                                 </dl>
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087                     </div>
3088                 </div>
3089
3090             </td>
3091             <td class="msource">
3092
3093                         Roo.dd.DragSource
3094                 &nbsp;
3095             </td>
3096         </tr>
3097
3098
3099           <tr class="method-row config-row-alt0 expandable">
3100             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3101
3102
3103             <td class="sig">
3104                 <a id="Roo.dd.DragDrop-method-padding"   name=".padding"></a>
3105                 <div class="fixedFont">
3106                         <span class="attributes"></span><b class="itemname">padding</b>
3107
3108                                  ()
3109
3110
3111
3112                 </div>
3113                 <div class="mdesc">
3114
3115                    <div class="short">The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.</div>
3116
3117
3118
3119                     <div class="long">
3120
3121                                 The padding configured for this drag and drop object for calculating<br/>the drop zone intersection with this object.
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138                     </div>
3139                 </div>
3140
3141             </td>
3142             <td class="msource">
3143
3144                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3145                 &nbsp;
3146             </td>
3147         </tr>
3148
3149
3150           <tr class="method-row config-row-alt1 expandable">
3151             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3152
3153
3154             <td class="sig">
3155                 <a id="Roo.dd.DragDrop-method-removeFromGroup"   name=".removeFromGroup"></a>
3156                 <div class="fixedFont">
3157                         <span class="attributes"></span><b class="itemname">removeFromGroup</b>
3158
3159                                  (string <B><i>sGroup</i></B>)
3160
3161
3162
3163                 </div>
3164                 <div class="mdesc">
3165
3166                    <div class="short">Remove's this instance from the supplied interaction group</div>
3167
3168
3169
3170                     <div class="long">
3171
3172                                 Remove's this instance from the supplied interaction group
3173
3174
3175
3176
3177
3178
3179                                 <dl class="detailList">
3180                                 <dt class="heading">Parameters:</dt>
3181
3182                                         <dt>
3183                                                 <span class="fixedFont">string</span>  <b>sGroup</b>
3184
3185                                         </dt>
3186                                         <dd>The group to drop</dd>
3187
3188                                 </dl>
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200                     </div>
3201                 </div>
3202
3203             </td>
3204             <td class="msource">
3205
3206                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3207                 &nbsp;
3208             </td>
3209         </tr>
3210
3211
3212           <tr class="method-row config-row-alt0 expandable">
3213             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3214
3215
3216             <td class="sig">
3217                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleClass"   name=".removeInvalidHandleClass"></a>
3218                 <div class="fixedFont">
3219                         <span class="attributes"></span><b class="itemname">removeInvalidHandleClass</b>
3220
3221                                  (string <B><i>cssClass</i></B>)
3222
3223
3224
3225                 </div>
3226                 <div class="mdesc">
3227
3228                    <div class="short">Unsets an invalid css class</div>
3229
3230
3231
3232                     <div class="long">
3233
3234                                 Unsets an invalid css class
3235
3236
3237
3238
3239
3240
3241                                 <dl class="detailList">
3242                                 <dt class="heading">Parameters:</dt>
3243
3244                                         <dt>
3245                                                 <span class="fixedFont">string</span>  <b>cssClass</b>
3246
3247                                         </dt>
3248                                         <dd>the class of the element(s) you wish to<br/>re-enable</dd>
3249
3250                                 </dl>
3251
3252
3253
3254
3255
3256
3257
3258
3259
3260
3261
3262                     </div>
3263                 </div>
3264
3265             </td>
3266             <td class="msource">
3267
3268                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3269                 &nbsp;
3270             </td>
3271         </tr>
3272
3273
3274           <tr class="method-row config-row-alt1 expandable">
3275             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3276
3277
3278             <td class="sig">
3279                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleId"   name=".removeInvalidHandleId"></a>
3280                 <div class="fixedFont">
3281                         <span class="attributes"></span><b class="itemname">removeInvalidHandleId</b>
3282
3283                                  (string <B><i>id</i></B>)
3284
3285
3286
3287                 </div>
3288                 <div class="mdesc">
3289
3290                    <div class="short">Unsets an invalid handle id</div>
3291
3292
3293
3294                     <div class="long">
3295
3296                                 Unsets an invalid handle id
3297
3298
3299
3300
3301
3302
3303                                 <dl class="detailList">
3304                                 <dt class="heading">Parameters:</dt>
3305
3306                                         <dt>
3307                                                 <span class="fixedFont">string</span>  <b>id</b>
3308
3309                                         </dt>
3310                                         <dd>the id of the element to re-enable</dd>
3311
3312                                 </dl>
3313
3314
3315
3316
3317
3318
3319
3320
3321
3322
3323
3324                     </div>
3325                 </div>
3326
3327             </td>
3328             <td class="msource">
3329
3330                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3331                 &nbsp;
3332             </td>
3333         </tr>
3334
3335
3336           <tr class="method-row config-row-alt0 expandable">
3337             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3338
3339
3340             <td class="sig">
3341                 <a id="Roo.dd.DragDrop-method-removeInvalidHandleType"   name=".removeInvalidHandleType"></a>
3342                 <div class="fixedFont">
3343                         <span class="attributes"></span><b class="itemname">removeInvalidHandleType</b>
3344
3345                                  (string <B><i>tagName</i></B>)
3346
3347
3348
3349                 </div>
3350                 <div class="mdesc">
3351
3352                    <div class="short">Unsets an excluded tag name set by addInvalidHandleType</div>
3353
3354
3355
3356                     <div class="long">
3357
3358                                 Unsets an excluded tag name set by addInvalidHandleType
3359
3360
3361
3362
3363
3364
3365                                 <dl class="detailList">
3366                                 <dt class="heading">Parameters:</dt>
3367
3368                                         <dt>
3369                                                 <span class="fixedFont">string</span>  <b>tagName</b>
3370
3371                                         </dt>
3372                                         <dd>the type of element to unexclude</dd>
3373
3374                                 </dl>
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386                     </div>
3387                 </div>
3388
3389             </td>
3390             <td class="msource">
3391
3392                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3393                 &nbsp;
3394             </td>
3395         </tr>
3396
3397
3398           <tr class="method-row config-row-alt1 expandable">
3399             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3400
3401
3402             <td class="sig">
3403                 <a id="Roo.dd.DragDrop-method-resetConstraints"   name=".resetConstraints"></a>
3404                 <div class="fixedFont">
3405                         <span class="attributes"></span><b class="itemname">resetConstraints</b>
3406
3407                                  (boolean <B><i>maintainOffset</i></B>)
3408
3409
3410
3411                 </div>
3412                 <div class="mdesc">
3413
3414                    <div class="short">resetConstraints must be called if you manually reposition a dd element.</div>
3415
3416
3417
3418                     <div class="long">
3419
3420                                 resetConstraints must be called if you manually reposition a dd element.
3421
3422
3423
3424
3425
3426
3427                                 <dl class="detailList">
3428                                 <dt class="heading">Parameters:</dt>
3429
3430                                         <dt>
3431                                                 <span class="fixedFont">boolean</span>  <b>maintainOffset</b>
3432
3433                                         </dt>
3434                                         <dd></dd>
3435
3436                                 </dl>
3437
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448                     </div>
3449                 </div>
3450
3451             </td>
3452             <td class="msource">
3453
3454                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3455                 &nbsp;
3456             </td>
3457         </tr>
3458
3459
3460           <tr class="method-row config-row-alt0 expandable">
3461             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3462
3463
3464             <td class="sig">
3465                 <a id="Roo.dd.DD-method-setDelta"   name=".setDelta"></a>
3466                 <div class="fixedFont">
3467                         <span class="attributes"></span><b class="itemname">setDelta</b>
3468
3469                                  (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
3470
3471
3472
3473                 </div>
3474                 <div class="mdesc">
3475
3476                    <div class="short">Sets the pointer offset.</div>
3477
3478
3479
3480                     <div class="long">
3481
3482                                 Sets the pointer offset.  You can call this directly to force the<br/>offset to be in a particular location (e.g., pass in 0,0 to set it<br/>to the center of the object)
3483
3484
3485
3486
3487
3488
3489                                 <dl class="detailList">
3490                                 <dt class="heading">Parameters:</dt>
3491
3492                                         <dt>
3493                                                 <span class="fixedFont">int</span>  <b>iDeltaX</b>
3494
3495                                         </dt>
3496                                         <dd>the distance from the left</dd>
3497
3498                                         <dt>
3499                                                 <span class="fixedFont">int</span>  <b>iDeltaY</b>
3500
3501                                         </dt>
3502                                         <dd>the distance from the top</dd>
3503
3504                                 </dl>
3505
3506
3507
3508
3509
3510
3511
3512
3513
3514
3515
3516                     </div>
3517                 </div>
3518
3519             </td>
3520             <td class="msource">
3521
3522                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3523                 &nbsp;
3524             </td>
3525         </tr>
3526
3527
3528           <tr class="method-row config-row-alt1 expandable">
3529             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3530
3531
3532             <td class="sig">
3533                 <a id="Roo.dd.DragDrop-method-setDragElId"   name=".setDragElId"></a>
3534                 <div class="fixedFont">
3535                         <span class="attributes"></span><b class="itemname">setDragElId</b>
3536
3537                                  (<B><i>id</i></B>)
3538
3539
3540
3541                 </div>
3542                 <div class="mdesc">
3543
3544                    <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>
3545
3546
3547
3548                     <div class="long">
3549
3550                                 Allows you to specify that an element other than the linked element<br/>will be moved with the cursor during a drag
3551
3552
3553
3554
3555
3556
3557                                 <dl class="detailList">
3558                                 <dt class="heading">Parameters:</dt>
3559
3560                                         <dt>
3561                                                  <b>id</b>
3562
3563                                         </dt>
3564                                         <dd>{string} the id of the element that will be used to initiate the drag</dd>
3565
3566                                 </dl>
3567
3568
3569
3570
3571
3572
3573
3574
3575
3576
3577
3578                     </div>
3579                 </div>
3580
3581             </td>
3582             <td class="msource">
3583
3584                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3585                 &nbsp;
3586             </td>
3587         </tr>
3588
3589
3590           <tr class="method-row config-row-alt0 expandable">
3591             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3592
3593
3594             <td class="sig">
3595                 <a id="Roo.dd.DD-method-setDragElPos"   name=".setDragElPos"></a>
3596                 <div class="fixedFont">
3597                         <span class="attributes"></span><b class="itemname">setDragElPos</b>
3598
3599                                  (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
3600
3601
3602
3603                 </div>
3604                 <div class="mdesc">
3605
3606                    <div class="short">Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
3607
3608
3609
3610                     <div class="long">
3611
3612                                 Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.  Override this if you want to place the element in a<br/>location other than where the cursor is.
3613
3614
3615
3616
3617
3618
3619                                 <dl class="detailList">
3620                                 <dt class="heading">Parameters:</dt>
3621
3622                                         <dt>
3623                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
3624
3625                                         </dt>
3626                                         <dd>the X coordinate of the mousedown or drag event</dd>
3627
3628                                         <dt>
3629                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
3630
3631                                         </dt>
3632                                         <dd>the Y coordinate of the mousedown or drag event</dd>
3633
3634                                 </dl>
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646                     </div>
3647                 </div>
3648
3649             </td>
3650             <td class="msource">
3651
3652                         <a href="./Roo.dd.DD.html#constructor" roo:cls="Roo.dd.DD.html#constructor">Roo.dd.DD</a>
3653                 &nbsp;
3654             </td>
3655         </tr>
3656
3657
3658           <tr class="method-row config-row-alt1 expandable">
3659             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3660
3661
3662             <td class="sig">
3663                 <a id="Roo.dd.DragDrop-method-setHandleElId"   name=".setHandleElId"></a>
3664                 <div class="fixedFont">
3665                         <span class="attributes"></span><b class="itemname">setHandleElId</b>
3666
3667                                  (<B><i>id</i></B>)
3668
3669
3670
3671                 </div>
3672                 <div class="mdesc">
3673
3674                    <div class="short">Allows you to specify a child of the linked element that should be<br/>used to initiate the drag operation.</div>
3675
3676
3677
3678                     <div class="long">
3679
3680                                 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.
3681
3682
3683
3684
3685
3686
3687                                 <dl class="detailList">
3688                                 <dt class="heading">Parameters:</dt>
3689
3690                                         <dt>
3691                                                  <b>id</b>
3692
3693                                         </dt>
3694                                         <dd>{string} the id of the element that will be used to<br/>initiate the drag.</dd>
3695
3696                                 </dl>
3697
3698
3699
3700
3701
3702
3703
3704
3705
3706
3707
3708                     </div>
3709                 </div>
3710
3711             </td>
3712             <td class="msource">
3713
3714                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3715                 &nbsp;
3716             </td>
3717         </tr>
3718
3719
3720           <tr class="method-row config-row-alt0 expandable">
3721             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3722
3723
3724             <td class="sig">
3725                 <a id="Roo.dd.DragDrop-method-setInitPosition"   name=".setInitPosition"></a>
3726                 <div class="fixedFont">
3727                         <span class="attributes"></span><b class="itemname">setInitPosition</b>
3728
3729                                  (int <B><i>diffX</i></B>, int <B><i>diffY</i></B>)
3730
3731
3732
3733                 </div>
3734                 <div class="mdesc">
3735
3736                    <div class="short">Stores the initial placement of the linked element.</div>
3737
3738
3739
3740                     <div class="long">
3741
3742                                 Stores the initial placement of the linked element.
3743
3744
3745
3746
3747
3748
3749                                 <dl class="detailList">
3750                                 <dt class="heading">Parameters:</dt>
3751
3752                                         <dt>
3753                                                 <span class="fixedFont">int</span>  <b>diffX</b>
3754
3755                                         </dt>
3756                                         <dd>the X offset, default 0</dd>
3757
3758                                         <dt>
3759                                                 <span class="fixedFont">int</span>  <b>diffY</b>
3760
3761                                         </dt>
3762                                         <dd>the Y offset, default 0</dd>
3763
3764                                 </dl>
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776                     </div>
3777                 </div>
3778
3779             </td>
3780             <td class="msource">
3781
3782                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3783                 &nbsp;
3784             </td>
3785         </tr>
3786
3787
3788           <tr class="method-row config-row-alt1 expandable">
3789             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3790
3791
3792             <td class="sig">
3793                 <a id="Roo.dd.DragDrop-method-setOuterHandleElId"   name=".setOuterHandleElId"></a>
3794                 <div class="fixedFont">
3795                         <span class="attributes"></span><b class="itemname">setOuterHandleElId</b>
3796
3797                                  (<B><i>id</i></B>)
3798
3799
3800
3801                 </div>
3802                 <div class="mdesc">
3803
3804                    <div class="short">Allows you to set an element outside of the linked element as a drag<br/>handle</div>
3805
3806
3807
3808                     <div class="long">
3809
3810                                 Allows you to set an element outside of the linked element as a drag<br/>handle
3811
3812
3813
3814
3815
3816
3817                                 <dl class="detailList">
3818                                 <dt class="heading">Parameters:</dt>
3819
3820                                         <dt>
3821                                                  <b>id</b>
3822
3823                                         </dt>
3824                                         <dd>the id of the element that will be used to initiate the drag</dd>
3825
3826                                 </dl>
3827
3828
3829
3830
3831
3832
3833
3834
3835
3836
3837
3838                     </div>
3839                 </div>
3840
3841             </td>
3842             <td class="msource">
3843
3844                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3845                 &nbsp;
3846             </td>
3847         </tr>
3848
3849
3850           <tr class="method-row config-row-alt0 expandable">
3851             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3852
3853
3854             <td class="sig">
3855                 <a id="Roo.dd.DragDrop-method-setPadding"   name=".setPadding"></a>
3856                 <div class="fixedFont">
3857                         <span class="attributes"></span><b class="itemname">setPadding</b>
3858
3859                                  (int <B><i>iTop</i></B>, int <B><i>iRight</i></B>, int <B><i>iBot</i></B>, int <B><i>iLeft</i></B>)
3860
3861
3862
3863                 </div>
3864                 <div class="mdesc">
3865
3866                    <div class="short">Configures the padding for the target zone in px.</div>
3867
3868
3869
3870                     <div class="long">
3871
3872                                 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.
3873
3874
3875
3876
3877
3878
3879                                 <dl class="detailList">
3880                                 <dt class="heading">Parameters:</dt>
3881
3882                                         <dt>
3883                                                 <span class="fixedFont">int</span>  <b>iTop</b>
3884
3885                                         </dt>
3886                                         <dd>Top pad</dd>
3887
3888                                         <dt>
3889                                                 <span class="fixedFont">int</span>  <b>iRight</b>
3890
3891                                         </dt>
3892                                         <dd>Right pad</dd>
3893
3894                                         <dt>
3895                                                 <span class="fixedFont">int</span>  <b>iBot</b>
3896
3897                                         </dt>
3898                                         <dd>Bot pad</dd>
3899
3900                                         <dt>
3901                                                 <span class="fixedFont">int</span>  <b>iLeft</b>
3902
3903                                         </dt>
3904                                         <dd>Left pad</dd>
3905
3906                                 </dl>
3907
3908
3909
3910
3911
3912
3913
3914
3915
3916
3917
3918                     </div>
3919                 </div>
3920
3921             </td>
3922             <td class="msource">
3923
3924                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3925                 &nbsp;
3926             </td>
3927         </tr>
3928
3929
3930           <tr class="method-row config-row-alt1 expandable">
3931             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
3932
3933
3934             <td class="sig">
3935                 <a id="Roo.dd.DragDrop-method-setXConstraint"   name=".setXConstraint"></a>
3936                 <div class="fixedFont">
3937                         <span class="attributes"></span><b class="itemname">setXConstraint</b>
3938
3939                                  (int <B><i>iLeft</i></B>, int <B><i>iRight</i></B>, int <B><i>iTickSize</i></B>)
3940
3941
3942
3943                 </div>
3944                 <div class="mdesc">
3945
3946                    <div class="short">By default, the element can be dragged any place on the screen.</div>
3947
3948
3949
3950                     <div class="long">
3951
3952                                 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.
3953
3954
3955
3956
3957
3958
3959                                 <dl class="detailList">
3960                                 <dt class="heading">Parameters:</dt>
3961
3962                                         <dt>
3963                                                 <span class="fixedFont">int</span>  <b>iLeft</b>
3964
3965                                         </dt>
3966                                         <dd>the number of pixels the element can move to the left</dd>
3967
3968                                         <dt>
3969                                                 <span class="fixedFont">int</span>  <b>iRight</b>
3970
3971                                         </dt>
3972                                         <dd>the number of pixels the element can move to the<br/>right</dd>
3973
3974                                         <dt>
3975                                                 <span class="fixedFont">int</span>  <b>iTickSize</b>
3976
3977                                         </dt>
3978                                         <dd>optional parameter for specifying that the<br/>element<br/>should move iTickSize pixels at a time.</dd>
3979
3980                                 </dl>
3981
3982
3983
3984
3985
3986
3987
3988
3989
3990
3991
3992                     </div>
3993                 </div>
3994
3995             </td>
3996             <td class="msource">
3997
3998                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
3999                 &nbsp;
4000             </td>
4001         </tr>
4002
4003
4004           <tr class="method-row config-row-alt0 expandable">
4005             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
4006
4007
4008             <td class="sig">
4009                 <a id="Roo.dd.DragDrop-method-setYConstraint"   name=".setYConstraint"></a>
4010                 <div class="fixedFont">
4011                         <span class="attributes"></span><b class="itemname">setYConstraint</b>
4012
4013                                  (int <B><i>iUp</i></B>, int <B><i>iDown</i></B>, int <B><i>iTickSize</i></B>)
4014
4015
4016
4017                 </div>
4018                 <div class="mdesc">
4019
4020                    <div class="short">By default, the element can be dragged any place on the screen.</div>
4021
4022
4023
4024                     <div class="long">
4025
4026                                 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.
4027
4028
4029
4030
4031
4032
4033                                 <dl class="detailList">
4034                                 <dt class="heading">Parameters:</dt>
4035
4036                                         <dt>
4037                                                 <span class="fixedFont">int</span>  <b>iUp</b>
4038
4039                                         </dt>
4040                                         <dd>the number of pixels the element can move up</dd>
4041
4042                                         <dt>
4043                                                 <span class="fixedFont">int</span>  <b>iDown</b>
4044
4045                                         </dt>
4046                                         <dd>the number of pixels the element can move down</dd>
4047
4048                                         <dt>
4049                                                 <span class="fixedFont">int</span>  <b>iTickSize</b>
4050
4051                                         </dt>
4052                                         <dd>optional parameter for specifying that the<br/>element should move iTickSize pixels at a time.</dd>
4053
4054                                 </dl>
4055
4056
4057
4058
4059
4060
4061
4062
4063
4064
4065
4066                     </div>
4067                 </div>
4068
4069             </td>
4070             <td class="msource">
4071
4072                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4073                 &nbsp;
4074             </td>
4075         </tr>
4076
4077
4078           <tr class="method-row config-row-alt1 expandable">
4079             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
4080
4081
4082             <td class="sig">
4083                 <a id="Roo.dd.DragDrop-method-startDrag"   name=".startDrag"></a>
4084                 <div class="fixedFont">
4085                         <span class="attributes"></span><b class="itemname">startDrag</b>
4086
4087                                  (int <B><i>X</i></B>, int <B><i>Y</i></B>)
4088
4089
4090
4091                 </div>
4092                 <div class="mdesc">
4093
4094                    <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>
4095
4096
4097
4098                     <div class="long">
4099
4100                                 Abstract method called after a drag/drop object is clicked<br/>and the drag or mousedown time thresholds have beeen met.
4101
4102
4103
4104
4105
4106
4107                                 <dl class="detailList">
4108                                 <dt class="heading">Parameters:</dt>
4109
4110                                         <dt>
4111                                                 <span class="fixedFont">int</span>  <b>X</b>
4112
4113                                         </dt>
4114                                         <dd>click location</dd>
4115
4116                                         <dt>
4117                                                 <span class="fixedFont">int</span>  <b>Y</b>
4118
4119                                         </dt>
4120                                         <dd>click location</dd>
4121
4122                                 </dl>
4123
4124
4125
4126
4127
4128
4129
4130
4131
4132
4133
4134                     </div>
4135                 </div>
4136
4137             </td>
4138             <td class="msource">
4139
4140                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4141                 &nbsp;
4142             </td>
4143         </tr>
4144
4145
4146           <tr class="method-row config-row-alt0 expandable">
4147             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
4148
4149
4150             <td class="sig">
4151                 <a id="Roo.dd.DragDrop-method-unlock"   name=".unlock"></a>
4152                 <div class="fixedFont">
4153                         <span class="attributes"></span><b class="itemname">unlock</b>
4154
4155                                  ()
4156
4157
4158
4159                 </div>
4160                 <div class="mdesc">
4161
4162                    <div class="short">Unlock this instace</div>
4163
4164
4165
4166                     <div class="long">
4167
4168                                 Unlock this instace
4169
4170
4171
4172
4173
4174
4175
4176
4177
4178
4179
4180
4181
4182
4183
4184
4185                     </div>
4186                 </div>
4187
4188             </td>
4189             <td class="msource">
4190
4191                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4192                 &nbsp;
4193             </td>
4194         </tr>
4195
4196
4197           <tr class="method-row config-row-alt1 expandable">
4198             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
4199
4200
4201             <td class="sig">
4202                 <a id="Roo.dd.DragDrop-method-unreg"   name=".unreg"></a>
4203                 <div class="fixedFont">
4204                         <span class="attributes"></span><b class="itemname">unreg</b>
4205
4206                                  ()
4207
4208
4209
4210                 </div>
4211                 <div class="mdesc">
4212
4213                    <div class="short">Remove all drag and drop hooks for this element</div>
4214
4215
4216
4217                     <div class="long">
4218
4219                                 Remove all drag and drop hooks for this element
4220
4221
4222
4223
4224
4225
4226
4227
4228
4229
4230
4231
4232
4233
4234
4235
4236                     </div>
4237                 </div>
4238
4239             </td>
4240             <td class="msource">
4241
4242                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
4243                 &nbsp;
4244             </td>
4245         </tr>
4246
4247
4248     </table>
4249
4250
4251   <!-- ============================== events summary / details ======================== -->
4252
4253
4254   <a id="Roo.dd.DragSource-events"></a>
4255
4256
4257
4258
4259
4260      <table cellspacing="0" class="member-table">
4261       <caption class="Empty">Events - Has None</caption>
4262      </table>
4263
4264
4265
4266
4267
4268
4269
4270
4271
4272 <!-- ============================== footer ================================= -->
4273                 <div class="fineprint" style="clear:both">
4274
4275                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
4276                         Based on
4277                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
4278                 </div>
4279         </body>
4280 </html>