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.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragSource
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DragSource
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_dd_DragSource.js.html">Roo/dd/DragSource.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DragSource</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.dd.DDProxy.html#constructor" roo:cls="Roo.dd.DDProxy.html#constructor">Roo.dd.DDProxy</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A simple class that provides the basic implementation needed to make any element draggable.
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.DragSource';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.dd.DragSource.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.dd.DragSource-configs"></a>
 108
 109
 110
 111
 112
 113       <table cellspacing="0" class="member-table">
 114       <caption>Config Options (Usually are also Properties)</caption>
 115
 116
 117         <tr>
 118             <th class="sig-header" colspan="2">Options</th>
 119
 120             <th class="msource-header">Defined By</th>
 121         </tr>
 122
 123
 124
 125
 126
 127                 <tr class="config-row expandable config-row-alt0 notInherited">
 128                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 129                     <td class="sig">
 130
 131                         <a id="Roo.dd.DragSource-cfg-dropAllowed" name=".dropAllowed"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">dropAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">The CSS class returned to the drag source when drop is allowed (defaults to "x-dd-drop-ok").</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.dd.DragSource
 152
 153                     </td>
 154                 </tr>
 155
 156
 157                 <tr class="config-row expandable config-row-alt1 notInherited">
 158                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 159                     <td class="sig">
 160
 161                         <a id="Roo.dd.DragSource-cfg-dropNotAllowed" name=".dropNotAllowed"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">dropNotAllowed</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 164
 165
 166                         </div>
 167
 168                         <div class="mdesc">
 169                             <div class="short">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">The CSS class returned to the drag source when drop is not allowed (defaults to "x-dd-drop-nodrop").</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.dd.DragSource
 182
 183                     </td>
 184                 </tr>
 185
 186
 187     </table>
 188
 189
 190
 191
 192
 193
 194
 195
 196
 197   <!-- ============================== public properties ==================== -->
 198
 199
 200
 201     <a id="Roo.dd.DragSource-props"></a>
 202
 203
 204
 205
 206
 207      <table cellspacing="0" class="member-table">
 208       <caption class="Empty">Public Properties - Has None</caption>
 209      </table>
 210
 211
 212
 213
 214   <!-- ============================== methods summary / details ======================== -->
 215
 216
 217   <a id="Roo.dd.DragSource-methods"></a>
 218         <!-- constructor?? -->
 219
 220         <!-- static's first
 221
 222
 223         -->
 224
 225         <!-- then dynamics first -->
 226
 227
 228
 229
 230
 231
 232       <table cellspacing="0" class="member-table">
 233       <caption>Public Methods</caption>
 234         <tr>
 235             <th class="sig-header" colspan="2">Method</th>
 236             <th class="msource-header">Defined By</th>
 237
 238         </tr>
 239
 240
 241
 242
 243
 244
 245
 246           <tr class="method-row config-row-alt0 expandable notInherited">
 247             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 248
 249
 250             <td class="sig">
 251                 <a id="Roo.dd-method-DragSource"   name=".DragSource"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragSource</b>
 254
 255                                  (<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>)
 256
 257
 258
 259                 </div>
 260                 <div class="mdesc">
 261
 262
 263                         <div class="short">Create a new Roo.dd.DragSource</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.dd.DragSource
 271
 272
 273                                 <dl class="detailList">
 274                                 <dt class="heading">Parameters:</dt>
 275
 276                                         <dt>
 277                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 278
 279                                         </dt>
 280                                         <dd>The container element</dd>
 281
 282                                         <dt>
 283                                                 <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>
 284
 285                                         </dt>
 286                                         <dd></dd>
 287
 288                                 </dl>
 289
 290
 291
 292
 293
 294
 295
 296
 297
 298
 299
 300                     </div>
 301                 </div>
 302
 303             </td>
 304             <td class="msource">
 305                 &nbsp;
 306             </td>
 307         </tr>
 308
 309
 310           <tr class="method-row config-row-alt1 expandable notInherited">
 311             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 312
 313
 314             <td class="sig">
 315                 <a id="Roo.dd.DragSource-method-beforeDragDrop"   name=".beforeDragDrop"></a>
 316                 <div class="fixedFont">
 317                         <span class="attributes"></span><b class="itemname">beforeDragDrop</b>
 318
 319                                  (<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>)
 320
 321
 322                                          :
 323
 324
 325                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 326
 327
 328
 329
 330
 331                 </div>
 332                 <div class="mdesc">
 333
 334                    <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>
 335
 336
 337
 338                     <div class="long">
 339
 340                                 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.
 341
 342
 343
 344
 345
 346
 347                                 <dl class="detailList">
 348                                 <dt class="heading">Parameters:</dt>
 349
 350                                         <dt>
 351                                                 <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>
 352
 353                                         </dt>
 354                                         <dd>The drop target</dd>
 355
 356                                         <dt>
 357                                                 <span class="fixedFont">Event</span>  <b>e</b>
 358
 359                                         </dt>
 360                                         <dd>The event object</dd>
 361
 362                                         <dt>
 363                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 364
 365                                         </dt>
 366                                         <dd>The id of the dragged element</dd>
 367
 368                                 </dl>
 369
 370
 371
 372
 373
 374                                 <dl class="detailList">
 375                                 <dt class="heading">Returns:</dt>
 376
 377                                         <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>
 378
 379                                 </dl>
 380
 381
 382
 383
 384
 385
 386
 387                     </div>
 388                 </div>
 389
 390             </td>
 391             <td class="msource">
 392
 393                         Roo.dd.DragSource
 394                 &nbsp;
 395             </td>
 396         </tr>
 397
 398
 399           <tr class="method-row config-row-alt0 expandable notInherited">
 400             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 401
 402
 403             <td class="sig">
 404                 <a id="Roo.dd.DragSource-method-beforeDragEnter"   name=".beforeDragEnter"></a>
 405                 <div class="fixedFont">
 406                         <span class="attributes"></span><b class="itemname">beforeDragEnter</b>
 407
 408                                  (<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>)
 409
 410
 411                                          :
 412
 413
 414                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 415
 416
 417
 418
 419
 420                 </div>
 421                 <div class="mdesc">
 422
 423                    <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>
 424
 425
 426
 427                     <div class="long">
 428
 429                                 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.
 430
 431
 432
 433
 434
 435
 436                                 <dl class="detailList">
 437                                 <dt class="heading">Parameters:</dt>
 438
 439                                         <dt>
 440                                                 <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>
 441
 442                                         </dt>
 443                                         <dd>The drop target</dd>
 444
 445                                         <dt>
 446                                                 <span class="fixedFont">Event</span>  <b>e</b>
 447
 448                                         </dt>
 449                                         <dd>The event object</dd>
 450
 451                                         <dt>
 452                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 453
 454                                         </dt>
 455                                         <dd>The id of the dragged element</dd>
 456
 457                                 </dl>
 458
 459
 460
 461
 462
 463                                 <dl class="detailList">
 464                                 <dt class="heading">Returns:</dt>
 465
 466                                         <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>
 467
 468                                 </dl>
 469
 470
 471
 472
 473
 474
 475
 476                     </div>
 477                 </div>
 478
 479             </td>
 480             <td class="msource">
 481
 482                         Roo.dd.DragSource
 483                 &nbsp;
 484             </td>
 485         </tr>
 486
 487
 488           <tr class="method-row config-row-alt1 expandable notInherited">
 489             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 490
 491
 492             <td class="sig">
 493                 <a id="Roo.dd.DragSource-method-beforeDragOut"   name=".beforeDragOut"></a>
 494                 <div class="fixedFont">
 495                         <span class="attributes"></span><b class="itemname">beforeDragOut</b>
 496
 497                                  (<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>)
 498
 499
 500                                          :
 501
 502
 503                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 504
 505
 506
 507
 508
 509                 </div>
 510                 <div class="mdesc">
 511
 512                    <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>
 513
 514
 515
 516                     <div class="long">
 517
 518                                 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.
 519
 520
 521
 522
 523
 524
 525                                 <dl class="detailList">
 526                                 <dt class="heading">Parameters:</dt>
 527
 528                                         <dt>
 529                                                 <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>
 530
 531                                         </dt>
 532                                         <dd>The drop target</dd>
 533
 534                                         <dt>
 535                                                 <span class="fixedFont">Event</span>  <b>e</b>
 536
 537                                         </dt>
 538                                         <dd>The event object</dd>
 539
 540                                         <dt>
 541                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 542
 543                                         </dt>
 544                                         <dd>The id of the dragged element</dd>
 545
 546                                 </dl>
 547
 548
 549
 550
 551
 552                                 <dl class="detailList">
 553                                 <dt class="heading">Returns:</dt>
 554
 555                                         <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>
 556
 557                                 </dl>
 558
 559
 560
 561
 562
 563
 564
 565                     </div>
 566                 </div>
 567
 568             </td>
 569             <td class="msource">
 570
 571                         Roo.dd.DragSource
 572                 &nbsp;
 573             </td>
 574         </tr>
 575
 576
 577           <tr class="method-row config-row-alt0 expandable notInherited">
 578             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 579
 580
 581             <td class="sig">
 582                 <a id="Roo.dd.DragSource-method-beforeDragOver"   name=".beforeDragOver"></a>
 583                 <div class="fixedFont">
 584                         <span class="attributes"></span><b class="itemname">beforeDragOver</b>
 585
 586                                  (<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>)
 587
 588
 589                                          :
 590
 591
 592                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 593
 594
 595
 596
 597
 598                 </div>
 599                 <div class="mdesc">
 600
 601                    <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>
 602
 603
 604
 605                     <div class="long">
 606
 607                                 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.
 608
 609
 610
 611
 612
 613
 614                                 <dl class="detailList">
 615                                 <dt class="heading">Parameters:</dt>
 616
 617                                         <dt>
 618                                                 <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>
 619
 620                                         </dt>
 621                                         <dd>The drop target</dd>
 622
 623                                         <dt>
 624                                                 <span class="fixedFont">Event</span>  <b>e</b>
 625
 626                                         </dt>
 627                                         <dd>The event object</dd>
 628
 629                                         <dt>
 630                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 631
 632                                         </dt>
 633                                         <dd>The id of the dragged element</dd>
 634
 635                                 </dl>
 636
 637
 638
 639
 640
 641                                 <dl class="detailList">
 642                                 <dt class="heading">Returns:</dt>
 643
 644                                         <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>
 645
 646                                 </dl>
 647
 648
 649
 650
 651
 652
 653
 654                     </div>
 655                 </div>
 656
 657             </td>
 658             <td class="msource">
 659
 660                         Roo.dd.DragSource
 661                 &nbsp;
 662             </td>
 663         </tr>
 664
 665
 666           <tr class="method-row config-row-alt1 expandable notInherited">
 667             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 668
 669
 670             <td class="sig">
 671                 <a id="Roo.dd.DragSource-method-beforeInvalidDrop"   name=".beforeInvalidDrop"></a>
 672                 <div class="fixedFont">
 673                         <span class="attributes"></span><b class="itemname">beforeInvalidDrop</b>
 674
 675                                  (<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>)
 676
 677
 678                                          :
 679
 680
 681                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 682
 683
 684
 685
 686
 687                 </div>
 688                 <div class="mdesc">
 689
 690                    <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>
 691
 692
 693
 694                     <div class="long">
 695
 696                                 An empty function by default, but provided so that you can perform a custom action after an invalid<br/>drop has occurred.
 697
 698
 699
 700
 701
 702
 703                                 <dl class="detailList">
 704                                 <dt class="heading">Parameters:</dt>
 705
 706                                         <dt>
 707                                                 <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>
 708
 709                                         </dt>
 710                                         <dd>The drop target</dd>
 711
 712                                         <dt>
 713                                                 <span class="fixedFont">Event</span>  <b>e</b>
 714
 715                                         </dt>
 716                                         <dd>The event object</dd>
 717
 718                                         <dt>
 719                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 720
 721                                         </dt>
 722                                         <dd>The id of the dragged element</dd>
 723
 724                                 </dl>
 725
 726
 727
 728
 729
 730                                 <dl class="detailList">
 731                                 <dt class="heading">Returns:</dt>
 732
 733                                         <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>
 734
 735                                 </dl>
 736
 737
 738
 739
 740
 741
 742
 743                     </div>
 744                 </div>
 745
 746             </td>
 747             <td class="msource">
 748
 749                         Roo.dd.DragSource
 750                 &nbsp;
 751             </td>
 752         </tr>
 753
 754
 755           <tr class="method-row config-row-alt0 expandable notInherited">
 756             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 757
 758
 759             <td class="sig">
 760                 <a id="Roo.dd.DragSource-method-getDragData"   name=".getDragData"></a>
 761                 <div class="fixedFont">
 762                         <span class="attributes"></span><b class="itemname">getDragData</b>
 763
 764                                  ()
 765
 766
 767                                          :
 768
 769
 770                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 771
 772
 773
 774
 775
 776                 </div>
 777                 <div class="mdesc">
 778
 779                    <div class="short">Returns the data object associated with this drag source</div>
 780
 781
 782
 783                     <div class="long">
 784
 785                                 Returns the data object associated with this drag source
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796                                 <dl class="detailList">
 797                                 <dt class="heading">Returns:</dt>
 798
 799                                         <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>
 800
 801                                 </dl>
 802
 803
 804
 805
 806
 807
 808
 809                     </div>
 810                 </div>
 811
 812             </td>
 813             <td class="msource">
 814
 815                         Roo.dd.DragSource
 816                 &nbsp;
 817             </td>
 818         </tr>
 819
 820
 821           <tr class="method-row config-row-alt1 expandable notInherited">
 822             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 823
 824
 825             <td class="sig">
 826                 <a id="Roo.dd.DragSource-method-getProxy"   name=".getProxy"></a>
 827                 <div class="fixedFont">
 828                         <span class="attributes"></span><b class="itemname">getProxy</b>
 829
 830                                  ()
 831
 832
 833                                          :
 834
 835
 836                                                 <a href="./Roo.dd.StatusProxy.html#constructor" roo:cls="Roo.dd.StatusProxy.html#constructor">Roo.dd.StatusProxy</a>
 837
 838
 839
 840
 841
 842                 </div>
 843                 <div class="mdesc">
 844
 845                    <div class="short">Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}</div>
 846
 847
 848
 849                     <div class="long">
 850
 851                                 Returns the drag source's underlying {<b>link</b> Roo.dd.StatusProxy}
 852
 853
 854
 855
 856
 857
 858
 859
 860
 861
 862                                 <dl class="detailList">
 863                                 <dt class="heading">Returns:</dt>
 864
 865                                         <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>
 866
 867                                 </dl>
 868
 869
 870
 871
 872
 873
 874
 875                     </div>
 876                 </div>
 877
 878             </td>
 879             <td class="msource">
 880
 881                         Roo.dd.DragSource
 882                 &nbsp;
 883             </td>
 884         </tr>
 885
 886
 887           <tr class="method-row config-row-alt0 expandable notInherited">
 888             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 889
 890
 891             <td class="sig">
 892                 <a id="Roo.dd.DragSource-method-hideProxy"   name=".hideProxy"></a>
 893                 <div class="fixedFont">
 894                         <span class="attributes"></span><b class="itemname">hideProxy</b>
 895
 896                                  ()
 897
 898
 899
 900                 </div>
 901                 <div class="mdesc">
 902
 903                    <div class="short">Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}</div>
 904
 905
 906
 907                     <div class="long">
 908
 909                                 Hides the drag source's {<b>link</b> Roo.dd.StatusProxy}
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926                     </div>
 927                 </div>
 928
 929             </td>
 930             <td class="msource">
 931
 932                         Roo.dd.DragSource
 933                 &nbsp;
 934             </td>
 935         </tr>
 936
 937
 938           <tr class="method-row config-row-alt1 expandable notInherited">
 939             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 940
 941
 942             <td class="sig">
 943                 <a id="Roo.dd.DragSource-method-onBeforeDrag"   name=".onBeforeDrag"></a>
 944                 <div class="fixedFont">
 945                         <span class="attributes"></span><b class="itemname">onBeforeDrag</b>
 946
 947                                  (<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>)
 948
 949
 950                                          :
 951
 952
 953                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 954
 955
 956
 957
 958
 959                 </div>
 960                 <div class="mdesc">
 961
 962                    <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>
 963
 964
 965
 966                     <div class="long">
 967
 968                                 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.
 969
 970
 971
 972
 973
 974
 975                                 <dl class="detailList">
 976                                 <dt class="heading">Parameters:</dt>
 977
 978                                         <dt>
 979                                                 <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>
 980
 981                                         </dt>
 982                                         <dd>An object containing arbitrary data to be shared with drop targets</dd>
 983
 984                                         <dt>
 985                                                 <span class="fixedFont">Event</span>  <b>e</b>
 986
 987                                         </dt>
 988                                         <dd>The event object</dd>
 989
 990                                 </dl>
 991
 992
 993
 994
 995
 996                                 <dl class="detailList">
 997                                 <dt class="heading">Returns:</dt>
 998
 999                                         <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>
