git.roojs.org Git - roojs1/blob - docs/symbols/_global_.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 - _global_</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="#_global_-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#_global_-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#_global_-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#_global_-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                                 Built-In Class _global_
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55         <tr><td class="label">Defined In:</td><td class="hd-info">
  56
  57         </td></tr>
  58         <tr><td class="label">Class:</td><td class="hd-info">_global_</td></tr>
  59
  60
  61
  62
  63     </table>
  64
  65
  66 <!-- ============================== class summary ========================== -->
  67     <div class="description">
  68
  69     </div>
  70
  71
  72 <!-- ============================== Class comment block... ========================== -->
  73
  74 <div class="comments">
  75         <b>Class Comments / Notes</B> =>
  76         <u onclick="parent.CommentDialog.showCommentId = '_global_';">[Add Your comment/notes about this class]</u>
  77         <br/>
  78         <iframe frameborder="0"  id="comments-" style="border: none;width:100%;"
  79                 src="/blog.php/GtkDjsComments/_global_.html"></iframe>
  80 </div>
  81
  82
  83
  84 <!-- ============================== config options ========================== -->
  85
  86
  87
  88
  89     <div class="hr"></div>
  90     <a id="_global_-configs"></a>
  91
  92
  93
  94
  95
  96       <table cellspacing="0" class="member-table">
  97       <caption>Config Options (Usually are also Properties)</caption>
  98
  99
 100         <tr>
 101             <th class="sig-header" colspan="2">Options</th>
 102
 103             <th class="msource-header">Defined By</th>
 104         </tr>
 105
 106
 107
 108
 109
 110                 <tr class="config-row expandable config-row-alt0 notInherited">
 111                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 112                     <td class="sig">
 113
 114                         <a id="_global_-cfg-disabled" name=".disabled"></a>
 115                         <div class="fixedFont">
 116                                 <b  class="itemname">disabled</b> : <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a>|boolean
 117
 118
 119                         </div>
 120
 121                         <div class="mdesc">
 122                             <div class="short">If this module is disabled by some rule, return true from the funtion</div>
 123                         </div>
 124
 125                         <div class="mdesc">
 126                             <div class="long">If this module is disabled by some rule, return true from the funtion</div>
 127                         </div>
 128
 129
 130
 131                     </td>
 132                     <td class="msource">
 133
 134                         _global_
 135
 136                     </td>
 137                 </tr>
 138
 139
 140                 <tr class="config-row expandable config-row-alt1 notInherited">
 141                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 142                     <td class="sig">
 143
 144                         <a id="_global_-cfg-items" name=".items"></a>
 145                         <div class="fixedFont">
 146                                 <b  class="itemname">items</b> : <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 147
 148
 149                         </div>
 150
 151                         <div class="mdesc">
 152                             <div class="short">A single item array - the first element is the root of the tree.</div>
 153                         </div>
 154
 155                         <div class="mdesc">
 156                             <div class="long">A single item array - the first element is the root of the tree..<br/>It's done this way to stay compatible with the Xtype system...</div>
 157                         </div>
 158
 159
 160
 161                     </td>
 162                     <td class="msource">
 163
 164                         _global_
 165
 166                     </td>
 167                 </tr>
 168
 169
 170                 <tr class="config-row expandable config-row-alt0 notInherited">
 171                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 172                     <td class="sig">
 173
 174                         <a id="_global_-cfg-name" name=".name"></a>
 175                         <div class="fixedFont">
 176                                 <b  class="itemname">name</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 177
 178
 179                         </div>
 180
 181                         <div class="mdesc">
 182                             <div class="short">String to display while loading.</div>
 183                         </div>
 184
 185                         <div class="mdesc">
 186                             <div class="long">String to display while loading.</div>
 187                         </div>
 188
 189
 190
 191                     </td>
 192                     <td class="msource">
 193
 194                         _global_
 195
 196                     </td>
 197                 </tr>
 198
 199
 200                 <tr class="config-row expandable config-row-alt1 notInherited">
 201                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 202                     <td class="sig">
 203
 204                         <a id="_global_-cfg-order" name=".order"></a>
 205                         <div class="fixedFont">
 206                                 <b  class="itemname">order</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 207
 208
 209                         </div>
 210
 211                         <div class="mdesc">
 212                             <div class="short">Used to set the order in which elements are created (usefull for multiple tabs)</div>
 213                         </div>
 214
 215                         <div class="mdesc">
 216                             <div class="long">Used to set the order in which elements are created (usefull for multiple tabs)</div>
 217                         </div>
 218
 219
 220
 221                     </td>
 222                     <td class="msource">
 223
 224                         _global_
 225
 226                     </td>
 227                 </tr>
 228
 229
 230                 <tr class="config-row expandable config-row-alt0 notInherited">
 231                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 232                     <td class="sig">
 233
 234                         <a id="_global_-cfg-parent" name=".parent"></a>
 235                         <div class="fixedFont">
 236                                 <b  class="itemname">parent</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 237
 238
 239                         </div>
 240
 241                         <div class="mdesc">
 242                             <div class="short">Name of parent element which it get xtype added to.</div>
 243                         </div>
 244
 245                         <div class="mdesc">
 246                             <div class="long">Name of parent element which it get xtype added to..</div>
 247                         </div>
 248
 249
 250
 251                     </td>
 252                     <td class="msource">
 253
 254                         _global_
 255
 256                     </td>
 257                 </tr>
 258
 259
 260     </table>
 261
 262
 263
 264
 265
 266
 267
 268
 269
 270   <!-- ============================== public properties ==================== -->
 271
 272
 273
 274     <a id="_global_-props"></a>
 275
 276
 277
 278
 279
 280      <table cellspacing="0" class="member-table">
 281       <caption class="Empty">Public Properties - Has None</caption>
 282      </table>
 283
 284
 285
 286
 287   <!-- ============================== methods summary / details ======================== -->
 288
 289
 290   <a id="_global_-methods"></a>
 291         <!-- constructor?? -->
 292
 293         <!-- static's first
 294
 295
 296         -->
 297
 298         <!-- then dynamics first -->
 299
 300
 301
 302
 303
 304
 305       <table cellspacing="0" class="member-table">
 306       <caption>Public Methods</caption>
 307         <tr>
 308             <th class="sig-header" colspan="2">Method</th>
 309             <th class="msource-header">Defined By</th>
 310
 311         </tr>
 312
 313
 314
 315
 316
 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="_global_-method-build"   name=".build"></a>
 325                 <div class="fixedFont">
 326                         <span class="attributes"></span><b class="itemname">build</b>
 327
 328                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>parent</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>optional</i></B>)
 329
 330
 331
 332                 </div>
 333                 <div class="mdesc">
 334
 335                    <div class="short">Build the registered modules.</div>
 336
 337
 338
 339                     <div class="long">
 340
 341                                 Build the registered modules.
 342
 343
 344
 345
 346
 347
 348                                 <dl class="detailList">
 349                                 <dt class="heading">Parameters:</dt>
 350
 351                                         <dt>
 352                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>parent</b>
 353
 354                                         </dt>
 355                                         <dd>element.</dd>
 356
 357                                         <dt>
 358                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>optional</b>
 359
 360                                         </dt>
 361                                         <dd>method to call after module has been added.</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                         _global_
 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="_global_-method-buildOrder"   name=".buildOrder"></a>
 393                 <div class="fixedFont">
 394                         <span class="attributes"></span><b class="itemname">buildOrder</b>
 395
 396                                  ()
 397
 398
 399                                          :
 400
 401
 402                                                 <a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a>
 403
 404
 405
 406
 407
 408                 </div>
 409                 <div class="mdesc">
 410
 411                    <div class="short">make a list of modules to build.</div>
 412
 413
 414
 415                     <div class="long">
 416
 417                                 make a list of modules to build.
 418
 419
 420
 421
 422
 423
 424
 425
 426
 427
 428                                 <dl class="detailList">
 429                                 <dt class="heading">Returns:</dt>
 430
 431                                         <dd><span class="fixedFont"><a href="./Array.html#constructor" roo:cls="Array.html#constructor">Array</a></span>  list of modules.</dd>
 432
 433                                 </dl>
 434
 435
 436
 437
 438
 439
 440
 441                     </div>
 442                 </div>
 443
 444             </td>
 445             <td class="msource">
 446
 447                         _global_
 448                 &nbsp;
 449             </td>
 450         </tr>
 451
 452
 453           <tr class="method-row config-row-alt0 expandable notInherited">
 454             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 455
 456
 457             <td class="sig">
 458                 <a id="_global_-method-preBuild"   name=".preBuild"></a>
 459                 <div class="fixedFont">
 460                         <span class="attributes"></span><b class="itemname">preBuild</b>
 461
 462                                  ()
 463
 464
 465
 466                 </div>
 467                 <div class="mdesc">
 468
 469                    <div class="short">move modules into their correct place in the tree.</div>
 470
 471
 472
 473                     <div class="long">
 474
 475                                 move modules into their correct place in the tree..
 476
 477
 478
 479
 480
 481
 482
 483
 484
 485
 486
 487
 488
 489
 490
 491
 492                     </div>
 493                 </div>
 494
 495             </td>
 496             <td class="msource">
 497
 498                         _global_
 499                 &nbsp;
 500             </td>
 501         </tr>
 502
 503
 504           <tr class="method-row config-row-alt1 expandable notInherited">
 505             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 506
 507
 508             <td class="sig">
 509                 <a id="_global_-method-register"   name=".register"></a>
 510                 <div class="fixedFont">
 511                         <span class="attributes"></span><b class="itemname">register</b>
 512
 513                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>details</i></B>)
 514
 515
 516
 517                 </div>
 518                 <div class="mdesc">
 519
 520                    <div class="short">Register components to be built later.</div>
 521
 522
 523
 524                     <div class="long">
 525
 526                                 Register components to be built later.
 527
 528
 529
 530
 531
 532
 533                                 <dl class="detailList">
 534                                 <dt class="heading">Parameters:</dt>
 535
 536                                         <dt>
 537                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>details</b>
 538
 539                                         </dt>
 540                                         <dd>about module<br/><br/>This solves the following issues<br/>- Building is not done on page load, but after an authentication process has occured.<br/>- Interface elements are registered on page load<br/>- Parent Interface elements may not be loaded before child, so this handles that..<br/><br/><br/>example:<br/><br/>MyApp.register({<br/>          order : '000001',<br/>          module : 'Pman.Tab.projectMgr',<br/>          region : 'center',<br/>          parent : 'Pman.layout',<br/>          disabled : false,  // or use a function..<br/>        })</dd>
 541
 542                                 </dl>
 543
 544
 545
 546
 547
 548
 549
 550
 551
 552
 553
 554                     </div>
 555                 </div>
 556
 557             </td>
 558             <td class="msource">
 559
 560                         _global_
 561                 &nbsp;
 562             </td>
 563         </tr>
 564
 565
 566           <tr class="method-row config-row-alt0 expandable notInherited">
 567             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 568
 569
 570             <td class="sig">
 571                 <a id="_global_-method-toObject"   name=".toObject"></a>
 572                 <div class="fixedFont">
 573                         <span class="attributes"></span><b class="itemname">toObject</b>
 574
 575                                  ()
 576
 577
 578
 579                 </div>
 580                 <div class="mdesc">
 581
 582                    <div class="short">convert a string to an object.</div>
 583
 584
 585
 586                     <div class="long">
 587
 588                                 convert a string to an object..
 589
 590
 591
 592
 593
 594
 595
 596
 597
 598
 599
 600
 601
 602
 603
 604
 605                     </div>
 606                 </div>
 607
 608             </td>
 609             <td class="msource">
 610
 611                         _global_
 612                 &nbsp;
 613             </td>
 614         </tr>
 615
 616
 617     </table>
 618
 619
 620   <!-- ============================== events summary / details ======================== -->
 621
 622
 623   <a id="_global_-events"></a>
 624
 625
 626
 627
 628
 629      <table cellspacing="0" class="member-table">
 630       <caption class="Empty">Events - Has None</caption>
 631      </table>
 632
 633
 634
 635
 636
 637
 638
 639
 640
 641 <!-- ============================== footer ================================= -->
 642                 <div class="fineprint" style="clear:both">
 643
 644                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:09 GMT+0800 (HKT)
 645                         Based on
 646                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 647                 </div>
 648         </body>
 649 </html>