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.NavGroup</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.NavGroup-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.NavGroup-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.NavGroup-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.NavGroup-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.bootstrap.NavGroup
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.bootstrap.NavGroup
62 <table cellspacing="0" class="class-summary-table">
64 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
66 <tr><td class="label">Defined In:</td><td class="hd-info">
68 <a href="./src/Roo_bootstrap_NavGroup.js.html">Roo/bootstrap/NavGroup.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">NavGroup</td></tr>
76 <tr><td class="label">Extends:</td><td class="hd-info">
77 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
85 <!-- ============================== class summary ========================== -->
86 <div class="description">
87 Bootstrap NavGroup class
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.NavGroup';">[Add Your comment/notes about this class]</u>
97 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
98 src="/blog.php/GtkDjsComments/Roo.bootstrap.NavGroup.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.bootstrap.NavGroup-configs"></a>
115 <table cellspacing="0" class="member-table">
116 <caption>Config Options (Usually are also Properties)</caption>
120 <th class="sig-header" colspan="2">Options</th>
122 <th class="msource-header">Defined By</th>
129 <tr class="config-row expandable config-row-alt0">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
134 <div class="fixedFont">
135 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
141 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
145 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
153 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
159 <tr class="config-row expandable config-row-alt1 notInherited">
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="Roo.bootstrap.NavGroup-cfg-align" name=".align"></a>
164 <div class="fixedFont">
165 <b class="itemname">align</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
171 <div class="short">left | right</div>
175 <div class="long">left | right</div>
183 Roo.bootstrap.NavGroup
189 <tr class="config-row expandable config-row-alt0">
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
193 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
194 <div class="fixedFont">
195 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
201 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
205 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
213 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
219 <tr class="config-row expandable config-row-alt1">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
223 <a id="Roo.bootstrap.Component-cfg-can_build_overlaid" name=".can_build_overlaid"></a>
224 <div class="fixedFont">
225 <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>
231 <div class="short">True if element can be rebuild from a HTML page</div>
235 <div class="long">True if element can be rebuild from a HTML page</div>
243 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
249 <tr class="config-row expandable config-row-alt0">
250 <td class="micon"><a class="exi" href="#expand"> </a></td>
253 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
254 <div class="fixedFont">
255 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
261 <div class="short">css class</div>
265 <div class="long">css class</div>
273 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
279 <tr class="config-row expandable config-row-alt1">
280 <td class="micon"><a class="exi" href="#expand"> </a></td>
283 <a id="Roo.bootstrap.Component-cfg-dataId" name=".dataId"></a>
284 <div class="fixedFont">
285 <b class="itemname">dataId</b> : string
291 <div class="short">cutomer id</div>
295 <div class="long">cutomer id</div>
303 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
309 <tr class="config-row expandable config-row-alt0">
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
313 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
314 <div class="fixedFont">
315 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
321 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
325 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
333 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
339 <tr class="config-row expandable config-row-alt1">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
343 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
344 <div class="fixedFont">
345 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
351 <div class="short">How this component should hidden.</div>
355 <div class="long">How this component should hidden. Supported values are<br/>"visibility" (css visibility), "offsets" (negative offset position) and<br/>"display" (css display) - defaults to "display".</div>
363 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
369 <tr class="config-row expandable config-row-alt0 notInherited">
370 <td class="micon"><a class="exi" href="#expand"> </a></td>
373 <a id="Roo.bootstrap.NavGroup-cfg-inverse" name=".inverse"></a>
374 <div class="fixedFont">
375 <b class="itemname">inverse</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
381 <div class="short">false | true</div>
385 <div class="long">false | true</div>
393 Roo.bootstrap.NavGroup
399 <tr class="config-row expandable config-row-alt1">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
403 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
404 <div class="fixedFont">
405 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
411 <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>
415 <div class="long">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></div>
423 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
429 <tr class="config-row expandable config-row-alt0">
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
434 <div class="fixedFont">
435 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
441 <div class="short">any extra css</div>
445 <div class="long">any extra css</div>
453 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
459 <tr class="config-row expandable config-row-alt1">
460 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
464 <div class="fixedFont">
465 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
471 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
475 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
483 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
499 <!-- ============================== public properties ==================== -->
503 <a id="Roo.bootstrap.NavGroup-props"></a>
509 <table cellspacing="0" class="member-table">
510 <caption class="Empty">Public Properties - Has None</caption>
516 <!-- ============================== methods summary / details ======================== -->
519 <a id="Roo.bootstrap.NavGroup-methods"></a>
520 <!-- constructor?? -->
527 <!-- then dynamics first -->
534 <table cellspacing="0" class="member-table">
535 <caption>Public Methods</caption>
537 <th class="sig-header" colspan="2">Method</th>
538 <th class="msource-header">Defined By</th>
548 <tr class="method-row config-row-alt0 expandable notInherited">
549 <td class="micon"><a class="exi" href="#expand"> </a></td>
553 <a id="Roo.bootstrap-method-NavGroup" name=".NavGroup"></a>
554 <div class="fixedFont">
555 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">NavGroup</b>
557 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
565 <div class="short">Create a new Roo.bootstrap.NavGroup</div>
572 Create a new Roo.bootstrap.NavGroup
575 <dl class="detailList">
576 <dt class="heading">Parameters:</dt>
579 <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>
582 <dd>The config object</dd>
606 <tr class="method-row config-row-alt1 expandable">
607 <td class="micon"><a class="exi" href="#expand"> </a></td>
611 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
612 <div class="fixedFont">
613 <span class="attributes"></span><b class="itemname">addEvents</b>
615 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
622 <div class="short">Used to define events on this Observable</div>
628 Used to define events on this Observable
635 <dl class="detailList">
636 <dt class="heading">Parameters:</dt>
639 <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>
642 <dd>The object with the events defined</dd>
662 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
668 <tr class="method-row config-row-alt0 expandable">
669 <td class="micon"><a class="exi" href="#expand"> </a></td>
673 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
674 <div class="fixedFont">
675 <span class="attributes"></span><b class="itemname">addListener</b>
677 (<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>)
684 <div class="short">Appends an event handler to this component</div>
690 Appends an event handler to this component
697 <dl class="detailList">
698 <dt class="heading">Parameters:</dt>
701 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
704 <dd>The type of event to listen for</dd>
707 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
710 <dd>The method the event invokes</dd>
713 <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>
716 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
719 <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>
722 <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>
742 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
748 <tr class="method-row config-row-alt1 expandable">
749 <td class="micon"><a class="exi" href="#expand"> </a></td>
753 <a id="Roo.Component-method-destroy" name=".destroy"></a>
754 <div class="fixedFont">
755 <span class="attributes"></span><b class="itemname">destroy</b>
764 <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>
770 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}.
793 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
799 <tr class="method-row config-row-alt0 expandable">
800 <td class="micon"><a class="exi" href="#expand"> </a></td>
804 <a id="Roo.Component-method-disable" name=".disable"></a>
805 <div class="fixedFont">
806 <span class="attributes"></span><b class="itemname">disable</b>
814 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
823 <div class="short">Disable this component.</div>
829 Disable this component.
840 <dl class="detailList">
841 <dt class="heading">Returns:</dt>
843 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
859 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
865 <tr class="method-row config-row-alt1 expandable">
866 <td class="micon"><a class="exi" href="#expand"> </a></td>
870 <a id="Roo.Component-method-enable" name=".enable"></a>
871 <div class="fixedFont">
872 <span class="attributes"></span><b class="itemname">enable</b>
880 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
889 <div class="short">Enable this component.</div>
895 Enable this component.
906 <dl class="detailList">
907 <dt class="heading">Returns:</dt>
909 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
925 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
931 <tr class="method-row config-row-alt0 expandable">
932 <td class="micon"><a class="exi" href="#expand"> </a></td>
936 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
937 <div class="fixedFont">
938 <span class="attributes"></span><b class="itemname">fireEvent</b>
940 (<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>)
946 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
955 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
961 Fires the specified event with the passed parameters (minus the event name).
968 <dl class="detailList">
969 <dt class="heading">Parameters:</dt>
972 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
978 <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>
981 <dd>Variable number of parameters are passed to handlers</dd>
989 <dl class="detailList">
990 <dt class="heading">Returns:</dt>
992 <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>
1006 <td class="msource">
1008 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1014 <tr class="method-row config-row-alt1 expandable">
1015 <td class="micon"><a class="exi" href="#expand"> </a></td>
1019 <a id="Roo.Component-method-focus" name=".focus"></a>
1020 <div class="fixedFont">
1021 <span class="attributes"></span><b class="itemname">focus</b>
1023 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1029 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1038 <div class="short">Try to focus this component.</div>
1044 Try to focus this component.
1051 <dl class="detailList">
1052 <dt class="heading">Parameters:</dt>
1055 <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>
1058 <dd>True to also select the text in this component (if applicable)</dd>
1066 <dl class="detailList">
1067 <dt class="heading">Returns:</dt>
1069 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1083 <td class="msource">
1085 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1091 <tr class="method-row config-row-alt0 expandable">
1092 <td class="micon"><a class="exi" href="#expand"> </a></td>
1096 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1097 <div class="fixedFont">
1098 <span class="attributes"></span><b class="itemname">getEl</b>
1106 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1115 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1121 Returns the underlying {<b>link</b> Roo.Element}.
1132 <dl class="detailList">
1133 <dt class="heading">Returns:</dt>
1135 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1149 <td class="msource">
1151 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1157 <tr class="method-row config-row-alt1 expandable">
1158 <td class="micon"><a class="exi" href="#expand"> </a></td>
1162 <a id="Roo.Component-method-getId" name=".getId"></a>
1163 <div class="fixedFont">
1164 <span class="attributes"></span><b class="itemname">getId</b>
1172 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1181 <div class="short">Returns the id of this component.</div>
1187 Returns the id of this component.
1198 <dl class="detailList">
1199 <dt class="heading">Returns:</dt>
1201 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1215 <td class="msource">
1217 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1223 <tr class="method-row config-row-alt0 expandable">
1224 <td class="micon"><a class="exi" href="#expand"> </a></td>
1228 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1229 <div class="fixedFont">
1230 <span class="attributes"></span><b class="itemname">hasListener</b>
1232 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1238 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1247 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1253 Checks to see if this object has any listeners for a specified event
1260 <dl class="detailList">
1261 <dt class="heading">Parameters:</dt>
1264 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1267 <dd>The name of the event to check for</dd>
1275 <dl class="detailList">
1276 <dt class="heading">Returns:</dt>
1278 <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>
1292 <td class="msource">
1294 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1300 <tr class="method-row config-row-alt1 expandable">
1301 <td class="micon"><a class="exi" href="#expand"> </a></td>
1305 <a id="Roo.Component-method-hide" name=".hide"></a>
1306 <div class="fixedFont">
1307 <span class="attributes"></span><b class="itemname">hide</b>
1315 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1324 <div class="short">Hide this component.</div>
1330 Hide this component.
1341 <dl class="detailList">
1342 <dt class="heading">Returns:</dt>
1344 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1358 <td class="msource">
1360 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1366 <tr class="method-row config-row-alt0 expandable">
1367 <td class="micon"><a class="exi" href="#expand"> </a></td>
1371 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1372 <div class="fixedFont">
1373 <span class="attributes"></span><b class="itemname">isVisible</b>
1382 <div class="short">Returns true if this component is visible.</div>
1388 Returns true if this component is visible.
1409 <td class="msource">
1411 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1417 <tr class="method-row config-row-alt1 expandable">
1418 <td class="micon"><a class="exi" href="#expand"> </a></td>
1422 <a id="Roo.util.Observable-method-on" name=".on"></a>
1423 <div class="fixedFont">
1424 <span class="attributes"></span><b class="itemname">on</b>
1426 (<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>)
1433 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1439 Appends an event handler to this element (shorthand for addListener)
1446 <dl class="detailList">
1447 <dt class="heading">Parameters:</dt>
1450 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1453 <dd>The type of event to listen for</dd>
1456 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1459 <dd>The method the event invokes</dd>
1462 <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>
1465 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1468 <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>
1489 <td class="msource">
1491 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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-purgeListeners" name=".purgeListeners"></a>
1503 <div class="fixedFont">
1504 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1513 <div class="short">Removes all listeners for this object</div>
1519 Removes all listeners for this object
1540 <td class="msource">
1542 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1548 <tr class="method-row config-row-alt1 expandable">
1549 <td class="micon"><a class="exi" href="#expand"> </a></td>
1553 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1554 <div class="fixedFont">
1555 <span class="attributes"></span><b class="itemname">removeListener</b>
1557 (<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>)
1564 <div class="short">Removes a listener</div>
1577 <dl class="detailList">
1578 <dt class="heading">Parameters:</dt>
1581 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1584 <dd>The type of event to listen for</dd>
1587 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1590 <dd>The handler to remove</dd>
1593 <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>
1596 <dd>(optional) The scope (this object) for the handler</dd>
1614 <td class="msource">
1616 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1622 <tr class="method-row config-row-alt0 expandable">
1623 <td class="micon"><a class="exi" href="#expand"> </a></td>
1627 <a id="Roo.Component-method-render" name=".render"></a>
1628 <div class="fixedFont">
1629 <span class="attributes"></span><b class="itemname">render</b>
1631 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1638 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1644 If this is a lazy rendering component, render it to its container element.
1651 <dl class="detailList">
1652 <dt class="heading">Parameters:</dt>
1655 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1658 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1676 <td class="msource">
1678 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1684 <tr class="method-row config-row-alt1 expandable">
1685 <td class="micon"><a class="exi" href="#expand"> </a></td>
1689 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1690 <div class="fixedFont">
1691 <span class="attributes"></span><b class="itemname">setDisabled</b>
1693 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1700 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1706 Convenience function for setting disabled/enabled by boolean.
1713 <dl class="detailList">
1714 <dt class="heading">Parameters:</dt>
1717 <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>
1738 <td class="msource">
1740 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1746 <tr class="method-row config-row-alt0 expandable">
1747 <td class="micon"><a class="exi" href="#expand"> </a></td>
1751 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1752 <div class="fixedFont">
1753 <span class="attributes"></span><b class="itemname">setVisible</b>
1755 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1761 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1770 <div class="short">Convenience function to hide or show this component by boolean.</div>
1776 Convenience function to hide or show this component by boolean.
1783 <dl class="detailList">
1784 <dt class="heading">Parameters:</dt>
1787 <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>
1790 <dd>True to show, false to hide</dd>
1798 <dl class="detailList">
1799 <dt class="heading">Returns:</dt>
1801 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1815 <td class="msource">
1817 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1823 <tr class="method-row config-row-alt1 expandable">
1824 <td class="micon"><a class="exi" href="#expand"> </a></td>
1828 <a id="Roo.Component-method-show" name=".show"></a>
1829 <div class="fixedFont">
1830 <span class="attributes"></span><b class="itemname">show</b>
1838 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1847 <div class="short">Show this component.</div>
1853 Show this component.
1864 <dl class="detailList">
1865 <dt class="heading">Returns:</dt>
1867 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1881 <td class="msource">
1883 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1889 <tr class="method-row config-row-alt0 expandable">
1890 <td class="micon"><a class="exi" href="#expand"> </a></td>
1894 <a id="Roo.util.Observable-method-un" name=".un"></a>
1895 <div class="fixedFont">
1896 <span class="attributes"></span><b class="itemname">un</b>
1898 (<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>)
1905 <div class="short">Removes a listener (shorthand for removeListener)</div>
1911 Removes a listener (shorthand for removeListener)
1918 <dl class="detailList">
1919 <dt class="heading">Parameters:</dt>
1922 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1925 <dd>The type of event to listen for</dd>
1928 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1931 <dd>The handler to remove</dd>
1934 <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>
1937 <dd>(optional) The scope (this object) for the handler</dd>
1955 <td class="msource">
1957 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1966 <!-- ============================== events summary / details ======================== -->
1969 <a id="Roo.bootstrap.NavGroup-events"></a>
1978 <table cellspacing="0" class="member-table">
1979 <caption>Events</caption>
1982 <th class="sig-header" colspan="2">Event</th>
1983 <th class="msource-header">Defined By</th>
1992 <tr class="method-row expandable config-row-alt0">
1993 <td class="micon"><a class="exi" href="#expand"> </a></td>
1996 <a id="Roo.Component-event-*beforedestroy"></a>
1998 <div class="fixedFont">
1999 <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>)
2005 <div class="short">Fires before the component is destroyed.
2011 Fires before the component is destroyed. Return false to stop the destroy.
2017 <dl class="detailList">
2018 <dt class="heading">Parameters:</dt>
2021 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2042 <td class="msource">
2043 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2047 <tr class="method-row expandable config-row-alt1">
2048 <td class="micon"><a class="exi" href="#expand"> </a></td>
2051 <a id="Roo.Component-event-*beforehide"></a>
2053 <div class="fixedFont">
2054 <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>)
2060 <div class="short">Fires before the component is hidden.
2066 Fires before the component is hidden. Return false to stop the hide.
2072 <dl class="detailList">
2073 <dt class="heading">Parameters:</dt>
2076 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2097 <td class="msource">
2098 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2102 <tr class="method-row expandable config-row-alt0">
2103 <td class="micon"><a class="exi" href="#expand"> </a></td>
2106 <a id="Roo.Component-event-*beforerender"></a>
2108 <div class="fixedFont">
2109 <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>)
2115 <div class="short">Fires before the component is rendered.
2121 Fires before the component is rendered. Return false to stop the render.
2127 <dl class="detailList">
2128 <dt class="heading">Parameters:</dt>
2131 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2152 <td class="msource">
2153 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2157 <tr class="method-row expandable config-row-alt1">
2158 <td class="micon"><a class="exi" href="#expand"> </a></td>
2161 <a id="Roo.Component-event-*beforeshow"></a>
2163 <div class="fixedFont">
2164 <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>)
2170 <div class="short">Fires before the component is shown.
2176 Fires before the component is shown. Return false to stop the show.
2182 <dl class="detailList">
2183 <dt class="heading">Parameters:</dt>
2186 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2207 <td class="msource">
2208 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2212 <tr class="method-row expandable config-row-alt0">
2213 <td class="micon"><a class="exi" href="#expand"> </a></td>
2216 <a id="Roo.Component-event-*destroy"></a>
2218 <div class="fixedFont">
2219 <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>)
2225 <div class="short">Fires after the component is destroyed.
2231 Fires after the component is destroyed.
2237 <dl class="detailList">
2238 <dt class="heading">Parameters:</dt>
2241 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2262 <td class="msource">
2263 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2267 <tr class="method-row expandable config-row-alt1">
2268 <td class="micon"><a class="exi" href="#expand"> </a></td>
2271 <a id="Roo.Component-event-*disable"></a>
2273 <div class="fixedFont">
2274 <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>)
2280 <div class="short">Fires after the component is disabled.
2286 Fires after the component is disabled.
2292 <dl class="detailList">
2293 <dt class="heading">Parameters:</dt>
2296 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2317 <td class="msource">
2318 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2322 <tr class="method-row expandable config-row-alt0">
2323 <td class="micon"><a class="exi" href="#expand"> </a></td>
2326 <a id="Roo.Component-event-*enable"></a>
2328 <div class="fixedFont">
2329 <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>)
2335 <div class="short">Fires after the component is enabled.
2341 Fires after the component is enabled.
2347 <dl class="detailList">
2348 <dt class="heading">Parameters:</dt>
2351 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2372 <td class="msource">
2373 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2377 <tr class="method-row expandable config-row-alt1">
2378 <td class="micon"><a class="exi" href="#expand"> </a></td>
2381 <a id="Roo.Component-event-*hide"></a>
2383 <div class="fixedFont">
2384 <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>)
2390 <div class="short">Fires after the component is hidden.
2396 Fires after the component is hidden.
2402 <dl class="detailList">
2403 <dt class="heading">Parameters:</dt>
2406 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2427 <td class="msource">
2428 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2432 <tr class="method-row expandable config-row-alt0">
2433 <td class="micon"><a class="exi" href="#expand"> </a></td>
2436 <a id="Roo.Component-event-*render"></a>
2438 <div class="fixedFont">
2439 <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>)
2445 <div class="short">Fires after the component is rendered.
2451 Fires after the component is rendered.
2457 <dl class="detailList">
2458 <dt class="heading">Parameters:</dt>
2461 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2482 <td class="msource">
2483 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2487 <tr class="method-row expandable config-row-alt1">
2488 <td class="micon"><a class="exi" href="#expand"> </a></td>
2491 <a id="Roo.Component-event-*show"></a>
2493 <div class="fixedFont">
2494 <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>)
2500 <div class="short">Fires after the component is shown.
2506 Fires after the component is shown.
2512 <dl class="detailList">
2513 <dt class="heading">Parameters:</dt>
2516 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2537 <td class="msource">
2538 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2549 <!-- ============================== footer ================================= -->
2550 <div class="fineprint" style="clear:both">
2552 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Apr 01 2014 13:11:08 GMT+0800 (HKT)
2554 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>