3 * Copyright(c) 2006-2009 Ext JS, LLC
5 * http://www.extjs.com/license
9 * <p>A basic tab container. TabPanels can be used exactly like a standard {@link Ext.Panel}
10 * for layout purposes, but also have special support for containing child Components
11 * (<tt>{@link Ext.Container#items items}</tt>) that are managed using a
12 * {@link Ext.layout.CardLayout CardLayout layout manager}, and displayed as separate tabs.</p>
14 * <b>Note:</b> By default, a tab's close tool <i>destroys</i> the child tab Component
15 * and all its descendants. This makes the child tab Component, and all its descendants <b>unusable</b>. To enable
16 * re-use of a tab, configure the TabPanel with <b><code>{@link #autoDestroy autoDestroy: false}</code></b>.
18 * <p><b><u>TabPanel header/footer elements</u></b></p>
19 * <p>TabPanels use their {@link Ext.Panel#header header} or {@link Ext.Panel#footer footer} element
20 * (depending on the {@link #tabPosition} configuration) to accommodate the tab selector buttons.
21 * This means that a TabPanel will not display any configured title, and will not display any
22 * configured header {@link Ext.Panel#tools tools}.</p>
23 * <p>To display a header, embed the TabPanel in a {@link Ext.Panel Panel} which uses
24 * <b><tt>{@link Ext.Container#layout layout:'fit'}</tt></b>.</p>
26 * <p><b><u>Tab Events</u></b></p>
27 * <p>There is no actual tab class — each tab is simply a {@link Ext.BoxComponent Component}
28 * such as a {@link Ext.Panel Panel}. However, when rendered in a TabPanel, each child Component
29 * can fire additional events that only exist for tabs and are not available from other Components.
30 * These events are:</p>
31 * <div><ul class="mdetail-params">
32 * <li><tt><b>{@link Ext.Panel#activate activate}</b></tt> : Fires when this Component becomes
33 * the active tab.</li>
34 * <li><tt><b>{@link Ext.Panel#deactivate deactivate}</b></tt> : Fires when the Component that
35 * was the active tab becomes deactivated.</li>
37 * <p><b><u>Creating TabPanels from Code</u></b></p>
38 * <p>TabPanels can be created and rendered completely in code, as in this example:</p>
40 var tabs = new Ext.TabPanel({
41 renderTo: Ext.getBody(),
52 * <p><b><u>Creating TabPanels from Existing Markup</u></b></p>
53 * <p>TabPanels can also be rendered from pre-existing markup in a couple of ways.</p>
54 * <div><ul class="mdetail-params">
56 * <li>Pre-Structured Markup</li>
57 * <div class="sub-desc">
58 * <p>A container div with one or more nested tab divs with class <tt>'x-tab'</tt> can be rendered entirely
59 * from existing markup (See the {@link #autoTabs} example).</p>
62 * <li>Un-Structured Markup</li>
63 * <div class="sub-desc">
64 * <p>A TabPanel can also be rendered from markup that is not strictly structured by simply specifying by id
65 * which elements should be the container and the tabs. Using this method tab content can be pulled from different
66 * elements within the page by id regardless of page structure. For example:</p>
68 var tabs = new Ext.TabPanel({
72 {contentEl:'tab1', title:'Tab 1'},
73 {contentEl:'tab2', title:'Tab 2'}
77 // Note that the tabs do not have to be nested within the container (although they can be)
78 <div id="my-tabs"></div>
79 <div id="tab1" class="x-hide-display">A simple tab</div>
80 <div id="tab2" class="x-hide-display">Another one</div>
82 * Note that the tab divs in this example contain the class <tt>'x-hide-display'</tt> so that they can be rendered
83 * deferred without displaying outside the tabs. You could alternately set <tt>{@link #deferredRender} = false </tt>
84 * to render all content tabs on page load.
91 * @param {Object} config The configuration options
94 Ext.TabPanel = Ext.extend(Ext.Panel, {
96 * @cfg {Boolean} layoutOnTabChange
97 * Set to true to force a layout of the active tab when the tab is changed. Defaults to false.
98 * See {@link Ext.layout.CardLayout}.<code>{@link Ext.layout.CardLayout#layoutOnCardChange layoutOnCardChange}</code>.
101 * @cfg {String} tabCls <b>This config option is used on <u>child Components</u> of ths TabPanel.</b> A CSS
102 * class name applied to the tab strip item representing the child Component, allowing special
103 * styling to be applied.
106 * @cfg {Boolean} monitorResize True to automatically monitor window resize events and rerender the layout on
107 * browser resize (defaults to true).
109 monitorResize : true,
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>
128 deferredRender : true,
130 * @cfg {Number} tabWidth The initial width in pixels of each new tab (defaults to 120).
134 * @cfg {Number} minTabWidth The minimum width in pixels for each tab when {@link #resizeTabs} = true (defaults to 30).
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).
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).
147 enableTabScroll : false,
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>.
155 * @cfg {Number} scrollRepeatInterval Number of milliseconds between each scroll while a tab scroll button is
156 * continuously pressed (defaults to <tt>400</tt>).
158 scrollRepeatInterval : 400,
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>.
163 scrollDuration : 0.35,
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>.
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>.
176 * @cfg {String} baseCls The base CSS class applied to the panel (defaults to <tt>'x-tab-panel'</tt>).
178 baseCls : 'x-tab-panel',
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
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
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>
198 var tabs = new Ext.TabPanel({
201 deferredRender: false,
205 // This markup will be converted to a TabPanel from the code above
206 <div id="my-tabs">
207 <div class="x-tab" title="Tab 1">A simple tab</div>
208 <div class="x-tab" title="Tab 2">Another one</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).
219 autoTabSelector : 'div.x-tab',
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 none).
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>)
232 * @cfg {Boolean} plain </tt>true</tt> to render the tab strip without a background container image
233 * (defaults to <tt>false</tt>).
237 * @cfg {Number} wheelIncrement For scrolling tabs, the number of pixels to increment on mouse wheel
238 * scrolling (defaults to <tt>20</tt>).
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.
250 itemCls : 'x-tab-item',
252 // private config overrides
254 headerAsText : false,
259 initComponent : function(){
261 Ext.TabPanel.superclass.initComponent.call(this);
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
273 * Fires after the active tab has changed.
274 * @param {TabPanel} this
275 * @param {Panel} tab The new active tab
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
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.
294 this.setLayout(new Ext.layout.CardLayout(Ext.apply({
295 layoutOnCardChange: this.layoutOnTabChange,
296 deferredRender: this.deferredRender
297 }, this.layoutConfig)));
299 if(this.tabPosition == 'top'){
300 this.elements += ',header';
301 this.stripTarget = 'header';
303 this.elements += ',footer';
304 this.stripTarget = 'footer';
307 this.stack = Ext.TabPanel.AccessStack();
313 onRender : function(ct, position){
314 Ext.TabPanel.superclass.onRender.call(this, ct, position);
317 var pos = this.tabPosition == 'top' ? 'header' : 'footer';
318 this[pos].addClass('x-tab-panel-'+pos+'-plain');
321 var st = this[this.stripTarget];
323 this.stripWrap = st.createChild({cls:'x-tab-strip-wrap', cn:{
324 tag:'ul', cls:'x-tab-strip x-tab-strip-'+this.tabPosition}});
326 var beforeEl = (this.tabPosition=='bottom' ? this.stripWrap : null);
327 this.stripSpacer = st.createChild({cls:'x-tab-strip-spacer'}, beforeEl);
328 this.strip = new Ext.Element(this.stripWrap.dom.firstChild);
330 this.edge = this.strip.createChild({tag:'li', cls:'x-tab-edge'});
331 this.strip.createChild({cls:'x-clear'});
333 this.body.addClass('x-tab-panel-body-'+this.tabPosition);
336 * @cfg {Template/XTemplate} itemTpl <p>(Optional) A {@link Ext.Template Template} or
337 * {@link Ext.XTemplate XTemplate} which may be provided to process the data object returned from
338 * <tt>{@link #getTemplateArgs}</tt> to produce a clickable selector element in the tab strip.</p>
339 * <p>The main element created should be a <tt><li></tt> element. In order for a click event on
340 * a selector element to be connected to its item, it must take its <i>id</i> from the TabPanel's
341 * native <tt>{@link #getTemplateArgs}</tt>.</p>
342 * <p>The child element which contains the title text must be marked by the CSS class
343 * <tt>x-tab-strip-inner</tt>.</p>
344 * <p>To enable closability, the created element should contain an element marked by the CSS class
345 * <tt>x-tab-strip-close</tt>.</p>
346 * <p>If a custom <tt>itemTpl</tt> is supplied, it is the developer's responsibility to create CSS
347 * style rules to create the desired appearance.</p>
348 * Below is an example of how to create customized tab selector items:<pre><code>
350 renderTo: document.body,
353 enableTabScroll: true,
356 defaults: {autoScroll:true},
357 itemTpl: new Ext.XTemplate(
358 '<li class="{cls}" id="{id}" style="overflow:hidden">',
359 '<tpl if="closable">',
360 '<a class="x-tab-strip-close" onclick="return false;"></a>',
362 '<a class="x-tab-right" href="#" onclick="return false;" style="padding-left:6px">',
363 '<em class="x-tab-left">',
364 '<span class="x-tab-strip-inner">',
365 '<img src="{src}" style="float:left;margin:3px 3px 0 0">',
366 '<span style="margin-left:20px" class="x-tab-strip-text {iconCls}">{text} {extra}</span>',
372 getTemplateArgs: function(item) {
373 // Call the native method to collect the base data. Like the ID!
374 var result = Ext.TabPanel.prototype.getTemplateArgs.call(this, item);
376 // Add stuff used in our template
377 return Ext.apply(result, {
378 closable: item.closable,
380 extra: item.extraText || ''
385 iconSrc: '../shared/icons/fam/grid.png',
390 iconSrc: '../shared/icons/fam/grid.png',
392 extraText: 'Extra stuff in the tab button'
398 var tt = new Ext.Template(
399 '<li class="{cls}" id="{id}"><a class="x-tab-strip-close" onclick="return false;"></a>',
400 '<a class="x-tab-right" href="#" onclick="return false;"><em class="x-tab-left">',
401 '<span class="x-tab-strip-inner"><span class="x-tab-strip-text {iconCls}">{text}</span></span>',
404 tt.disableFormats = true;
406 Ext.TabPanel.prototype.itemTpl = tt;
409 this.items.each(this.initTab, this);
413 afterRender : function(){
414 Ext.TabPanel.superclass.afterRender.call(this);
416 this.readTabs(false);
418 if(this.activeTab !== undefined){
419 var item = Ext.isObject(this.activeTab) ? this.activeTab : this.items.get(this.activeTab);
420 delete this.activeTab;
421 this.setActiveTab(item);
426 initEvents : function(){
427 Ext.TabPanel.superclass.initEvents.call(this);
428 this.mon(this.strip, {
430 mousedown: this.onStripMouseDown,
431 contextmenu: this.onStripContextMenu
433 if(this.enableTabScroll){
434 this.mon(this.strip, 'mousewheel', this.onWheel, this);
439 findTargets : function(e){
441 var itemEl = e.getTarget('li', this.strip);
443 item = this.getComponent(itemEl.id.split(this.idDelimiter)[1]);
453 close : e.getTarget('.x-tab-strip-close', this.strip),
460 onStripMouseDown : function(e){
465 var t = this.findTargets(e);
467 if (t.item.fireEvent('beforeclose', t.item) !== false) {
468 t.item.fireEvent('close', t.item);
474 if(t.item && t.item != this.activeTab){
475 this.setActiveTab(t.item);
480 onStripContextMenu : function(e){
482 var t = this.findTargets(e);
484 this.fireEvent('contextmenu', this, t.item, e);
489 * True to scan the markup in this tab panel for <tt>{@link #autoTabs}</tt> using the
490 * <tt>{@link #autoTabSelector}</tt>
491 * @param {Boolean} removeExisting True to remove existing tabs
493 readTabs : function(removeExisting){
494 if(removeExisting === true){
495 this.items.each(function(item){
499 var tabs = this.el.query(this.autoTabSelector);
500 for(var i = 0, len = tabs.length; i < len; i++){
502 var title = tab.getAttribute('title');
503 tab.removeAttribute('title');
512 initTab : function(item, index){
513 var before = this.strip.dom.childNodes[index];
514 var p = this.getTemplateArgs(item);
516 this.itemTpl.insertBefore(before, p) :
517 this.itemTpl.append(this.strip, p);
519 Ext.fly(el).addClassOnOver('x-tab-strip-over');
522 Ext.fly(el).child('span.x-tab-strip-text', true).qtip = item.tabTip;
526 item.on('disable', this.onItemDisabled, this);
527 item.on('enable', this.onItemEnabled, this);
528 item.on('titlechange', this.onItemTitleChanged, this);
529 item.on('iconchange', this.onItemIconChanged, this);
530 item.on('beforeshow', this.onBeforeShowItem, this);
534 * <p>Provides template arguments for rendering a tab selector item in the tab strip.</p>
535 * <p>This method returns an object hash containing properties used by the TabPanel's <tt>{@link #itemTpl}</tt>
536 * to create a formatted, clickable tab selector element. The properties which must be returned
537 * are:</p><div class="mdetail-params"><ul>
538 * <li><b>id</b> : String<div class="sub-desc">A unique identifier which links to the item</div></li>
539 * <li><b>text</b> : String<div class="sub-desc">The text to display</div></li>
540 * <li><b>cls</b> : String<div class="sub-desc">The CSS class name</div></li>
541 * <li><b>iconCls</b> : String<div class="sub-desc">A CSS class to provide appearance for an icon.</div></li>
543 * @param {BoxComponent} item The {@link Ext.BoxComponent BoxComponent} for which to create a selector element in the tab strip.
544 * @return {Object} An object hash containing the properties required to render the selector element.
546 getTemplateArgs : function(item) {
547 var cls = item.closable ? 'x-tab-strip-closable' : '';
549 cls += ' x-item-disabled';
552 cls += ' x-tab-with-icon';
555 cls += ' ' + item.tabCls;
559 id: this.id + this.idDelimiter + item.getItemId(),
562 iconCls: item.iconCls || ''
568 Ext.TabPanel.superclass.onAdd.call(this, c);
570 var items = this.items;
571 this.initTab(c, items.indexOf(c));
572 if(items.getCount() == 1){
575 this.delegateUpdates();
580 onBeforeAdd : function(item){
581 var existing = item.events ? (this.items.containsKey(item.getItemId()) ? item : null) : this.items.get(item);
583 this.setActiveTab(item);
586 Ext.TabPanel.superclass.onBeforeAdd.apply(this, arguments);
587 var es = item.elements;
588 item.elements = es ? es.replace(',header', '') : es;
589 item.border = (item.border === true);
593 onRemove : function(c){
594 Ext.TabPanel.superclass.onRemove.call(this, c);
595 Ext.destroy(Ext.get(this.getTabEl(c)));
596 this.stack.remove(c);
597 c.un('disable', this.onItemDisabled, this);
598 c.un('enable', this.onItemEnabled, this);
599 c.un('titlechange', this.onItemTitleChanged, this);
600 c.un('iconchange', this.onItemIconChanged, this);
601 c.un('beforeshow', this.onBeforeShowItem, this);
602 if(c == this.activeTab){
603 var next = this.stack.next();
605 this.setActiveTab(next);
606 }else if(this.items.getCount() > 0){
607 this.setActiveTab(0);
609 this.activeTab = null;
612 this.delegateUpdates();
616 onBeforeShowItem : function(item){
617 if(item != this.activeTab){
618 this.setActiveTab(item);
624 onItemDisabled : function(item){
625 var el = this.getTabEl(item);
627 Ext.fly(el).addClass('x-item-disabled');
629 this.stack.remove(item);
633 onItemEnabled : function(item){
634 var el = this.getTabEl(item);
636 Ext.fly(el).removeClass('x-item-disabled');
641 onItemTitleChanged : function(item){
642 var el = this.getTabEl(item);
644 Ext.fly(el).child('span.x-tab-strip-text', true).innerHTML = item.title;
649 onItemIconChanged : function(item, iconCls, oldCls){
650 var el = this.getTabEl(item);
653 el.child('span.x-tab-strip-text').replaceClass(oldCls, iconCls);
654 el[Ext.isEmpty(iconCls) ? 'removeClass' : 'addClass']('x-tab-with-icon');
659 * Gets the DOM element for the tab strip item which activates the child panel with the specified
660 * ID. Access this to change the visual treatment of the item, for example by changing the CSS class name.
661 * @param {Panel/Number/String} tab The tab component, or the tab's index, or the tabs id or itemId.
662 * @return {HTMLElement} The DOM node
664 getTabEl : function(item){
665 return document.getElementById(this.id + this.idDelimiter + this.getComponent(item).getItemId());
669 onResize : function(){
670 Ext.TabPanel.superclass.onResize.apply(this, arguments);
671 this.delegateUpdates();
675 * Suspends any internal calculations or scrolling while doing a bulk operation. See {@link #endUpdate}
677 beginUpdate : function(){
678 this.suspendUpdates = true;
682 * Resumes calculations and scrolling at the end of a bulk operation. See {@link #beginUpdate}
684 endUpdate : function(){
685 this.suspendUpdates = false;
686 this.delegateUpdates();
690 * Hides the tab strip item for the passed tab
691 * @param {Number/String/Panel} item The tab index, id or item
693 hideTabStripItem : function(item){
694 item = this.getComponent(item);
695 var el = this.getTabEl(item);
697 el.style.display = 'none';
698 this.delegateUpdates();
700 this.stack.remove(item);
704 * Unhides the tab strip item for the passed tab
705 * @param {Number/String/Panel} item The tab index, id or item
707 unhideTabStripItem : function(item){
708 item = this.getComponent(item);
709 var el = this.getTabEl(item);
711 el.style.display = '';
712 this.delegateUpdates();
717 delegateUpdates : function(){
718 if(this.suspendUpdates){
721 if(this.resizeTabs && this.rendered){
724 if(this.enableTabScroll && this.rendered){
725 this.autoScrollTabs();
730 autoSizeTabs : function(){
731 var count = this.items.length;
732 var ce = this.tabPosition != 'bottom' ? 'header' : 'footer';
733 var ow = this[ce].dom.offsetWidth;
734 var aw = this[ce].dom.clientWidth;
736 if(!this.resizeTabs || count < 1 || !aw){ // !aw for display:none
740 var each = Math.max(Math.min(Math.floor((aw-4) / count) - this.tabMargin, this.tabWidth), this.minTabWidth); // -4 for float errors in IE
741 this.lastTabWidth = each;
742 var lis = this.strip.query("li:not([className^=x-tab-edge])");
743 for(var i = 0, len = lis.length; i < len; i++) {
745 var inner = Ext.fly(li).child('.x-tab-strip-inner', true);
746 var tw = li.offsetWidth;
747 var iw = inner.offsetWidth;
748 inner.style.width = (each - (tw-iw)) + 'px';
753 adjustBodyWidth : function(w){
755 this.header.setWidth(w);
758 this.footer.setWidth(w);
764 * Sets the specified tab as the active tab. This method fires the {@link #beforetabchange} event which
765 * can <tt>return false</tt> to cancel the tab change.
766 * @param {String/Number} item
767 * The id or tab Panel to activate. This parameter may be any of the following:
768 * <div><ul class="mdetail-params">
769 * <li>a <b><tt>String</tt></b> : representing the <code>{@link Ext.Component#itemId itemId}</code>
770 * or <code>{@link Ext.Component#id id}</code> of the child component </li>
771 * <li>a <b><tt>Number</tt></b> : representing the position of the child component
772 * within the <code>{@link Ext.Container#items items}</code> <b>property</b></li>
774 * <p>For additional information see {@link Ext.util.MixedCollection#get}.
776 setActiveTab : function(item){
777 item = this.getComponent(item);
778 if(!item || this.fireEvent('beforetabchange', this, item, this.activeTab) === false){
782 this.activeTab = item;
785 if(this.activeTab != item){
787 var oldEl = this.getTabEl(this.activeTab);
789 Ext.fly(oldEl).removeClass('x-tab-strip-active');
791 this.activeTab.fireEvent('deactivate', this.activeTab);
793 var el = this.getTabEl(item);
794 Ext.fly(el).addClass('x-tab-strip-active');
795 this.activeTab = item;
796 this.stack.add(item);
798 this.layout.setActiveItem(item);
800 this.scrollToTab(item, this.animScroll);
803 item.fireEvent('activate', item);
804 this.fireEvent('tabchange', this, item);
809 * Gets the currently active tab.
810 * @return {Panel} The active tab
812 getActiveTab : function(){
813 return this.activeTab || null;
817 * Gets the specified tab by id.
818 * @param {String} id The tab id
819 * @return {Panel} The tab
821 getItem : function(item){
822 return this.getComponent(item);
826 autoScrollTabs : function(){
827 this.pos = this.tabPosition=='bottom' ? this.footer : this.header;
828 var count = this.items.length;
829 var ow = this.pos.dom.offsetWidth;
830 var tw = this.pos.dom.clientWidth;
832 var wrap = this.stripWrap;
834 var cw = wd.offsetWidth;
835 var pos = this.getScrollPos();
836 var l = this.edge.getOffsetsTo(this.stripWrap)[0] + pos;
838 if(!this.enableTabScroll || count < 1 || cw < 20){ // 20 to prevent display:none issues
845 this.scrolling = false;
846 this.pos.removeClass('x-tab-scrolling');
847 this.scrollLeft.hide();
848 this.scrollRight.hide();
849 // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari
850 if(Ext.isAir || Ext.isWebKit){
851 wd.style.marginLeft = '';
852 wd.style.marginRight = '';
857 this.pos.addClass('x-tab-scrolling');
858 // See here: http://extjs.com/forum/showthread.php?t=49308&highlight=isSafari
859 if(Ext.isAir || Ext.isWebKit){
860 wd.style.marginLeft = '18px';
861 wd.style.marginRight = '18px';
864 tw -= wrap.getMargins('lr');
865 wrap.setWidth(tw > 20 ? tw : 20);
867 if(!this.scrollLeft){
868 this.createScrollers();
870 this.scrollLeft.show();
871 this.scrollRight.show();
874 this.scrolling = true;
875 if(pos > (l-tw)){ // ensure it stays within bounds
876 wd.scrollLeft = l-tw;
877 }else{ // otherwise, make sure the active tab is still visible
878 this.scrollToTab(this.activeTab, false);
880 this.updateScrollButtons();
885 createScrollers : function(){
886 this.pos.addClass('x-tab-scrolling-' + this.tabPosition);
887 var h = this.stripWrap.dom.offsetHeight;
890 var sl = this.pos.insertFirst({
891 cls:'x-tab-scroller-left'
894 sl.addClassOnOver('x-tab-scroller-left-over');
895 this.leftRepeater = new Ext.util.ClickRepeater(sl, {
896 interval : this.scrollRepeatInterval,
897 handler: this.onScrollLeft,
900 this.scrollLeft = sl;
903 var sr = this.pos.insertFirst({
904 cls:'x-tab-scroller-right'
907 sr.addClassOnOver('x-tab-scroller-right-over');
908 this.rightRepeater = new Ext.util.ClickRepeater(sr, {
909 interval : this.scrollRepeatInterval,
910 handler: this.onScrollRight,
913 this.scrollRight = sr;
917 getScrollWidth : function(){
918 return this.edge.getOffsetsTo(this.stripWrap)[0] + this.getScrollPos();
922 getScrollPos : function(){
923 return parseInt(this.stripWrap.dom.scrollLeft, 10) || 0;
927 getScrollArea : function(){
928 return parseInt(this.stripWrap.dom.clientWidth, 10) || 0;
932 getScrollAnim : function(){
933 return {duration:this.scrollDuration, callback: this.updateScrollButtons, scope: this};
937 getScrollIncrement : function(){
938 return this.scrollIncrement || (this.resizeTabs ? this.lastTabWidth+2 : 100);
942 * Scrolls to a particular tab if tab scrolling is enabled
943 * @param {Panel} item The item to scroll to
944 * @param {Boolean} animate True to enable animations
947 scrollToTab : function(item, animate){
949 var el = this.getTabEl(item);
950 var pos = this.getScrollPos(), area = this.getScrollArea();
951 var left = Ext.fly(el).getOffsetsTo(this.stripWrap)[0] + pos;
952 var right = left + el.offsetWidth;
954 this.scrollTo(left, animate);
955 }else if(right > (pos + area)){
956 this.scrollTo(right - area, animate);
961 scrollTo : function(pos, animate){
962 this.stripWrap.scrollTo('left', pos, animate ? this.getScrollAnim() : false);
964 this.updateScrollButtons();
968 onWheel : function(e){
969 var d = e.getWheelDelta()*this.wheelIncrement*-1;
972 var pos = this.getScrollPos();
973 var newpos = pos + d;
974 var sw = this.getScrollWidth()-this.getScrollArea();
976 var s = Math.max(0, Math.min(sw, newpos));
978 this.scrollTo(s, false);
983 onScrollRight : function(){
984 var sw = this.getScrollWidth()-this.getScrollArea();
985 var pos = this.getScrollPos();
986 var s = Math.min(sw, pos + this.getScrollIncrement());
988 this.scrollTo(s, this.animScroll);
993 onScrollLeft : function(){
994 var pos = this.getScrollPos();
995 var s = Math.max(0, pos - this.getScrollIncrement());
997 this.scrollTo(s, this.animScroll);
1002 updateScrollButtons : function(){
1003 var pos = this.getScrollPos();
1004 this.scrollLeft[pos === 0 ? 'addClass' : 'removeClass']('x-tab-scroller-left-disabled');
1005 this.scrollRight[pos >= (this.getScrollWidth()-this.getScrollArea()) ? 'addClass' : 'removeClass']('x-tab-scroller-right-disabled');
1009 beforeDestroy : function() {
1011 this.items.each(function(item){
1012 if(item && item.tabEl){
1013 Ext.get(item.tabEl).removeAllListeners();
1019 this.strip.removeAllListeners();
1021 Ext.TabPanel.superclass.beforeDestroy.apply(this);
1025 * @cfg {Boolean} collapsible
1029 * @cfg {String} header
1033 * @cfg {Boolean} headerAsText
1045 * @cfg {Array} tools
1049 * @cfg {Array} toolTemplate
1053 * @cfg {Boolean} hideCollapseTool
1057 * @cfg {Boolean} titleCollapse
1061 * @cfg {Boolean} collapsed
1065 * @cfg {String} layout
1069 * @cfg {Boolean} preventBodyReset
1073 Ext.reg('tabpanel', Ext.TabPanel);
1076 * See {@link #setActiveTab}. Sets the specified tab as the active tab. This method fires
1077 * the {@link #beforetabchange} event which can <tt>return false</tt> to cancel the tab change.
1078 * @param {String/Panel} tab The id or tab Panel to activate
1081 Ext.TabPanel.prototype.activate = Ext.TabPanel.prototype.setActiveTab;
1083 // private utility class used by TabPanel
1084 Ext.TabPanel.AccessStack = function(){
1087 add : function(item){
1089 if(items.length > 10){
1094 remove : function(item){
1096 for(var i = 0, len = items.length; i < len; i++) {
1097 if(items[i] != item){