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.bootstrap.NavHeaderbar</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.bootstrap.NavHeaderbar-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.NavHeaderbar-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.NavHeaderbar-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.NavHeaderbar-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 src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
48 <img src="../../images/default/s.gif" height="1" width="40"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
49 <img src="../../images/default/s.gif" height="1" width="60"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.bootstrap.Navbar.html#constructor" roo:cls="Roo.bootstrap.Navbar.html#constructor">Roo.bootstrap.Navbar</a>
50 <img src="../../images/default/s.gif" height="1" width="80"/><img src="../../images/default/tree/elbow-end.gif" class="elbow"/><a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
51 <img src="../../images/default/s.gif" height="1" width="100"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.bootstrap.NavHeaderbar
56 <!-- ============================== class title / details ============================ -->
59 <h1 class="classTitle">
61 Class Roo.bootstrap.NavHeaderbar
64 <table cellspacing="0" class="class-summary-table">
66 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
68 <tr><td class="label">Defined In:</td><td class="hd-info">
70 <a href="./src/Roo_bootstrap_NavHeaderbar.js.html">Roo/bootstrap/NavHeaderbar.js</a>.
73 <tr><td class="label">Class:</td><td class="hd-info">NavHeaderbar</td></tr>
78 <tr><td class="label">Extends:</td><td class="hd-info">
79 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
87 <!-- ============================== class summary ========================== -->
88 <div class="description">
89 Bootstrap Sidebar class
93 <!-- ============================== Class comment block... ========================== -->
95 <div class="comments">
96 <b>Class Comments / Notes</B> =>
97 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.NavHeaderbar';">[Add Your comment/notes about this class]</u>
99 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
100 src="/blog.php/GtkDjsComments/Roo.bootstrap.NavHeaderbar.html"></iframe>
105 <!-- ============================== config options ========================== -->
110 <div class="hr"></div>
111 <a id="Roo.bootstrap.NavHeaderbar-configs"></a>
117 <table cellspacing="0" class="member-table">
118 <caption>Config Options (Usually are also Properties)</caption>
122 <th class="sig-header" colspan="2">Options</th>
124 <th class="msource-header">Defined By</th>
131 <tr class="config-row expandable config-row-alt0">
132 <td class="micon"><a class="exi" href="#expand"> </a></td>
135 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
136 <div class="fixedFont">
137 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
143 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
148 which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'
158 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
164 <tr class="config-row expandable config-row-alt1">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.bootstrap.NavSimplebar-cfg-align" name=".align"></a>
169 <div class="fixedFont">
170 <b class="itemname">align</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
176 <div class="short">alignment</div>
182 <BR/>Possible Values: left, right
191 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
197 <tr class="config-row expandable config-row-alt0">
198 <td class="micon"><a class="exi" href="#expand"> </a></td>
201 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
202 <div class="fixedFont">
203 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
209 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
214 Whether the component can move the Dom node when rendering (defaults to true).
224 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
230 <tr class="config-row expandable config-row-alt1">
231 <td class="micon"><a class="exi" href="#expand"> </a></td>
234 <a id="Roo.bootstrap.NavSimplebar-cfg-arrangement" name=".arrangement"></a>
235 <div class="fixedFont">
236 <b class="itemname">arrangement</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
242 <div class="short">stacked | justified</div>
257 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
263 <tr class="config-row expandable config-row-alt0 notInherited">
264 <td class="micon"><a class="exi" href="#expand"> </a></td>
267 <a id="Roo.bootstrap.NavHeaderbar-cfg-autohide" name=".autohide"></a>
268 <div class="fixedFont">
269 <b class="itemname">autohide</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
275 <div class="short">a top nav bar header that hides on scroll.</div>
280 a top nav bar header that hides on scroll.
290 Roo.bootstrap.NavHeaderbar
296 <tr class="config-row expandable config-row-alt1 notInherited">
297 <td class="micon"><a class="exi" href="#expand"> </a></td>
300 <a id="Roo.bootstrap.NavHeaderbar-cfg-brand" name=".brand"></a>
301 <div class="fixedFont">
302 <b class="itemname">brand</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
308 <div class="short">what is brand</div>
323 Roo.bootstrap.NavHeaderbar
329 <tr class="config-row expandable config-row-alt0 notInherited">
330 <td class="micon"><a class="exi" href="#expand"> </a></td>
333 <a id="Roo.bootstrap.NavHeaderbar-cfg-brand_href" name=".brand_href"></a>
334 <div class="fixedFont">
335 <b class="itemname">brand_href</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
341 <div class="short">href of the brand</div>
356 Roo.bootstrap.NavHeaderbar
362 <tr class="config-row expandable config-row-alt1">
363 <td class="micon"><a class="exi" href="#expand"> </a></td>
366 <a id="Roo.bootstrap.Component-cfg-can_build_overlaid" name=".can_build_overlaid"></a>
367 <div class="fixedFont">
368 <b class="itemname">can_build_overlaid</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
374 <div class="short">True if element can be rebuild from a HTML page</div>
379 True if element can be rebuild from a HTML page
389 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
395 <tr class="config-row expandable config-row-alt0">
396 <td class="micon"><a class="exi" href="#expand"> </a></td>
399 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
400 <div class="fixedFont">
401 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
407 <div class="short">css class</div>
422 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
428 <tr class="config-row expandable config-row-alt1">
429 <td class="micon"><a class="exi" href="#expand"> </a></td>
432 <a id="Roo.bootstrap.Component-cfg-container_method" name=".container_method"></a>
433 <div class="fixedFont">
434 <b class="itemname">container_method</b> : string
440 <div class="short">method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)</div>
445 method to fetch parents container element (used by NavHeaderbar - getHeaderChildContainer)
455 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
461 <tr class="config-row expandable config-row-alt0">
462 <td class="micon"><a class="exi" href="#expand"> </a></td>
465 <a id="Roo.bootstrap.Component-cfg-dataId" name=".dataId"></a>
466 <div class="fixedFont">
467 <b class="itemname">dataId</b> : string
473 <div class="short">cutomer id</div>
488 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
494 <tr class="config-row expandable config-row-alt1 notInherited">
495 <td class="micon"><a class="exi" href="#expand"> </a></td>
498 <a id="Roo.bootstrap.NavHeaderbar-cfg-desktopCenter" name=".desktopCenter"></a>
499 <div class="fixedFont">
500 <b class="itemname">desktopCenter</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
506 <div class="short">should the header be centered on desktop using a container class</div>
511 should the header be centered on desktop using a container class
521 Roo.bootstrap.NavHeaderbar
527 <tr class="config-row expandable config-row-alt0">
528 <td class="micon"><a class="exi" href="#expand"> </a></td>
531 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
532 <div class="fixedFont">
533 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
539 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
544 CSS class added to the component when it is disabled (defaults to "x-item-disabled").
554 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
560 <tr class="config-row expandable config-row-alt1">
561 <td class="micon"><a class="exi" href="#expand"> </a></td>
564 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
565 <div class="fixedFont">
566 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
572 <div class="short">How this component should hidden.</div>
577 How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".
578 <BR/>Possible Values: display, visibility
587 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
593 <tr class="config-row expandable config-row-alt0">
594 <td class="micon"><a class="exi" href="#expand"> </a></td>
597 <a id="Roo.bootstrap.NavSimplebar-cfg-inverse" name=".inverse"></a>
598 <div class="fixedFont">
599 <b class="itemname">inverse</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
605 <div class="short">is inverted color</div>
620 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
626 <tr class="config-row expandable config-row-alt1">
627 <td class="micon"><a class="exi" href="#expand"> </a></td>
630 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
631 <div class="fixedFont">
632 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
638 <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>
643 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>
653 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
659 <tr class="config-row expandable config-row-alt0">
660 <td class="micon"><a class="exi" href="#expand"> </a></td>
663 <a id="Roo.bootstrap.NavSimplebar-cfg-loadMask" name=".loadMask"></a>
664 <div class="fixedFont">
665 <b class="itemname">loadMask</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
671 <div class="short">loadMask on the bar</div>
677 <BR/>Possible Values: true, false
686 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
692 <tr class="config-row expandable config-row-alt1">
693 <td class="micon"><a class="exi" href="#expand"> </a></td>
696 <a id="Roo.bootstrap.NavSimplebar-cfg-main" name=".main"></a>
697 <div class="fixedFont">
698 <b class="itemname">main</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
704 <div class="short">main nav bar? default false</div>
709 main nav bar? default false
710 <BR/>Possible Values: true, false
719 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
725 <tr class="config-row expandable config-row-alt0 notInherited">
726 <td class="micon"><a class="exi" href="#expand"> </a></td>
729 <a id="Roo.bootstrap.NavHeaderbar-cfg-mobilerow" name=".mobilerow"></a>
730 <div class="fixedFont">
731 <b class="itemname">mobilerow</b> : <a href="./Roo.bootstrap.Row.html#constructor" roo:cls="Roo.bootstrap.Row.html#constructor">Roo.bootstrap.Row</a>
737 <div class="short">- a row to display on mobile only.</div>
742 - a row to display on mobile only..
752 Roo.bootstrap.NavHeaderbar
758 <tr class="config-row expandable config-row-alt1">
759 <td class="micon"><a class="exi" href="#expand"> </a></td>
762 <a id="Roo.bootstrap.Component-cfg-name" name=".name"></a>
763 <div class="fixedFont">
764 <b class="itemname">name</b> : string
770 <div class="short">Specifies name attribute</div>
775 Specifies name attribute
785 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
791 <tr class="config-row expandable config-row-alt0 notInherited">
792 <td class="micon"><a class="exi" href="#expand"> </a></td>
795 <a id="Roo.bootstrap.NavHeaderbar-cfg-position" name=".position"></a>
796 <div class="fixedFont">
797 <b class="itemname">position</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
803 <div class="short">position</div>
809 <BR/>Possible Values: fixed-top, fixed-bottom, static-top
818 Roo.bootstrap.NavHeaderbar
824 <tr class="config-row expandable config-row-alt1 notInherited">
825 <td class="micon"><a class="exi" href="#expand"> </a></td>
828 <a id="Roo.bootstrap.NavHeaderbar-cfg-srButton" name=".srButton"></a>
829 <div class="fixedFont">
830 <b class="itemname">srButton</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
836 <div class="short">generate the (screen reader / mobile) sr-only button default true</div>
841 generate the (screen reader / mobile) sr-only button default true
851 Roo.bootstrap.NavHeaderbar
857 <tr class="config-row expandable config-row-alt0">
858 <td class="micon"><a class="exi" href="#expand"> </a></td>
861 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
862 <div class="fixedFont">
863 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
869 <div class="short">any extra css</div>
884 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
890 <tr class="config-row expandable config-row-alt1">
891 <td class="micon"><a class="exi" href="#expand"> </a></td>
894 <a id="Roo.bootstrap.NavSimplebar-cfg-tag" name=".tag"></a>
895 <div class="fixedFont">
896 <b class="itemname">tag</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
902 <div class="short">default is nav</div>
908 <BR/>Possible Values: header, footer, nav, div
917 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
923 <tr class="config-row expandable config-row-alt0">
924 <td class="micon"><a class="exi" href="#expand"> </a></td>
927 <a id="Roo.bootstrap.Component-cfg-tooltip" name=".tooltip"></a>
928 <div class="fixedFont">
929 <b class="itemname">tooltip</b> : string
935 <div class="short">Text for the tooltip</div>
950 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
956 <tr class="config-row expandable config-row-alt1">
957 <td class="micon"><a class="exi" href="#expand"> </a></td>
960 <a id="Roo.bootstrap.NavSimplebar-cfg-type" name=".type"></a>
961 <div class="fixedFont">
962 <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
968 <div class="short"></div>
974 <BR/>Possible Values: nav, pills, tabs
983 <a href="./Roo.bootstrap.NavSimplebar.html#constructor" roo:cls="Roo.bootstrap.NavSimplebar.html#constructor">Roo.bootstrap.NavSimplebar</a>
989 <tr class="config-row expandable config-row-alt0">
990 <td class="micon"><a class="exi" href="#expand"> </a></td>
993 <a id="Roo.bootstrap.Component-cfg-visibilityEl" name=".visibilityEl"></a>
994 <div class="fixedFont">
995 <b class="itemname">visibilityEl</b> : string|object
1001 <div class="short">What element to use for visibility (<b>see</b> getVisibilityEl())</div>
1006 What element to use for visibility (<b>see</b> getVisibilityEl())
1007 <BR/>Possible Values: el, parent
1014 <td class="msource">
1016 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
1022 <tr class="config-row expandable config-row-alt1">
1023 <td class="micon"><a class="exi" href="#expand"> </a></td>
1026 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
1027 <div class="fixedFont">
1028 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1034 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
1039 extra attributes to add to 'element' (used by builder to store stuff.)
1047 <td class="msource">
1049 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
1065 <!-- ============================== public properties ==================== -->
1069 <a id="Roo.bootstrap.NavHeaderbar-props"></a>
1075 <table cellspacing="0" class="member-table">
1076 <caption class="Empty">Public Properties - Has None</caption>
1082 <!-- ============================== methods summary / details ======================== -->
1085 <a id="Roo.bootstrap.NavHeaderbar-methods"></a>
1086 <!-- constructor?? -->
1093 <!-- then dynamics first -->
1100 <table cellspacing="0" class="member-table">
1101 <caption>Public Methods</caption>
1103 <th class="sig-header" colspan="2">Method</th>
1104 <th class="msource-header">Defined By</th>
1114 <tr class="method-row config-row-alt0 expandable notInherited">
1115 <td class="micon"><a class="exi" href="#expand"> </a></td>
1119 <a id="Roo.bootstrap-method-NavHeaderbar" name=".NavHeaderbar"></a>
1120 <div class="fixedFont">
1121 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">NavHeaderbar</b>
1123 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1131 <div class="short">Create a new Roo.bootstrap.NavHeaderbar</div>
1138 Create a new Roo.bootstrap.NavHeaderbar
1141 <dl class="detailList">
1142 <dt class="heading">Parameters:</dt>
1145 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>config</b>
1148 <dd>The config object</dd>
1166 <td class="msource">
1172 <tr class="method-row config-row-alt1 expandable">
1173 <td class="micon"><a class="exi" href="#expand"> </a></td>
1177 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1178 <div class="fixedFont">
1179 <span class="attributes"></span><b class="itemname">addEvents</b>
1181 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1188 <div class="short">Used to define events on this Observable</div>
1194 Used to define events on this Observable
1201 <dl class="detailList">
1202 <dt class="heading">Parameters:</dt>
1205 <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>
1208 <dd>The object with the events defined</dd>
1226 <td class="msource">
1228 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1234 <tr class="method-row config-row-alt0 expandable">
1235 <td class="micon"><a class="exi" href="#expand"> </a></td>
1239 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1240 <div class="fixedFont">
1241 <span class="attributes"></span><b class="itemname">addListener</b>
1243 (<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>)
1250 <div class="short">Appends an event handler to this component</div>
1256 Appends an event handler to this component
1263 <dl class="detailList">
1264 <dt class="heading">Parameters:</dt>
1267 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1270 <dd>The type of event to listen for</dd>
1273 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1276 <dd>The method the event invokes</dd>
1279 <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>
1282 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1285 <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>
1288 <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>
1306 <td class="msource">
1308 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1314 <tr class="method-row config-row-alt1 expandable">
1315 <td class="micon"><a class="exi" href="#expand"> </a></td>
1319 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1320 <div class="fixedFont">
1321 <span class="attributes"></span><b class="itemname">destroy</b>
1330 <div class="short">Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.</div>
1336 Destroys this component by purging any event listeners, removing the component's element from the DOM,<br/>removing the component from its {<b>link</b> Roo.Container} (if applicable) and unregistering it from {<b>link</b> Roo.ComponentMgr}.
1357 <td class="msource">
1359 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1365 <tr class="method-row config-row-alt0 expandable">
1366 <td class="micon"><a class="exi" href="#expand"> </a></td>
1370 <a id="Roo.Component-method-disable" name=".disable"></a>
1371 <div class="fixedFont">
1372 <span class="attributes"></span><b class="itemname">disable</b>
1380 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1389 <div class="short">Disable this component.</div>
1395 Disable this component.
1406 <dl class="detailList">
1407 <dt class="heading">Returns:</dt>
1409 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1423 <td class="msource">
1425 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1431 <tr class="method-row config-row-alt1 expandable">
1432 <td class="micon"><a class="exi" href="#expand"> </a></td>
1436 <a id="Roo.Component-method-enable" name=".enable"></a>
1437 <div class="fixedFont">
1438 <span class="attributes"></span><b class="itemname">enable</b>
1446 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1455 <div class="short">Enable this component.</div>
1461 Enable this component.
1472 <dl class="detailList">
1473 <dt class="heading">Returns:</dt>
1475 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1489 <td class="msource">
1491 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1497 <tr class="method-row config-row-alt0 expandable">
1498 <td class="micon"><a class="exi" href="#expand"> </a></td>
1502 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1503 <div class="fixedFont">
1504 <span class="attributes"></span><b class="itemname">fireEvent</b>
1506 (<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>)
1512 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1521 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1527 Fires the specified event with the passed parameters (minus the event name).
1534 <dl class="detailList">
1535 <dt class="heading">Parameters:</dt>
1538 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1544 <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>
1547 <dd>Variable number of parameters are passed to handlers</dd>
1555 <dl class="detailList">
1556 <dt class="heading">Returns:</dt>
1558 <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>
1572 <td class="msource">
1574 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1580 <tr class="method-row config-row-alt1 expandable">
1581 <td class="micon"><a class="exi" href="#expand"> </a></td>
1585 <a id="Roo.Component-method-focus" name=".focus"></a>
1586 <div class="fixedFont">
1587 <span class="attributes"></span><b class="itemname">focus</b>
1589 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1595 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1604 <div class="short">Try to focus this component.</div>
1610 Try to focus this component.
1617 <dl class="detailList">
1618 <dt class="heading">Parameters:</dt>
1621 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>selectText</b>
1624 <dd>True to also select the text in this component (if applicable)</dd>
1632 <dl class="detailList">
1633 <dt class="heading">Returns:</dt>
1635 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1649 <td class="msource">
1651 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1657 <tr class="method-row config-row-alt0 expandable">
1658 <td class="micon"><a class="exi" href="#expand"> </a></td>
1662 <a id="Roo.bootstrap.Component-method-getChildContainer" name=".getChildContainer"></a>
1663 <div class="fixedFont">
1664 <span class="attributes"></span><b class="itemname">getChildContainer</b>
1672 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1681 <div class="short">Fetch the element to add children to</div>
1687 Fetch the element to add children to
1698 <dl class="detailList">
1699 <dt class="heading">Returns:</dt>
1701 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> defaults to this.el</dd>
1715 <td class="msource">
1717 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
1723 <tr class="method-row config-row-alt1 expandable">
1724 <td class="micon"><a class="exi" href="#expand"> </a></td>
1728 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1729 <div class="fixedFont">
1730 <span class="attributes"></span><b class="itemname">getEl</b>
1738 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1747 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1753 Returns the underlying {<b>link</b> Roo.Element}.
1764 <dl class="detailList">
1765 <dt class="heading">Returns:</dt>
1767 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1781 <td class="msource">
1783 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1789 <tr class="method-row config-row-alt0 expandable">
1790 <td class="micon"><a class="exi" href="#expand"> </a></td>
1794 <a id="Roo.Component-method-getId" name=".getId"></a>
1795 <div class="fixedFont">
1796 <span class="attributes"></span><b class="itemname">getId</b>
1804 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1813 <div class="short">Returns the id of this component.</div>
1819 Returns the id of this component.
1830 <dl class="detailList">
1831 <dt class="heading">Returns:</dt>
1833 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1847 <td class="msource">
1849 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1855 <tr class="method-row config-row-alt1 expandable">
1856 <td class="micon"><a class="exi" href="#expand"> </a></td>
1860 <a id="Roo.bootstrap.Component-method-getVisibilityEl" name=".getVisibilityEl"></a>
1861 <div class="fixedFont">
1862 <span class="attributes"></span><b class="itemname">getVisibilityEl</b>
1871 <div class="short">Get the element that will be used to show or hide</div>
1877 Get the element that will be used to show or hide
1898 <td class="msource">
1900 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
1906 <tr class="method-row config-row-alt0 expandable">
1907 <td class="micon"><a class="exi" href="#expand"> </a></td>
1911 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1912 <div class="fixedFont">
1913 <span class="attributes"></span><b class="itemname">hasListener</b>
1915 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1921 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1930 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1936 Checks to see if this object has any listeners for a specified event
1943 <dl class="detailList">
1944 <dt class="heading">Parameters:</dt>
1947 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1950 <dd>The name of the event to check for</dd>
1958 <dl class="detailList">
1959 <dt class="heading">Returns:</dt>
1961 <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>
1975 <td class="msource">
1977 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1983 <tr class="method-row config-row-alt1 expandable">
1984 <td class="micon"><a class="exi" href="#expand"> </a></td>
1988 <a id="Roo.bootstrap.Component-method-hide" name=".hide"></a>
1989 <div class="fixedFont">
1990 <span class="attributes"></span><b class="itemname">hide</b>
1999 <div class="short">Hide a component - adds 'hidden' class</div>
2005 Hide a component - adds 'hidden' class
2026 <td class="msource">
2028 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
2034 <tr class="method-row config-row-alt0 expandable">
2035 <td class="micon"><a class="exi" href="#expand"> </a></td>
2039 <a id="Roo.bootstrap.Component-method-initEvents" name=".initEvents"></a>
2040 <div class="fixedFont">
2041 <span class="attributes"></span><b class="itemname">initEvents</b>
2050 <div class="short">Initialize Events for the element</div>
2056 Initialize Events for the element
2077 <td class="msource">
2079 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
2085 <tr class="method-row config-row-alt1 expandable">
2086 <td class="micon"><a class="exi" href="#expand"> </a></td>
2090 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2091 <div class="fixedFont">
2092 <span class="attributes"></span><b class="itemname">isVisible</b>
2101 <div class="short">Returns true if this component is visible.</div>
2107 Returns true if this component is visible.
2128 <td class="msource">
2130 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2136 <tr class="method-row config-row-alt0 expandable">
2137 <td class="micon"><a class="exi" href="#expand"> </a></td>
2141 <a id="Roo.util.Observable-method-on" name=".on"></a>
2142 <div class="fixedFont">
2143 <span class="attributes"></span><b class="itemname">on</b>
2145 (<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>)
2152 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2158 Appends an event handler to this element (shorthand for addListener)
2165 <dl class="detailList">
2166 <dt class="heading">Parameters:</dt>
2169 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2172 <dd>The type of event to listen for</dd>
2175 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2178 <dd>The method the event invokes</dd>
2181 <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>
2184 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2187 <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>
2208 <td class="msource">
2210 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2216 <tr class="method-row config-row-alt1 expandable">
2217 <td class="micon"><a class="exi" href="#expand"> </a></td>
2221 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2222 <div class="fixedFont">
2223 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2232 <div class="short">Removes all listeners for this object</div>
2238 Removes all listeners for this object
2259 <td class="msource">
2261 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2267 <tr class="method-row config-row-alt0 expandable">
2268 <td class="micon"><a class="exi" href="#expand"> </a></td>
2272 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2273 <div class="fixedFont">
2274 <span class="attributes"></span><b class="itemname">removeListener</b>
2276 (<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>)
2283 <div class="short">Removes a listener</div>
2296 <dl class="detailList">
2297 <dt class="heading">Parameters:</dt>
2300 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2303 <dd>The type of event to listen for</dd>
2306 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2309 <dd>The handler to remove</dd>
2312 <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>
2315 <dd>(optional) The scope (this object) for the handler</dd>
2333 <td class="msource">
2335 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2341 <tr class="method-row config-row-alt1 expandable">
2342 <td class="micon"><a class="exi" href="#expand"> </a></td>
2346 <a id="Roo.Component-method-render" name=".render"></a>
2347 <div class="fixedFont">
2348 <span class="attributes"></span><b class="itemname">render</b>
2350 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2357 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2363 If this is a lazy rendering component, render it to its container element.
2370 <dl class="detailList">
2371 <dt class="heading">Parameters:</dt>
2374 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2377 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2395 <td class="msource">
2397 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2403 <tr class="method-row config-row-alt0 expandable">
2404 <td class="micon"><a class="exi" href="#expand"> </a></td>
2408 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2409 <div class="fixedFont">
2410 <span class="attributes"></span><b class="itemname">setDisabled</b>
2412 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2419 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2425 Convenience function for setting disabled/enabled by boolean.
2432 <dl class="detailList">
2433 <dt class="heading">Parameters:</dt>
2436 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>disabled</b>
2457 <td class="msource">
2459 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2465 <tr class="method-row config-row-alt1 expandable">
2466 <td class="micon"><a class="exi" href="#expand"> </a></td>
2470 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2471 <div class="fixedFont">
2472 <span class="attributes"></span><b class="itemname">setVisible</b>
2474 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2480 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2489 <div class="short">Convenience function to hide or show this component by boolean.</div>
2495 Convenience function to hide or show this component by boolean.
2502 <dl class="detailList">
2503 <dt class="heading">Parameters:</dt>
2506 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>visible</b>
2509 <dd>True to show, false to hide</dd>
2517 <dl class="detailList">
2518 <dt class="heading">Returns:</dt>
2520 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2534 <td class="msource">
2536 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2542 <tr class="method-row config-row-alt0 expandable">
2543 <td class="micon"><a class="exi" href="#expand"> </a></td>
2547 <a id="Roo.bootstrap.Component-method-show" name=".show"></a>
2548 <div class="fixedFont">
2549 <span class="attributes"></span><b class="itemname">show</b>
2558 <div class="short">Show a component - removes 'hidden' class</div>
2564 Show a component - removes 'hidden' class
2585 <td class="msource">
2587 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
2593 <tr class="method-row config-row-alt1 expandable">
2594 <td class="micon"><a class="exi" href="#expand"> </a></td>
2598 <a id="Roo.bootstrap.Component-method-tooltipEl" name=".tooltipEl"></a>
2599 <div class="fixedFont">
2600 <span class="attributes"></span><b class="itemname">tooltipEl</b>
2608 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
2617 <div class="short">Fetch the element to display the tooltip on.</div>
2623 Fetch the element to display the tooltip on.
2634 <dl class="detailList">
2635 <dt class="heading">Returns:</dt>
2637 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> defaults to this.el</dd>
2651 <td class="msource">
2653 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
2659 <tr class="method-row config-row-alt0 expandable">
2660 <td class="micon"><a class="exi" href="#expand"> </a></td>
2664 <a id="Roo.util.Observable-method-un" name=".un"></a>
2665 <div class="fixedFont">
2666 <span class="attributes"></span><b class="itemname">un</b>
2668 (<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>)
2675 <div class="short">Removes a listener (shorthand for removeListener)</div>
2681 Removes a listener (shorthand for removeListener)
2688 <dl class="detailList">
2689 <dt class="heading">Parameters:</dt>
2692 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2695 <dd>The type of event to listen for</dd>
2698 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2701 <dd>The handler to remove</dd>
2704 <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>
2707 <dd>(optional) The scope (this object) for the handler</dd>
2725 <td class="msource">
2727 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2736 <!-- ============================== events summary / details ======================== -->
2739 <a id="Roo.bootstrap.NavHeaderbar-events"></a>
2748 <table cellspacing="0" class="member-table">
2749 <caption>Events</caption>
2752 <th class="sig-header" colspan="2">Event</th>
2753 <th class="msource-header">Defined By</th>
2762 <tr class="method-row expandable config-row-alt0">
2763 <td class="micon"><a class="exi" href="#expand"> </a></td>
2766 <a id="Roo.Component-event-*beforedestroy"></a>
2768 <div class="fixedFont">
2769 <b class="itemname">beforedestroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2775 <div class="short">Fires before the component is destroyed.
2781 Fires before the component is destroyed. Return false to stop the destroy.
2787 <dl class="detailList">
2788 <dt class="heading">Parameters:</dt>
2791 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2812 <td class="msource">
2813 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2817 <tr class="method-row expandable config-row-alt1">
2818 <td class="micon"><a class="exi" href="#expand"> </a></td>
2821 <a id="Roo.Component-event-*beforehide"></a>
2823 <div class="fixedFont">
2824 <b class="itemname">beforehide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2830 <div class="short">Fires before the component is hidden.
2836 Fires before the component is hidden. Return false to stop the hide.
2842 <dl class="detailList">
2843 <dt class="heading">Parameters:</dt>
2846 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2867 <td class="msource">
2868 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2872 <tr class="method-row expandable config-row-alt0">
2873 <td class="micon"><a class="exi" href="#expand"> </a></td>
2876 <a id="Roo.Component-event-*beforerender"></a>
2878 <div class="fixedFont">
2879 <b class="itemname">beforerender</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2885 <div class="short">Fires before the component is rendered.
2891 Fires before the component is rendered. Return false to stop the render.
2897 <dl class="detailList">
2898 <dt class="heading">Parameters:</dt>
2901 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2922 <td class="msource">
2923 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2927 <tr class="method-row expandable config-row-alt1">
2928 <td class="micon"><a class="exi" href="#expand"> </a></td>
2931 <a id="Roo.Component-event-*beforeshow"></a>
2933 <div class="fixedFont">
2934 <b class="itemname">beforeshow</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
2940 <div class="short">Fires before the component is shown.
2946 Fires before the component is shown. Return false to stop the show.
2952 <dl class="detailList">
2953 <dt class="heading">Parameters:</dt>
2956 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2977 <td class="msource">
2978 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2982 <tr class="method-row expandable config-row-alt0">
2983 <td class="micon"><a class="exi" href="#expand"> </a></td>
2986 <a id="Roo.bootstrap.Navbar-event-*beforetoggle"></a>
2988 <div class="fixedFont">
2989 <b class="itemname">beforetoggle</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2995 <div class="short">Fire before toggle the menu
3001 Fire before toggle the menu
3007 <dl class="detailList">
3008 <dt class="heading">Parameters:</dt>
3011 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3032 <td class="msource">
3033 <a href="./Roo.bootstrap.Navbar.html#constructor" roo:cls="Roo.bootstrap.Navbar.html#constructor">Roo.bootstrap.Navbar</a>
3037 <tr class="method-row expandable config-row-alt1">
3038 <td class="micon"><a class="exi" href="#expand"> </a></td>
3041 <a id="Roo.bootstrap.Component-event-*childrenrendered"></a>
3043 <div class="fixedFont">
3044 <b class="itemname">childrenrendered</b> (<a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a> <B><i>this</i></B>)
3050 <div class="short">Fires when the children have been rendered.
3056 Fires when the children have been rendered..
3062 <dl class="detailList">
3063 <dt class="heading">Parameters:</dt>
3066 <span class="fixedFont"><a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a></span> <b>this</b>
3087 <td class="msource">
3088 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
3092 <tr class="method-row expandable config-row-alt0">
3093 <td class="micon"><a class="exi" href="#expand"> </a></td>
3096 <a id="Roo.Component-event-*destroy"></a>
3098 <div class="fixedFont">
3099 <b class="itemname">destroy</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3105 <div class="short">Fires after the component is destroyed.
3111 Fires after the component is destroyed.
3117 <dl class="detailList">
3118 <dt class="heading">Parameters:</dt>
3121 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3142 <td class="msource">
3143 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3147 <tr class="method-row expandable config-row-alt1">
3148 <td class="micon"><a class="exi" href="#expand"> </a></td>
3151 <a id="Roo.Component-event-*disable"></a>
3153 <div class="fixedFont">
3154 <b class="itemname">disable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3160 <div class="short">Fires after the component is disabled.
3166 Fires after the component is disabled.
3172 <dl class="detailList">
3173 <dt class="heading">Parameters:</dt>
3176 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3197 <td class="msource">
3198 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3202 <tr class="method-row expandable config-row-alt0">
3203 <td class="micon"><a class="exi" href="#expand"> </a></td>
3206 <a id="Roo.Component-event-*enable"></a>
3208 <div class="fixedFont">
3209 <b class="itemname">enable</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3215 <div class="short">Fires after the component is enabled.
3221 Fires after the component is enabled.
3227 <dl class="detailList">
3228 <dt class="heading">Parameters:</dt>
3231 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3252 <td class="msource">
3253 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3257 <tr class="method-row expandable config-row-alt1">
3258 <td class="micon"><a class="exi" href="#expand"> </a></td>
3261 <a id="Roo.Component-event-*hide"></a>
3263 <div class="fixedFont">
3264 <b class="itemname">hide</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3270 <div class="short">Fires after the component is hidden.
3276 Fires after the component is hidden.
3282 <dl class="detailList">
3283 <dt class="heading">Parameters:</dt>
3286 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3307 <td class="msource">
3308 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3312 <tr class="method-row expandable config-row-alt0">
3313 <td class="micon"><a class="exi" href="#expand"> </a></td>
3316 <a id="Roo.Component-event-*render"></a>
3318 <div class="fixedFont">
3319 <b class="itemname">render</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3325 <div class="short">Fires after the component is rendered.
3331 Fires after the component is rendered.
3337 <dl class="detailList">
3338 <dt class="heading">Parameters:</dt>
3341 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3362 <td class="msource">
3363 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3367 <tr class="method-row expandable config-row-alt1">
3368 <td class="micon"><a class="exi" href="#expand"> </a></td>
3371 <a id="Roo.Component-event-*show"></a>
3373 <div class="fixedFont">
3374 <b class="itemname">show</b> (<a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a> <B><i>this</i></B>)
3380 <div class="short">Fires after the component is shown.
3386 Fires after the component is shown.
3392 <dl class="detailList">
3393 <dt class="heading">Parameters:</dt>
3396 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3417 <td class="msource">
3418 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3429 <!-- ============================== footer ================================= -->
3430 <div class="fineprint" style="clear:both">
3432 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 13 2018 14:10:53 GMT+0800 (HKT)
3434 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>