git.roojs.org Git - roojs1/blob - docs/symbols/Roo.Component.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.Component</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.Component-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.Component-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.Component-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.Component-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.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  47 <img src="../../images/default/s.gif" height="1"  width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.Component
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.Component
  58                         </h1>
  59
  60     <table cellspacing="0" class="class-summary-table">
  61
  62                 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
  63
  64         <tr><td class="label">Defined In:</td><td class="hd-info">
  65
  66                                         <a href="./src/Roo_Component.js.html">Roo/Component.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">Component</td></tr>
  70
  71
  72         <tr><td class="label">Subclasses:</td><td class="hd-info">
  73                 <a href="./Roo.BoxComponent.html#constructor" roo:cls="Roo.BoxComponent.html#constructor">Roo.BoxComponent</a>, <a href="./Roo.ColorPalette.html#constructor" roo:cls="Roo.ColorPalette.html#constructor">Roo.ColorPalette</a>, <a href="./Roo.DatePicker.html#constructor" roo:cls="Roo.DatePicker.html#constructor">Roo.DatePicker</a>, <a href="./Roo.Editor.html#constructor" roo:cls="Roo.Editor.html#constructor">Roo.Editor</a>, <a href="./Roo.form.Checkbox.html#constructor" roo:cls="Roo.form.Checkbox.html#constructor">Roo.form.Checkbox</a>, <a href="./Roo.form.Column.html#constructor" roo:cls="Roo.form.Column.html#constructor">Roo.form.Column</a>, <a href="./Roo.form.ComboBox.html#constructor" roo:cls="Roo.form.ComboBox.html#constructor">Roo.form.ComboBox</a>, <a href="./Roo.form.DateField.html#constructor" roo:cls="Roo.form.DateField.html#constructor">Roo.form.DateField</a>, <a href="./Roo.form.FCKeditor.html#constructor" roo:cls="Roo.form.FCKeditor.html#constructor">Roo.form.FCKeditor</a>, <a href="./Roo.form.Field.html#constructor" roo:cls="Roo.form.Field.html#constructor">Roo.form.Field</a>, <a href="./Roo.form.FieldSet.html#constructor" roo:cls="Roo.form.FieldSet.html#constructor">Roo.form.FieldSet</a>, <a href="./Roo.form.GridField.html#constructor" roo:cls="Roo.form.GridField.html#constructor">Roo.form.GridField</a>, <a href="./Roo.form.Hidden.html#constructor" roo:cls="Roo.form.Hidden.html#constructor">Roo.form.Hidden</a>, <a href="./Roo.form.Layout.html#constructor" roo:cls="Roo.form.Layout.html#constructor">Roo.form.Layout</a>, <a href="./Roo.form.NumberField.html#constructor" roo:cls="Roo.form.NumberField.html#constructor">Roo.form.NumberField</a>, <a href="./Roo.form.Radio.html#constructor" roo:cls="Roo.form.Radio.html#constructor">Roo.form.Radio</a>, <a href="./Roo.form.Row.html#constructor" roo:cls="Roo.form.Row.html#constructor">Roo.form.Row</a>, <a href="./Roo.form.TextArea.html#constructor" roo:cls="Roo.form.TextArea.html#constructor">Roo.form.TextArea</a>, <a href="./Roo.form.TextField.html#constructor" roo:cls="Roo.form.TextField.html#constructor">Roo.form.TextField</a>, <a href="./Roo.form.TriggerField.html#constructor" roo:cls="Roo.form.TriggerField.html#constructor">Roo.form.TriggerField</a>, <a href="./Roo.grid.GridEditor.html#constructor" roo:cls="Roo.grid.GridEditor.html#constructor">Roo.grid.GridEditor</a>, <a href="./Roo.menu.Adapter.html#constructor" roo:cls="Roo.menu.Adapter.html#constructor">Roo.menu.Adapter</a>, <a href="./Roo.menu.BaseItem.html#constructor" roo:cls="Roo.menu.BaseItem.html#constructor">Roo.menu.BaseItem</a>, <a href="./Roo.menu.CheckItem.html#constructor" roo:cls="Roo.menu.CheckItem.html#constructor">Roo.menu.CheckItem</a>, <a href="./Roo.menu.ColorItem.html#constructor" roo:cls="Roo.menu.ColorItem.html#constructor">Roo.menu.ColorItem</a>, <a href="./Roo.menu.DateItem.html#constructor" roo:cls="Roo.menu.DateItem.html#constructor">Roo.menu.DateItem</a>, <a href="./Roo.menu.Item.html#constructor" roo:cls="Roo.menu.Item.html#constructor">Roo.menu.Item</a>, <a href="./Roo.menu.Separator.html#constructor" roo:cls="Roo.menu.Separator.html#constructor">Roo.menu.Separator</a>, <a href="./Roo.menu.TextItem.html#constructor" roo:cls="Roo.menu.TextItem.html#constructor">Roo.menu.TextItem</a>, <a href="./Roo.tree.TreeEditor.html#constructor" roo:cls="Roo.tree.TreeEditor.html#constructor">Roo.tree.TreeEditor</a>
  74
  75
  76
  77         </td></tr>
  78
  79
  80
  81                 <tr><td class="label">Extends:</td><td class="hd-info">
  82                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  83
  84                 </td></tr>
  85
  86
  87     </table>
  88
  89
  90 <!-- ============================== class summary ========================== -->
  91     <div class="description">
  92         Base class for all major Roo components.  All subclasses of Component can automatically participate in the standard<br/>Roo component lifecycle of creation, rendering and destruction.  They also have automatic support for basic hide/show<br/>and enable/disable behavior.  Component allows any subclass to be lazy-rendered into any {<b>link</b> Roo.Container} and<br/>to be automatically registered with the {<b>link</b> Roo.ComponentMgr} so that it can be referenced at any time via {<b>link</b> Roo.getCmp}.<br/>All visual components (widgets) that require rendering into a layout should subclass Component.
  93     </div>
  94
  95
  96 <!-- ============================== Class comment block... ========================== -->
  97
  98 <div class="comments">
  99         <b>Class Comments / Notes</B> =>
 100         <u onclick="parent.CommentDialog.showCommentId = 'Roo.Component';">[Add Your comment/notes about this class]</u>
 101         <br/>
 102         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
 103                 src="/blog.php/GtkDjsComments/Roo.Component.html"></iframe>
 104 </div>
 105
 106
 107
 108 <!-- ============================== config options ========================== -->
 109
 110
 111
 112
 113     <div class="hr"></div>
 114     <a id="Roo.Component-configs"></a>
 115
 116
 117
 118
 119
 120       <table cellspacing="0" class="member-table">
 121       <caption>Config Options (Usually are also Properties)</caption>
 122
 123
 124         <tr>
 125             <th class="sig-header" colspan="2">Options</th>
 126
 127             <th class="msource-header">Defined By</th>
 128         </tr>
 129
 130
 131
 132
 133
 134                 <tr class="config-row expandable config-row-alt0 notInherited">
 135                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 136                     <td class="sig">
 137
 138                         <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
 139                         <div class="fixedFont">
 140                                 <b  class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 141
 142
 143                         </div>
 144
 145                         <div class="mdesc">
 146                             <div class="short">which property holds the element that used for  hide() / show() / disable() / enable()<br/>default is 'el'</div>
 147                         </div>
 148
 149                         <div class="mdesc">
 150                             <div class="long">which property holds the element that used for  hide() / show() / disable() / enable()<br/>default is 'el'</div>
 151                         </div>
 152
 153
 154
 155                     </td>
 156                     <td class="msource">
 157
 158                         Roo.Component
 159
 160                     </td>
 161                 </tr>
 162
 163
 164                 <tr class="config-row expandable config-row-alt1 notInherited">
 165                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 166                     <td class="sig">
 167
 168                         <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
 169                         <div class="fixedFont">
 170                                 <b  class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 171
 172
 173                         </div>
 174
 175                         <div class="mdesc">
 176                             <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
 177                         </div>
 178
 179                         <div class="mdesc">
 180                             <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
 181                         </div>
 182
 183
 184
 185                     </td>
 186                     <td class="msource">
 187
 188                         Roo.Component
 189
 190                     </td>
 191                 </tr>
 192
 193
 194                 <tr class="config-row expandable config-row-alt0 notInherited">
 195                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 196                     <td class="sig">
 197
 198                         <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
 199                         <div class="fixedFont">
 200                                 <b  class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 201
 202
 203                         </div>
 204
 205                         <div class="mdesc">
 206                             <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
 207                         </div>
 208
 209                         <div class="mdesc">
 210                             <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
 211                         </div>
 212
 213
 214
 215                     </td>
 216                     <td class="msource">
 217
 218                         Roo.Component
 219
 220                     </td>
 221                 </tr>
 222
 223
 224                 <tr class="config-row expandable config-row-alt1 notInherited">
 225                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 226                     <td class="sig">
 227
 228                         <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
 229                         <div class="fixedFont">
 230                                 <b  class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 231
 232
 233                         </div>
 234
 235                         <div class="mdesc">
 236                             <div class="short">How this component should hidden.</div>
 237                         </div>
 238
 239                         <div class="mdesc">
 240                             <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
 241                         </div>
 242
 243
 244
 245                     </td>
 246                     <td class="msource">
 247
 248                         Roo.Component
 249
 250                     </td>
 251                 </tr>
 252
 253
 254                 <tr class="config-row expandable config-row-alt0">
 255                    <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 256                     <td class="sig">
 257
 258                         <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
 259                         <div class="fixedFont">
 260                                 <b  class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
 261
 262
 263                         </div>
 264
 265                         <div class="mdesc">
 266                             <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           .</div>
 267                         </div>
 268
 269                         <div class="mdesc">
 270                             <div class="long">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/>    listeners :  { <br/>       'click' : function(e) {<br/>           ..... <br/>        } ,<br/>        .... <br/>    } <br/>  </code></pre></div>
 271                         </div>
 272
 273
 274
 275                     </td>
 276                     <td class="msource">
 277
 278                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 279
 280                     </td>
 281                 </tr>
 282
 283
 284     </table>
 285
 286
 287
 288
 289
 290
 291
 292
 293
 294   <!-- ============================== public properties ==================== -->
 295
 296
 297
 298     <a id="Roo.Component-props"></a>
 299
 300
 301
 302
 303
 304      <table cellspacing="0" class="member-table">
 305       <caption class="Empty">Public Properties - Has None</caption>
 306      </table>
 307
 308
 309
 310
 311   <!-- ============================== methods summary / details ======================== -->
 312
 313
 314   <a id="Roo.Component-methods"></a>
 315         <!-- constructor?? -->
 316
 317         <!-- static's first
 318
 319
 320         -->
 321
 322         <!-- then dynamics first -->
 323
 324
 325
 326
 327
 328
 329       <table cellspacing="0" class="member-table">
 330       <caption>Public Methods</caption>
 331         <tr>
 332             <th class="sig-header" colspan="2">Method</th>
 333             <th class="msource-header">Defined By</th>
 334
 335         </tr>
 336
 337
 338
 339
 340
 341
 342
 343           <tr class="method-row config-row-alt0 expandable notInherited">
 344             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 345
 346
 347             <td class="sig">
 348                 <a id="Roo-method-Component"   name=".Component"></a>
 349                 <div class="fixedFont">
 350                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">Component</b>
 351
 352                                  (<a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object <B><i>config</i></B>)
 353
 354
 355
 356                 </div>
 357                 <div class="mdesc">
 358
 359
 360                         <div class="short">Create a new Roo.Component</div>
 361
 362
 363                     <div class="long">
 364
 365
 366
 367                                 Create a new Roo.Component
 368
 369
 370                                 <dl class="detailList">
 371                                 <dt class="heading">Parameters:</dt>
 372
 373                                         <dt>
 374                                                 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>/String/Object</span>  <b>config</b>
 375
 376                                         </dt>
 377                                         <dd>The configuration options.  If an element is passed, it is set as the internal<br/>element and its id used as the component id.  If a string is passed, it is assumed to be the id of an existing element<br/>and is used as the component id.  Otherwise, it is assumed to be a standard config object and is applied to the component.</dd>
 378
 379                                 </dl>
 380
 381
 382
 383
 384
 385
 386
 387
 388
 389
 390
 391                     </div>
 392                 </div>
 393
 394             </td>
 395             <td class="msource">
 396                 &nbsp;
 397             </td>
 398         </tr>
 399
 400
 401           <tr class="method-row config-row-alt1 expandable">
 402             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 403
 404
 405             <td class="sig">
 406                 <a id="Roo.util.Observable-method-addEvents"   name=".addEvents"></a>
 407                 <div class="fixedFont">
 408                         <span class="attributes"></span><b class="itemname">addEvents</b>
 409
 410                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
 411
 412
 413
 414                 </div>
 415                 <div class="mdesc">
 416
 417                    <div class="short">Used to define events on this Observable</div>
 418
 419
 420
 421                     <div class="long">
 422
 423                                 Used to define events on this Observable
 424
 425
 426
 427
 428
 429
 430                                 <dl class="detailList">
 431                                 <dt class="heading">Parameters:</dt>
 432
 433                                         <dt>
 434                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>object</b>
 435
 436                                         </dt>
 437                                         <dd>The object with the events defined</dd>
 438
 439                                 </dl>
 440
 441
 442
 443
 444
 445
 446
 447
 448
 449
 450
 451                     </div>
 452                 </div>
 453
 454             </td>
 455             <td class="msource">
 456
 457                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 458                 &nbsp;
 459             </td>
 460         </tr>
 461
 462
 463           <tr class="method-row config-row-alt0 expandable">
 464             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 465
 466
 467             <td class="sig">
 468                 <a id="Roo.util.Observable-method-addListener"   name=".addListener"></a>
 469                 <div class="fixedFont">
 470                         <span class="attributes"></span><b class="itemname">addListener</b>
 471
 472                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
 473
 474
 475
 476                 </div>
 477                 <div class="mdesc">
 478
 479                    <div class="short">Appends an event handler to this component</div>
 480
 481
 482
 483                     <div class="long">
 484
 485                                 Appends an event handler to this component
 486
 487
 488
 489
 490
 491
 492                                 <dl class="detailList">
 493                                 <dt class="heading">Parameters:</dt>
 494
 495                                         <dt>
 496                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 497
 498                                         </dt>
 499                                         <dd>The type of event to listen for</dd>
 500
 501                                         <dt>
 502                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
 503
 504                                         </dt>
 505                                         <dd>The method the event invokes</dd>
 506
 507                                         <dt>
 508                                                 <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>
 509
 510                                         </dt>
 511                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
 512
 513                                         <dt>
 514                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
 515
 516                                         </dt>
 517                                         <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/>             <pre><code><br/>                el.on('click', this.onClick, this, {<br/>                       single: true,<br/>              delay: 100,<br/>                forumId: 4<br/>         });<br/>                </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/>               el.on({<br/>                    'click': {<br/>                 fn: this.onClick,<br/>                  scope: this,<br/>                       delay: 100<br/>                 }, <br/>                'mouseover': {<br/>                     fn: this.onMouseOver,<br/>                      scope: this<br/>                },<br/>                 'mouseout': {<br/>                      fn: this.onMouseOut,<br/>                       scope: this<br/>                }<br/>          });<br/>                </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/>        <pre><code><br/>                el.on({<br/>                    'click': this.onClick,<br/>             'mouseover': this.onMouseOver,<br/>             'mouseout': this.onMouseOut,<br/>               scope: this<br/>                });<br/>                </code></pre></dd>
 518
 519                                 </dl>
 520
 521
 522
 523
 524
 525
 526
 527
 528
 529
 530
 531                     </div>
 532                 </div>
 533
 534             </td>
 535             <td class="msource">
 536
 537                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 538                 &nbsp;
 539             </td>
 540         </tr>
 541
 542
 543           <tr class="method-row config-row-alt1 expandable notInherited">
 544             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 545
 546
 547             <td class="sig">
 548                 <a id="Roo.Component-method-destroy"   name=".destroy"></a>
 549                 <div class="fixedFont">
 550                         <span class="attributes"></span><b class="itemname">destroy</b>
 551
 552                                  ()
 553
 554
 555
 556                 </div>
 557                 <div class="mdesc">
 558
 559                    <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
 560
 561
 562
 563                     <div class="long">
 564
 565                                 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
 566
 567
 568
 569
 570
 571
 572
 573
 574
 575
 576
 577
 578
 579
 580
 581
 582                     </div>
 583                 </div>
 584
 585             </td>
 586             <td class="msource">
 587
 588                         Roo.Component
 589                 &nbsp;
 590             </td>
 591         </tr>
 592
 593
 594           <tr class="method-row config-row-alt0 expandable notInherited">
 595             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 596
 597
 598             <td class="sig">
 599                 <a id="Roo.Component-method-disable"   name=".disable"></a>
 600                 <div class="fixedFont">
 601                         <span class="attributes"></span><b class="itemname">disable</b>
 602
 603                                  ()
 604
 605
 606                                          :
 607
 608
 609                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 610
 611
 612
 613
 614
 615                 </div>
 616                 <div class="mdesc">
 617
 618                    <div class="short">Disable this component.</div>
 619
 620
 621
 622                     <div class="long">
 623
 624                                 Disable this component.
 625
 626
 627
 628
 629
 630
 631
 632
 633
 634
 635                                 <dl class="detailList">
 636                                 <dt class="heading">Returns:</dt>
 637
 638                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 639
 640                                 </dl>
 641
 642
 643
 644
 645
 646
 647
 648                     </div>
 649                 </div>
 650
 651             </td>
 652             <td class="msource">
 653
 654                         Roo.Component
 655                 &nbsp;
 656             </td>
 657         </tr>
 658
 659
 660           <tr class="method-row config-row-alt1 expandable notInherited">
 661             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 662
 663
 664             <td class="sig">
 665                 <a id="Roo.Component-method-enable"   name=".enable"></a>
 666                 <div class="fixedFont">
 667                         <span class="attributes"></span><b class="itemname">enable</b>
 668
 669                                  ()
 670
 671
 672                                          :
 673
 674
 675                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 676
 677
 678
 679
 680
 681                 </div>
 682                 <div class="mdesc">
 683
 684                    <div class="short">Enable this component.</div>
 685
 686
 687
 688                     <div class="long">
 689
 690                                 Enable this component.
 691
 692
 693
 694
 695
 696
 697
 698
 699
 700
 701                                 <dl class="detailList">
 702                                 <dt class="heading">Returns:</dt>
 703
 704                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 705
 706                                 </dl>
 707
 708
 709
 710
 711
 712
 713
 714                     </div>
 715                 </div>
 716
 717             </td>
 718             <td class="msource">
 719
 720                         Roo.Component
 721                 &nbsp;
 722             </td>
 723         </tr>
 724
 725
 726           <tr class="method-row config-row-alt0 expandable">
 727             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 728
 729
 730             <td class="sig">
 731                 <a id="Roo.util.Observable-method-fireEvent"   name=".fireEvent"></a>
 732                 <div class="fixedFont">
 733                         <span class="attributes"></span><b class="itemname">fireEvent</b>
 734
 735                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
 736
 737
 738                                          :
 739
 740
 741                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
 742
 743
 744
 745
 746
 747                 </div>
 748                 <div class="mdesc">
 749
 750                    <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
 751
 752
 753
 754                     <div class="long">
 755
 756                                 Fires the specified event with the passed parameters (minus the event name).
 757
 758
 759
 760
 761
 762
 763                                 <dl class="detailList">
 764                                 <dt class="heading">Parameters:</dt>
 765
 766                                         <dt>
 767                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
 768
 769                                         </dt>
 770                                         <dd></dd>
 771
 772                                         <dt>
 773                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span>  <b>args</b>
 774
 775                                         </dt>
 776                                         <dd>Variable number of parameters are passed to handlers</dd>
 777
 778                                 </dl>
 779
 780
 781
 782
 783
 784                                 <dl class="detailList">
 785                                 <dt class="heading">Returns:</dt>
 786
 787                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  returns false if any of the handlers return false otherwise it returns true</dd>
 788
 789                                 </dl>
 790
 791
 792
 793
 794
 795
 796
 797                     </div>
 798                 </div>
 799
 800             </td>
 801             <td class="msource">
 802
 803                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
 804                 &nbsp;
 805             </td>
 806         </tr>
 807
 808
 809           <tr class="method-row config-row-alt1 expandable notInherited">
 810             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 811
 812
 813             <td class="sig">
 814                 <a id="Roo.Component-method-focus"   name=".focus"></a>
 815                 <div class="fixedFont">
 816                         <span class="attributes"></span><b class="itemname">focus</b>
 817
 818                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
 819
 820
 821                                          :
 822
 823
 824                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
 825
 826
 827
 828
 829
 830                 </div>
 831                 <div class="mdesc">
 832
 833                    <div class="short">Try to focus this component.</div>
 834
 835
 836
 837                     <div class="long">
 838
 839                                 Try to focus this component.
 840
 841
 842
 843
 844
 845
 846                                 <dl class="detailList">
 847                                 <dt class="heading">Parameters:</dt>
 848
 849                                         <dt>
 850                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>selectText</b>
 851
 852                                         </dt>
 853                                         <dd>True to also select the text in this component (if applicable)</dd>
 854
 855                                 </dl>
 856
 857
 858
 859
 860
 861                                 <dl class="detailList">
 862                                 <dt class="heading">Returns:</dt>
 863
 864                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
 865
 866                                 </dl>
 867
 868
 869
 870
 871
 872
 873
 874                     </div>
 875                 </div>
 876
 877             </td>
 878             <td class="msource">
 879
 880                         Roo.Component
 881                 &nbsp;
 882             </td>
 883         </tr>
 884
 885
 886           <tr class="method-row config-row-alt0 expandable notInherited">
 887             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 888
 889
 890             <td class="sig">
 891                 <a id="Roo.Component-method-getEl"   name=".getEl"></a>
 892                 <div class="fixedFont">
 893                         <span class="attributes"></span><b class="itemname">getEl</b>
 894
 895                                  ()
 896
 897
 898                                          :
 899
 900
 901                                                 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
 902
 903
 904
 905
 906
 907                 </div>
 908                 <div class="mdesc">
 909
 910                    <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
 911
 912
 913
 914                     <div class="long">
 915
 916                                 Returns the underlying {<b>link</b> Roo.Element}.
 917
 918
 919
 920
 921
 922
 923
 924
 925
 926
 927                                 <dl class="detailList">
 928                                 <dt class="heading">Returns:</dt>
 929
 930                                         <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span>  The element</dd>
 931
 932                                 </dl>
 933
 934
 935
 936
 937
 938
 939
 940                     </div>
 941                 </div>
 942
 943             </td>
 944             <td class="msource">
 945
 946                         Roo.Component
 947                 &nbsp;
 948             </td>
 949         </tr>
 950
 951
 952           <tr class="method-row config-row-alt1 expandable notInherited">
 953             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 954
 955
 956             <td class="sig">
 957                 <a id="Roo.Component-method-getId"   name=".getId"></a>
 958                 <div class="fixedFont">
 959                         <span class="attributes"></span><b class="itemname">getId</b>
 960
 961                                  ()
 962
 963
 964                                          :
 965
 966
 967                                                 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
 968
 969
 970
 971
 972
 973                 </div>
 974                 <div class="mdesc">
 975
 976                    <div class="short">Returns the id of this component.</div>
 977
 978
 979
 980                     <div class="long">
 981
 982                                 Returns the id of this component.
 983
 984
 985
 986
 987
 988
 989
 990
 991
 992
 993                                 <dl class="detailList">
 994                                 <dt class="heading">Returns:</dt>
 995
 996                                         <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  </dd>
 997
 998                                 </dl>
 999
