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