1 <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
4 <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
7 <meta http-equiv="content-type" content="text/html; charset=undefined" />
8 <meta name="generator" content="JsDoc Toolkit" />
11 <title>JsDoc Reference - Roo.TabPanel</title>
14 <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
15 <link rel="stylesheet" type="text/css" href="../default.css" />
18 <script type="text/javascript" src="../page.js">
25 <body onload="RooDocsPage.onload();">
28 <div class="body-wrap">
30 <!-- ============================== links to methods. ================================= -->
32 <div class="top-tools">
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>
43 <!-- ============================== inheritance Block. ================================= -->
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
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_TabPanel.js.html">Roo/TabPanel.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">TabPanel</td></tr>
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>
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>
89 <!-- ============================== Class comment block... ========================== -->
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>
95 <iframe frameborder="0" id="comments-Roo" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.TabPanel.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.TabPanel-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
132 <div class="fixedFont">
133 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <div class="short">list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> .</div>
144 list of events and functions to call for this object, <br/>For example :<br/><pre><code><br/> listeners : { <br/> 'click' : function(e) {<br/> ..... <br/> } ,<br/> .... <br/> } <br/> </code></pre>
154 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
170 <!-- ============================== public properties ==================== -->
174 <a id="Roo.TabPanel-props"></a>
180 <table cellspacing="0" class="member-table">
181 <caption class="Empty">Public Properties - Has None</caption>
187 <!-- ============================== methods summary / details ======================== -->
190 <a id="Roo.TabPanel-methods"></a>
191 <!-- constructor?? -->
198 <!-- then dynamics first -->
205 <table cellspacing="0" class="member-table">
206 <caption>Public Methods</caption>
208 <th class="sig-header" colspan="2">Method</th>
209 <th class="msource-header">Defined By</th>
219 <tr class="method-row config-row-alt0 expandable notInherited">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
224 <a id="Roo-method-TabPanel" name=".TabPanel"></a>
225 <div class="fixedFont">
226 <span class="attributes">new <B>Roo.</B></span><b class="itemname">TabPanel</b>
228 (<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>)
236 <div class="short">Create a new Roo.TabPanel</div>
243 Create a new Roo.TabPanel
246 <dl class="detailList">
247 <dt class="heading">Parameters:</dt>
250 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>container</b>
253 <dd>The id, DOM element or Roo.Element container where this TabPanel is to be rendered.</dd>
256 <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>
259 <dd>Config object to set any properties for this TabPanel, or true to render the tabs on the bottom.</dd>
283 <tr class="method-row config-row-alt1 expandable notInherited">
284 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.TabPanel-method-activate" name=".activate"></a>
289 <div class="fixedFont">
290 <span class="attributes"></span><b class="itemname">activate</b>
292 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
298 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
307 <div class="short">Activates a {<b>link</b> Roo.TabPanelItem}.</div>
313 Activates a {<b>link</b> Roo.TabPanelItem}. The currently active one will be deactivated.
320 <dl class="detailList">
321 <dt class="heading">Parameters:</dt>
324 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
327 <dd>The id or index of the TabPanelItem to activate.</dd>
335 <dl class="detailList">
336 <dt class="heading">Returns:</dt>
338 <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> The TabPanelItem.</dd>
360 <tr class="method-row config-row-alt0 expandable">
361 <td class="micon"><a class="exi" href="#expand"> </a></td>
365 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
366 <div class="fixedFont">
367 <span class="attributes"></span><b class="itemname">addEvents</b>
369 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
376 <div class="short">Used to define events on this Observable</div>
382 Used to define events on this Observable
389 <dl class="detailList">
390 <dt class="heading">Parameters:</dt>
393 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>object</b>
396 <dd>The object with the events defined</dd>
416 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
422 <tr class="method-row config-row-alt1 expandable">
423 <td class="micon"><a class="exi" href="#expand"> </a></td>
427 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
428 <div class="fixedFont">
429 <span class="attributes"></span><b class="itemname">addListener</b>
431 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
438 <div class="short">Appends an event handler to this component</div>
444 Appends an event handler to this component
451 <dl class="detailList">
452 <dt class="heading">Parameters:</dt>
455 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
458 <dd>The type of event to listen for</dd>
461 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
464 <dd>The method the event invokes</dd>
467 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
470 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
473 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
476 <dd>(optional) An object containing handler configuration<br/>properties. This may contain any of the following properties:<ul><br/><li>scope {Object} The scope in which to execute the handler function. The handler function's "this" context.</li><br/><li>delay {Number} The number of milliseconds to delay the invocation of the handler after te event fires.</li><br/><li>single {Boolean} True to add a handler to handle just the next firing of the event, and then remove itself.</li><br/><li>buffer {Number} Causes the handler to be scheduled to run in an {<b>link</b> Roo.util.DelayedTask} delayed<br/>by the specified number of milliseconds. If the event fires again within that time, the original<br/>handler is <em>not</em> invoked, but the new handler is scheduled in its place.</li><br/></ul><br><br/><p><br/><b>Combining Options</b><br><br/>Using the options argument, it is possible to combine different types of listeners:<br><br/><br><br/>A normalized, delayed, one-time listener that auto stops the event and passes a custom argument (forumId)<br/> <pre><code><br/> el.on('click', this.onClick, this, {<br/> single: true,<br/> delay: 100,<br/> forumId: 4<br/> });<br/> </code></pre><br/><p><br/><b>Attaching multiple handlers in 1 call</b><br><br/>The method also allows for a single argument to be passed which is a config object containing properties<br/>which specify multiple handlers.<br/><pre><code><br/> el.on({<br/> 'click': {<br/> fn: this.onClick,<br/> scope: this,<br/> delay: 100<br/> }, <br/> 'mouseover': {<br/> fn: this.onMouseOver,<br/> scope: this<br/> },<br/> 'mouseout': {<br/> fn: this.onMouseOut,<br/> scope: this<br/> }<br/> });<br/> </code></pre><br/><p><br/>Or a shorthand syntax which passes the same scope object to all handlers:<br/> <pre><code><br/> el.on({<br/> 'click': this.onClick,<br/> 'mouseover': this.onMouseOver,<br/> 'mouseout': this.onMouseOut,<br/> scope: this<br/> });<br/> </code></pre></dd>
496 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
502 <tr class="method-row config-row-alt0 expandable notInherited">
503 <td class="micon"><a class="exi" href="#expand"> </a></td>
507 <a id="Roo.TabPanel-method-addTab" name=".addTab"></a>
508 <div class="fixedFont">
509 <span class="attributes"></span><b class="itemname">addTab</b>
511 (<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>)
517 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
526 <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>
532 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.
539 <dl class="detailList">
540 <dt class="heading">Parameters:</dt>
543 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
546 <dd>The id of the div to use <b>or create</b></dd>
549 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
552 <dd>The text for the tab</dd>
555 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>content</b>
558 <dd>(optional) Content to put in the TabPanelItem body</dd>
561 <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>
564 <dd>(optional) True to create a close icon on the tab</dd>
572 <dl class="detailList">
573 <dt class="heading">Returns:</dt>
575 <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> The created TabPanelItem</dd>
597 <tr class="method-row config-row-alt1 expandable notInherited">
598 <td class="micon"><a class="exi" href="#expand"> </a></td>
602 <a id="Roo.TabPanel-method-addTabItem" name=".addTabItem"></a>
603 <div class="fixedFont">
604 <span class="attributes"></span><b class="itemname">addTabItem</b>
606 (<a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>item</i></B>)
613 <div class="short">Adds an existing {<b>link</b> Roo.TabPanelItem}.</div>
619 Adds an existing {<b>link</b> Roo.TabPanelItem}.
626 <dl class="detailList">
627 <dt class="heading">Parameters:</dt>
630 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>item</b>
633 <dd>The TabPanelItem to add</dd>
659 <tr class="method-row config-row-alt0 expandable notInherited">
660 <td class="micon"><a class="exi" href="#expand"> </a></td>
664 <a id="Roo.TabPanel-method-autoSizeTabs" name=".autoSizeTabs"></a>
665 <div class="fixedFont">
666 <span class="attributes"></span><b class="itemname">autoSizeTabs</b>
675 <div class="short">Manual call to resize the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
681 Manual call to resize the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
710 <tr class="method-row config-row-alt1 expandable notInherited">
711 <td class="micon"><a class="exi" href="#expand"> </a></td>
715 <a id="Roo.TabPanel-method-beginUpdate" name=".beginUpdate"></a>
716 <div class="fixedFont">
717 <span class="attributes"></span><b class="itemname">beginUpdate</b>
726 <div class="short">Disables tab resizing while tabs are being added (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
732 Disables tab resizing while tabs are being added (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
761 <tr class="method-row config-row-alt0 expandable notInherited">
762 <td class="micon"><a class="exi" href="#expand"> </a></td>
766 <a id="Roo.TabPanel-method-destroy" name=".destroy"></a>
767 <div class="fixedFont">
768 <span class="attributes"></span><b class="itemname">destroy</b>
770 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
777 <div class="short">Destroys this TabPanel</div>
783 Destroys this TabPanel
790 <dl class="detailList">
791 <dt class="heading">Parameters:</dt>
794 <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>
797 <dd>(optional) True to remove the element from the DOM as well (defaults to undefined)</dd>
823 <tr class="method-row config-row-alt1 expandable notInherited">
824 <td class="micon"><a class="exi" href="#expand"> </a></td>
828 <a id="Roo.TabPanel-method-disableTab" name=".disableTab"></a>
829 <div class="fixedFont">
830 <span class="attributes"></span><b class="itemname">disableTab</b>
832 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
839 <div class="short">Disables a {<b>link</b> Roo.TabPanelItem}.</div>
845 Disables a {<b>link</b> Roo.TabPanelItem}. It cannot be the active tab, if it is this call is ignored.
852 <dl class="detailList">
853 <dt class="heading">Parameters:</dt>
856 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
859 <dd>The id or index of the TabPanelItem to disable.</dd>
885 <tr class="method-row config-row-alt0 expandable notInherited">
886 <td class="micon"><a class="exi" href="#expand"> </a></td>
890 <a id="Roo.TabPanel-method-enableTab" name=".enableTab"></a>
891 <div class="fixedFont">
892 <span class="attributes"></span><b class="itemname">enableTab</b>
894 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
901 <div class="short">Enables a {<b>link</b> Roo.TabPanelItem} that is disabled.</div>
907 Enables a {<b>link</b> Roo.TabPanelItem} that is disabled.
914 <dl class="detailList">
915 <dt class="heading">Parameters:</dt>
918 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
921 <dd>The id or index of the TabPanelItem to enable.</dd>
947 <tr class="method-row config-row-alt1 expandable notInherited">
948 <td class="micon"><a class="exi" href="#expand"> </a></td>
952 <a id="Roo.TabPanel-method-endUpdate" name=".endUpdate"></a>
953 <div class="fixedFont">
954 <span class="attributes"></span><b class="itemname">endUpdate</b>
963 <div class="short">Stops an update and resizes the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)</div>
969 Stops an update and resizes the tabs (if {<b>link</b> <b>resizeTabs</b>} is false this does nothing)
998 <tr class="method-row config-row-alt0 expandable">
999 <td class="micon"><a class="exi" href="#expand"> </a></td>
1003 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1004 <div class="fixedFont">
1005 <span class="attributes"></span><b class="itemname">fireEvent</b>
1007 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a> <B><i>args</i></B>)
1013 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1022 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1028 Fires the specified event with the passed parameters (minus the event name).
1035 <dl class="detailList">
1036 <dt class="heading">Parameters:</dt>
1039 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1045 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object...</a></span> <b>args</b>
1048 <dd>Variable number of parameters are passed to handlers</dd>
1056 <dl class="detailList">
1057 <dt class="heading">Returns:</dt>
1059 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> returns false if any of the handlers return false otherwise it returns true</dd>
1073 <td class="msource">
1075 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1081 <tr class="method-row config-row-alt1 expandable notInherited">
1082 <td class="micon"><a class="exi" href="#expand"> </a></td>
1086 <a id="Roo.TabPanel-method-getActiveTab" name=".getActiveTab"></a>
1087 <div class="fixedFont">
1088 <span class="attributes"></span><b class="itemname">getActiveTab</b>
1096 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
1105 <div class="short">Gets the active {<b>link</b> Roo.TabPanelItem}.</div>
1111 Gets the active {<b>link</b> Roo.TabPanelItem}.
1122 <dl class="detailList">
1123 <dt class="heading">Returns:</dt>
1125 <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>
1139 <td class="msource">
1147 <tr class="method-row config-row-alt0 expandable notInherited">
1148 <td class="micon"><a class="exi" href="#expand"> </a></td>
1152 <a id="Roo.TabPanel-method-getCount" name=".getCount"></a>
1153 <div class="fixedFont">
1154 <span class="attributes"></span><b class="itemname">getCount</b>
1162 <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1171 <div class="short">Returns the number of tabs in this TabPanel.</div>
1177 Returns the number of tabs in this TabPanel.
1188 <dl class="detailList">
1189 <dt class="heading">Returns:</dt>
1191 <dd><span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> </dd>
1205 <td class="msource">
1213 <tr class="method-row config-row-alt1 expandable notInherited">
1214 <td class="micon"><a class="exi" href="#expand"> </a></td>
1218 <a id="Roo.TabPanel-method-getTab" name=".getTab"></a>
1219 <div class="fixedFont">
1220 <span class="attributes"></span><b class="itemname">getTab</b>
1222 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1228 <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a>
1237 <div class="short">Returns the {<b>link</b> Roo.TabPanelItem} with the specified id/index</div>
1243 Returns the {<b>link</b> Roo.TabPanelItem} with the specified id/index
1250 <dl class="detailList">
1251 <dt class="heading">Parameters:</dt>
1254 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
1257 <dd>The id or index of the TabPanelItem to fetch.</dd>
1265 <dl class="detailList">
1266 <dt class="heading">Returns:</dt>
1268 <dd><span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> </dd>
1282 <td class="msource">
1290 <tr class="method-row config-row-alt0 expandable">
1291 <td class="micon"><a class="exi" href="#expand"> </a></td>
1295 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1296 <div class="fixedFont">
1297 <span class="attributes"></span><b class="itemname">hasListener</b>
1299 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1305 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1314 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1320 Checks to see if this object has any listeners for a specified event
1327 <dl class="detailList">
1328 <dt class="heading">Parameters:</dt>
1331 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1334 <dd>The name of the event to check for</dd>
1342 <dl class="detailList">
1343 <dt class="heading">Returns:</dt>
1345 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> True if the event is being listened for, else false</dd>
1359 <td class="msource">
1361 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1367 <tr class="method-row config-row-alt1 expandable notInherited">
1368 <td class="micon"><a class="exi" href="#expand"> </a></td>
1372 <a id="Roo.TabPanel-method-hideTab" name=".hideTab"></a>
1373 <div class="fixedFont">
1374 <span class="attributes"></span><b class="itemname">hideTab</b>
1376 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1383 <div class="short">Hides the {<b>link</b> Roo.TabPanelItem} with the specified id/index</div>
1389 Hides the {<b>link</b> Roo.TabPanelItem} with the specified id/index
1396 <dl class="detailList">
1397 <dt class="heading">Parameters:</dt>
1400 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
1403 <dd>The id or index of the TabPanelItem to hide.</dd>
1421 <td class="msource">
1429 <tr class="method-row config-row-alt0 expandable">
1430 <td class="micon"><a class="exi" href="#expand"> </a></td>
1434 <a id="Roo.util.Observable-method-on" name=".on"></a>
1435 <div class="fixedFont">
1436 <span class="attributes"></span><b class="itemname">on</b>
1438 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>options</i></B>)
1445 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1451 Appends an event handler to this element (shorthand for addListener)
1458 <dl class="detailList">
1459 <dt class="heading">Parameters:</dt>
1462 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1465 <dd>The type of event to listen for</dd>
1468 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1471 <dd>The method the event invokes</dd>
1474 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1477 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1480 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>options</b>
1501 <td class="msource">
1503 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1509 <tr class="method-row config-row-alt1 expandable">
1510 <td class="micon"><a class="exi" href="#expand"> </a></td>
1514 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1515 <div class="fixedFont">
1516 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1525 <div class="short">Removes all listeners for this object</div>
1531 Removes all listeners for this object
1552 <td class="msource">
1554 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1560 <tr class="method-row config-row-alt0 expandable">
1561 <td class="micon"><a class="exi" href="#expand"> </a></td>
1565 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1566 <div class="fixedFont">
1567 <span class="attributes"></span><b class="itemname">removeListener</b>
1569 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1576 <div class="short">Removes a listener</div>
1589 <dl class="detailList">
1590 <dt class="heading">Parameters:</dt>
1593 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1596 <dd>The type of event to listen for</dd>
1599 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1602 <dd>The handler to remove</dd>
1605 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1608 <dd>(optional) The scope (this object) for the handler</dd>
1626 <td class="msource">
1628 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1634 <tr class="method-row config-row-alt1 expandable notInherited">
1635 <td class="micon"><a class="exi" href="#expand"> </a></td>
1639 <a id="Roo.TabPanel-method-removeTab" name=".removeTab"></a>
1640 <div class="fixedFont">
1641 <span class="attributes"></span><b class="itemname">removeTab</b>
1643 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1650 <div class="short">Removes a {<b>link</b> Roo.TabPanelItem}.</div>
1656 Removes a {<b>link</b> Roo.TabPanelItem}.
1663 <dl class="detailList">
1664 <dt class="heading">Parameters:</dt>
1667 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
1670 <dd>The id or index of the TabPanelItem to remove.</dd>
1688 <td class="msource">
1696 <tr class="method-row config-row-alt0 expandable notInherited">
1697 <td class="micon"><a class="exi" href="#expand"> </a></td>
1701 <a id="Roo.TabPanel-method-setTabWidth" name=".setTabWidth"></a>
1702 <div class="fixedFont">
1703 <span class="attributes"></span><b class="itemname">setTabWidth</b>
1705 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>The</i></B>)
1712 <div class="short">Resizes all the tabs to the passed width</div>
1718 Resizes all the tabs to the passed width
1725 <dl class="detailList">
1726 <dt class="heading">Parameters:</dt>
1729 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>The</b>
1750 <td class="msource">
1758 <tr class="method-row config-row-alt1 expandable notInherited">
1759 <td class="micon"><a class="exi" href="#expand"> </a></td>
1763 <a id="Roo.TabPanel-method-syncHeight" name=".syncHeight"></a>
1764 <div class="fixedFont">
1765 <span class="attributes"></span><b class="itemname">syncHeight</b>
1767 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>targetHeight</i></B>)
1774 <div class="short">Updates the tab body element to fit the height of the container element<br/>for overflow scrolling</div>
1780 Updates the tab body element to fit the height of the container element<br/>for overflow scrolling
1787 <dl class="detailList">
1788 <dt class="heading">Parameters:</dt>
1791 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>targetHeight</b>
1794 <dd>(optional) Override the starting height from the elements height</dd>
1812 <td class="msource">
1820 <tr class="method-row config-row-alt0 expandable">
1821 <td class="micon"><a class="exi" href="#expand"> </a></td>
1825 <a id="Roo.util.Observable-method-un" name=".un"></a>
1826 <div class="fixedFont">
1827 <span class="attributes"></span><b class="itemname">un</b>
1829 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>, <a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a> <B><i>handler</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>scope</i></B>)
1836 <div class="short">Removes a listener (shorthand for removeListener)</div>
1842 Removes a listener (shorthand for removeListener)
1849 <dl class="detailList">
1850 <dt class="heading">Parameters:</dt>
1853 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1856 <dd>The type of event to listen for</dd>
1859 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1862 <dd>The handler to remove</dd>
1865 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>scope</b>
1868 <dd>(optional) The scope (this object) for the handler</dd>
1886 <td class="msource">
1888 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1894 <tr class="method-row config-row-alt1 expandable notInherited">
1895 <td class="micon"><a class="exi" href="#expand"> </a></td>
1899 <a id="Roo.TabPanel-method-unhideTab" name=".unhideTab"></a>
1900 <div class="fixedFont">
1901 <span class="attributes"></span><b class="itemname">unhideTab</b>
1903 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number <B><i>id</i></B>)
1910 <div class="short">"Unhides" the {<b>link</b> Roo.TabPanelItem} with the specified id/index.</div>
1916 "Unhides" the {<b>link</b> Roo.TabPanelItem} with the specified id/index.
1923 <dl class="detailList">
1924 <dt class="heading">Parameters:</dt>
1927 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Number</span> <b>id</b>
1930 <dd>The id or index of the TabPanelItem to unhide.</dd>
1948 <td class="msource">
1959 <!-- ============================== events summary / details ======================== -->
1962 <a id="Roo.TabPanel-events"></a>
1971 <table cellspacing="0" class="member-table">
1972 <caption>Events</caption>
1975 <th class="sig-header" colspan="2">Event</th>
1976 <th class="msource-header">Defined By</th>
1985 <tr class="method-row expandable config-row-alt0 notInherited">
1986 <td class="micon"><a class="exi" href="#expand"> </a></td>
1989 <a id="Roo.TabPanel-event-*beforetabchange"></a>
1991 <div class="fixedFont">
1992 <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>)
1998 <div class="short">Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change
2004 Fires before the active tab changes, set cancel to true on the "e" parameter to cancel the change
2010 <dl class="detailList">
2011 <dt class="heading">Parameters:</dt>
2014 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>this</b>
2020 <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>
2023 <dd>Set cancel to true on this object to cancel the tab change</dd>
2026 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>tab</b>
2029 <dd>The tab being changed to</dd>
2047 <td class="msource">
2052 <tr class="method-row expandable config-row-alt1 notInherited">
2053 <td class="micon"><a class="exi" href="#expand"> </a></td>
2056 <a id="Roo.TabPanel-event-*tabchange"></a>
2058 <div class="fixedFont">
2059 <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>)
2065 <div class="short">Fires when the active tab changes
2071 Fires when the active tab changes
2077 <dl class="detailList">
2078 <dt class="heading">Parameters:</dt>
2081 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>this</b>
2087 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>activePanel</b>
2090 <dd>The new active tab</dd>
2108 <td class="msource">
2120 <!-- ============================== footer ================================= -->
2121 <div class="fineprint" style="clear:both">
2123 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Oct 14 2016 10:07:51 GMT+0800 (HKT)
2125 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>