1000
1001                                 </dl>
1002
1003
1004
1005
1006
1007
1008
1009                     </div>
1010                 </div>
1011
1012             </td>
1013             <td class="msource">
1014
1015                         Roo.dd.DragSource
1016                 &nbsp;
1017             </td>
1018         </tr>
1019
1020
1021           <tr class="method-row config-row-alt0 expandable notInherited">
1022             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1023
1024
1025             <td class="sig">
1026                 <a id="Roo.dd.DragSource-method-onStartDrag"   name=".onStartDrag"></a>
1027                 <div class="fixedFont">
1028                         <span class="attributes"></span><b class="itemname">onStartDrag</b>
1029
1030                                  (<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>)
1031
1032
1033
1034                 </div>
1035                 <div class="mdesc">
1036
1037                    <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>
1038
1039
1040
1041                     <div class="long">
1042
1043                                 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.
1044
1045
1046
1047
1048
1049
1050                                 <dl class="detailList">
1051                                 <dt class="heading">Parameters:</dt>
1052
1053                                         <dt>
1054                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>x</b>
1055
1056                                         </dt>
1057                                         <dd>The x position of the click on the dragged object</dd>
1058
1059                                         <dt>
1060                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>y</b>
1061
1062                                         </dt>
1063                                         <dd>The y position of the click on the dragged object</dd>
1064
1065                                 </dl>
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077                     </div>
1078                 </div>
1079
1080             </td>
1081             <td class="msource">
1082
1083                         Roo.dd.DragSource
1084                 &nbsp;
1085             </td>
1086         </tr>
1087
1088
1089     </table>
1090
1091
1092   <!-- ============================== events summary / details ======================== -->
1093
1094
1095   <a id="Roo.dd.DragSource-events"></a>
1096
1097
1098
1099
1100
1101      <table cellspacing="0" class="member-table">
1102       <caption class="Empty">Events - Has None</caption>
1103      </table>
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113 <!-- ============================== footer ================================= -->
1114                 <div class="fineprint" style="clear:both">
1115
1116                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:53 GMT+0800 (HKT)
1117                         Based on
1118                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1119                 </div>
1120         </body>
1121 </html>