git.roojs.org Git - roojs1/blob - docs/symbols/Roo.dd.Registry.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.Registry</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.Registry-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.dd.Registry-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.dd.Registry-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.dd.Registry-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 <!-- ============================== class title / details ============================ -->
  46
  47
  48     <h1 class="classTitle">
  49
  50                                 Class Roo.dd.Registry
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo.dd</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_dd_Registry.js.html">Roo/dd/Registry.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">Registry</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Provides easy access to all drag drop components that are registered on a page.  Items can be retrieved either<br/>directly by DOM node id, or by passing in the drag drop event that occurred and looking up the event target.
  73     </div>
  74
  75
  76 <!-- ============================== Class comment block... ========================== -->
  77
  78 <div class="comments">
  79         <b>Class Comments / Notes</B> =>
  80         <u onclick="parent.CommentDialog.showCommentId = 'Roo.dd.Registry';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo.dd" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.dd.Registry.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.dd.Registry-configs"></a>
  95
  96
  97
  98      <table cellspacing="0" class="member-table">
  99       <caption class="Empty">Config Options - Has None</caption>
 100      </table>
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113   <!-- ============================== public properties ==================== -->
 114
 115
 116
 117     <a id="Roo.dd.Registry-props"></a>
 118
 119
 120
 121
 122
 123      <table cellspacing="0" class="member-table">
 124       <caption class="Empty">Public Properties - Has None</caption>
 125      </table>
 126
 127
 128
 129
 130   <!-- ============================== methods summary / details ======================== -->
 131
 132
 133   <a id="Roo.dd.Registry-methods"></a>
 134         <!-- constructor?? -->
 135
 136         <!-- static's first
 137
 138
 139         -->
 140
 141         <!-- then dynamics first -->
 142
 143
 144
 145
 146
 147
 148       <table cellspacing="0" class="member-table">
 149       <caption>Public Methods</caption>
 150         <tr>
 151             <th class="sig-header" colspan="2">Method</th>
 152             <th class="msource-header">Defined By</th>
 153
 154         </tr>
 155
 156
 157
 158
 159
 160
 161
 162           <tr class="method-row config-row-alt0 expandable notInherited">
 163             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 164
 165
 166             <td class="sig">
 167                 <a id="Roo.dd.Registry-method-getHandle"   name=".getHandle"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandle</b>
 170
 171                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>id</i></B>)
 172
 173
 174                                          :
 175
 176
 177                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 178
 179
 180
 181
 182
 183                 </div>
 184                 <div class="mdesc">
 185
 186                    <div class="short">Returns the handle registered for a DOM Node by id</div>
 187
 188
 189
 190                     <div class="long">
 191
 192                                 Returns the handle registered for a DOM Node by id
 193
 194
 195
 196
 197
 198
 199                                 <dl class="detailList">
 200                                 <dt class="heading">Parameters:</dt>
 201
 202                                         <dt>
 203                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>id</b>
 204
 205                                         </dt>
 206                                         <dd>The DOM node or id to look up</dd>
 207
 208                                 </dl>
 209
 210
 211
 212
 213
 214                                 <dl class="detailList">
 215                                 <dt class="heading">Returns:</dt>
 216
 217                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  handle The custom handle data</dd>
 218
 219                                 </dl>
 220
 221
 222
 223
 224
 225
 226
 227                     </div>
 228                 </div>
 229
 230             </td>
 231             <td class="msource">
 232
 233                         Roo.dd.Registry
 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.Registry-method-getHandleFromEvent"   name=".getHandleFromEvent"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getHandleFromEvent</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 the handle that is registered for the DOM node that is the target of the event</div>
 264
 265
 266
 267                     <div class="long">
 268
 269                                 Returns the handle that is registered for the DOM node that is the target of the event
 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>  handle The custom handle 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.Registry
 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.Registry-method-getTarget"   name=".getTarget"></a>
 322                 <div class="fixedFont">
 323                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTarget</b>
 324
 325                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>id</i></B>)
 326
 327
 328                                          :
 329
 330
 331                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 332
 333
 334
 335
 336
 337                 </div>
 338                 <div class="mdesc">
 339
 340                    <div class="short">Returns a custom data object that is registered for a DOM node by id</div>
 341
 342
 343
 344                     <div class="long">
 345
 346                                 Returns a custom data object that is registered for a DOM node by id
 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="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>id</b>
 358
 359                                         </dt>
 360                                         <dd>The DOM node or id to look up</dd>
 361
 362                                 </dl>
 363
 364
 365
 366
 367
 368                                 <dl class="detailList">
 369                                 <dt class="heading">Returns:</dt>
 370
 371                                         <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>
 372
 373                                 </dl>
 374
 375
 376
 377
 378
 379
 380
 381                     </div>
 382                 </div>
 383
 384             </td>
 385             <td class="msource">
 386
 387                         Roo.dd.Registry
 388                 &nbsp;
 389             </td>
 390         </tr>
 391
 392
 393           <tr class="method-row config-row-alt1 expandable notInherited">
 394             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 395
 396
 397             <td class="sig">
 398                 <a id="Roo.dd.Registry-method-getTargetFromEvent"   name=".getTargetFromEvent"></a>
 399                 <div class="fixedFont">
 400                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">getTargetFromEvent</b>
 401
 402                                  (Event <B><i>e</i></B>)
 403
 404
 405                                          :
 406
 407
 408                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 409
 410
 411
 412
 413
 414                 </div>
 415                 <div class="mdesc">
 416
 417                    <div class="short">Returns a custom data object that is registered for the DOM node that is the target of the event</div>
 418
 419
 420
 421                     <div class="long">
 422
 423                                 Returns a custom data object that is registered for the DOM node that is the target of the event
 424
 425
 426
 427
 428
 429
 430                                 <dl class="detailList">
 431                                 <dt class="heading">Parameters:</dt>
 432
 433                                         <dt>
 434                                                 <span class="fixedFont">Event</span>  <b>e</b>
 435
 436                                         </dt>
 437                                         <dd>The event</dd>
 438
 439                                 </dl>
 440
 441
 442
 443
 444
 445                                 <dl class="detailList">
 446                                 <dt class="heading">Returns:</dt>
 447
 448                                         <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>
 449
 450                                 </dl>
 451
 452
 453
 454
 455
 456
 457
 458                     </div>
 459                 </div>
 460
 461             </td>
 462             <td class="msource">
 463
 464                         Roo.dd.Registry
 465                 &nbsp;
 466             </td>
 467         </tr>
 468
 469
 470           <tr class="method-row config-row-alt0 expandable notInherited">
 471             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 472
 473
 474             <td class="sig">
 475                 <a id="Roo.dd.Registry-method-register"   name=".register"></a>
 476                 <div class="fixedFont">
 477                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">register</b>
 478
 479                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>element</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>)
 480
 481
 482
 483                 </div>
 484                 <div class="mdesc">
 485
 486                    <div class="short">Register a drag drop element</div>
 487
 488
 489
 490                     <div class="long">
 491
 492                                 Register a drag drop element
 493
 494
 495
 496
 497
 498
 499                                 <dl class="detailList">
 500                                 <dt class="heading">Parameters:</dt>
 501
 502                                         <dt>
 503                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>element</b>
 504
 505                                         </dt>
 506                                         <dd>The id or DOM node to register</dd>
 507
 508                                         <dt>
 509                                                 <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>
 510
 511                                         </dt>
 512                                         <dd>(optional) A custom data object that will be passed between the elements that are involved<br/>in drag drop operations.  You can populate this object with any arbitrary properties that your own code<br/>knows how to interpret, plus there are some specific properties known to the Registry that should be<br/>populated in the data object (if applicable):<br/><pre><br/>Value      Description<br /><br/>---------  ------------------------------------------<br /><br/>handles    Array of DOM nodes that trigger dragging<br /><br/>           for the element being registered<br /><br/>isHandle   True if the element passed in triggers<br /><br/>           dragging itself, else false<br/></pre></dd>
 513
 514                                 </dl>
 515
 516
 517
 518
 519
 520
 521
 522
 523
 524
 525
 526                     </div>
 527                 </div>
 528
 529             </td>
 530             <td class="msource">
 531
 532                         Roo.dd.Registry
 533                 &nbsp;
 534             </td>
 535         </tr>
 536
 537
 538           <tr class="method-row config-row-alt1 expandable notInherited">
 539             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 540
 541
 542             <td class="sig">
 543                 <a id="Roo.dd.Registry-method-unregister"   name=".unregister"></a>
 544                 <div class="fixedFont">
 545                         <span class="attributes">Roo.dd.Registry.</span><b class="itemname">unregister</b>
 546
 547                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a> <B><i>element</i></B>)
 548
 549
 550
 551                 </div>
 552                 <div class="mdesc">
 553
 554                    <div class="short">Unregister a drag drop element</div>
 555
 556
 557
 558                     <div class="long">
 559
 560                                 Unregister a drag drop element
 561
 562
 563
 564
 565
 566
 567                                 <dl class="detailList">
 568                                 <dt class="heading">Parameters:</dt>
 569
 570                                         <dt>
 571                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>|<a href="http://www.w3.org/TR/DOM-Level-2-HTML/html.html#ID-58190037">HTMLElement</a></span>  <b>element</b>
 572
 573                                         </dt>
 574                                         <dd>The id or DOM node to unregister</dd>
 575
 576                                 </dl>
 577
 578
 579
 580
 581
 582
 583
 584
 585
 586
 587
 588                     </div>
 589                 </div>
 590
 591             </td>
 592             <td class="msource">
 593
 594                         Roo.dd.Registry
 595                 &nbsp;
 596             </td>
 597         </tr>
 598
 599
 600     </table>
 601
 602
 603   <!-- ============================== events summary / details ======================== -->
 604
 605
 606   <a id="Roo.dd.Registry-events"></a>
 607
 608
 609
 610
 611
 612      <table cellspacing="0" class="member-table">
 613       <caption class="Empty">Events - Has None</caption>
 614      </table>
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624 <!-- ============================== footer ================================= -->
 625                 <div class="fineprint" style="clear:both">
 626
 627                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:07 GMT+0800 (HKT)
 628                         Based on
 629                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 630                 </div>
 631         </body>
 632 </html>