git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.DropTarget.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.DropTarget</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.DropTarget-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DropTarget-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DropTarget-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DropTarget-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.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DropTarget
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DropTarget
  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_DropTarget.js.html">Roo/dd/DropTarget.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DropTarget</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.dd.DDTarget.html#constructor" roo:cls="Roo.dd.DDTarget.html#constructor">Roo.dd.DDTarget</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 a drop target that can have<br/>draggable items dropped onto it.  The drop has no effect until an implementation of notifyDrop is provided.
  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.DropTarget';">[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.DropTarget.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.dd.DropTarget-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.DropTarget-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.DropTarget
 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.DropTarget-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.DropTarget
 182
 183                     </td>
 184                 </tr>
 185
 186
 187                 <tr class="config-row expandable config-row-alt0 notInherited">
 188                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 189                     <td class="sig">
 190
 191                         <a id="Roo.dd.DropTarget-cfg-overClass" name=".overClass"></a>
 192                         <div class="fixedFont">
 193                                 <b  class="itemname">overClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 194
 195
 196                         </div>
 197
 198                         <div class="mdesc">
 199                             <div class="short">The CSS class applied to the drop target element while the drag source is over it (defaults to "").</div>
 200                         </div>
 201
 202                         <div class="mdesc">
 203                             <div class="long">The CSS class applied to the drop target element while the drag source is over it (defaults to "").</div>
 204                         </div>
 205
 206
 207
 208                     </td>
 209                     <td class="msource">
 210
 211                         Roo.dd.DropTarget
 212
 213                     </td>
 214                 </tr>
 215
 216
 217     </table>
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227   <!-- ============================== public properties ==================== -->
 228
 229
 230
 231     <a id="Roo.dd.DropTarget-props"></a>
 232
 233
 234
 235
 236
 237      <table cellspacing="0" class="member-table">
 238       <caption class="Empty">Public Properties - Has None</caption>
 239      </table>
 240
 241
 242
 243
 244   <!-- ============================== methods summary / details ======================== -->
 245
 246
 247   <a id="Roo.dd.DropTarget-methods"></a>
 248         <!-- constructor?? -->
 249
 250         <!-- static's first
 251
 252
 253         -->
 254
 255         <!-- then dynamics first -->
 256
 257
 258
 259
 260
 261
 262       <table cellspacing="0" class="member-table">
 263       <caption>Public Methods</caption>
 264         <tr>
 265             <th class="sig-header" colspan="2">Method</th>
 266             <th class="msource-header">Defined By</th>
 267
 268         </tr>
 269
 270
 271
 272
 273
 274
 275
 276           <tr class="method-row config-row-alt0 expandable notInherited">
 277             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 278
 279
 280             <td class="sig">
 281                 <a id="Roo.dd-method-DropTarget"   name=".DropTarget"></a>
 282                 <div class="fixedFont">
 283                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DropTarget</b>
 284
 285                                  (<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>)
 286
 287
 288
 289                 </div>
 290                 <div class="mdesc">
 291
 292
 293                         <div class="short">Create a new Roo.dd.DropTarget</div>
 294
 295
 296                     <div class="long">
 297
 298
 299
 300                                 Create a new Roo.dd.DropTarget
 301
 302
 303                                 <dl class="detailList">
 304                                 <dt class="heading">Parameters:</dt>
 305
 306                                         <dt>
 307                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>el</b>
 308
 309                                         </dt>
 310                                         <dd>The container element</dd>
 311
 312                                         <dt>
 313                                                 <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>
 314
 315                                         </dt>
 316                                         <dd></dd>
 317
 318                                 </dl>
 319
 320
 321
 322
 323
 324
 325
 326
 327
 328
 329
 330                     </div>
 331                 </div>
 332
 333             </td>
 334             <td class="msource">
 335                 &nbsp;
 336             </td>
 337         </tr>
 338
 339
 340           <tr class="method-row config-row-alt1 expandable notInherited">
 341             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 342
 343
 344             <td class="sig">
 345                 <a id="Roo.dd.DropTarget-method-notifyDrop"   name=".notifyDrop"></a>
 346                 <div class="fixedFont">
 347                         <span class="attributes"></span><b class="itemname">notifyDrop</b>
 348
 349                                  (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 350
 351
 352                                          :
 353
 354
 355                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 356
 357
 358
 359
 360
 361                 </div>
 362                 <div class="mdesc">
 363
 364                    <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the dragged item has<br/>been dropped on it.</div>
 365
 366
 367
 368                     <div class="long">
 369
 370                                 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the dragged item has<br/>been dropped on it.  This method has no default implementation and returns false, so you must provide an<br/>implementation that does something to process the drop event and returns true so that the drag source's<br/>repair action does not run.
 371
 372
 373
 374
 375
 376
 377                                 <dl class="detailList">
 378                                 <dt class="heading">Parameters:</dt>
 379
 380                                         <dt>
 381                                                 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span>  <b>source</b>
 382
 383                                         </dt>
 384                                         <dd>The drag source that was dragged over this drop target</dd>
 385
 386                                         <dt>
 387                                                 <span class="fixedFont">Event</span>  <b>e</b>
 388
 389                                         </dt>
 390                                         <dd>The event</dd>
 391
 392                                         <dt>
 393                                                 <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>
 394
 395                                         </dt>
 396                                         <dd>An object containing arbitrary data supplied by the drag source</dd>
 397
 398                                 </dl>
 399
 400
 401
 402
 403
 404                                 <dl class="detailList">
 405                                 <dt class="heading">Returns:</dt>
 406
 407                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the drop was valid, else false</dd>
 408
 409                                 </dl>
 410
 411
 412
 413
 414
 415
 416
 417                     </div>
 418                 </div>
 419
 420             </td>
 421             <td class="msource">
 422
 423                         Roo.dd.DropTarget
 424                 &nbsp;
 425             </td>
 426         </tr>
 427
 428
 429           <tr class="method-row config-row-alt0 expandable notInherited">
 430             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 431
 432
 433             <td class="sig">
 434                 <a id="Roo.dd.DropTarget-method-notifyEnter"   name=".notifyEnter"></a>
 435                 <div class="fixedFont">
 436                         <span class="attributes"></span><b class="itemname">notifyEnter</b>
 437
 438                                  (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 439
 440
 441                                          :
 442
 443
 444                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 445
 446
 447
 448
 449
 450                 </div>
 451                 <div class="mdesc">
 452
 453                    <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source is now over the<br/>target.</div>
 454
 455
 456
 457                     <div class="long">
 458
 459                                 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source is now over the<br/>target.  This default implementation adds the CSS class specified by overClass (if any) to the drop element<br/>and returns the dropAllowed config value.  This method should be overridden if drop validation is required.
 460
 461
 462
 463
 464
 465
 466                                 <dl class="detailList">
 467                                 <dt class="heading">Parameters:</dt>
 468
 469                                         <dt>
 470                                                 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span>  <b>source</b>
 471
 472                                         </dt>
 473                                         <dd>The drag source that was dragged over this drop target</dd>
 474
 475                                         <dt>
 476                                                 <span class="fixedFont">Event</span>  <b>e</b>
 477
 478                                         </dt>
 479                                         <dd>The event</dd>
 480
 481                                         <dt>
 482                                                 <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>
 483
 484                                         </dt>
 485                                         <dd>An object containing arbitrary data supplied by the drag source</dd>
 486
 487                                 </dl>
 488
 489
 490
 491
 492
 493                                 <dl class="detailList">
 494                                 <dt class="heading">Returns:</dt>
 495
 496                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  status The CSS class that communicates the drop status back to the source so that the<br/>underlying {<b>link</b> Roo.dd.StatusProxy} can be updated</dd>
 497
 498                                 </dl>
 499
 500
 501
 502
 503
 504
 505
 506                     </div>
 507                 </div>
 508
 509             </td>
 510             <td class="msource">
 511
 512                         Roo.dd.DropTarget
 513                 &nbsp;
 514             </td>
 515         </tr>
 516
 517
 518           <tr class="method-row config-row-alt1 expandable notInherited">
 519             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 520
 521
 522             <td class="sig">
 523                 <a id="Roo.dd.DropTarget-method-notifyOut"   name=".notifyOut"></a>
 524                 <div class="fixedFont">
 525                         <span class="attributes"></span><b class="itemname">notifyOut</b>
 526
 527                                  (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 528
 529
 530
 531                 </div>
 532                 <div class="mdesc">
 533
 534                    <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged<br/>out of the target without dropping.</div>
 535
 536
 537
 538                     <div class="long">
 539
 540                                 The function a {<b>link</b> Roo.dd.DragSource} calls once to notify this drop target that the source has been dragged<br/>out of the target without dropping.  This default implementation simply removes the CSS class specified by<br/>overClass (if any) from the drop element.
 541
 542
 543
 544
 545
 546
 547                                 <dl class="detailList">
 548                                 <dt class="heading">Parameters:</dt>
 549
 550                                         <dt>
 551                                                 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span>  <b>source</b>
 552
 553                                         </dt>
 554                                         <dd>The drag source that was dragged over this drop target</dd>
 555
 556                                         <dt>
 557                                                 <span class="fixedFont">Event</span>  <b>e</b>
 558
 559                                         </dt>
 560                                         <dd>The event</dd>
 561
 562                                         <dt>
 563                                                 <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>
 564
 565                                         </dt>
 566                                         <dd>An object containing arbitrary data supplied by the drag source</dd>
 567
 568                                 </dl>
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580                     </div>
 581                 </div>
 582
 583             </td>
 584             <td class="msource">
 585
 586                         Roo.dd.DropTarget
 587                 &nbsp;
 588             </td>
 589         </tr>
 590
 591
 592           <tr class="method-row config-row-alt0 expandable notInherited">
 593             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 594
 595
 596             <td class="sig">
 597                 <a id="Roo.dd.DropTarget-method-notifyOver"   name=".notifyOver"></a>
 598                 <div class="fixedFont">
 599                         <span class="attributes"></span><b class="itemname">notifyOver</b>
 600
 601                                  (<a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a> <B><i>source</i></B>, Event <B><i>e</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>data</i></B>)
 602
 603
 604                                          :
 605
 606
 607                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 608
 609
 610
 611
 612
 613                 </div>
 614                 <div class="mdesc">
 615
 616                    <div class="short">The function a {<b>link</b> Roo.dd.DragSource} calls continuously while it is being dragged over the target.</div>
 617
 618
 619
 620                     <div class="long">
 621
 622                                 The function a {<b>link</b> Roo.dd.DragSource} calls continuously while it is being dragged over the target.<br/>This method will be called on every mouse movement while the drag source is over the drop target.<br/>This default implementation simply returns the dropAllowed config value.
 623
 624
 625
 626
 627
 628
 629                                 <dl class="detailList">
 630                                 <dt class="heading">Parameters:</dt>
 631
 632                                         <dt>
 633                                                 <span class="fixedFont"><a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a></span>  <b>source</b>
 634
 635                                         </dt>
 636                                         <dd>The drag source that was dragged over this drop target</dd>
 637
 638                                         <dt>
 639                                                 <span class="fixedFont">Event</span>  <b>e</b>
 640
 641                                         </dt>
 642                                         <dd>The event</dd>
 643
 644                                         <dt>
 645                                                 <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>
 646
 647                                         </dt>
 648                                         <dd>An object containing arbitrary data supplied by the drag source</dd>
 649
 650                                 </dl>
 651
 652
 653
 654
 655
 656                                 <dl class="detailList">
 657                                 <dt class="heading">Returns:</dt>
 658
 659                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  status The CSS class that communicates the drop status back to the source so that the<br/>underlying {<b>link</b> Roo.dd.StatusProxy} can be updated</dd>
 660
 661                                 </dl>
 662
 663
 664
 665
 666
 667
 668
 669                     </div>
 670                 </div>
 671
 672             </td>
 673             <td class="msource">
 674
 675                         Roo.dd.DropTarget
 676                 &nbsp;
 677             </td>
 678         </tr>
 679
 680
 681     </table>
 682
 683
 684   <!-- ============================== events summary / details ======================== -->
 685
 686
 687   <a id="Roo.dd.DropTarget-events"></a>
 688
 689
 690
 691
 692
 693      <table cellspacing="0" class="member-table">
 694       <caption class="Empty">Events - Has None</caption>
 695      </table>
 696
 697
 698
 699
 700
 701
 702
 703
 704
 705 <!-- ============================== footer ================================= -->
 706                 <div class="fineprint" style="clear:both">
 707
 708                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:37:06 GMT+0800 (HKT)
 709                         Based on
 710                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 711                 </div>
 712         </body>
 713 </html>