1000
1001
1002
1003
1004
1005
1006                     </div>
1007                 </div>
1008
1009             </td>
1010             <td class="msource">
1011
1012                         Roo.Component
1013                 &nbsp;
1014             </td>
1015         </tr>
1016
1017
1018           <tr class="method-row config-row-alt0 expandable">
1019             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1020
1021
1022             <td class="sig">
1023                 <a id="Roo.util.Observable-method-hasListener"   name=".hasListener"></a>
1024                 <div class="fixedFont">
1025                         <span class="attributes"></span><b class="itemname">hasListener</b>
1026
1027                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1028
1029
1030                                          :
1031
1032
1033                                                 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1034
1035
1036
1037
1038
1039                 </div>
1040                 <div class="mdesc">
1041
1042                    <div class="short">Checks to see if this object has any listeners for a specified event</div>
1043
1044
1045
1046                     <div class="long">
1047
1048                                 Checks to see if this object has any listeners for a specified event
1049
1050
1051
1052
1053
1054
1055                                 <dl class="detailList">
1056                                 <dt class="heading">Parameters:</dt>
1057
1058                                         <dt>
1059                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1060
1061                                         </dt>
1062                                         <dd>The name of the event to check for</dd>
1063
1064                                 </dl>
1065
1066
1067
1068
1069
1070                                 <dl class="detailList">
1071                                 <dt class="heading">Returns:</dt>
1072
1073                                         <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  True if the event is being listened for, else false</dd>
1074
1075                                 </dl>
1076
1077
1078
1079
1080
1081
1082
1083                     </div>
1084                 </div>
1085
1086             </td>
1087             <td class="msource">
1088
1089                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1090                 &nbsp;
1091             </td>
1092         </tr>
1093
1094
1095           <tr class="method-row config-row-alt1 expandable notInherited">
1096             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1097
1098
1099             <td class="sig">
1100                 <a id="Roo.Component-method-hide"   name=".hide"></a>
1101                 <div class="fixedFont">
1102                         <span class="attributes"></span><b class="itemname">hide</b>
1103
1104                                  ()
1105
1106
1107                                          :
1108
1109
1110                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1111
1112
1113
1114
1115
1116                 </div>
1117                 <div class="mdesc">
1118
1119                    <div class="short">Hide this component.</div>
1120
1121
1122
1123                     <div class="long">
1124
1125                                 Hide this component.
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136                                 <dl class="detailList">
1137                                 <dt class="heading">Returns:</dt>
1138
1139                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
1140
1141                                 </dl>
1142
1143
1144
1145
1146
1147
1148
1149                     </div>
1150                 </div>
1151
1152             </td>
1153             <td class="msource">
1154
1155                         Roo.Component
1156                 &nbsp;
1157             </td>
1158         </tr>
1159
1160
1161           <tr class="method-row config-row-alt0 expandable notInherited">
1162             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1163
1164
1165             <td class="sig">
1166                 <a id="Roo.Component-method-isVisible"   name=".isVisible"></a>
1167                 <div class="fixedFont">
1168                         <span class="attributes"></span><b class="itemname">isVisible</b>
1169
1170                                  ()
1171
1172
1173
1174                 </div>
1175                 <div class="mdesc">
1176
1177                    <div class="short">Returns true if this component is visible.</div>
1178
1179
1180
1181                     <div class="long">
1182
1183                                 Returns true if this component is visible.
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200                     </div>
1201                 </div>
1202
1203             </td>
1204             <td class="msource">
1205
1206                         Roo.Component
1207                 &nbsp;
1208             </td>
1209         </tr>
1210
1211
1212           <tr class="method-row config-row-alt1 expandable">
1213             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1214
1215
1216             <td class="sig">
1217                 <a id="Roo.util.Observable-method-on"   name=".on"></a>
1218                 <div class="fixedFont">
1219                         <span class="attributes"></span><b class="itemname">on</b>
1220
1221                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1222
1223
1224
1225                 </div>
1226                 <div class="mdesc">
1227
1228                    <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1229
1230
1231
1232                     <div class="long">
1233
1234                                 Appends an event handler to this element (shorthand for addListener)
1235
1236
1237
1238
1239
1240
1241                                 <dl class="detailList">
1242                                 <dt class="heading">Parameters:</dt>
1243
1244                                         <dt>
1245                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1246
1247                                         </dt>
1248                                         <dd>The type of event to listen for</dd>
1249
1250                                         <dt>
1251                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1252
1253                                         </dt>
1254                                         <dd>The method the event invokes</dd>
1255
1256                                         <dt>
1257                                                 <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>
1258
1259                                         </dt>
1260                                         <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1261
1262                                         <dt>
1263                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span>  <b>options</b>
1264
1265                                         </dt>
1266                                         <dd>(optional)</dd>
1267
1268                                 </dl>
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280                     </div>
1281                 </div>
1282
1283             </td>
1284             <td class="msource">
1285
1286                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1287                 &nbsp;
1288             </td>
1289         </tr>
1290
1291
1292           <tr class="method-row config-row-alt0 expandable">
1293             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1294
1295
1296             <td class="sig">
1297                 <a id="Roo.util.Observable-method-purgeListeners"   name=".purgeListeners"></a>
1298                 <div class="fixedFont">
1299                         <span class="attributes"></span><b class="itemname">purgeListeners</b>
1300
1301                                  ()
1302
1303
1304
1305                 </div>
1306                 <div class="mdesc">
1307
1308                    <div class="short">Removes all listeners for this object</div>
1309
1310
1311
1312                     <div class="long">
1313
1314                                 Removes all listeners for this object
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331                     </div>
1332                 </div>
1333
1334             </td>
1335             <td class="msource">
1336
1337                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1338                 &nbsp;
1339             </td>
1340         </tr>
1341
1342
1343           <tr class="method-row config-row-alt1 expandable">
1344             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1345
1346
1347             <td class="sig">
1348                 <a id="Roo.util.Observable-method-removeListener"   name=".removeListener"></a>
1349                 <div class="fixedFont">
1350                         <span class="attributes"></span><b class="itemname">removeListener</b>
1351
1352                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1353
1354
1355
1356                 </div>
1357                 <div class="mdesc">
1358
1359                    <div class="short">Removes a listener</div>
1360
1361
1362
1363                     <div class="long">
1364
1365                                 Removes a listener
1366
1367
1368
1369
1370
1371
1372                                 <dl class="detailList">
1373                                 <dt class="heading">Parameters:</dt>
1374
1375                                         <dt>
1376                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1377
1378                                         </dt>
1379                                         <dd>The type of event to listen for</dd>
1380
1381                                         <dt>
1382                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1383
1384                                         </dt>
1385                                         <dd>The handler to remove</dd>
1386
1387                                         <dt>
1388                                                 <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>
1389
1390                                         </dt>
1391                                         <dd>(optional) The scope (this object) for the handler</dd>
1392
1393                                 </dl>
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405                     </div>
1406                 </div>
1407
1408             </td>
1409             <td class="msource">
1410
1411                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1412                 &nbsp;
1413             </td>
1414         </tr>
1415
1416
1417           <tr class="method-row config-row-alt0 expandable notInherited">
1418             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1419
1420
1421             <td class="sig">
1422                 <a id="Roo.Component-method-render"   name=".render"></a>
1423                 <div class="fixedFont">
1424                         <span class="attributes"></span><b class="itemname">render</b>
1425
1426                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1427
1428
1429
1430                 </div>
1431                 <div class="mdesc">
1432
1433                    <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1434
1435
1436
1437                     <div class="long">
1438
1439                                 If this is a lazy rendering component, render it to its container element.
1440
1441
1442
1443
1444
1445
1446                                 <dl class="detailList">
1447                                 <dt class="heading">Parameters:</dt>
1448
1449                                         <dt>
1450                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span>  <b>container</b>
1451
1452                                         </dt>
1453                                         <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1454
1455                                 </dl>
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467                     </div>
1468                 </div>
1469
1470             </td>
1471             <td class="msource">
1472
1473                         Roo.Component
1474                 &nbsp;
1475             </td>
1476         </tr>
1477
1478
1479           <tr class="method-row config-row-alt1 expandable notInherited">
1480             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1481
1482
1483             <td class="sig">
1484                 <a id="Roo.Component-method-setDisabled"   name=".setDisabled"></a>
1485                 <div class="fixedFont">
1486                         <span class="attributes"></span><b class="itemname">setDisabled</b>
1487
1488                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1489
1490
1491
1492                 </div>
1493                 <div class="mdesc">
1494
1495                    <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1496
1497
1498
1499                     <div class="long">
1500
1501                                 Convenience function for setting disabled/enabled by boolean.
1502
1503
1504
1505
1506
1507
1508                                 <dl class="detailList">
1509                                 <dt class="heading">Parameters:</dt>
1510
1511                                         <dt>
1512                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>disabled</b>
1513
1514                                         </dt>
1515                                         <dd></dd>
1516
1517                                 </dl>
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529                     </div>
1530                 </div>
1531
1532             </td>
1533             <td class="msource">
1534
1535                         Roo.Component
1536                 &nbsp;
1537             </td>
1538         </tr>
1539
1540
1541           <tr class="method-row config-row-alt0 expandable notInherited">
1542             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1543
1544
1545             <td class="sig">
1546                 <a id="Roo.Component-method-setVisible"   name=".setVisible"></a>
1547                 <div class="fixedFont">
1548                         <span class="attributes"></span><b class="itemname">setVisible</b>
1549
1550                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1551
1552
1553                                          :
1554
1555
1556                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1557
1558
1559
1560
1561
1562                 </div>
1563                 <div class="mdesc">
1564
1565                    <div class="short">Convenience function to hide or show this component by boolean.</div>
1566
1567
1568
1569                     <div class="long">
1570
1571                                 Convenience function to hide or show this component by boolean.
1572
1573
1574
1575
1576
1577
1578                                 <dl class="detailList">
1579                                 <dt class="heading">Parameters:</dt>
1580
1581                                         <dt>
1582                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>visible</b>
1583
1584                                         </dt>
1585                                         <dd>True to show, false to hide</dd>
1586
1587                                 </dl>
1588
1589
1590
1591
1592
1593                                 <dl class="detailList">
1594                                 <dt class="heading">Returns:</dt>
1595
1596                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
1597
1598                                 </dl>
1599
1600
1601
1602
1603
1604
1605
1606                     </div>
1607                 </div>
1608
1609             </td>
1610             <td class="msource">
1611
1612                         Roo.Component
1613                 &nbsp;
1614             </td>
1615         </tr>
1616
1617
1618           <tr class="method-row config-row-alt1 expandable notInherited">
1619             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1620
1621
1622             <td class="sig">
1623                 <a id="Roo.Component-method-show"   name=".show"></a>
1624                 <div class="fixedFont">
1625                         <span class="attributes"></span><b class="itemname">show</b>
1626
1627                                  ()
1628
1629
1630                                          :
1631
1632
1633                                                 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1634
1635
1636
1637
1638
1639                 </div>
1640                 <div class="mdesc">
1641
1642                    <div class="short">Show this component.</div>
1643
1644
1645
1646                     <div class="long">
1647
1648                                 Show this component.
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659                                 <dl class="detailList">
1660                                 <dt class="heading">Returns:</dt>
1661
1662                                         <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span>  this</dd>
1663
1664                                 </dl>
1665
1666
1667
1668
1669
1670
1671
1672                     </div>
1673                 </div>
1674
1675             </td>
1676             <td class="msource">
1677
1678                         Roo.Component
1679                 &nbsp;
1680             </td>
1681         </tr>
1682
1683
1684           <tr class="method-row config-row-alt0 expandable">
1685             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1686
1687
1688             <td class="sig">
1689                 <a id="Roo.util.Observable-method-un"   name=".un"></a>
1690                 <div class="fixedFont">
1691                         <span class="attributes"></span><b class="itemname">un</b>
1692
1693                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</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>)
1694
1695
1696
1697                 </div>
1698                 <div class="mdesc">
1699
1700                    <div class="short">Removes a listener (shorthand for removeListener)</div>
1701
1702
1703
1704                     <div class="long">
1705
1706                                 Removes a listener (shorthand for removeListener)
1707
1708
1709
1710
1711
1712
1713                                 <dl class="detailList">
1714                                 <dt class="heading">Parameters:</dt>
1715
1716                                         <dt>
1717                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>eventName</b>
1718
1719                                         </dt>
1720                                         <dd>The type of event to listen for</dd>
1721
1722                                         <dt>
1723                                                 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span>  <b>handler</b>
1724
1725                                         </dt>
1726                                         <dd>The handler to remove</dd>
1727
1728                                         <dt>
1729                                                 <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>
1730
1731                                         </dt>
1732                                         <dd>(optional) The scope (this object) for the handler</dd>
1733
1734                                 </dl>
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746                     </div>
1747                 </div>
1748
1749             </td>
1750             <td class="msource">
1751
1752                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1753                 &nbsp;
1754             </td>
1755         </tr>
1756
1757
1758     </table>
1759
1760
1761   <!-- ============================== events summary / details ======================== -->
1762
1763
1764   <a id="Roo.Component-events"></a>
1765
1766
1767
1768
1769
1770
1771
1772
1773       <table cellspacing="0" class="member-table">
1774                 <caption>Events</caption>
1775               <thead>
1776                 <tr>
1777                     <th class="sig-header" colspan="2">Event</th>
1778                     <th class="msource-header">Defined By</th>
1779
1780                 </tr>
1781               </thead>
1782
1783
1784
1785
1786
1787           <tr class="method-row expandable config-row-alt0 notInherited">
1788             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1789
1790             <td class="sig">
1791                 <a id="Roo.Component-event-*beforedestroy"></a>
1792
1793                <div class="fixedFont">
1794                 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1795
1796                 </div>
1797
1798                 <div class="mdesc">
1799
1800                    <div class="short">Fires before the component is destroyed.
1801
1802                 </div>
1803
1804                     <div class="long">
1805
1806                         Fires before the component is destroyed. Return false to stop the destroy.
1807
1808
1809
1810
1811
1812                                 <dl class="detailList">
1813                                 <dt class="heading">Parameters:</dt>
1814
1815                                         <dt>
1816                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1817
1818                                         </dt>
1819                                         <dd></dd>
1820
1821                                 </dl>
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833                     </div>
1834                 </div>
1835
1836             </td>
1837             <td class="msource">
1838                 Roo.Component
1839             </td>
1840         </tr>
1841
1842           <tr class="method-row expandable config-row-alt1 notInherited">
1843             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1844
1845             <td class="sig">
1846                 <a id="Roo.Component-event-*beforehide"></a>
1847
1848                <div class="fixedFont">
1849                 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1850
1851                 </div>
1852
1853                 <div class="mdesc">
1854
1855                    <div class="short">Fires before the component is hidden.
1856
1857                 </div>
1858
1859                     <div class="long">
1860
1861                         Fires before the component is hidden. Return false to stop the hide.
1862
1863
1864
1865
1866
1867                                 <dl class="detailList">
1868                                 <dt class="heading">Parameters:</dt>
1869
1870                                         <dt>
1871                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1872
1873                                         </dt>
1874                                         <dd></dd>
1875
1876                                 </dl>
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888                     </div>
1889                 </div>
1890
1891             </td>
1892             <td class="msource">
1893                 Roo.Component
1894             </td>
1895         </tr>
1896
1897           <tr class="method-row expandable config-row-alt0 notInherited">
1898             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1899
1900             <td class="sig">
1901                 <a id="Roo.Component-event-*beforerender"></a>
1902
1903                <div class="fixedFont">
1904                 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1905
1906                 </div>
1907
1908                 <div class="mdesc">
1909
1910                    <div class="short">Fires before the component is rendered.
1911
1912                 </div>
1913
1914                     <div class="long">
1915
1916                         Fires before the component is rendered. Return false to stop the render.
1917
1918
1919
1920
1921
1922                                 <dl class="detailList">
1923                                 <dt class="heading">Parameters:</dt>
1924
1925                                         <dt>
1926                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1927
1928                                         </dt>
1929                                         <dd></dd>
1930
1931                                 </dl>
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943                     </div>
1944                 </div>
1945
1946             </td>
1947             <td class="msource">
1948                 Roo.Component
1949             </td>
1950         </tr>
1951
1952           <tr class="method-row expandable config-row-alt1 notInherited">
1953             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1954
1955             <td class="sig">
1956                 <a id="Roo.Component-event-*beforeshow"></a>
1957
1958                <div class="fixedFont">
1959                 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
1960
1961                 </div>
1962
1963                 <div class="mdesc">
1964
1965                    <div class="short">Fires before the component is shown.
1966
1967                 </div>
1968
1969                     <div class="long">
1970
1971                         Fires before the component is shown.  Return false to stop the show.
1972
1973
1974
1975
1976
1977                                 <dl class="detailList">
1978                                 <dt class="heading">Parameters:</dt>
1979
1980                                         <dt>
1981                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1982
1983                                         </dt>
1984                                         <dd></dd>
1985
1986                                 </dl>
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998                     </div>
1999                 </div>
2000
2001             </td>
2002             <td class="msource">
2003                 Roo.Component
2004             </td>
2005         </tr>
2006
2007           <tr class="method-row expandable config-row-alt0 notInherited">
2008             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2009
2010             <td class="sig">
2011                 <a id="Roo.Component-event-*destroy"></a>
2012
2013                <div class="fixedFont">
2014                 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2015
2016                 </div>
2017
2018                 <div class="mdesc">
2019
2020                    <div class="short">Fires after the component is destroyed.
2021
2022                 </div>
2023
2024                     <div class="long">
2025
2026                         Fires after the component is destroyed.
2027
2028
2029
2030
2031
2032                                 <dl class="detailList">
2033                                 <dt class="heading">Parameters:</dt>
2034
2035                                         <dt>
2036                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2037
2038                                         </dt>
2039                                         <dd></dd>
2040
2041                                 </dl>
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053                     </div>
2054                 </div>
2055
2056             </td>
2057             <td class="msource">
2058                 Roo.Component
2059             </td>
2060         </tr>
2061
2062           <tr class="method-row expandable config-row-alt1 notInherited">
2063             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2064
2065             <td class="sig">
2066                 <a id="Roo.Component-event-*disable"></a>
2067
2068                <div class="fixedFont">
2069                 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2070
2071                 </div>
2072
2073                 <div class="mdesc">
2074
2075                    <div class="short">Fires after the component is disabled.
2076
2077                 </div>
2078
2079                     <div class="long">
2080
2081                         Fires after the component is disabled.
2082
2083
2084
2085
2086
2087                                 <dl class="detailList">
2088                                 <dt class="heading">Parameters:</dt>
2089
2090                                         <dt>
2091                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2092
2093                                         </dt>
2094                                         <dd></dd>
2095
2096                                 </dl>
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108                     </div>
2109                 </div>
2110
2111             </td>
2112             <td class="msource">
2113                 Roo.Component
2114             </td>
2115         </tr>
2116
2117           <tr class="method-row expandable config-row-alt0 notInherited">
2118             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2119
2120             <td class="sig">
2121                 <a id="Roo.Component-event-*enable"></a>
2122
2123                <div class="fixedFont">
2124                 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2125
2126                 </div>
2127
2128                 <div class="mdesc">
2129
2130                    <div class="short">Fires after the component is enabled.
2131
2132                 </div>
2133
2134                     <div class="long">
2135
2136                         Fires after the component is enabled.
2137
2138
2139
2140
2141
2142                                 <dl class="detailList">
2143                                 <dt class="heading">Parameters:</dt>
2144
2145                                         <dt>
2146                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2147
2148                                         </dt>
2149                                         <dd></dd>
2150
2151                                 </dl>
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163                     </div>
2164                 </div>
2165
2166             </td>
2167             <td class="msource">
2168                 Roo.Component
2169             </td>
2170         </tr>
2171
2172           <tr class="method-row expandable config-row-alt1 notInherited">
2173             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2174
2175             <td class="sig">
2176                 <a id="Roo.Component-event-*hide"></a>
2177
2178                <div class="fixedFont">
2179                 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2180
2181                 </div>
2182
2183                 <div class="mdesc">
2184
2185                    <div class="short">Fires after the component is hidden.
2186
2187                 </div>
2188
2189                     <div class="long">
2190
2191                         Fires after the component is hidden.
2192
2193
2194
2195
2196
2197                                 <dl class="detailList">
2198                                 <dt class="heading">Parameters:</dt>
2199
2200                                         <dt>
2201                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2202
2203                                         </dt>
2204                                         <dd></dd>
2205
2206                                 </dl>
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218                     </div>
2219                 </div>
2220
2221             </td>
2222             <td class="msource">
2223                 Roo.Component
2224             </td>
2225         </tr>
2226
2227           <tr class="method-row expandable config-row-alt0 notInherited">
2228             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2229
2230             <td class="sig">
2231                 <a id="Roo.Component-event-*render"></a>
2232
2233                <div class="fixedFont">
2234                 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2235
2236                 </div>
2237
2238                 <div class="mdesc">
2239
2240                    <div class="short">Fires after the component is rendered.
2241
2242                 </div>
2243
2244                     <div class="long">
2245
2246                         Fires after the component is rendered.
2247
2248
2249
2250
2251
2252                                 <dl class="detailList">
2253                                 <dt class="heading">Parameters:</dt>
2254
2255                                         <dt>
2256                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2257
2258                                         </dt>
2259                                         <dd></dd>
2260
2261                                 </dl>
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273                     </div>
2274                 </div>
2275
2276             </td>
2277             <td class="msource">
2278                 Roo.Component
2279             </td>
2280         </tr>
2281
2282           <tr class="method-row expandable config-row-alt1 notInherited">
2283             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
2284
2285             <td class="sig">
2286                 <a id="Roo.Component-event-*show"></a>
2287
2288                <div class="fixedFont">
2289                 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2290
2291                 </div>
2292
2293                 <div class="mdesc">
2294
2295                    <div class="short">Fires after the component is shown.
2296
2297                 </div>
2298
2299                     <div class="long">
2300
2301                         Fires after the component is shown.
2302
2303
2304
2305
2306
2307                                 <dl class="detailList">
2308                                 <dt class="heading">Parameters:</dt>
2309
2310                                         <dt>
2311                                                 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2312
2313                                         </dt>
2314                                         <dd></dd>
2315
2316                                 </dl>
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328                     </div>
2329                 </div>
2330
2331             </td>
2332             <td class="msource">
2333                 Roo.Component
2334             </td>
2335         </tr>
2336
2337
2338     </table>
2339
2340
2341
2342
2343
2344 <!-- ============================== footer ================================= -->
2345                 <div class="fineprint" style="clear:both">
2346
2347                         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)
2348                         Based on
2349                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
2350                 </div>
2351         </body>
2352 </html>