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.TabPanelItem</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.TabPanelItem-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.TabPanelItem-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.TabPanelItem-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.TabPanelItem-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.TabPanelItem
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.TabPanelItem
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">TabPanelItem</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 Represents an individual item (tab plus body) in a TabPanel.
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.TabPanelItem';">[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.TabPanelItem.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.TabPanelItem-configs"></a>
111 <table cellspacing="0" class="member-table">
112 <caption class="Empty">Config Options - Has None</caption>
126 <!-- ============================== public properties ==================== -->
130 <a id="Roo.TabPanelItem-props"></a>
136 <table cellspacing="0" class="member-table">
137 <caption class="Empty">Public Properties - Has None</caption>
143 <!-- ============================== methods summary / details ======================== -->
146 <a id="Roo.TabPanelItem-methods"></a>
147 <!-- constructor?? -->
154 <!-- then dynamics first -->
161 <table cellspacing="0" class="member-table">
162 <caption>Public Methods</caption>
164 <th class="sig-header" colspan="2">Method</th>
165 <th class="msource-header">Defined By</th>
175 <tr class="method-row config-row-alt0 expandable notInherited">
176 <td class="micon"><a class="exi" href="#expand"> </a></td>
180 <a id="Roo-method-TabPanelItem" name=".TabPanelItem"></a>
181 <div class="fixedFont">
182 <span class="attributes">new <B>Roo.</B></span><b class="itemname">TabPanelItem</b>
184 (<a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a> <B><i>tabPanel</i></B>, <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="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>closable</i></B>)
192 <div class="short">Create a new Roo.TabPanelItem</div>
199 Create a new Roo.TabPanelItem
202 <dl class="detailList">
203 <dt class="heading">Parameters:</dt>
206 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>tabPanel</b>
209 <dd>The {<b>link</b> Roo.TabPanel} this TabPanelItem belongs to</dd>
212 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>id</b>
215 <dd>The id of this TabPanelItem</dd>
218 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
221 <dd>The text for the tab of this TabPanelItem</dd>
224 <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>
227 <dd>True to allow this TabPanelItem to be closable (defaults to false)</dd>
251 <tr class="method-row config-row-alt1 expandable notInherited">
252 <td class="micon"><a class="exi" href="#expand"> </a></td>
256 <a id="Roo.TabPanelItem-method-activate" name=".activate"></a>
257 <div class="fixedFont">
258 <span class="attributes"></span><b class="itemname">activate</b>
267 <div class="short">Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.</div>
273 Activates this TabPanelItem -- this <b>does</b> deactivate the currently active TabPanelItem.
302 <tr class="method-row config-row-alt0 expandable notInherited">
303 <td class="micon"><a class="exi" href="#expand"> </a></td>
307 <a id="Roo.TabPanelItem-method-disable" name=".disable"></a>
308 <div class="fixedFont">
309 <span class="attributes"></span><b class="itemname">disable</b>
318 <div class="short">Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.</div>
324 Disables this TabPanelItem -- this does nothing if this is the active TabPanelItem.
353 <tr class="method-row config-row-alt1 expandable notInherited">
354 <td class="micon"><a class="exi" href="#expand"> </a></td>
358 <a id="Roo.TabPanelItem-method-enable" name=".enable"></a>
359 <div class="fixedFont">
360 <span class="attributes"></span><b class="itemname">enable</b>
369 <div class="short">Enables this TabPanelItem if it was previously disabled.</div>
375 Enables this TabPanelItem if it was previously disabled.
404 <tr class="method-row config-row-alt0 expandable notInherited">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
409 <a id="Roo.TabPanelItem-method-getText" name=".getText"></a>
410 <div class="fixedFont">
411 <span class="attributes"></span><b class="itemname">getText</b>
419 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
428 <div class="short">Returns the text for this tab</div>
434 Returns the text for this tab
445 <dl class="detailList">
446 <dt class="heading">Returns:</dt>
448 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
470 <tr class="method-row config-row-alt1 expandable notInherited">
471 <td class="micon"><a class="exi" href="#expand"> </a></td>
475 <a id="Roo.TabPanelItem-method-getUpdateManager" name=".getUpdateManager"></a>
476 <div class="fixedFont">
477 <span class="attributes"></span><b class="itemname">getUpdateManager</b>
485 <a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a>
494 <div class="short">Gets the {<b>link</b> Roo.UpdateManager} for the body of this TabPanelItem.</div>
500 Gets the {<b>link</b> Roo.UpdateManager} for the body of this TabPanelItem. Enables you to perform Ajax updates.
511 <dl class="detailList">
512 <dt class="heading">Returns:</dt>
514 <dd><span class="fixedFont"><a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a></span> The UpdateManager</dd>
536 <tr class="method-row config-row-alt0 expandable notInherited">
537 <td class="micon"><a class="exi" href="#expand"> </a></td>
541 <a id="Roo.TabPanelItem-method-hide" name=".hide"></a>
542 <div class="fixedFont">
543 <span class="attributes"></span><b class="itemname">hide</b>
552 <div class="short">Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.</div>
558 Hides this TabPanelItem -- if you don't activate another TabPanelItem this could look odd.
587 <tr class="method-row config-row-alt1 expandable notInherited">
588 <td class="micon"><a class="exi" href="#expand"> </a></td>
592 <a id="Roo.TabPanelItem-method-isActive" name=".isActive"></a>
593 <div class="fixedFont">
594 <span class="attributes"></span><b class="itemname">isActive</b>
602 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
611 <div class="short">Returns true if this tab is the active tab.</div>
617 Returns true if this tab is the active tab.
628 <dl class="detailList">
629 <dt class="heading">Returns:</dt>
631 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
653 <tr class="method-row config-row-alt0 expandable notInherited">
654 <td class="micon"><a class="exi" href="#expand"> </a></td>
658 <a id="Roo.TabPanelItem-method-isHidden" name=".isHidden"></a>
659 <div class="fixedFont">
660 <span class="attributes"></span><b class="itemname">isHidden</b>
668 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
677 <div class="short">Returns true if this tab is "hidden"</div>
683 Returns true if this tab is "hidden"
694 <dl class="detailList">
695 <dt class="heading">Returns:</dt>
697 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> </dd>
719 <tr class="method-row config-row-alt1 expandable notInherited">
720 <td class="micon"><a class="exi" href="#expand"> </a></td>
724 <a id="Roo.TabPanelItem-method-refresh" name=".refresh"></a>
725 <div class="fixedFont">
726 <span class="attributes"></span><b class="itemname">refresh</b>
735 <div class="short">Forces a content refresh from the URL specified in the {<b>link</b> <b>setUrl</b>} method.</div>
741 Forces a content refresh from the URL specified in the {<b>link</b> <b>setUrl</b>} method.<br/> Will fail silently if the setUrl method has not been called.<br/> This does not activate the panel, just updates its content.
770 <tr class="method-row config-row-alt0 expandable notInherited">
771 <td class="micon"><a class="exi" href="#expand"> </a></td>
775 <a id="Roo.TabPanelItem-method-setContent" name=".setContent"></a>
776 <div class="fixedFont">
777 <span class="attributes"></span><b class="itemname">setContent</b>
779 (<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>loadScripts</i></B>)
786 <div class="short">Sets the content for this TabPanelItem.</div>
792 Sets the content for this TabPanelItem.
799 <dl class="detailList">
800 <dt class="heading">Parameters:</dt>
803 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>content</b>
809 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>loadScripts</b>
812 <dd>true to look for and load scripts</dd>
838 <tr class="method-row config-row-alt1 expandable notInherited">
839 <td class="micon"><a class="exi" href="#expand"> </a></td>
843 <a id="Roo.TabPanelItem-method-setHidden" name=".setHidden"></a>
844 <div class="fixedFont">
845 <span class="attributes"></span><b class="itemname">setHidden</b>
847 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hidden</i></B>)
854 <div class="short">Show or hide the tab</div>
867 <dl class="detailList">
868 <dt class="heading">Parameters:</dt>
871 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>hidden</b>
874 <dd>True to hide or false to show.</dd>
900 <tr class="method-row config-row-alt0 expandable notInherited">
901 <td class="micon"><a class="exi" href="#expand"> </a></td>
905 <a id="Roo.TabPanelItem-method-setText" name=".setText"></a>
906 <div class="fixedFont">
907 <span class="attributes"></span><b class="itemname">setText</b>
909 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>text</i></B>)
916 <div class="short">Sets the text for the tab (Note: this also sets the tooltip text)</div>
922 Sets the text for the tab (Note: this also sets the tooltip text)
929 <dl class="detailList">
930 <dt class="heading">Parameters:</dt>
933 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>text</b>
936 <dd>The tab's text and tooltip</dd>
962 <tr class="method-row config-row-alt1 expandable notInherited">
963 <td class="micon"><a class="exi" href="#expand"> </a></td>
967 <a id="Roo.TabPanelItem-method-setTooltip" name=".setTooltip"></a>
968 <div class="fixedFont">
969 <span class="attributes"></span><b class="itemname">setTooltip</b>
971 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>tooltip</i></B>)
978 <div class="short">Set the tooltip for the tab.</div>
984 Set the tooltip for the tab.
991 <dl class="detailList">
992 <dt class="heading">Parameters:</dt>
995 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>tooltip</b>
998 <dd>The tab's tooltip</dd>
1016 <td class="msource">
1024 <tr class="method-row config-row-alt0 expandable notInherited">
1025 <td class="micon"><a class="exi" href="#expand"> </a></td>
1029 <a id="Roo.TabPanelItem-method-setUrl" name=".setUrl"></a>
1030 <div class="fixedFont">
1031 <span class="attributes"></span><b class="itemname">setUrl</b>
1033 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function <B><i>url</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object <B><i>params</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>loadOnce</i></B>)
1039 <a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a>
1048 <div class="short">Set a URL to be used to load the content for this TabPanelItem.</div>
1054 Set a URL to be used to load the content for this TabPanelItem.
1061 <dl class="detailList">
1062 <dt class="heading">Parameters:</dt>
1065 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Function</span> <b>url</b>
1068 <dd>The URL to load the content from, or a function to call to get the URL</dd>
1071 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/Object</span> <b>params</b>
1074 <dd>(optional) The string params for the update call or an object of the params. See {<b>link</b> Roo.UpdateManager<b>update</b>} for more details. (Defaults to null)</dd>
1077 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>loadOnce</b>
1080 <dd>(optional) Whether to only load the content once. If this is false it makes the Ajax call every time this TabPanelItem is activated. (Defaults to false)</dd>
1088 <dl class="detailList">
1089 <dt class="heading">Returns:</dt>
1091 <dd><span class="fixedFont"><a href="./Roo.UpdateManager.html#constructor" roo:cls="Roo.UpdateManager.html#constructor">Roo.UpdateManager</a></span> The UpdateManager</dd>
1105 <td class="msource">
1113 <tr class="method-row config-row-alt1 expandable notInherited">
1114 <td class="micon"><a class="exi" href="#expand"> </a></td>
1118 <a id="Roo.TabPanelItem-method-show" name=".show"></a>
1119 <div class="fixedFont">
1120 <span class="attributes"></span><b class="itemname">show</b>
1129 <div class="short">Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.</div>
1135 Shows this TabPanelItem -- this <b>does not</b> deactivate the currently active TabPanelItem.
1156 <td class="msource">
1167 <!-- ============================== events summary / details ======================== -->
1170 <a id="Roo.TabPanelItem-events"></a>
1179 <table cellspacing="0" class="member-table">
1180 <caption>Events</caption>
1183 <th class="sig-header" colspan="2">Event</th>
1184 <th class="msource-header">Defined By</th>
1193 <tr class="method-row expandable config-row-alt0 notInherited">
1194 <td class="micon"><a class="exi" href="#expand"> </a></td>
1197 <a id="Roo.TabPanelItem-event-*activate"></a>
1199 <div class="fixedFont">
1200 <b class="itemname">activate</b> (<a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a> <B><i>tabPanel</i></B>, <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>this</i></B>)
1206 <div class="short">Fires when this tab becomes the active tab.
1212 Fires when this tab becomes the active tab.
1218 <dl class="detailList">
1219 <dt class="heading">Parameters:</dt>
1222 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>tabPanel</b>
1225 <dd>The parent TabPanel</dd>
1228 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>this</b>
1249 <td class="msource">
1254 <tr class="method-row expandable config-row-alt1 notInherited">
1255 <td class="micon"><a class="exi" href="#expand"> </a></td>
1258 <a id="Roo.TabPanelItem-event-*beforeclose"></a>
1260 <div class="fixedFont">
1261 <b class="itemname">beforeclose</b> (<a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</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>)
1267 <div class="short">Fires before this tab is closed.
1273 Fires before this tab is closed. To cancel the close, set cancel to true on e (e.cancel = true).
1279 <dl class="detailList">
1280 <dt class="heading">Parameters:</dt>
1283 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>this</b>
1289 <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>
1292 <dd>Set cancel to true on this object to cancel the close.</dd>
1310 <td class="msource">
1315 <tr class="method-row expandable config-row-alt0 notInherited">
1316 <td class="micon"><a class="exi" href="#expand"> </a></td>
1319 <a id="Roo.TabPanelItem-event-*close"></a>
1321 <div class="fixedFont">
1322 <b class="itemname">close</b> (<a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>this</i></B>)
1328 <div class="short">Fires when this tab is closed.
1334 Fires when this tab is closed.
1340 <dl class="detailList">
1341 <dt class="heading">Parameters:</dt>
1344 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>this</b>
1365 <td class="msource">
1370 <tr class="method-row expandable config-row-alt1 notInherited">
1371 <td class="micon"><a class="exi" href="#expand"> </a></td>
1374 <a id="Roo.TabPanelItem-event-*deactivate"></a>
1376 <div class="fixedFont">
1377 <b class="itemname">deactivate</b> (<a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a> <B><i>tabPanel</i></B>, <a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a> <B><i>this</i></B>)
1383 <div class="short">Fires when this tab is no longer the active tab.
1389 Fires when this tab is no longer the active tab.
1395 <dl class="detailList">
1396 <dt class="heading">Parameters:</dt>
1399 <span class="fixedFont"><a href="./Roo.TabPanel.html#constructor" roo:cls="Roo.TabPanel.html#constructor">Roo.TabPanel</a></span> <b>tabPanel</b>
1402 <dd>The parent TabPanel</dd>
1405 <span class="fixedFont"><a href="./Roo.TabPanelItem.html#constructor" roo:cls="Roo.TabPanelItem.html#constructor">Roo.TabPanelItem</a></span> <b>this</b>
1426 <td class="msource">
1438 <!-- ============================== footer ================================= -->
1439 <div class="fineprint" style="clear:both">
1441 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:24 GMT+0800 (HKT)
1443 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>