git.roojs.org Git - roojs1/blob - docs/symbols/Roo.TabPanel.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.TabPanel</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.TabPanel-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
  35         <a class="inner-link" href="#Roo.TabPanel-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
  36         <a class="inner-link" href="#Roo.TabPanel-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
  37         <a class="inner-link" href="#Roo.TabPanel-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.TabPanel
  48
  49                    </pre>
  50                 </div>
  51
  52 <!-- ============================== class title / details ============================ -->
  53
  54
  55     <h1 class="classTitle">
  56
  57                                 Class Roo.TabPanel
  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_TabPanel.js.html">Roo/TabPanel.js</a>.
  67
  68         </td></tr>
  69         <tr><td class="label">Class:</td><td class="hd-info">TabPanel</td></tr>
  70
  71
  72
  73
  74                 <tr><td class="label">Extends:</td><td class="hd-info">
  75                         <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
  76
  77                 </td></tr>
  78
  79
  80     </table>
  81
  82
  83 <!-- ============================== class summary ========================== -->
  84     <div class="description">
  85         A lightweight tab container.<br/><br><br><br/>Usage:<br/><pre><code><br/>// basic tabs 1, built from existing content<br/>var tabs = new Roo.TabPanel("tabs1");<br/>tabs.addTab("script", "View Script");<br/>tabs.addTab("markup", "View Markup");<br/>tabs.activate("script");<br/><br/>// more advanced tabs, built from javascript<br/>var jtabs = new Roo.TabPanel("jtabs");<br/>jtabs.addTab("jtabs-1", "Normal Tab", "My content was added during construction.");<br/><br/>// set up the UpdateManager<br/>var tab2 = jtabs.addTab("jtabs-2", "Ajax Tab 1");<br/>var updater = tab2.getUpdateManager();<br/>updater.setDefaultUrl("ajax1.htm");<br/>tab2.on('activate', updater.refresh, updater, true);<br/><br/>// Use setUrl for Ajax loading<br/>var tab3 = jtabs.addTab("jtabs-3", "Ajax Tab 2");<br/>tab3.setUrl("ajax2.htm", null, true);<br/><br/>// Disabled tab<br/>var tab4 = jtabs.addTab("tabs1-5", "Disabled Tab", "Can't see me cause I'm disabled");<br/>tab4.disable();<br/><br/>jtabs.activate("jtabs-1");<br/></code></pre>
  86     </div>
  87
  88
  89 <!-- ============================== Class comment block... ========================== -->
  90
  91 <div class="comments">
  92         <b>Class Comments / Notes</B> =>
  93         <u onclick="parent.CommentDialog.showCommentId = 'Roo.TabPanel';">[Add Your comment/notes about this class]</u>
  94         <br/>
  95         <iframe frameborder="0"  id="comments-Roo" style="border: none;width:100%;"
  96                 src="/blog.php/GtkDjsComments/Roo.TabPanel.html"></iframe>
  97 </div>
  98
  99
 100
 101 <!-- ============================== config options ========================== -->
 102
 103
 104
 105
 106     <div class="hr"></div>
 107     <a id="Roo.TabPanel-configs"></a>
 108
 109
 110
 111      <table cellspacing="0" class="member-table">
 112       <caption class="Empty">Config Options - Has None</caption>
 113      </table>
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126   <!-- ============================== public properties ==================== -->
 127
 128
 129
 130     <a id="Roo.TabPanel-props"></a>
 131
 132
 133
 134
 135
 136      <table cellspacing="0" class="member-table">
 137       <caption class="Empty">Public Properties - Has None</caption>
 138      </table>
 139
 140
 141
 142
 143   <!-- ============================== methods summary / details ======================== -->
 144
 145
 146   <a id="Roo.TabPanel-methods"></a>
 147         <!-- constructor?? -->
 148
 149         <!-- static's first
 150
 151
 152         -->
 153
 154         <!-- then dynamics first -->
 155
 156
 157
 158
 159
 160
 161       <table cellspacing="0" class="member-table">
 162       <caption>Public Methods</caption>
 163         <tr>
 164             <th class="sig-header" colspan="2">Method</th>
 165             <th class="msource-header">Defined By</th>
 166
 167         </tr>
 168
 169
 170
 171
 172
 173
 174
 175           <tr class="method-row config-row-alt0 expandable notInherited">
 176             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 177
 178
 179             <td class="sig">
 180                 <a id="Roo-method-TabPanel"   name=".TabPanel"></a>
 181                 <div class="fixedFont">
 182                         <span class="attributes">new <B>Roo.</B></span><b class="itemname">TabPanel</b>
 183
 184                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>container</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Boolean <B><i>config</i></B>)
 185
 186
 187
 188                 </div>
 189                 <div class="mdesc">
 190
 191
 192                         <div class="short">Create a new Roo.TabPanel</div>
 193
 194
 195                     <div class="long">
 196
 197
 198
 199                                 Create a new Roo.TabPanel
 200
 201
 202                                 <dl class="detailList">
 203                                 <dt class="heading">Parameters:</dt>
 204
 205                                         <dt>
 206                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span>  <b>container</b>
 207
 208                                         </dt>
 209                                         <dd>The id, DOM element or Roo.Element container where this TabPanel is to be rendered.</dd>
 210
 211                                         <dt>
 212                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>/Boolean</span>  <b>config</b>
 213
 214                                         </dt>
 215                                         <dd>Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.</dd>
 216
 217                                 </dl>
 218
 219
 220
 221
 222
 223
 224
 225
 226
 227
 228
 229                     </div>
 230                 </div>
 231
 232             </td>
 233             <td class="msource">
 234                 &nbsp;
 235             </td>
 236         </tr>
 237
 238
 239           <tr class="method-row config-row-alt1 expandable notInherited">
 240             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 241
 242
 243             <td class="sig">
 244                 <a id="Roo.TabPanel-method-activate"   name=".activate"></a>
 245                 <div class="fixedFont">
 246                         <span class="attributes"></span><b class="itemname">activate</b>
 247
 248                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
 249
 250
 251                                          :
 252
 253
 254                                                 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
 255
 256
 257
 258
 259
 260                 </div>
 261                 <div class="mdesc">
 262
 263                    <div class="short">Activates a {<b>link</b> Roo.TabPanelItem}.</div>
 264
 265
 266
 267                     <div class="long">
 268
 269                                 Activates a {<b>link</b> Roo.TabPanelItem}. The currently active one will be deactivated.
 270
 271
 272
 273
 274
 275
 276                                 <dl class="detailList">
 277                                 <dt class="heading">Parameters:</dt>
 278
 279                                         <dt>
 280                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
 281
 282                                         </dt>
 283                                         <dd>The id or index of the TabPanelItem to activate.</dd>
 284
 285                                 </dl>
 286
 287
 288
 289
 290
 291                                 <dl class="detailList">
 292                                 <dt class="heading">Returns:</dt>
 293
 294                                         <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span>  The TabPanelItem.</dd>
 295
 296                                 </dl>
 297
 298
 299
 300
 301
 302
 303
 304                     </div>
 305                 </div>
 306
 307             </td>
 308             <td class="msource">
 309
 310                         Roo.TabPanel
 311                 &nbsp;
 312             </td>
 313         </tr>
 314
 315
 316           <tr class="method-row config-row-alt0 expandable notInherited">
 317             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 318
 319
 320             <td class="sig">
 321                 <a id="Roo.TabPanel-method-addTab"   name=".addTab"></a>
 322                 <div class="fixedFont">
 323                         <span class="attributes"></span><b class="itemname">addTab</b>
 324
 325                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>id</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>content</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>closable</i></B>)
 326
 327
 328                                          :
 329
 330
 331                                                 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
 332
 333
 334
 335
 336
 337                 </div>
 338                 <div class="mdesc">
 339
 340                    <div class="short">Creates a new {<b>link</b> Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.</div>
 341
 342
 343
 344                     <div class="long">
 345
 346                                 Creates a new {<b>link</b> Roo.TabPanelItem} by looking for an existing element with the provided id -- if it's not found it creates one.
 347
 348
 349
 350
 351
 352
 353                                 <dl class="detailList">
 354                                 <dt class="heading">Parameters:</dt>
 355
 356                                         <dt>
 357                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>id</b>
 358
 359                                         </dt>
 360                                         <dd>The id of the div to use <b>or create</b></dd>
 361
 362                                         <dt>
 363                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>text</b>
 364
 365                                         </dt>
 366                                         <dd>The text for the tab</dd>
 367
 368                                         <dt>
 369                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span>  <b>content</b>
 370
 371                                         </dt>
 372                                         <dd>(optional) Content to put in the TabPanelItem body</dd>
 373
 374                                         <dt>
 375                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>closable</b>
 376
 377                                         </dt>
 378                                         <dd>(optional) True to create a close icon on the tab</dd>
 379
 380                                 </dl>
 381
 382
 383
 384
 385
 386                                 <dl class="detailList">
 387                                 <dt class="heading">Returns:</dt>
 388
 389                                         <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span>  The created TabPanelItem</dd>
 390
 391                                 </dl>
 392
 393
 394
 395
 396
 397
 398
 399                     </div>
 400                 </div>
 401
 402             </td>
 403             <td class="msource">
 404
 405                         Roo.TabPanel
 406                 &nbsp;
 407             </td>
 408         </tr>
 409
 410
 411           <tr class="method-row config-row-alt1 expandable notInherited">
 412             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 413
 414
 415             <td class="sig">
 416                 <a id="Roo.TabPanel-method-addTabItem"   name=".addTabItem"></a>
 417                 <div class="fixedFont">
 418                         <span class="attributes"></span><b class="itemname">addTabItem</b>
 419
 420                                  (<a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>item</i></B>)
 421
 422
 423
 424                 </div>
 425                 <div class="mdesc">
 426
 427                    <div class="short">Adds an existing {<b>link</b> Roo.TabPanelItem}.</div>
 428
 429
 430
 431                     <div class="long">
 432
 433                                 Adds an existing {<b>link</b> Roo.TabPanelItem}.
 434
 435
 436
 437
 438
 439
 440                                 <dl class="detailList">
 441                                 <dt class="heading">Parameters:</dt>
 442
 443                                         <dt>
 444                                                 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span>  <b>item</b>
 445
 446                                         </dt>
 447                                         <dd>The TabPanelItem to add</dd>
 448
 449                                 </dl>
 450
 451
 452
 453
 454
 455
 456
 457
 458
 459
 460
 461                     </div>
 462                 </div>
 463
 464             </td>
 465             <td class="msource">
 466
 467                         Roo.TabPanel
 468                 &nbsp;
 469             </td>
 470         </tr>
 471
 472
 473           <tr class="method-row config-row-alt0 expandable notInherited">
 474             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 475
 476
 477             <td class="sig">
 478                 <a id="Roo.TabPanel-method-autoSizeTabs"   name=".autoSizeTabs"></a>
 479                 <div class="fixedFont">
 480                         <span class="attributes"></span><b class="itemname">autoSizeTabs</b>
 481
 482                                  ()
 483
 484
 485
 486                 </div>
 487                 <div class="mdesc">
 488
 489                    <div class="short">Manual call to resize the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
 490
 491
 492
 493                     <div class="long">
 494
 495                                 Manual call to resize the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
 496
 497
 498
 499
 500
 501
 502
 503
 504
 505
 506
 507
 508
 509
 510
 511
 512                     </div>
 513                 </div>
 514
 515             </td>
 516             <td class="msource">
 517
 518                         Roo.TabPanel
 519                 &nbsp;
 520             </td>
 521         </tr>
 522
 523
 524           <tr class="method-row config-row-alt1 expandable notInherited">
 525             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 526
 527
 528             <td class="sig">
 529                 <a id="Roo.TabPanel-method-beginUpdate"   name=".beginUpdate"></a>
 530                 <div class="fixedFont">
 531                         <span class="attributes"></span><b class="itemname">beginUpdate</b>
 532
 533                                  ()
 534
 535
 536
 537                 </div>
 538                 <div class="mdesc">
 539
 540                    <div class="short">Disables tab resizing while tabs are being added (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
 541
 542
 543
 544                     <div class="long">
 545
 546                                 Disables tab resizing while tabs are being added (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
 547
 548
 549
 550
 551
 552
 553
 554
 555
 556
 557
 558
 559
 560
 561
 562
 563                     </div>
 564                 </div>
 565
 566             </td>
 567             <td class="msource">
 568
 569                         Roo.TabPanel
 570                 &nbsp;
 571             </td>
 572         </tr>
 573
 574
 575           <tr class="method-row config-row-alt0 expandable notInherited">
 576             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 577
 578
 579             <td class="sig">
 580                 <a id="Roo.TabPanel-method-destroy"   name=".destroy"></a>
 581                 <div class="fixedFont">
 582                         <span class="attributes"></span><b class="itemname">destroy</b>
 583
 584                                  (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
 585
 586
 587
 588                 </div>
 589                 <div class="mdesc">
 590
 591                    <div class="short">Destroys this TabPanel</div>
 592
 593
 594
 595                     <div class="long">
 596
 597                                 Destroys this TabPanel
 598
 599
 600
 601
 602
 603
 604                                 <dl class="detailList">
 605                                 <dt class="heading">Parameters:</dt>
 606
 607                                         <dt>
 608                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span>  <b>removeEl</b>
 609
 610                                         </dt>
 611                                         <dd>(optional) True to remove the element from the DOM as well (defaults to undefined)</dd>
 612
 613                                 </dl>
 614
 615
 616
 617
 618
 619
 620
 621
 622
 623
 624
 625                     </div>
 626                 </div>
 627
 628             </td>
 629             <td class="msource">
 630
 631                         Roo.TabPanel
 632                 &nbsp;
 633             </td>
 634         </tr>
 635
 636
 637           <tr class="method-row config-row-alt1 expandable notInherited">
 638             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 639
 640
 641             <td class="sig">
 642                 <a id="Roo.TabPanel-method-disableTab"   name=".disableTab"></a>
 643                 <div class="fixedFont">
 644                         <span class="attributes"></span><b class="itemname">disableTab</b>
 645
 646                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
 647
 648
 649
 650                 </div>
 651                 <div class="mdesc">
 652
 653                    <div class="short">Disables a {<b>link</b> Roo.TabPanelItem}.</div>
 654
 655
 656
 657                     <div class="long">
 658
 659                                 Disables a {<b>link</b> Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.
 660
 661
 662
 663
 664
 665
 666                                 <dl class="detailList">
 667                                 <dt class="heading">Parameters:</dt>
 668
 669                                         <dt>
 670                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
 671
 672                                         </dt>
 673                                         <dd>The id or index of the TabPanelItem to disable.</dd>
 674
 675                                 </dl>
 676
 677
 678
 679
 680
 681
 682
 683
 684
 685
 686
 687                     </div>
 688                 </div>
 689
 690             </td>
 691             <td class="msource">
 692
 693                         Roo.TabPanel
 694                 &nbsp;
 695             </td>
 696         </tr>
 697
 698
 699           <tr class="method-row config-row-alt0 expandable notInherited">
 700             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 701
 702
 703             <td class="sig">
 704                 <a id="Roo.TabPanel-method-enableTab"   name=".enableTab"></a>
 705                 <div class="fixedFont">
 706                         <span class="attributes"></span><b class="itemname">enableTab</b>
 707
 708                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
 709
 710
 711
 712                 </div>
 713                 <div class="mdesc">
 714
 715                    <div class="short">Enables a {<b>link</b> Roo.TabPanelItem} that is disabled.</div>
 716
 717
 718
 719                     <div class="long">
 720
 721                                 Enables a {<b>link</b> Roo.TabPanelItem} that is disabled.
 722
 723
 724
 725
 726
 727
 728                                 <dl class="detailList">
 729                                 <dt class="heading">Parameters:</dt>
 730
 731                                         <dt>
 732                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
 733
 734                                         </dt>
 735                                         <dd>The id or index of the TabPanelItem to enable.</dd>
 736
 737                                 </dl>
 738
 739
 740
 741
 742
 743
 744
 745
 746
 747
 748
 749                     </div>
 750                 </div>
 751
 752             </td>
 753             <td class="msource">
 754
 755                         Roo.TabPanel
 756                 &nbsp;
 757             </td>
 758         </tr>
 759
 760
 761           <tr class="method-row config-row-alt1 expandable notInherited">
 762             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 763
 764
 765             <td class="sig">
 766                 <a id="Roo.TabPanel-method-endUpdate"   name=".endUpdate"></a>
 767                 <div class="fixedFont">
 768                         <span class="attributes"></span><b class="itemname">endUpdate</b>
 769
 770                                  ()
 771
 772
 773
 774                 </div>
 775                 <div class="mdesc">
 776
 777                    <div class="short">Stops an update and resizes the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
 778
 779
 780
 781                     <div class="long">
 782
 783                                 Stops an update and resizes the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
 784
 785
 786
 787
 788
 789
 790
 791
 792
 793
 794
 795
 796
 797
 798
 799
 800                     </div>
 801                 </div>
 802
 803             </td>
 804             <td class="msource">
 805
 806                         Roo.TabPanel
 807                 &nbsp;
 808             </td>
 809         </tr>
 810
 811
 812           <tr class="method-row config-row-alt0 expandable notInherited">
 813             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 814
 815
 816             <td class="sig">
 817                 <a id="Roo.TabPanel-method-getActiveTab"   name=".getActiveTab"></a>
 818                 <div class="fixedFont">
 819                         <span class="attributes"></span><b class="itemname">getActiveTab</b>
 820
 821                                  ()
 822
 823
 824                                          :
 825
 826
 827                                                 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
 828
 829
 830
 831
 832
 833                 </div>
 834                 <div class="mdesc">
 835
 836                    <div class="short">Gets the active {<b>link</b> Roo.TabPanelItem}.</div>
 837
 838
 839
 840                     <div class="long">
 841
 842                                 Gets the active {<b>link</b> Roo.TabPanelItem}.
 843
 844
 845
 846
 847
 848
 849
 850
 851
 852
 853                                 <dl class="detailList">
 854                                 <dt class="heading">Returns:</dt>
 855
 856                                         <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span>  The active TabPanelItem or null if none are active.</dd>
 857
 858                                 </dl>
 859
 860
 861
 862
 863
 864
 865
 866                     </div>
 867                 </div>
 868
 869             </td>
 870             <td class="msource">
 871
 872                         Roo.TabPanel
 873                 &nbsp;
 874             </td>
 875         </tr>
 876
 877
 878           <tr class="method-row config-row-alt1 expandable notInherited">
 879             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 880
 881
 882             <td class="sig">
 883                 <a id="Roo.TabPanel-method-getCount"   name=".getCount"></a>
 884                 <div class="fixedFont">
 885                         <span class="attributes"></span><b class="itemname">getCount</b>
 886
 887                                  ()
 888
 889
 890                                          :
 891
 892
 893                                                 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
 894
 895
 896
 897
 898
 899                 </div>
 900                 <div class="mdesc">
 901
 902                    <div class="short">Returns the number of tabs in this TabPanel.</div>
 903
 904
 905
 906                     <div class="long">
 907
 908                                 Returns the number of tabs in this TabPanel.
 909
 910
 911
 912
 913
 914
 915
 916
 917
 918
 919                                 <dl class="detailList">
 920                                 <dt class="heading">Returns:</dt>
 921
 922                                         <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  </dd>
 923
 924                                 </dl>
 925
 926
 927
 928
 929
 930
 931
 932                     </div>
 933                 </div>
 934
 935             </td>
 936             <td class="msource">
 937
 938                         Roo.TabPanel
 939                 &nbsp;
 940             </td>
 941         </tr>
 942
 943
 944           <tr class="method-row config-row-alt0 expandable notInherited">
 945             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
 946
 947
 948             <td class="sig">
 949                 <a id="Roo.TabPanel-method-getTab"   name=".getTab"></a>
 950                 <div class="fixedFont">
 951                         <span class="attributes"></span><b class="itemname">getTab</b>
 952
 953                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
 954
 955
 956                                          :
 957
 958
 959                                                 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
 960
 961
 962
 963
 964
 965                 </div>
 966                 <div class="mdesc">
 967
 968                    <div class="short">Returns the {<b>link</b> Roo.TabPanelItem} with the specified id/index</div>
 969
 970
 971
 972                     <div class="long">
 973
 974                                 Returns the {<b>link</b> Roo.TabPanelItem} with the specified id/index
 975
 976
 977
 978
 979
 980
 981                                 <dl class="detailList">
 982                                 <dt class="heading">Parameters:</dt>
 983
 984                                         <dt>
 985                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
 986
 987                                         </dt>
 988                                         <dd>The id or index of the TabPanelItem to fetch.</dd>
 989
 990                                 </dl>
 991
 992
 993
 994
 995
 996                                 <dl class="detailList">
 997                                 <dt class="heading">Returns:</dt>
 998
 999                                         <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span>  </dd>
1000
1001                                 </dl>
1002
1003
1004
1005
1006
1007
1008
1009                     </div>
1010                 </div>
1011
1012             </td>
1013             <td class="msource">
1014
1015                         Roo.TabPanel
1016                 &nbsp;
1017             </td>
1018         </tr>
1019
1020
1021           <tr class="method-row config-row-alt1 expandable notInherited">
1022             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1023
1024
1025             <td class="sig">
1026                 <a id="Roo.TabPanel-method-hideTab"   name=".hideTab"></a>
1027                 <div class="fixedFont">
1028                         <span class="attributes"></span><b class="itemname">hideTab</b>
1029
1030                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1031
1032
1033
1034                 </div>
1035                 <div class="mdesc">
1036
1037                    <div class="short">Hides the {<b>link</b> Roo.TabPanelItem} with the specified id/index</div>
1038
1039
1040
1041                     <div class="long">
1042
1043                                 Hides the {<b>link</b> Roo.TabPanelItem} with the specified id/index
1044
1045
1046
1047
1048
1049
1050                                 <dl class="detailList">
1051                                 <dt class="heading">Parameters:</dt>
1052
1053                                         <dt>
1054                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
1055
1056                                         </dt>
1057                                         <dd>The id or index of the TabPanelItem to hide.</dd>
1058
1059                                 </dl>
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071                     </div>
1072                 </div>
1073
1074             </td>
1075             <td class="msource">
1076
1077                         Roo.TabPanel
1078                 &nbsp;
1079             </td>
1080         </tr>
1081
1082
1083           <tr class="method-row config-row-alt0 expandable notInherited">
1084             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1085
1086
1087             <td class="sig">
1088                 <a id="Roo.TabPanel-method-removeTab"   name=".removeTab"></a>
1089                 <div class="fixedFont">
1090                         <span class="attributes"></span><b class="itemname">removeTab</b>
1091
1092                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1093
1094
1095
1096                 </div>
1097                 <div class="mdesc">
1098
1099                    <div class="short">Removes a {<b>link</b> Roo.TabPanelItem}.</div>
1100
1101
1102
1103                     <div class="long">
1104
1105                                 Removes a {<b>link</b> Roo.TabPanelItem}.
1106
1107
1108
1109
1110
1111
1112                                 <dl class="detailList">
1113                                 <dt class="heading">Parameters:</dt>
1114
1115                                         <dt>
1116                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
1117
1118                                         </dt>
1119                                         <dd>The id or index of the TabPanelItem to remove.</dd>
1120
1121                                 </dl>
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133                     </div>
1134                 </div>
1135
1136             </td>
1137             <td class="msource">
1138
1139                         Roo.TabPanel
1140                 &nbsp;
1141             </td>
1142         </tr>
1143
1144
1145           <tr class="method-row config-row-alt1 expandable notInherited">
1146             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1147
1148
1149             <td class="sig">
1150                 <a id="Roo.TabPanel-method-setTabWidth"   name=".setTabWidth"></a>
1151                 <div class="fixedFont">
1152                         <span class="attributes"></span><b class="itemname">setTabWidth</b>
1153
1154                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>The</i></B>)
1155
1156
1157
1158                 </div>
1159                 <div class="mdesc">
1160
1161                    <div class="short">Resizes all the tabs to the passed width</div>
1162
1163
1164
1165                     <div class="long">
1166
1167                                 Resizes all the tabs to the passed width
1168
1169
1170
1171
1172
1173
1174                                 <dl class="detailList">
1175                                 <dt class="heading">Parameters:</dt>
1176
1177                                         <dt>
1178                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>The</b>
1179
1180                                         </dt>
1181                                         <dd>new width</dd>
1182
1183                                 </dl>
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195                     </div>
1196                 </div>
1197
1198             </td>
1199             <td class="msource">
1200
1201                         Roo.TabPanel
1202                 &nbsp;
1203             </td>
1204         </tr>
1205
1206
1207           <tr class="method-row config-row-alt0 expandable notInherited">
1208             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1209
1210
1211             <td class="sig">
1212                 <a id="Roo.TabPanel-method-syncHeight"   name=".syncHeight"></a>
1213                 <div class="fixedFont">
1214                         <span class="attributes"></span><b class="itemname">syncHeight</b>
1215
1216                                  (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>targetHeight</i></B>)
1217
1218
1219
1220                 </div>
1221                 <div class="mdesc">
1222
1223                    <div class="short">Updates the tab body element to fit the height of the container element<br/>for overflow scrolling</div>
1224
1225
1226
1227                     <div class="long">
1228
1229                                 Updates the tab body element to fit the height of the container element<br/>for overflow scrolling
1230
1231
1232
1233
1234
1235
1236                                 <dl class="detailList">
1237                                 <dt class="heading">Parameters:</dt>
1238
1239                                         <dt>
1240                                                 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span>  <b>targetHeight</b>
1241
1242                                         </dt>
1243                                         <dd>(optional) Override the starting height from the elements height</dd>
1244
1245                                 </dl>
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257                     </div>
1258                 </div>
1259
1260             </td>
1261             <td class="msource">
1262
1263                         Roo.TabPanel
1264                 &nbsp;
1265             </td>
1266         </tr>
1267
1268
1269           <tr class="method-row config-row-alt1 expandable notInherited">
1270             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1271
1272
1273             <td class="sig">
1274                 <a id="Roo.TabPanel-method-unhideTab"   name=".unhideTab"></a>
1275                 <div class="fixedFont">
1276                         <span class="attributes"></span><b class="itemname">unhideTab</b>
1277
1278                                  (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1279
1280
1281
1282                 </div>
1283                 <div class="mdesc">
1284
1285                    <div class="short">"Unhides" the {<b>link</b> Roo.TabPanelItem} with the specified id/index.</div>
1286
1287
1288
1289                     <div class="long">
1290
1291                                 "Unhides" the {<b>link</b> Roo.TabPanelItem} with the specified id/index.
1292
1293
1294
1295
1296
1297
1298                                 <dl class="detailList">
1299                                 <dt class="heading">Parameters:</dt>
1300
1301                                         <dt>
1302                                                 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span>  <b>id</b>
1303
1304                                         </dt>
1305                                         <dd>The id or index of the TabPanelItem to unhide.</dd>
1306
1307                                 </dl>
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319                     </div>
1320                 </div>
1321
1322             </td>
1323             <td class="msource">
1324
1325                         Roo.TabPanel
1326                 &nbsp;
1327             </td>
1328         </tr>
1329
1330
1331     </table>
1332
1333
1334   <!-- ============================== events summary / details ======================== -->
1335
1336
1337   <a id="Roo.TabPanel-events"></a>
1338
1339
1340
1341
1342
1343
1344
1345
1346       <table cellspacing="0" class="member-table">
1347                 <caption>Events</caption>
1348               <thead>
1349                 <tr>
1350                     <th class="sig-header" colspan="2">Event</th>
1351                     <th class="msource-header">Defined By</th>
1352
1353                 </tr>
1354               </thead>
1355
1356
1357
1358
1359
1360           <tr class="method-row expandable config-row-alt0 notInherited">
1361             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1362
1363             <td class="sig">
1364                 <a id="Roo.TabPanel-event-*beforetabchange"></a>
1365
1366                <div class="fixedFont">
1367                 <b class="itemname">beforetabchange</b> (<a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>, <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>tab</i></B>)
1368
1369                 </div>
1370
1371                 <div class="mdesc">
1372
1373                    <div class="short">Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change
1374
1375                 </div>
1376
1377                     <div class="long">
1378
1379                         Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change
1380
1381
1382
1383
1384
1385                                 <dl class="detailList">
1386                                 <dt class="heading">Parameters:</dt>
1387
1388                                         <dt>
1389                                                 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>this</b>
1390
1391                                         </dt>
1392                                         <dd></dd>
1393
1394                                         <dt>
1395                                                 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
1396
1397                                         </dt>
1398                                         <dd>Set cancel to true on this object to cancel the tab change</dd>
1399
1400                                         <dt>
1401                                                 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>tab</b>
1402
1403                                         </dt>
1404                                         <dd>The tab being changed to</dd>
1405
1406                                 </dl>
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418                     </div>
1419                 </div>
1420
1421             </td>
1422             <td class="msource">
1423                 Roo.TabPanel
1424             </td>
1425         </tr>
1426
1427           <tr class="method-row expandable config-row-alt1 notInherited">
1428             <td class="micon"><a class="exi" href="#expand">&nbsp;</a></td>
1429
1430             <td class="sig">
1431                 <a id="Roo.TabPanel-event-*tabchange"></a>
1432
1433                <div class="fixedFont">
1434                 <b class="itemname">tabchange</b> (<a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a> <B><i>this</i></B>, <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>activePanel</i></B>)
1435
1436                 </div>
1437
1438                 <div class="mdesc">
1439
1440                    <div class="short">Fires when the active tab changes
1441
1442                 </div>
1443
1444                     <div class="long">
1445
1446                         Fires when the active tab changes
1447
1448
1449
1450
1451
1452                                 <dl class="detailList">
1453                                 <dt class="heading">Parameters:</dt>
1454
1455                                         <dt>
1456                                                 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>this</b>
1457
1458                                         </dt>
1459                                         <dd></dd>
1460
1461                                         <dt>
1462                                                 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>activePanel</b>
1463
1464                                         </dt>
1465                                         <dd>The new active tab</dd>
1466
1467                                 </dl>
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479                     </div>
1480                 </div>
1481
1482             </td>
1483             <td class="msource">
1484                 Roo.TabPanel
1485             </td>
1486         </tr>
1487
1488
1489     </table>
1490
1491
1492
1493
1494
1495 <!-- ============================== footer ================================= -->
1496                 <div class="fineprint" style="clear:both">
1497
1498                         Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a>  on Fri Jul 16 2010 16:37:03 GMT+0800 (HKT)
1499                         Based on
1500                         <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
1501                 </div>
1502         </body>
1503 </html>