docs/source/TabPanel.html

   1 <html>\r
   2 <head>\r
   3   <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />    \r
   4   <title>The source code</title>\r
   5     <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />\r
   6     <script type="text/javascript" src="../resources/prettify/prettify.js"></script>\r
   7 </head>\r
   8 <body  onload="prettyPrint();">\r
   9     <pre class="prettyprint lang-js"><div id="cls-Ext.TabPanel"></div>/**
  10  * @class Ext.TabPanel
  11  * <p>A basic tab container. TabPanels can be used exactly like a standard {@link Ext.Panel}
  12  * for layout purposes, but also have special support for containing child Components
  13  * (<tt>{@link Ext.Container#items items}</tt>) that are managed using a
  14  * {@link Ext.layout.CardLayout CardLayout layout manager}, and displayed as separate tabs.</p>
  15  *
  16  * <b>Note:</b> By default, a tab's close tool <i>destroys</i> the child tab Component
  17  * and all its descendants. This makes the child tab Component, and all its descendants <b>unusable</b>. To enable
  18  * re-use of a tab, configure the TabPanel with <b><code>{@link #autoDestroy autoDestroy: false}</code></b>.
  19  *
  20  * <p><b><u>TabPanel header/footer elements</u></b></p>
  21  * <p>TabPanels use their {@link Ext.Panel#header header} or {@link Ext.Panel#footer footer} element
  22  * (depending on the {@link #tabPosition} configuration) to accommodate the tab selector buttons.
  23  * This means that a TabPanel will not display any configured title, and will not display any
  24  * configured header {@link Ext.Panel#tools tools}.</p>
  25  * <p>To display a header, embed the TabPanel in a {@link Ext.Panel Panel} which uses
  26  * <b><tt>{@link Ext.Container#layout layout:'fit'}</tt></b>.</p>
  27  *
  28  * <p><b><u>Tab Events</u></b></p>
  29  * <p>There is no actual tab class &mdash; each tab is simply a {@link Ext.BoxComponent Component}
  30  * such as a {@link Ext.Panel Panel}. However, when rendered in a TabPanel, each child Component
  31  * can fire additional events that only exist for tabs and are not available from other Components.
  32  * These events are:</p>
  33  * <div><ul class="mdetail-params">
  34  * <li><tt><b>{@link Ext.Panel#activate activate}</b></tt> : Fires when this Component becomes
  35  * the active tab.</li>
  36  * <li><tt><b>{@link Ext.Panel#deactivate deactivate}</b></tt> : Fires when the Component that
  37  * was the active tab becomes deactivated.</li>
  38  * <li><tt><b>{@link Ext.Panel#beforeclose beforeclose}</b></tt> : Fires when the user clicks on the close tool of a closeable tab.
  39  * May be vetoed by returning <code>false</code> from a handler.</li>
  40  * <li><tt><b>{@link Ext.Panel#close close}</b></tt> : Fires a closeable tab has been closed by the user.</li>
  41  * </ul></div>
  42  * <p><b><u>Creating TabPanels from Code</u></b></p>
  43  * <p>TabPanels can be created and rendered completely in code, as in this example:</p>
  44  * <pre><code>
  45 var tabs = new Ext.TabPanel({
  46     renderTo: Ext.getBody(),
  47     activeTab: 0,
  48     items: [{
  49         title: 'Tab 1',
  50         html: 'A simple tab'
  51     },{
  52         title: 'Tab 2',
  53         html: 'Another one'
  54     }]
  55 });
  56 </code></pre>
  57  * <p><b><u>Creating TabPanels from Existing Markup</u></b></p>
  58  * <p>TabPanels can also be rendered from pre-existing markup in a couple of ways.</p>
  59  * <div><ul class="mdetail-params">
  60  *
  61  * <li>Pre-Structured Markup</li>
  62  * <div class="sub-desc">
  63  * <p>A container div with one or more nested tab divs with class <tt>'x-tab'</tt> can be rendered entirely
  64  * from existing markup (See the {@link #autoTabs} example).</p>
  65  * </div>
  66  *
  67  * <li>Un-Structured Markup</li>
  68  * <div class="sub-desc">
  69  * <p>A TabPanel can also be rendered from markup that is not strictly structured by simply specifying by id
  70  * which elements should be the container and the tabs. Using this method tab content can be pulled from different
  71  * elements within the page by id regardless of page structure. For example:</p>
  72  * <pre><code>
  73 var tabs = new Ext.TabPanel({
  74     renderTo: 'my-tabs',
  75     activeTab: 0,
  76     items:[
  77         {contentEl:'tab1', title:'Tab 1'},
  78         {contentEl:'tab2', title:'Tab 2'}
  79     ]
  80 });
  81
  82 // Note that the tabs do not have to be nested within the container (although they can be)
  83 &lt;div id="my-tabs">&lt;/div>
  84 &lt;div id="tab1" class="x-hide-display">A simple tab&lt;/div>
  85 &lt;div id="tab2" class="x-hide-display">Another one&lt;/div>
  86 </code></pre>
  87  * Note that the tab divs in this example contain the class <tt>'x-hide-display'</tt> so that they can be rendered
  88  * deferred without displaying outside the tabs. You could alternately set <tt>{@link #deferredRender} = false </tt>
  89  * to render all content tabs on page load.
  90  * </div>
  91  *
  92  * </ul></div>
  93  *
  94  * @extends Ext.Panel
  95  * @constructor
  96  * @param {Object} config The configuration options
  97  * @xtype tabpanel
  98  */
  99 Ext.TabPanel = Ext.extend(Ext.Panel,  {
 100     <div id="cfg-Ext.TabPanel-layoutOnTabChange"></div>/**
 101      * @cfg {Boolean} layoutOnTabChange
 102      * Set to true to force a layout of the active tab when the tab is changed. Defaults to false.
 103      * See {@link Ext.layout.CardLayout}.<code>{@link Ext.layout.CardLayout#layoutOnCardChange layoutOnCardChange}</code>.
 104      */
 105     <div id="cfg-Ext.TabPanel-tabCls"></div>/**
 106      * @cfg {String} tabCls <b>This config option is used on <u>child Components</u> of ths TabPanel.</b> A CSS
 107      * class name applied to the tab strip item representing the child Component, allowing special
 108      * styling to be applied.
 109      */
 110     <div id="cfg-Ext.TabPanel-deferredRender"></div>/**
 111      * @cfg {Boolean} deferredRender
 112      * <p><tt>true</tt> by default to defer the rendering of child <tt>{@link Ext.Container#items items}</tt>
 113      * to the browsers DOM until a tab is activated. <tt>false</tt> will render all contained
 114      * <tt>{@link Ext.Container#items items}</tt> as soon as the {@link Ext.layout.CardLayout layout}
 115      * is rendered. If there is a significant amount of content or a lot of heavy controls being
 116      * rendered into panels that are not displayed by default, setting this to <tt>true</tt> might
 117      * improve performance.</p>
 118      * <br><p>The <tt>deferredRender</tt> property is internally passed to the layout manager for
 119      * TabPanels ({@link Ext.layout.CardLayout}) as its {@link Ext.layout.CardLayout#deferredRender}
 120      * configuration value.</p>
 121      * <br><p><b>Note</b>: leaving <tt>deferredRender</tt> as <tt>true</tt> means that the content
 122      * within an unactivated tab will not be available. For example, this means that if the TabPanel
 123      * is within a {@link Ext.form.FormPanel form}, then until a tab is activated, any Fields within
 124      * unactivated tabs will not be rendered, and will therefore not be submitted and will not be
 125      * available to either {@link Ext.form.BasicForm#getValues getValues} or
 126      * {@link Ext.form.BasicForm#setValues setValues}.</p>
 127      */
 128     deferredRender : true,
 129     <div id="cfg-Ext.TabPanel-tabWidth"></div>/**
 130      * @cfg {Number} tabWidth The initial width in pixels of each new tab (defaults to 120).
 131      */
 132     tabWidth : 120,
 133     <div id="cfg-Ext.TabPanel-minTabWidth"></div>/**
 134      * @cfg {Number} minTabWidth The minimum width in pixels for each tab when {@link #resizeTabs} = true (defaults to 30).
 135      */
 136     minTabWidth : 30,
 137     <div id="cfg-Ext.TabPanel-resizeTabs"></div>/**
 138      * @cfg {Boolean} resizeTabs True to automatically resize each tab so that the tabs will completely fill the
 139      * tab strip (defaults to false).  Setting this to true may cause specific widths that might be set per tab to
 140      * be overridden in order to fit them all into view (although {@link #minTabWidth} will always be honored).
 141      */
 142     resizeTabs : false,
 143     <div id="cfg-Ext.TabPanel-enableTabScroll"></div>/**
 144      * @cfg {Boolean} enableTabScroll True to enable scrolling to tabs that may be invisible due to overflowing the
 145      * overall TabPanel width. Only available with tabPosition:'top' (defaults to false).
 146      */
 147     enableTabScroll : false,
 148     <div id="cfg-Ext.TabPanel-scrollIncrement"></div>/**
 149      * @cfg {Number} scrollIncrement The number of pixels to scroll each time a tab scroll button is pressed
 150      * (defaults to <tt>100</tt>, or if <tt>{@link #resizeTabs} = true</tt>, the calculated tab width).  Only
 151      * applies when <tt>{@link #enableTabScroll} = true</tt>.
 152      */
 153     scrollIncrement : 0,
 154     <div id="cfg-Ext.TabPanel-scrollRepeatInterval"></div>/**
 155      * @cfg {Number} scrollRepeatInterval Number of milliseconds between each scroll while a tab scroll button is
 156      * continuously pressed (defaults to <tt>400</tt>).
 157      */
 158     scrollRepeatInterval : 400,
 159     <div id="cfg-Ext.TabPanel-scrollDuration"></div>/**
 160      * @cfg {Float} scrollDuration The number of milliseconds that each scroll animation should last (defaults
 161      * to <tt>.35</tt>). Only applies when <tt>{@link #animScroll} = true</tt>.
 162      */
 163     scrollDuration : 0.35,
 164     <div id="cfg-Ext.TabPanel-animScroll"></div>/**
 165      * @cfg {Boolean} animScroll True to animate tab scrolling so that hidden tabs slide smoothly into view (defaults
 166      * to <tt>true</tt>).  Only applies when <tt>{@link #enableTabScroll} = true</tt>.
 167      */
 168     animScroll : true,
 169     <div id="cfg-Ext.TabPanel-tabPosition"></div>/**
 170      * @cfg {String} tabPosition The position where the tab strip should be rendered (defaults to <tt>'top'</tt>).
 171      * The only other supported value is <tt>'bottom'</tt>.  <b>Note</b>: tab scrolling is only supported for
 172      * <tt>tabPosition: 'top'</tt>.
 173      */
 174     tabPosition : 'top',
 175     <div id="cfg-Ext.TabPanel-baseCls"></div>/**
 176      * @cfg {String} baseCls The base CSS class applied to the panel (defaults to <tt>'x-tab-panel'</tt>).
 177      */
 178     baseCls : 'x-tab-panel',
 179     <div id="cfg-Ext.TabPanel-autoTabs"></div>/**
 180      * @cfg {Boolean} autoTabs
 181      * <p><tt>true</tt> to query the DOM for any divs with a class of 'x-tab' to be automatically converted
 182      * to tabs and added to this panel (defaults to <tt>false</tt>).  Note that the query will be executed within
 183      * the scope of the container element only (so that multiple tab panels from markup can be supported via this
 184      * method).</p>
 185      * <p>This method is only possible when the markup is structured correctly as a container with nested divs
 186      * containing the class <tt>'x-tab'</tt>. To create TabPanels without these limitations, or to pull tab content
 187      * from other elements on the page, see the example at the top of the class for generating tabs from markup.</p>
 188      * <p>There are a couple of things to note when using this method:<ul>
 189      * <li>When using the <tt>autoTabs</tt> config (as opposed to passing individual tab configs in the TabPanel's
 190      * {@link #items} collection), you must use <tt>{@link #applyTo}</tt> to correctly use the specified <tt>id</tt>
 191      * as the tab container. The <tt>autoTabs</tt> method <em>replaces</em> existing content with the TabPanel
 192      * components.</li>
 193      * <li>Make sure that you set <tt>{@link #deferredRender}: false</tt> so that the content elements for each
 194      * tab will be rendered into the TabPanel immediately upon page load, otherwise they will not be transformed
 195      * until each tab is activated and will be visible outside the TabPanel.</li>
 196      * </ul>Example usage:</p>
 197      * <pre><code>
 198 var tabs = new Ext.TabPanel({
 199     applyTo: 'my-tabs',
 200     activeTab: 0,
 201     deferredRender: false,
 202     autoTabs: true
 203 });
 204
 205 // This markup will be converted to a TabPanel from the code above
 206 &lt;div id="my-tabs">
 207     &lt;div class="x-tab" title="Tab 1">A simple tab&lt;/div>
 208     &lt;div class="x-tab" title="Tab 2">Another one&lt;/div>
 209 &lt;/div>
 210 </code></pre>
 211      */
 212     autoTabs : false,
 213     <div id="cfg-Ext.TabPanel-autoTabSelector"></div>/**
 214      * @cfg {String} autoTabSelector The CSS selector used to search for tabs in existing markup when
 215      * <tt>{@link #autoTabs} = true</tt> (defaults to <tt>'div.x-tab'</tt>).  This can be any valid selector
 216      * supported by {@link Ext.DomQuery#select}. Note that the query will be executed within the scope of this
 217      * tab panel only (so that multiple tab panels from markup can be supported on a page).
 218      */
 219     autoTabSelector : 'div.x-tab',
 220     <div id="cfg-Ext.TabPanel-activeTab"></div>/**
 221      * @cfg {String/Number} activeTab A string id or the numeric index of the tab that should be initially
 222      * activated on render (defaults to undefined).
 223      */
 224     activeTab : undefined,
 225     <div id="cfg-Ext.TabPanel-tabMargin"></div>/**
 226      * @cfg {Number} tabMargin The number of pixels of space to calculate into the sizing and scrolling of
 227      * tabs. If you change the margin in CSS, you will need to update this value so calculations are correct
 228      * with either <tt>{@link #resizeTabs}</tt> or scrolling tabs. (defaults to <tt>2</tt>)
 229      */
 230     tabMargin : 2,
 231     <div id="cfg-Ext.TabPanel-plain"></div>/**
 232      * @cfg {Boolean} plain </tt>true</tt> to render the tab strip without a background container image
 233      * (defaults to <tt>false</tt>).
 234      */
 235     plain : false,
 236     <div id="cfg-Ext.TabPanel-wheelIncrement"></div>/**
 237      * @cfg {Number} wheelIncrement For scrolling tabs, the number of pixels to increment on mouse wheel
 238      * scrolling (defaults to <tt>20</tt>).
 239      */
 240     wheelIncrement : 20,
 241
 242     /*
 243      * This is a protected property used when concatenating tab ids to the TabPanel id for internal uniqueness.
 244      * It does not generally need to be changed, but can be if external code also uses an id scheme that can
 245      * potentially clash with this one.
 246      */
 247     idDelimiter : '__',
 248
 249     // private
 250     itemCls : 'x-tab-item',
 251
 252     // private config overrides
 253     elements : 'body',
 254     headerAsText : false,
 255     frame : false,
 256     hideBorders :true,
 257
 258     // private
 259     initComponent : function(){
 260         this.frame = false;
 261         Ext.TabPanel.superclass.initComponent.call(this);
 262         this.addEvents(
 263             <div id="event-Ext.TabPanel-beforetabchange"></div>/**
 264              * @event beforetabchange
 265              * Fires before the active tab changes. Handlers can <tt>return false</tt> to cancel the tab change.
 266              * @param {TabPanel} this
 267              * @param {Panel} newTab The tab being activated
 268              * @param {Panel} currentTab The current active tab
 269              */
 270             'beforetabchange',
 271             <div id="event-Ext.TabPanel-tabchange"></div>/**
 272              * @event tabchange
 273              * Fires after the active tab has changed.
 274              * @param {TabPanel} this
 275              * @param {Panel} tab The new active tab
 276              */
 277             'tabchange',
 278             <div id="event-Ext.TabPanel-contextmenu"></div>/**
 279              * @event contextmenu
 280              * Relays the contextmenu event from a tab selector element in the tab strip.
 281              * @param {TabPanel} this
 282              * @param {Panel} tab The target tab
 283              * @param {EventObject} e
 284              */
 285             'contextmenu'
 286         );
 287         <div id="cfg-Ext.TabPanel-layoutConfig"></div>/**
 288          * @cfg {Object} layoutConfig
 289          * TabPanel implicitly uses {@link Ext.layout.CardLayout} as its layout manager.
 290          * <code>layoutConfig</code> may be used to configure this layout manager.
 291          * <code>{@link #deferredRender}</code> and <code>{@link #layoutOnTabChange}</code>
 292          * configured on the TabPanel will be applied as configs to the layout manager.
 293          */
 294         this.setLayout(new Ext.layout.CardLayout(Ext.apply({
 295             layoutOnCardChange: this.layoutOnTabChange,
 296             deferredRender: this.deferredRender
 297         }, this.layoutConfig)));
 298
 299         if(this.tabPosition == 'top'){
 300             this.elements += ',header';
 301             this.stripTarget = 'header';
 302         }else {
 303             this.elements += ',footer';
 304             this.stripTarget = 'footer';
 305         }
 306         if(!this.stack){
 307             this.stack = Ext.TabPanel.AccessStack();
 308         }
 309         this.initItems();
 310     },
 311
 312     // private
 313     onRender : function(ct, position){
 314         Ext.TabPanel.superclass.onRender.call(this, ct, position);
 315
 316         if(this.plain){
 317             var pos = this.tabPosition == 'top' ? 'header' : 'footer';
 318             this[pos].addClass('x-tab-panel-'+pos+'-plain');
 319         }
 320
 321         var st = this[this.stripTarget];
 322
 323         this.stripWrap = st.createChild({cls:'x-tab-strip-wrap', cn:{
 324             tag:'ul', cls:'x-tab-strip x-tab-strip-'+this.tabPosition}});
 325
 326         var beforeEl = (this.tabPosition=='bottom' ? this.stripWrap : null);
 327         st.createChild({cls:'x-tab-strip-spacer'}, beforeEl);
 328         this.strip = new Ext.Element(this.stripWrap.dom.firstChild);
 329
 330         // create an empty span with class x-tab-strip-text to force the height of the header element when there's no tabs.
 331         this.edge = this.strip.createChild({tag:'li', cls:'x-tab-edge', cn: [{tag: 'span', cls: 'x-tab-strip-text', cn: '&#160;'}]});
 332         this.strip.createChild({cls:'x-clear'});
 333
 334         this.body.addClass('x-tab-panel-body-'+this.tabPosition);
 335
 336         <div id="cfg-Ext.TabPanel-itemTpl"></div>/**
 337          * @cfg {Template/XTemplate} itemTpl <p>(Optional) A {@link Ext.Template Template} or
 338          * {@link Ext.XTemplate XTemplate} which may be provided to process the data object returned from
 339          * <tt>{@link #getTemplateArgs}</tt> to produce a clickable selector element in the tab strip.</p>
 340          * <p>The main element created should be a <tt>&lt;li></tt> element. In order for a click event on
 341          * a selector element to be connected to its item, it must take its <i>id</i> from the TabPanel's
 342          * native <tt>{@link #getTemplateArgs}</tt>.</p>
 343          * <p>The child element which contains the title text must be marked by the CSS class
 344          * <tt>x-tab-strip-inner</tt>.</p>
 345          * <p>To enable closability, the created element should contain an element marked by the CSS class
 346          * <tt>x-tab-strip-close</tt>.</p>
 347          * <p>If a custom <tt>itemTpl</tt> is supplied, it is the developer's responsibility to create CSS
 348          * style rules to create the desired appearance.</p>
 349          * Below is an example of how to create customized tab selector items:<pre><code>
 350 new Ext.TabPanel({
 351     renderTo: document.body,
 352     minTabWidth: 115,
 353     tabWidth: 135,
 354     enableTabScroll: true,
 355     width: 600,
 356     height: 250,
 357     defaults: {autoScroll:true},
 358     itemTpl: new Ext.XTemplate(
 359     '&lt;li class="{cls}" id="{id}" style="overflow:hidden">',
 360          '&lt;tpl if="closable">',
 361             '&lt;a class="x-tab-strip-close">&lt;/a>',
 362          '&lt;/tpl>',
 363          '&lt;a class="x-tab-right" href="#" style="padding-left:6px">',
 364             '&lt;em class="x-tab-left">',
 365                 '&lt;span class="x-tab-strip-inner">',
 366                     '&lt;img src="{src}" style="float:left;margin:3px 3px 0 0">',
 367                     '&lt;span style="margin-left:20px" class="x-tab-strip-text {iconCls}">{text} {extra}&lt;/span>',
 368                 '&lt;/span>',
 369             '&lt;/em>',
 370         '&lt;/a>',
 371     '&lt;/li>'
 372     ),
 373     getTemplateArgs: function(item) {
 374 //      Call the native method to collect the base data. Like the ID!
 375         var result = Ext.TabPanel.prototype.getTemplateArgs.call(this, item);
 376
 377 //      Add stuff used in our template
 378         return Ext.apply(result, {
 379             closable: item.closable,
 380             src: item.iconSrc,
 381             extra: item.extraText || ''
 382         });
 383     },
 384     items: [{
 385         title: 'New Tab 1',
 386         iconSrc: '../shared/icons/fam/grid.png',
 387         html: 'Tab Body 1',
 388         closable: true
 389     }, {
 390         title: 'New Tab 2',
 391         iconSrc: '../shared/icons/fam/grid.png',
 392         html: 'Tab Body 2',
 393         extraText: 'Extra stuff in the tab button'
 394     }]
 395 });
 396 </code></pre>
 397          */
 398         if(!this.itemTpl){
 399             var tt = new Ext.Template(
 400                  '<li class="{cls}" id="{id}"><a class="x-tab-strip-close"></a>',
 401                  '<a class="x-tab-right" href="#"><em class="x-tab-left">',
 402                  '<span class="x-tab-strip-inner"><span class="x-tab-strip-text {iconCls}">{text}</span></span>',
 403                  '</em></a></li>'
 404             );
 405             tt.disableFormats = true;
 406             tt.compile();
 407             Ext.TabPanel.prototype.itemTpl = tt;
 408         }
 409
 410         this.items.each(this.initTab, this);
 411     },
 412
 413     // private
 414     afterRender : function(){
 415         Ext.TabPanel.superclass.afterRender.call(this);
 416         if(this.autoTabs){
 417             this.readTabs(false);
 418         }
 419         if(this.activeTab !== undefined){
 420             var item = Ext.isObject(this.activeTab) ? this.activeTab : this.items.get(this.activeTab);
 421             delete this.activeTab;
 422             this.setActiveTab(item);
 423         }
 424     },
 425
 426     // private
 427     initEvents : function(){
 428         Ext.TabPanel.superclass.initEvents.call(this);
 429         this.mon(this.strip, {
 430             scope: this,
 431             mousedown: this.onStripMouseDown,
 432             contextmenu: this.onStripContextMenu
 433         });
 434         if(this.enableTabScroll){
 435             this.mon(this.strip, 'mousewheel', this.onWheel, this);
 436         }
 437     },
 438
 439     // private
 440     findTargets : function(e){
 441         var item = null,
 442             itemEl = e.getTarget('li:not(.x-tab-edge)', this.strip);
 443
 444         if(itemEl){
 445             item = this.getComponent(itemEl.id.split(this.idDelimiter)[1]);
 446             if(item.disabled){
 447                 return {
 448                     close : null,
 449                     item : null,
 450                     el : null
 451                 };
 452             }
 453         }
 454         return {
 455             close : e.getTarget('.x-tab-strip-close', this.strip),
 456             item : item,
 457             el : itemEl
 458         };
 459     },
 460
 461     // private
 462     onStripMouseDown : function(e){
 463         if(e.button !== 0){
 464             return;
 465         }
 466         e.preventDefault();
 467         var t = this.findTargets(e);
 468         if(t.close){
 469             if (t.item.fireEvent('beforeclose', t.item) !== false) {
 470                 t.item.fireEvent('close', t.item);
 471                 this.remove(t.item);
 472             }
 473             return;
 474         }
 475         if(t.item && t.item != this.activeTab){
 476             this.setActiveTab(t.item);
 477         }
 478     },
 479
 480     // private
 481     onStripContextMenu : function(e){
 482         e.preventDefault();
 483         var t = this.findTargets(e);
 484         if(t.item){
 485             this.fireEvent('contextmenu', this, t.item, e);
 486         }
 487     },
 488
 489     <div id="method-Ext.TabPanel-readTabs"></div>/**
 490      * True to scan the markup in this tab panel for <tt>{@link #autoTabs}</tt> using the
 491      * <tt>{@link #autoTabSelector}</tt>
 492      * @param {Boolean} removeExisting True to remove existing tabs
 493      */
 494     readTabs : function(removeExisting){
 495         if(removeExisting === true){
 496             this.items.each(function(item){
 497                 this.remove(item);
 498             }, this);
 499         }
 500         var tabs = this.el.query(this.autoTabSelector);
 501         for(var i = 0, len = tabs.length; i < len; i++){
 502             var tab = tabs[i],
 503                 title = tab.getAttribute('title');
 504             tab.removeAttribute('title');
 505             this.add({
 506                 title: title,
 507                 contentEl: tab
 508             });
 509         }
 510     },
 511
 512     // private
 513     initTab : function(item, index){
 514         var before = this.strip.dom.childNodes[index],
 515             p = this.getTemplateArgs(item),
 516             el = before ?
 517                  this.itemTpl.insertBefore(before, p) :
 518                  this.itemTpl.append(this.strip, p),
 519             cls = 'x-tab-strip-over',
 520             tabEl = Ext.get(el);
 521
 522         tabEl.hover(function(){
 523             if(!item.disabled){
 524                 tabEl.addClass(cls);
 525             }
 526         }, function(){
 527             tabEl.removeClass(cls);
 528         });
 529
 530         if(item.tabTip){
 531             tabEl.child('span.x-tab-strip-text', true).qtip = item.tabTip;
 532         }
 533         item.tabEl = el;
 534
 535         // Route *keyboard triggered* click events to the tab strip mouse handler.
 536         tabEl.select('a').on('click', function(e){
 537             if(!e.getPageX()){
 538                 this.onStripMouseDown(e);
 539             }
 540         }, this, {preventDefault: true});
 541
 542         item.on({
 543             scope: this,
 544             disable: this.onItemDisabled,
 545             enable: this.onItemEnabled,
 546             titlechange: this.onItemTitleChanged,
 547             iconchange: this.onItemIconChanged,
 548             beforeshow: this.onBeforeShowItem
 549         });
 550     },
 551
 552
 553
 554     <div id="method-Ext.TabPanel-getTemplateArgs"></div>/**
 555      * <p>Provides template arguments for rendering a tab selector item in the tab strip.</p>
 556      * <p>This method returns an object hash containing properties used by the TabPanel's <tt>{@link #itemTpl}</tt>
 557      * to create a formatted, clickable tab selector element. The properties which must be returned
 558      * are:</p><div class="mdetail-params"><ul>
 559      * <li><b>id</b> : String<div class="sub-desc">A unique identifier which links to the item</div></li>
 560      * <li><b>text</b> : String<div class="sub-desc">The text to display</div></li>
 561      * <li><b>cls</b> : String<div class="sub-desc">The CSS class name</div></li>
 562      * <li><b>iconCls</b> : String<div class="sub-desc">A CSS class to provide appearance for an icon.</div></li>
 563      * </ul></div>
 564      * @param {BoxComponent} item The {@link Ext.BoxComponent BoxComponent} for which to create a selector element in the tab strip.
 565      * @return {Object} An object hash containing the properties required to render the selector element.
 566      */
 567     getTemplateArgs : function(item) {
 568         var cls = item.closable ? 'x-tab-strip-closable' : '';
 569         if(item.disabled){
 570             cls += ' x-item-disabled';
 571         }
 572         if(item.iconCls){
 573             cls += ' x-tab-with-icon';
 574         }
 575         if(item.tabCls){
 576             cls += ' ' + item.tabCls;
 577         }
 578
 579         return {
 580             id: this.id + this.idDelimiter + item.getItemId(),
 581             text: item.title,
 582             cls: cls,
 583             iconCls: item.iconCls || ''
 584         };
 585     },
 586
 587     // private
 588     onAdd : function(c){
 589         Ext.TabPanel.superclass.onAdd.call(this, c);
 590         if(this.rendered){
 591             var items = this.items;
 592             this.initTab(c, items.indexOf(c));
 593             if(items.getCount() == 1){
 594                 this.syncSize();
 595             }
 596             this.delegateUpdates();
 597         }
 598     },
 599
 600     // private
 601     onBeforeAdd : function(item){
 602         var existing = item.events ? (this.items.containsKey(item.getItemId()) ? item : null) : this.items.get(item);
 603         if(existing){
 604             this.setActiveTab(item);
 605             return false;
 606         }
 607         Ext.TabPanel.superclass.onBeforeAdd.apply(this, arguments);
 608         var es = item.elements;
 609         item.elements = es ? es.replace(',header', '') : es;
 610         item.border = (item.border === true);
 611     },
 612
 613     // private
 614     onRemove : function(c){
 615         var te = Ext.get(c.tabEl);
 616         // check if the tabEl exists, it won't if the tab isn't rendered
 617         if(te){
 618             te.select('a').removeAllListeners();
 619             Ext.destroy(te);
 620         }
 621         Ext.TabPanel.superclass.onRemove.call(this, c);
 622         this.stack.remove(c);
 623         delete c.tabEl;
 624         c.un('disable', this.onItemDisabled, this);
 625         c.un('enable', this.onItemEnabled, this);
 626         c.un('titlechange', this.onItemTitleChanged, this);
 627         c.un('iconchange', this.onItemIconChanged, this);
 628         c.un('beforeshow', this.onBeforeShowItem, this);
 629         if(c == this.activeTab){
 630             var next = this.stack.next();
 631             if(next){
 632                 this.setActiveTab(next);
 633             }else if(this.items.getCount() > 0){
 634                 this.setActiveTab(0);
 635             }else{
 636                 this.setActiveTab(null);
 637             }
 638         }
 639         if(!this.destroying){
 640             this.delegateUpdates();
 641         }
 642     },
 643
 644     // private
 645     onBeforeShowItem : function(item){
 646         if(item != this.activeTab){
 647             this.setActiveTab(item);
 648             return false;
 649         }
 650     },
 651
 652     // private
 653     onItemDisabled : function(item){
 654         var el = this.getTabEl(item);
 655         if(el){
 656             Ext.fly(el).addClass('x-item-disabled');
 657         }
 658         this.stack.remove(item);
 659     },
 660
 661     // private
 662     onItemEnabled : function(item){
 663         var el = this.getTabEl(item);
 664         if(el){
 665             Ext.fly(el).removeClass('x-item-disabled');
 666         }
 667     },
 668
 669     // private
 670     onItemTitleChanged : function(item){
 671         var el = this.getTabEl(item);
 672         if(el){
 673             Ext.fly(el).child('span.x-tab-strip-text', true).innerHTML = item.title;
 674         }
 675     },
 676
 677     //private
 678     onItemIconChanged : function(item, iconCls, oldCls){
 679         var el = this.getTabEl(item);
 680         if(el){
 681             el = Ext.get(el);
 682             el.child('span.x-tab-strip-text').replaceClass(oldCls, iconCls);
 683             el[Ext.isEmpty(iconCls) ? 'removeClass' : 'addClass']('x-tab-with-icon');
 684         }
 685     },
 686
 687     <div id="method-Ext.TabPanel-getTabEl"></div>/**
 688      * Gets the DOM element for the tab strip item which activates the child panel with the specified
 689      * ID. Access this to change the visual treatment of the item, for example by changing the CSS class name.
 690      * @param {Panel/Number/String} tab The tab component, or the tab's index, or the tabs id or itemId.
 691      * @return {HTMLElement} The DOM node
 692      */
 693     getTabEl : function(item){
 694         var c = this.getComponent(item);
 695         return c ? c.tabEl : null;
 696     },
 697
 698     // private
 699     onResize : function(){
 700         Ext.TabPanel.superclass.onResize.apply(this, arguments);
 701         this.delegateUpdates();
 702     },
 703
 704     <div id="method-Ext.TabPanel-beginUpdate"></div>/**
 705      * Suspends any internal calculations or scrolling while doing a bulk operation. See {@link #endUpdate}
 706      */
 707     beginUpdate : function(){
 708         this.suspendUpdates = true;
 709     },
 710
 711     <div id="method-Ext.TabPanel-endUpdate"></div>/**
 712      * Resumes calculations and scrolling at the end of a bulk operation. See {@link #beginUpdate}
 713      */
 714     endUpdate : function(){
 715         this.suspendUpdates = false;
 716         this.delegateUpdates();
 717     },
 718
 719     <div id="method-Ext.TabPanel-hideTabStripItem"></div>/**
 720      * Hides the tab strip item for the passed tab
 721      * @param {Number/String/Panel} item The tab index, id or item
 722      */
 723     hideTabStripItem : function(item){
 724         item = this.getComponent(item);
 725         var el = this.getTabEl(item);
 726         if(el){
 727             el.style.display = 'none';
 728             this.delegateUpdates();
 729         }
 730         this.stack.remove(item);
 731     },
 732
 733     <div id="method-Ext.TabPanel-unhideTabStripItem"></div>/**
 734      * Unhides the tab strip item for the passed tab
 735      * @param {Number/String/Panel} item The tab index, id or item
 736      */
 737     unhideTabStripItem : function(item){
 738         item = this.getComponent(item);
 739         var el = this.getTabEl(item);
 740         if(el){
 741             el.style.display = '';
 742             this.delegateUpdates();
 743         }
 744     },
 745
 746     // private
 747     delegateUpdates : function(){
 748         if(this.suspendUpdates){
 749             return;
 750         }
 751         if(this.resizeTabs && this.rendered){
 752             this.autoSizeTabs();
 753         }
 754         if(this.enableTabScroll && this.rendered){
 755             this.autoScrollTabs();
 756         }
 757     },
 758
 759     // private
 760     autoSizeTabs : function(){
 761         var count = this.items.length,
 762             ce = this.tabPosition != 'bottom' ? 'header' : 'footer',
 763             ow = this[ce].dom.offsetWidth,
 764             aw = this[ce].dom.clientWidth;
 765
 766         if(!this.resizeTabs || count < 1 || !aw){ // !aw for display:none
 767             return;
 768         }
 769
 770         var each = Math.max(Math.min(Math.floor((aw-4) / count) - this.tabMargin, this.tabWidth), this.minTabWidth); // -4 for float errors in IE
 771         this.lastTabWidth = each;
 772         var lis = this.strip.query('li:not(.x-tab-edge)');
 773         for(var i = 0, len = lis.length; i < len; i++) {
 774             var li = lis[i],
 775                 inner = Ext.fly(li).child('.x-tab-strip-inner', true),
 776                 tw = li.offsetWidth,
 777                 iw = inner.offsetWidth;
 778             inner.style.width = (each - (tw-iw)) + 'px';
 779         }
 780     },
 781
 782     // private
 783     adjustBodyWidth : function(w){
 784         if(this.header){
 785             this.header.setWidth(w);
 786         }
 787         if(this.footer){
 788             this.footer.setWidth(w);
 789         }
 790         return w;
 791     },
 792
 793     <div id="method-Ext.TabPanel-setActiveTab"></div>/**
 794      * Sets the specified tab as the active tab. This method fires the {@link #beforetabchange} event which
 795      * can <tt>return false</tt> to cancel the tab change.
 796      * @param {String/Number} item
 797      * The id or tab Panel to activate. This parameter may be any of the following:
 798      * <div><ul class="mdetail-params">
 799      * <li>a <b><tt>String</tt></b> : representing the <code>{@link Ext.Component#itemId itemId}</code>
 800      * or <code>{@link Ext.Component#id id}</code> of the child component </li>
 801      * <li>a <b><tt>Number</tt></b> : representing the position of the child component
 802      * within the <code>{@link Ext.Container#items items}</code> <b>property</b></li>
 803      * </ul></div>
 804      * <p>For additional information see {@link Ext.util.MixedCollection#get}.
 805      */
 806     setActiveTab : function(item){
 807         item = this.getComponent(item);
 808         if(this.fireEvent('beforetabchange', this, item, this.activeTab) === false){
 809             return;
 810         }
 811         if(!this.rendered){
 812             this.activeTab = item;
 813             return;
 814         }
 815         if(this.activeTab != item){
 816             if(this.activeTab){
 817                 var oldEl = this.getTabEl(this.activeTab);
 818                 if(oldEl){
 819                     Ext.fly(oldEl).removeClass('x-tab-strip-active');
 820                 }
 821             }
 822             if(item){
 823                 var el = this.getTabEl(item);
 824                 Ext.fly(el).addClass('x-tab-strip-active');
 825                 this.activeTab = item;
 826                 this.stack.add(item);
 827
 828                 this.layout.setActiveItem(item);
 829                 if(this.scrolling){
 830                     this.scrollToTab(item, this.animScroll);
 831                 }
 832             }
 833             this.fireEvent('tabchange', this, item);
 834         }
 835     },
 836
 837     <div id="method-Ext.TabPanel-getActiveTab"></div>/**
 838      * Returns the Component which is the currently active tab. <b>Note that before the TabPanel
 839      * first activates a child Component, this method will return whatever was configured in the
 840      * {@link #activeTab} config option.</b>
 841      * @return {BoxComponent} The currently active child Component if one <i>is</i> active, or the {@link #activeTab} config value.
 842      */
 843     getActiveTab : function(){
 844         return this.activeTab || null;
 845     },
 846
 847     <div id="method-Ext.TabPanel-getItem"></div>/**
 848      * Gets the specified tab by id.
 849      * @param {String} id The tab id
 850      * @return {Panel} The tab
 851      */
 852     getItem : function(item){
 853         return this.getComponent(item);
 854     },
 855
 856     // private
 857     autoScrollTabs : function(){
 858         this.pos = this.tabPosition=='bottom' ? this.footer : this.header;
 859         var count = this.items.length,
 860             ow = this.pos.dom.offsetWidth,
 861             tw = this.pos.dom.clientWidth,
 862             wrap = this.stripWrap,
 863             wd = wrap.dom,
 864             cw = wd.offsetWidth,
 865             pos = this.getScrollPos(),
 866             l = this.edge.getOffsetsTo(this.stripWrap)[0] + pos;
 867
 868         if(!this.enableTabScroll || count < 1 || cw < 20){ // 20 to prevent display:none issues
 869             return;
 870         }
 871         if(l <= tw){
 872             wd.scrollLeft = 0;
 873             wrap.setWidth(tw);
 874             if(this.scrolling){
 875                 this.scrolling = false;
 876                 this.pos.removeClass('x-tab-scrolling');
 877                 this.scrollLeft.hide();
 878                 this.scrollRight.hide();
 879                 // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari
 880                 if(Ext.isAir || Ext.isWebKit){
 881                     wd.style.marginLeft = '';
 882                     wd.style.marginRight = '';
 883                 }
 884             }
 885         }else{
 886             if(!this.scrolling){
 887                 this.pos.addClass('x-tab-scrolling');
 888                 // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari
 889                 if(Ext.isAir || Ext.isWebKit){
 890                     wd.style.marginLeft = '18px';
 891                     wd.style.marginRight = '18px';
 892                 }
 893             }
 894             tw -= wrap.getMargins('lr');
 895             wrap.setWidth(tw > 20 ? tw : 20);
 896             if(!this.scrolling){
 897                 if(!this.scrollLeft){
 898                     this.createScrollers();
 899                 }else{
 900                     this.scrollLeft.show();
 901                     this.scrollRight.show();
 902                 }
 903             }
 904             this.scrolling = true;
 905             if(pos > (l-tw)){ // ensure it stays within bounds
 906                 wd.scrollLeft = l-tw;
 907             }else{ // otherwise, make sure the active tab is still visible
 908                 this.scrollToTab(this.activeTab, false);
 909             }
 910             this.updateScrollButtons();
 911         }
 912     },
 913
 914     // private
 915     createScrollers : function(){
 916         this.pos.addClass('x-tab-scrolling-' + this.tabPosition);
 917         var h = this.stripWrap.dom.offsetHeight;
 918
 919         // left
 920         var sl = this.pos.insertFirst({
 921             cls:'x-tab-scroller-left'
 922         });
 923         sl.setHeight(h);
 924         sl.addClassOnOver('x-tab-scroller-left-over');
 925         this.leftRepeater = new Ext.util.ClickRepeater(sl, {
 926             interval : this.scrollRepeatInterval,
 927             handler: this.onScrollLeft,
 928             scope: this
 929         });
 930         this.scrollLeft = sl;
 931
 932         // right
 933         var sr = this.pos.insertFirst({
 934             cls:'x-tab-scroller-right'
 935         });
 936         sr.setHeight(h);
 937         sr.addClassOnOver('x-tab-scroller-right-over');
 938         this.rightRepeater = new Ext.util.ClickRepeater(sr, {
 939             interval : this.scrollRepeatInterval,
 940             handler: this.onScrollRight,
 941             scope: this
 942         });
 943         this.scrollRight = sr;
 944     },
 945
 946     // private
 947     getScrollWidth : function(){
 948         return this.edge.getOffsetsTo(this.stripWrap)[0] + this.getScrollPos();
 949     },
 950
 951     // private
 952     getScrollPos : function(){
 953         return parseInt(this.stripWrap.dom.scrollLeft, 10) || 0;
 954     },
 955
 956     // private
 957     getScrollArea : function(){
 958         return parseInt(this.stripWrap.dom.clientWidth, 10) || 0;
 959     },
 960
 961     // private
 962     getScrollAnim : function(){
 963         return {duration:this.scrollDuration, callback: this.updateScrollButtons, scope: this};
 964     },
 965
 966     // private
 967     getScrollIncrement : function(){
 968         return this.scrollIncrement || (this.resizeTabs ? this.lastTabWidth+2 : 100);
 969     },
 970
 971     <div id="method-Ext.TabPanel-scrollToTab"></div>/**
 972      * Scrolls to a particular tab if tab scrolling is enabled
 973      * @param {Panel} item The item to scroll to
 974      * @param {Boolean} animate True to enable animations
 975      */
 976
 977     scrollToTab : function(item, animate){
 978         if(!item){
 979             return;
 980         }
 981         var el = this.getTabEl(item),
 982             pos = this.getScrollPos(),
 983             area = this.getScrollArea(),
 984             left = Ext.fly(el).getOffsetsTo(this.stripWrap)[0] + pos,
 985             right = left + el.offsetWidth;
 986         if(left < pos){
 987             this.scrollTo(left, animate);
 988         }else if(right > (pos + area)){
 989             this.scrollTo(right - area, animate);
 990         }
 991     },
 992
 993     // private
 994     scrollTo : function(pos, animate){
 995         this.stripWrap.scrollTo('left', pos, animate ? this.getScrollAnim() : false);
 996         if(!animate){
 997             this.updateScrollButtons();
 998         }
 999     },
1000
1001     onWheel : function(e){
1002         var d = e.getWheelDelta()*this.wheelIncrement*-1;
1003         e.stopEvent();
1004
1005         var pos = this.getScrollPos(),
1006             newpos = pos + d,
1007             sw = this.getScrollWidth()-this.getScrollArea();
1008
1009         var s = Math.max(0, Math.min(sw, newpos));
1010         if(s != pos){
1011             this.scrollTo(s, false);
1012         }
1013     },
1014
1015     // private
1016     onScrollRight : function(){
1017         var sw = this.getScrollWidth()-this.getScrollArea(),
1018             pos = this.getScrollPos(),
1019             s = Math.min(sw, pos + this.getScrollIncrement());
1020         if(s != pos){
1021             this.scrollTo(s, this.animScroll);
1022         }
1023     },
1024
1025     // private
1026     onScrollLeft : function(){
1027         var pos = this.getScrollPos(),
1028             s = Math.max(0, pos - this.getScrollIncrement());
1029         if(s != pos){
1030             this.scrollTo(s, this.animScroll);
1031         }
1032     },
1033
1034     // private
1035     updateScrollButtons : function(){
1036         var pos = this.getScrollPos();
1037         this.scrollLeft[pos === 0 ? 'addClass' : 'removeClass']('x-tab-scroller-left-disabled');
1038         this.scrollRight[pos >= (this.getScrollWidth()-this.getScrollArea()) ? 'addClass' : 'removeClass']('x-tab-scroller-right-disabled');
1039     },
1040
1041     // private
1042     beforeDestroy : function() {
1043         Ext.destroy(this.leftRepeater, this.rightRepeater);
1044         this.deleteMembers('strip', 'edge', 'scrollLeft', 'scrollRight', 'stripWrap');
1045         this.activeTab = null;
1046         Ext.TabPanel.superclass.beforeDestroy.apply(this);
1047     }
1048
1049     <div id="cfg-Ext.TabPanel-collapsible"></div>/**
1050      * @cfg {Boolean} collapsible
1051      * @hide
1052      */
1053     <div id="cfg-Ext.TabPanel-header"></div>/**
1054      * @cfg {String} header
1055      * @hide
1056      */
1057     <div id="cfg-Ext.TabPanel-headerAsText"></div>/**
1058      * @cfg {Boolean} headerAsText
1059      * @hide
1060      */
1061     <div id="prop-Ext.TabPanel-header"></div>/**
1062      * @property header
1063      * @hide
1064      */
1065     <div id="cfg-Ext.TabPanel-null"></div>/**
1066      * @cfg title
1067      * @hide
1068      */
1069     <div id="cfg-Ext.TabPanel-tools"></div>/**
1070      * @cfg {Array} tools
1071      * @hide
1072      */
1073     <div id="cfg-Ext.TabPanel-toolTemplate"></div>/**
1074      * @cfg {Array} toolTemplate
1075      * @hide
1076      */
1077     <div id="cfg-Ext.TabPanel-hideCollapseTool"></div>/**
1078      * @cfg {Boolean} hideCollapseTool
1079      * @hide
1080      */
1081     <div id="cfg-Ext.TabPanel-titleCollapse"></div>/**
1082      * @cfg {Boolean} titleCollapse
1083      * @hide
1084      */
1085     <div id="cfg-Ext.TabPanel-collapsed"></div>/**
1086      * @cfg {Boolean} collapsed
1087      * @hide
1088      */
1089     <div id="cfg-Ext.TabPanel-layout"></div>/**
1090      * @cfg {String} layout
1091      * @hide
1092      */
1093     <div id="cfg-Ext.TabPanel-preventBodyReset"></div>/**
1094      * @cfg {Boolean} preventBodyReset
1095      * @hide
1096      */
1097 });
1098 Ext.reg('tabpanel', Ext.TabPanel);
1099
1100 <div id="method-Ext.TabPanel-activate"></div>/**
1101  * See {@link #setActiveTab}. Sets the specified tab as the active tab. This method fires
1102  * the {@link #beforetabchange} event which can <tt>return false</tt> to cancel the tab change.
1103  * @param {String/Panel} tab The id or tab Panel to activate
1104  * @method activate
1105  */
1106 Ext.TabPanel.prototype.activate = Ext.TabPanel.prototype.setActiveTab;
1107
1108 // private utility class used by TabPanel
1109 Ext.TabPanel.AccessStack = function(){
1110     var items = [];
1111     return {
1112         add : function(item){
1113             items.push(item);
1114             if(items.length > 10){
1115                 items.shift();
1116             }
1117         },
1118
1119         remove : function(item){
1120             var s = [];
1121             for(var i = 0, len = items.length; i < len; i++) {
1122                 if(items[i] != item){
1123                     s.push(items[i]);
1124                 }
1125             }
1126             items = s;
1127         },
1128
1129         next : function(){
1130             return items.pop();
1131         }
1132     };
1133 };
1134 </pre>    \r
1135 </body>\r
1136 </html>