git.roojs.org Git - roojs1/blob - docs/symbols/Roo.ComponentMgr.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.ComponentMgr</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.ComponentMgr-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.ComponentMgr-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.ComponentMgr-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.ComponentMgr-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.ComponentMgr
  51                         </h1>
  52
  53     <table cellspacing="0" class="class-summary-table">
  54
  55                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  56
  57         <tr><td class="label">Defined In:</td><td class="hd-info">
  58
  59                                         <a href="./src/Roo_ComponentMgr.js.html">Roo/ComponentMgr.js</a>.
  60
  61         </td></tr>
  62         <tr><td class="label">Class:</td><td class="hd-info">ComponentMgr</td></tr>
  63
  64
  65
  66
  67     </table>
  68
  69
  70 <!-- ============================== class summary ========================== -->
  71     <div class="description">
  72         Provides a common registry of all components on a page so that they can be easily accessed by component id (see {<b>link</b> Roo.getCmp}).
  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.ComponentMgr';">[Add Your comment/notes about this class]</u>
  81         <br/>
  82         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  83                 src="/blog.php/GtkDjsComments/Roo.ComponentMgr.html"></iframe>
  84 </div>
  85
  86
  87
  88 <!-- ============================== config options ========================== -->
  89
  90
  91
  92
  93     <div class="hr"></div>
  94     <a id="Roo.ComponentMgr-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.ComponentMgr-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.ComponentMgr-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.ComponentMgr-method-get"   name=".get"></a>
 168                 <div class="fixedFont">
 169                         <span class="attributes">Roo.ComponentMgr.</span><b class="itemname">get</b>
 170
 171                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>)
 172
 173
 174
 175                 </div>
 176                 <div class="mdesc">
 177
 178                    <div class="short">Returns a component by id</div>
 179
 180
 181
 182                     <div class="long">
 183
 184                                 Returns a component by id
 185
 186
 187
 188
 189
 190
 191                                 <dl class="detailList">
 192                                 <dt class="heading">Parameters:</dt>
 193
 194                                         <dt>
 195                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 196
 197                                         </dt>
 198                                         <dd>The component id</dd>
 199
 200                                 </dl>
 201
 202
 203
 204
 205
 206
 207
 208
 209
 210
 211
 212                     </div>
 213                 </div>
 214
 215             </td>
 216             <td class="msource">
 217
 218                         Roo.ComponentMgr
 219                 &nbsp;
 220             </td>
 221         </tr>
 222
 223
 224           <tr class="method-row config-row-alt1 expandable notInherited">
 225             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 226
 227
 228             <td class="sig">
 229                 <a id="Roo.ComponentMgr-method-onAvailable"   name=".onAvailable"></a>
 230                 <div class="fixedFont">
 231                         <span class="attributes">Roo.ComponentMgr.</span><b class="itemname">onAvailable</b>
 232
 233                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, Funtction <B><i>fn</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
 234
 235
 236
 237                 </div>
 238                 <div class="mdesc">
 239
 240                    <div class="short">Registers a function that will be called when a specified component is added to ComponentMgr</div>
 241
 242
 243
 244                     <div class="long">
 245
 246                                 Registers a function that will be called when a specified component is added to ComponentMgr
 247
 248
 249
 250
 251
 252
 253                                 <dl class="detailList">
 254                                 <dt class="heading">Parameters:</dt>
 255
 256                                         <dt>
 257                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 258
 259                                         </dt>
 260                                         <dd>The component id</dd>
 261
 262                                         <dt>
 263                                                 <span class="fixedFont">Funtction</span>  <b>fn</b>
 264
 265                                         </dt>
 266                                         <dd>The callback function</dd>
 267
 268                                         <dt>
 269                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>scope</b>
 270
 271                                         </dt>
 272                                         <dd>The scope of the callback</dd>
 273
 274                                 </dl>
 275
 276
 277
 278
 279
 280
 281
 282
 283
 284
 285
 286                     </div>
 287                 </div>
 288
 289             </td>
 290             <td class="msource">
 291
 292                         Roo.ComponentMgr
 293                 &nbsp;
 294             </td>
 295         </tr>
 296
 297
 298           <tr class="method-row config-row-alt0 expandable notInherited">
 299             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 300
 301
 302             <td class="sig">
 303                 <a id="Roo.ComponentMgr-method-register"   name=".register"></a>
 304                 <div class="fixedFont">
 305                         <span class="attributes">Roo.ComponentMgr.</span><b class="itemname">register</b>
 306
 307                                  (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>c</i></B>)
 308
 309
 310
 311                 </div>
 312                 <div class="mdesc">
 313
 314                    <div class="short">Registers a component.</div>
 315
 316
 317
 318                     <div class="long">
 319
 320                                 Registers a component.
 321
 322
 323
 324
 325
 326
 327                                 <dl class="detailList">
 328                                 <dt class="heading">Parameters:</dt>
 329
 330                                         <dt>
 331                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  <b>c</b>
 332
 333                                         </dt>
 334                                         <dd>The component</dd>
 335
 336                                 </dl>
 337
 338
 339
 340
 341
 342
 343
 344
 345
 346
 347
 348                     </div>
 349                 </div>
 350
 351             </td>
 352             <td class="msource">
 353
 354                         Roo.ComponentMgr
 355                 &nbsp;
 356             </td>
 357         </tr>
 358
 359
 360           <tr class="method-row config-row-alt1 expandable notInherited">
 361             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 362
 363
 364             <td class="sig">
 365                 <a id="Roo.ComponentMgr-method-unregister"   name=".unregister"></a>
 366                 <div class="fixedFont">
 367                         <span class="attributes">Roo.ComponentMgr.</span><b class="itemname">unregister</b>
 368
 369                                  (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>c</i></B>)
 370
 371
 372
 373                 </div>
 374                 <div class="mdesc">
 375
 376                    <div class="short">Unregisters a component.</div>
 377
 378
 379
 380                     <div class="long">
 381
 382                                 Unregisters a component.
 383
 384
 385
 386
 387
 388
 389                                 <dl class="detailList">
 390                                 <dt class="heading">Parameters:</dt>
 391
 392                                         <dt>
 393                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  <b>c</b>
 394
 395                                         </dt>
 396                                         <dd>The component</dd>
 397
 398                                 </dl>
 399
 400
 401
 402
 403
 404
 405
 406
 407
 408
 409
 410                     </div>
 411                 </div>
 412
 413             </td>
 414             <td class="msource">
 415
 416                         Roo.ComponentMgr
 417                 &nbsp;
 418             </td>
 419         </tr>
 420
 421
 422     </table>
 423
 424
 425   <!-- ============================== events summary / details ======================== -->
 426
 427
 428   <a id="Roo.ComponentMgr-events"></a>
 429
 430
 431
 432
 433
 434      <table cellspacing="0" class="member-table">
 435       <caption class="Empty">Events - Has None</caption>
 436      </table>
 437
 438
 439
 440
 441
 442
 443
 444
 445
 446 <!-- ============================== footer ================================= -->
 447                 <div class="fineprint" style="clear:both">
 448
 449                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Tue Jul 27 2010 11:05:06 GMT+0800 (HKT)
 450                         Based on
 451                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
 452                 </div>
 453         </body>
 454 </html>