git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.DD.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.DD</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.DD-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.DD-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.DD-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.DD-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
  38         <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
  39         -->
  40     </div>
  41
  42
  43 <!-- ============================== inheritance Block. ================================= -->
  44
  45                 <div class="inheritance res-block">
  46                    <pre class="res-block-inner"><a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.dd.DD
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.dd.DD
  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_DD.js.html">Roo/dd/DD.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">DD</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.dd.DragDrop.html#constructor" roo:cls="Roo.dd.DragDrop.html#constructor">Roo.dd.DragDrop</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A DragDrop implementation where the linked element follows the<br/>mouse cursor during a drag.
  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.DD';">[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.DD.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.dd.DD-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.DD-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.DD-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-DD"   name=".DD"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.dd.</B></span><b class="itemname">DD</b>
 183
 184                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>sGroup</i></B>, object <B><i>config</i></B>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.dd.DD</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.dd.DD
 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></span>  <b>id</b>
 207
 208                                         </dt>
 209                                         <dd>the id of the linked element</dd>
 210
 211                                         <dt>
 212                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>sGroup</b>
 213
 214                                         </dt>
 215                                         <dd>the group of related DragDrop items</dd>
 216
 217                                         <dt>
 218                                                 <span class="fixedFont">object</span>  <b>config</b>
 219
 220                                         </dt>
 221                                         <dd>an object containing configurable attributes<br/>               Valid properties for DD:<br/>                   scroll</dd>
 222
 223                                 </dl>
 224
 225
 226
 227
 228
 229
 230
 231
 232
 233
 234
 235                     </div>
 236                 </div>
 237
 238             </td>
 239             <td class="msource">
 240                 &nbsp;
 241             </td>
 242         </tr>
 243
 244
 245           <tr class="method-row config-row-alt1 expandable notInherited">
 246             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 247
 248
 249             <td class="sig">
 250                 <a id="Roo.dd.DD-method-alignElWithMouse"   name=".alignElWithMouse"></a>
 251                 <div class="fixedFont">
 252                         <span class="attributes"></span><b class="itemname">alignElWithMouse</b>
 253
 254                                  (<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>el</i></B>, int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
 255
 256
 257
 258                 </div>
 259                 <div class="mdesc">
 260
 261                    <div class="short">Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
 262
 263
 264
 265                     <div class="long">
 266
 267                                 Sets the element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.  Override this if you want to place the element in a<br/>location other than where the cursor is.
 268
 269
 270
 271
 272
 273
 274                                 <dl class="detailList">
 275                                 <dt class="heading">Parameters:</dt>
 276
 277                                         <dt>
 278                                                 <span class="fixedFont"><a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>el</b>
 279
 280                                         </dt>
 281                                         <dd>the element to move</dd>
 282
 283                                         <dt>
 284                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
 285
 286                                         </dt>
 287                                         <dd>the X coordinate of the mousedown or drag event</dd>
 288
 289                                         <dt>
 290                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
 291
 292                                         </dt>
 293                                         <dd>the Y coordinate of the mousedown or drag event</dd>
 294
 295                                 </dl>
 296
 297
 298
 299
 300
 301
 302
 303
 304
 305
 306
 307                     </div>
 308                 </div>
 309
 310             </td>
 311             <td class="msource">
 312
 313                         Roo.dd.DD
 314                 &nbsp;
 315             </td>
 316         </tr>
 317
 318
 319           <tr class="method-row config-row-alt0 expandable notInherited">
 320             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 321
 322
 323             <td class="sig">
 324                 <a id="Roo.dd.DD-method-autoOffset"   name=".autoOffset"></a>
 325                 <div class="fixedFont">
 326                         <span class="attributes"></span><b class="itemname">autoOffset</b>
 327
 328                                  (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
 329
 330
 331
 332                 </div>
 333                 <div class="mdesc">
 334
 335                    <div class="short">Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked</div>
 336
 337
 338
 339                     <div class="long">
 340
 341                                 Sets the pointer offset to the distance between the linked element's top<br/>left corner and the location the element was clicked
 342
 343
 344
 345
 346
 347
 348                                 <dl class="detailList">
 349                                 <dt class="heading">Parameters:</dt>
 350
 351                                         <dt>
 352                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
 353
 354                                         </dt>
 355                                         <dd>the X coordinate of the click</dd>
 356
 357                                         <dt>
 358                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
 359
 360                                         </dt>
 361                                         <dd>the Y coordinate of the click</dd>
 362
 363                                 </dl>
 364
 365
 366
 367
 368
 369
 370
 371
 372
 373
 374
 375                     </div>
 376                 </div>
 377
 378             </td>
 379             <td class="msource">
 380
 381                         Roo.dd.DD
 382                 &nbsp;
 383             </td>
 384         </tr>
 385
 386
 387           <tr class="method-row config-row-alt1 expandable notInherited">
 388             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 389
 390
 391             <td class="sig">
 392                 <a id="Roo.dd.DD-method-cachePosition"   name=".cachePosition"></a>
 393                 <div class="fixedFont">
 394                         <span class="attributes"></span><b class="itemname">cachePosition</b>
 395
 396                                  (<B><i>iPageX</i></B>, <B><i>iPageY</i></B>)
 397
 398
 399
 400                 </div>
 401                 <div class="mdesc">
 402
 403                    <div class="short">Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.</div>
 404
 405
 406
 407                     <div class="long">
 408
 409                                 Saves the most recent position so that we can reset the constraints and<br/>tick marks on-demand.  We need to know this so that we can calculate the<br/>number of pixels the element is offset from its original position.
 410
 411
 412
 413
 414
 415
 416                                 <dl class="detailList">
 417                                 <dt class="heading">Parameters:</dt>
 418
 419                                         <dt>
 420                                                  <b>iPageX</b>
 421
 422                                         </dt>
 423                                         <dd>the current x position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
 424
 425                                         <dt>
 426                                                  <b>iPageY</b>
 427
 428                                         </dt>
 429                                         <dd>the current y position (optional, this just makes it so we<br/>don't have to look it up again)</dd>
 430
 431                                 </dl>
 432
 433
 434
 435
 436
 437
 438
 439
 440
 441
 442
 443                     </div>
 444                 </div>
 445
 446             </td>
 447             <td class="msource">
 448
 449                         Roo.dd.DD
 450                 &nbsp;
 451             </td>
 452         </tr>
 453
 454
 455           <tr class="method-row config-row-alt0 expandable notInherited">
 456             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 457
 458
 459             <td class="sig">
 460                 <a id="Roo.dd.DD-method-setDelta"   name=".setDelta"></a>
 461                 <div class="fixedFont">
 462                         <span class="attributes"></span><b class="itemname">setDelta</b>
 463
 464                                  (int <B><i>iDeltaX</i></B>, int <B><i>iDeltaY</i></B>)
 465
 466
 467
 468                 </div>
 469                 <div class="mdesc">
 470
 471                    <div class="short">Sets the pointer offset.</div>
 472
 473
 474
 475                     <div class="long">
 476
 477                                 Sets the pointer offset.  You can call this directly to force the<br/>offset to be in a particular location (e.g., pass in 0,0 to set it<br/>to the center of the object)
 478
 479
 480
 481
 482
 483
 484                                 <dl class="detailList">
 485                                 <dt class="heading">Parameters:</dt>
 486
 487                                         <dt>
 488                                                 <span class="fixedFont">int</span>  <b>iDeltaX</b>
 489
 490                                         </dt>
 491                                         <dd>the distance from the left</dd>
 492
 493                                         <dt>
 494                                                 <span class="fixedFont">int</span>  <b>iDeltaY</b>
 495
 496                                         </dt>
 497                                         <dd>the distance from the top</dd>
 498
 499                                 </dl>
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511                     </div>
 512                 </div>
 513
 514             </td>
 515             <td class="msource">
 516
 517                         Roo.dd.DD
 518                 &nbsp;
 519             </td>
 520         </tr>
 521
 522
 523           <tr class="method-row config-row-alt1 expandable notInherited">
 524             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 525
 526
 527             <td class="sig">
 528                 <a id="Roo.dd.DD-method-setDragElPos"   name=".setDragElPos"></a>
 529                 <div class="fixedFont">
 530                         <span class="attributes"></span><b class="itemname">setDragElPos</b>
 531
 532                                  (int <B><i>iPageX</i></B>, int <B><i>iPageY</i></B>)
 533
 534
 535
 536                 </div>
 537                 <div class="mdesc">
 538
 539                    <div class="short">Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.</div>
 540
 541
 542
 543                     <div class="long">
 544
 545                                 Sets the drag element to the location of the mousedown or click event,<br/>maintaining the cursor location relative to the location on the element<br/>that was clicked.  Override this if you want to place the element in a<br/>location other than where the cursor is.
 546
 547
 548
 549
 550
 551
 552                                 <dl class="detailList">
 553                                 <dt class="heading">Parameters:</dt>
 554
 555                                         <dt>
 556                                                 <span class="fixedFont">int</span>  <b>iPageX</b>
 557
 558                                         </dt>
 559                                         <dd>the X coordinate of the mousedown or drag event</dd>
 560
 561                                         <dt>
 562                                                 <span class="fixedFont">int</span>  <b>iPageY</b>
 563
 564                                         </dt>
 565                                         <dd>the Y coordinate of the mousedown or drag event</dd>
 566
 567                                 </dl>
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579                     </div>
 580                 </div>
 581
 582             </td>
 583             <td class="msource">
 584
 585                         Roo.dd.DD
 586                 &nbsp;
 587             </td>
 588         </tr>
 589
 590
 591     </table>
 592
 593
 594   <!-- ============================== events summary / details ======================== -->
 595
 596
 597   <a id="Roo.dd.DD-events"></a>
 598
 599
 600
 601
 602
 603      <table cellspacing="0" class="member-table">
 604       <caption class="Empty">Events - Has None</caption>
 605      </table>
 606
 607
 608
 609
 610
 611
 612
 613
 614
 615 <!-- ============================== footer ================================= -->
 616                 <div class="fineprint" style="clear:both">
 617
 618                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:11:53 GMT+0800 (HKT)
 619                         Based on
 620                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 621                 </div>
 622         </body>
 623 </html>