git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.DragZone.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.DragZone</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.DragZone-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DragZone-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DragZone-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DragZone-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.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DragZone
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DragZone
  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_DragZone.js.html">Roo/dd/DragZone.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DragZone</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.dd.DragSource.html#constructor" roo:cls="Roo.dd.DragSource.html#constructor">Roo.dd.DragSource</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 sources.<br /><br/>By default, this class requires that draggable child nodes 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.DragZone';">[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.DragZone.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.dd.DragZone-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.DragZone-cfg-containerScroll" name=".containerScroll"></a>
 132                         <div class="fixedFont">
 133                                 <b  class="itemname">containerScroll</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 134
 135
 136                         </div>
 137
 138                         <div class="mdesc">
 139                             <div class="short">True to register this container with the Scrollmanager<br/>for auto scrolling during drag operations.</div>
 140                         </div>
 141
 142                         <div class="mdesc">
 143                             <div class="long">True to register this container with the Scrollmanager<br/>for auto scrolling during drag operations.</div>
 144                         </div>
 145
 146
 147
 148                     </td>
 149                     <td class="msource">
 150
 151                         Roo.dd.DragZone
 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.DragZone-cfg-hlColor" name=".hlColor"></a>
 162                         <div class="fixedFont">
 163                                 <b  class="itemname">hlColor</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 color to use when visually highlighting the drag source in the afterRepair<br/>method after a failed drop (defaults to "c3daf9" - light blue)</div>
 170                         </div>
 171
 172                         <div class="mdesc">
 173                             <div class="long">The color to use when visually highlighting the drag source in the afterRepair<br/>method after a failed drop (defaults to "c3daf9" - light blue)</div>
 174                         </div>
 175
 176
 177
 178                     </td>
 179                     <td class="msource">
 180
 181                         Roo.dd.DragZone
 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.DragZone-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.DragZone-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-DragZone"   name=".DragZone"></a>
 252                 <div class="fixedFont">
 253                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DragZone</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.DragZone</div>
 264
 265
 266                     <div class="long">
 267
 268
 269
 270                                 Create a new Roo.dd.DragZone
 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.DragZone-method-afterRepair"   name=".afterRepair"></a>
 316                 <div class="fixedFont">
 317                         <span class="attributes"></span><b class="itemname">afterRepair</b>
 318
 319                                  ()
 320
 321
 322
 323                 </div>
 324                 <div class="mdesc">
 325
 326                    <div class="short">Called after a repair of an invalid drop.</div>
 327
 328
 329
 330                     <div class="long">
 331
 332                                 Called after a repair of an invalid drop. By default, highlights this.dragData.ddel
 333
 334
 335
 336
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348
 349                     </div>
 350                 </div>
 351
 352             </td>
 353             <td class="msource">
 354
 355                         Roo.dd.DragZone
 356                 &nbsp;
 357             </td>
 358         </tr>
 359
 360
 361           <tr class="method-row config-row-alt0 expandable notInherited">
 362             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 363
 364
 365             <td class="sig">
 366                 <a id="Roo.dd.DragZone-method-getDragData"   name=".getDragData"></a>
 367                 <div class="fixedFont">
 368                         <span class="attributes"></span><b class="itemname">getDragData</b>
 369
 370                                  (EventObject <B><i>e</i></B>)
 371
 372
 373                                          :
 374
 375
 376                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 377
 378
 379
 380
 381
 382                 </div>
 383                 <div class="mdesc">
 384
 385                    <div class="short">Called when a mousedown occurs in this container.</div>
 386
 387
 388
 389                     <div class="long">
 390
 391                                 Called when a mousedown occurs in this container. Looks in {<b>link</b> Roo.dd.Registry}<br/>for a valid target to drag based on the mouse down. Override this method<br/>to provide your own lookup logic (e.g. finding a child by class name). Make sure your returned<br/>object has a "ddel" attribute (with an HTML Element) for other functions to work.
 392
 393
 394
 395
 396
 397
 398                                 <dl class="detailList">
 399                                 <dt class="heading">Parameters:</dt>
 400
 401                                         <dt>
 402                                                 <span class="fixedFont">EventObject</span>  <b>e</b>
 403
 404                                         </dt>
 405                                         <dd>The mouse down event</dd>
 406
 407                                 </dl>
 408
 409
 410
 411
 412
 413                                 <dl class="detailList">
 414                                 <dt class="heading">Returns:</dt>
 415
 416                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  The dragData</dd>
 417
 418                                 </dl>
 419
 420
 421
 422
 423
 424
 425
 426                     </div>
 427                 </div>
 428
 429             </td>
 430             <td class="msource">
 431
 432                         Roo.dd.DragZone
 433                 &nbsp;
 434             </td>
 435         </tr>
 436
 437
 438           <tr class="method-row config-row-alt1 expandable notInherited">
 439             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 440
 441
 442             <td class="sig">
 443                 <a id="Roo.dd.DragZone-method-getRepairXY"   name=".getRepairXY"></a>
 444                 <div class="fixedFont">
 445                         <span class="attributes"></span><b class="itemname">getRepairXY</b>
 446
 447                                  (EventObject <B><i>e</i></B>)
 448
 449
 450                                          :
 451
 452
 453                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 454
 455
 456
 457
 458
 459                 </div>
 460                 <div class="mdesc">
 461
 462                    <div class="short">Called before a repair of an invalid drop to get the XY to animate to.</div>
 463
 464
 465
 466                     <div class="long">
 467
 468                                 Called before a repair of an invalid drop to get the XY to animate to. By default returns<br/>the XY of this.dragData.ddel
 469
 470
 471
 472
 473
 474
 475                                 <dl class="detailList">
 476                                 <dt class="heading">Parameters:</dt>
 477
 478                                         <dt>
 479                                                 <span class="fixedFont">EventObject</span>  <b>e</b>
 480
 481                                         </dt>
 482                                         <dd>The mouse up event</dd>
 483
 484                                 </dl>
 485
 486
 487
 488
 489
 490                                 <dl class="detailList">
 491                                 <dt class="heading">Returns:</dt>
 492
 493                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  The xy location (e.g. [100, 200])</dd>
 494
 495                                 </dl>
 496
 497
 498
 499
 500
 501
 502
 503                     </div>
 504                 </div>
 505
 506             </td>
 507             <td class="msource">
 508
 509                         Roo.dd.DragZone
 510                 &nbsp;
 511             </td>
 512         </tr>
 513
 514
 515           <tr class="method-row config-row-alt0 expandable notInherited">
 516             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 517
 518
 519             <td class="sig">
 520                 <a id="Roo.dd.DragZone-method-onInitDrag"   name=".onInitDrag"></a>
 521                 <div class="fixedFont">
 522                         <span class="attributes"></span><b class="itemname">onInitDrag</b>
 523
 524                                  (<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>)
 525
 526
 527                                          :
 528
 529
 530                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 531
 532
 533
 534
 535
 536                 </div>
 537                 <div class="mdesc">
 538
 539                    <div class="short">Called once drag threshold has been reached to initialize the proxy element.</div>
 540
 541
 542
 543                     <div class="long">
 544
 545                                 Called once drag threshold has been reached to initialize the proxy element. By default, it clones the<br/>this.dragData.ddel
 546
 547
 548
 549
 550
 551
 552                                 <dl class="detailList">
 553                                 <dt class="heading">Parameters:</dt>
 554
 555                                         <dt>
 556                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>x</b>
 557
 558                                         </dt>
 559                                         <dd>The x position of the click on the dragged object</dd>
 560
 561                                         <dt>
 562                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>y</b>
 563
 564                                         </dt>
 565                                         <dd>The y position of the click on the dragged object</dd>
 566
 567                                 </dl>
 568
 569
 570
 571
 572
 573                                 <dl class="detailList">
 574                                 <dt class="heading">Returns:</dt>
 575
 576                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  true to continue the drag, false to cancel</dd>
 577
 578                                 </dl>
 579
 580
 581
 582
 583
 584
 585
 586                     </div>
 587                 </div>
 588
 589             </td>
 590             <td class="msource">
 591
 592                         Roo.dd.DragZone
 593                 &nbsp;
 594             </td>
 595         </tr>
 596
 597
 598     </table>
 599
 600
 601   <!-- ============================== events summary / details ======================== -->
 602
 603
 604   <a id="Roo.dd.DragZone-events"></a>
 605
 606
 607
 608
 609
 610      <table cellspacing="0" class="member-table">
 611       <caption class="Empty">Events - Has None</caption>
 612      </table>
 613
 614
 615
 616
 617
 618
 619
 620
 621
 622 <!-- ============================== footer ================================= -->
 623                 <div class="fineprint" style="clear:both">
 624
 625                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:43:10 GMT+0800 (HKT)
 626                         Based on
 627                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 628                 </div>
 629         </body>
 630 </html>