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.NavSidebar</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.NavSidebar-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.NavSidebar-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.NavSidebar-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.NavSidebar-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.bootstrap.NavSidebar
55 <!-- ============================== class title / details ============================ -->
58 <h1 class="classTitle">
60 Class Roo.bootstrap.NavSidebar
63 <table cellspacing="0" class="class-summary-table">
65 <tr><td class="label">Package:</td><td class="hd-info">Roo.bootstrap</td></tr>
67 <tr><td class="label">Defined In:</td><td class="hd-info">
69 <a href="./src/Roo_bootstrap_NavSidebar.js.html">Roo/bootstrap/NavSidebar.js</a>.
72 <tr><td class="label">Class:</td><td class="hd-info">NavSidebar</td></tr>
77 <tr><td class="label">Extends:</td><td class="hd-info">
78 <a href="./Roo.bootstrap.Navbar.html#constructor" roo:cls="Roo.bootstrap.Navbar.html#constructor">Roo.bootstrap.Navbar</a>
86 <!-- ============================== class summary ========================== -->
87 <div class="description">
88 Bootstrap Sidebar class
92 <!-- ============================== Class comment block... ========================== -->
94 <div class="comments">
95 <b>Class Comments / Notes</B> =>
96 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.NavSidebar';">[Add Your comment/notes about this class]</u>
98 <iframe frameborder="0" id="comments-Roo.bootstrap" style="border: none;width:100%;"
99 src="/blog.php/GtkDjsComments/Roo.bootstrap.NavSidebar.html"></iframe>
104 <!-- ============================== config options ========================== -->
109 <div class="hr"></div>
110 <a id="Roo.bootstrap.NavSidebar-configs"></a>
116 <table cellspacing="0" class="member-table">
117 <caption>Config Options (Usually are also Properties)</caption>
121 <th class="sig-header" colspan="2">Options</th>
123 <th class="msource-header">Defined By</th>
130 <tr class="config-row expandable config-row-alt0">
131 <td class="micon"><a class="exi" href="#expand"> </a></td>
134 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
135 <div class="fixedFont">
136 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
142 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
146 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
154 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
160 <tr class="config-row expandable config-row-alt1">
161 <td class="micon"><a class="exi" href="#expand"> </a></td>
164 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
165 <div class="fixedFont">
166 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
172 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
176 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
184 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
190 <tr class="config-row expandable config-row-alt0">
191 <td class="micon"><a class="exi" href="#expand"> </a></td>
194 <a id="Roo.bootstrap.Component-cfg-can_build_overlaid" name=".can_build_overlaid"></a>
195 <div class="fixedFont">
196 <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>
202 <div class="short">True if element can be rebuild from a HTML page</div>
206 <div class="long">True if element can be rebuild from a HTML page</div>
214 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
220 <tr class="config-row expandable config-row-alt1">
221 <td class="micon"><a class="exi" href="#expand"> </a></td>
224 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
225 <div class="fixedFont">
226 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
232 <div class="short">css class</div>
236 <div class="long">css class</div>
244 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
250 <tr class="config-row expandable config-row-alt0">
251 <td class="micon"><a class="exi" href="#expand"> </a></td>
254 <a id="Roo.bootstrap.Component-cfg-dataId" name=".dataId"></a>
255 <div class="fixedFont">
256 <b class="itemname">dataId</b> : string
262 <div class="short">cutomer id</div>
266 <div class="long">cutomer id</div>
274 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
280 <tr class="config-row expandable config-row-alt1">
281 <td class="micon"><a class="exi" href="#expand"> </a></td>
284 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
285 <div class="fixedFont">
286 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
292 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
296 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
304 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
310 <tr class="config-row expandable config-row-alt0">
311 <td class="micon"><a class="exi" href="#expand"> </a></td>
314 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
315 <div class="fixedFont">
316 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
322 <div class="short">How this component should hidden.</div>
326 <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>
334 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
340 <tr class="config-row expandable config-row-alt1">
341 <td class="micon"><a class="exi" href="#expand"> </a></td>
344 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
345 <div class="fixedFont">
346 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
352 <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>
356 <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>
364 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
370 <tr class="config-row expandable config-row-alt0">
371 <td class="micon"><a class="exi" href="#expand"> </a></td>
374 <a id="Roo.bootstrap.Component-cfg-name" name=".name"></a>
375 <div class="fixedFont">
376 <b class="itemname">name</b> : string
382 <div class="short">Specifies name attribute</div>
386 <div class="long">Specifies name attribute</div>
394 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
400 <tr class="config-row expandable config-row-alt1">
401 <td class="micon"><a class="exi" href="#expand"> </a></td>
404 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
405 <div class="fixedFont">
406 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
412 <div class="short">any extra css</div>
416 <div class="long">any extra css</div>
424 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
430 <tr class="config-row expandable config-row-alt0">
431 <td class="micon"><a class="exi" href="#expand"> </a></td>
434 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
435 <div class="fixedFont">
436 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
442 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
446 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
454 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
470 <!-- ============================== public properties ==================== -->
474 <a id="Roo.bootstrap.NavSidebar-props"></a>
480 <table cellspacing="0" class="member-table">
481 <caption class="Empty">Public Properties - Has None</caption>
487 <!-- ============================== methods summary / details ======================== -->
490 <a id="Roo.bootstrap.NavSidebar-methods"></a>
491 <!-- constructor?? -->
498 <!-- then dynamics first -->
505 <table cellspacing="0" class="member-table">
506 <caption>Public Methods</caption>
508 <th class="sig-header" colspan="2">Method</th>
509 <th class="msource-header">Defined By</th>
519 <tr class="method-row config-row-alt0 expandable notInherited">
520 <td class="micon"><a class="exi" href="#expand"> </a></td>
524 <a id="Roo.bootstrap-method-NavSidebar" name=".NavSidebar"></a>
525 <div class="fixedFont">
526 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">NavSidebar</b>
528 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
536 <div class="short">Create a new Roo.bootstrap.NavSidebar</div>
543 Create a new Roo.bootstrap.NavSidebar
546 <dl class="detailList">
547 <dt class="heading">Parameters:</dt>
550 <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>
553 <dd>The config object</dd>
577 <tr class="method-row config-row-alt1 expandable">
578 <td class="micon"><a class="exi" href="#expand"> </a></td>
582 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
583 <div class="fixedFont">
584 <span class="attributes"></span><b class="itemname">addEvents</b>
586 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
593 <div class="short">Used to define events on this Observable</div>
599 Used to define events on this Observable
606 <dl class="detailList">
607 <dt class="heading">Parameters:</dt>
610 <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>
613 <dd>The object with the events defined</dd>
633 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
639 <tr class="method-row config-row-alt0 expandable">
640 <td class="micon"><a class="exi" href="#expand"> </a></td>
644 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
645 <div class="fixedFont">
646 <span class="attributes"></span><b class="itemname">addListener</b>
648 (<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>)
655 <div class="short">Appends an event handler to this component</div>
661 Appends an event handler to this component
668 <dl class="detailList">
669 <dt class="heading">Parameters:</dt>
672 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
675 <dd>The type of event to listen for</dd>
678 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
681 <dd>The method the event invokes</dd>
684 <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>
687 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
690 <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>
693 <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>
713 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
719 <tr class="method-row config-row-alt1 expandable">
720 <td class="micon"><a class="exi" href="#expand"> </a></td>
724 <a id="Roo.Component-method-destroy" name=".destroy"></a>
725 <div class="fixedFont">
726 <span class="attributes"></span><b class="itemname">destroy</b>
735 <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>
741 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}.
764 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
770 <tr class="method-row config-row-alt0 expandable">
771 <td class="micon"><a class="exi" href="#expand"> </a></td>
775 <a id="Roo.Component-method-disable" name=".disable"></a>
776 <div class="fixedFont">
777 <span class="attributes"></span><b class="itemname">disable</b>
785 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
794 <div class="short">Disable this component.</div>
800 Disable this component.
811 <dl class="detailList">
812 <dt class="heading">Returns:</dt>
814 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
830 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
836 <tr class="method-row config-row-alt1 expandable">
837 <td class="micon"><a class="exi" href="#expand"> </a></td>
841 <a id="Roo.Component-method-enable" name=".enable"></a>
842 <div class="fixedFont">
843 <span class="attributes"></span><b class="itemname">enable</b>
851 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
860 <div class="short">Enable this component.</div>
866 Enable this component.
877 <dl class="detailList">
878 <dt class="heading">Returns:</dt>
880 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
896 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
902 <tr class="method-row config-row-alt0 expandable">
903 <td class="micon"><a class="exi" href="#expand"> </a></td>
907 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
908 <div class="fixedFont">
909 <span class="attributes"></span><b class="itemname">fireEvent</b>
911 (<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>)
917 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
926 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
932 Fires the specified event with the passed parameters (minus the event name).
939 <dl class="detailList">
940 <dt class="heading">Parameters:</dt>
943 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
949 <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>
952 <dd>Variable number of parameters are passed to handlers</dd>
960 <dl class="detailList">
961 <dt class="heading">Returns:</dt>
963 <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>
979 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
985 <tr class="method-row config-row-alt1 expandable">
986 <td class="micon"><a class="exi" href="#expand"> </a></td>
990 <a id="Roo.Component-method-focus" name=".focus"></a>
991 <div class="fixedFont">
992 <span class="attributes"></span><b class="itemname">focus</b>
994 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1000 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1009 <div class="short">Try to focus this component.</div>
1015 Try to focus this component.
1022 <dl class="detailList">
1023 <dt class="heading">Parameters:</dt>
1026 <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>
1029 <dd>True to also select the text in this component (if applicable)</dd>
1037 <dl class="detailList">
1038 <dt class="heading">Returns:</dt>
1040 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1054 <td class="msource">
1056 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1062 <tr class="method-row config-row-alt0 expandable">
1063 <td class="micon"><a class="exi" href="#expand"> </a></td>
1067 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1068 <div class="fixedFont">
1069 <span class="attributes"></span><b class="itemname">getEl</b>
1077 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1086 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1092 Returns the underlying {<b>link</b> Roo.Element}.
1103 <dl class="detailList">
1104 <dt class="heading">Returns:</dt>
1106 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1120 <td class="msource">
1122 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1128 <tr class="method-row config-row-alt1 expandable">
1129 <td class="micon"><a class="exi" href="#expand"> </a></td>
1133 <a id="Roo.Component-method-getId" name=".getId"></a>
1134 <div class="fixedFont">
1135 <span class="attributes"></span><b class="itemname">getId</b>
1143 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1152 <div class="short">Returns the id of this component.</div>
1158 Returns the id of this component.
1169 <dl class="detailList">
1170 <dt class="heading">Returns:</dt>
1172 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1186 <td class="msource">
1188 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1194 <tr class="method-row config-row-alt0 expandable">
1195 <td class="micon"><a class="exi" href="#expand"> </a></td>
1199 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1200 <div class="fixedFont">
1201 <span class="attributes"></span><b class="itemname">hasListener</b>
1203 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1209 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1218 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1224 Checks to see if this object has any listeners for a specified event
1231 <dl class="detailList">
1232 <dt class="heading">Parameters:</dt>
1235 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1238 <dd>The name of the event to check for</dd>
1246 <dl class="detailList">
1247 <dt class="heading">Returns:</dt>
1249 <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>
1263 <td class="msource">
1265 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1271 <tr class="method-row config-row-alt1 expandable">
1272 <td class="micon"><a class="exi" href="#expand"> </a></td>
1276 <a id="Roo.Component-method-hide" name=".hide"></a>
1277 <div class="fixedFont">
1278 <span class="attributes"></span><b class="itemname">hide</b>
1286 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1295 <div class="short">Hide this component.</div>
1301 Hide this component.
1312 <dl class="detailList">
1313 <dt class="heading">Returns:</dt>
1315 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1329 <td class="msource">
1331 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1337 <tr class="method-row config-row-alt0 expandable">
1338 <td class="micon"><a class="exi" href="#expand"> </a></td>
1342 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1343 <div class="fixedFont">
1344 <span class="attributes"></span><b class="itemname">isVisible</b>
1353 <div class="short">Returns true if this component is visible.</div>
1359 Returns true if this component is visible.
1380 <td class="msource">
1382 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1388 <tr class="method-row config-row-alt1 expandable">
1389 <td class="micon"><a class="exi" href="#expand"> </a></td>
1393 <a id="Roo.util.Observable-method-on" name=".on"></a>
1394 <div class="fixedFont">
1395 <span class="attributes"></span><b class="itemname">on</b>
1397 (<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>)
1404 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1410 Appends an event handler to this element (shorthand for addListener)
1417 <dl class="detailList">
1418 <dt class="heading">Parameters:</dt>
1421 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1424 <dd>The type of event to listen for</dd>
1427 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1430 <dd>The method the event invokes</dd>
1433 <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>
1436 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1439 <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>
1460 <td class="msource">
1462 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1468 <tr class="method-row config-row-alt0 expandable">
1469 <td class="micon"><a class="exi" href="#expand"> </a></td>
1473 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1474 <div class="fixedFont">
1475 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1484 <div class="short">Removes all listeners for this object</div>
1490 Removes all listeners for this object
1511 <td class="msource">
1513 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1519 <tr class="method-row config-row-alt1 expandable">
1520 <td class="micon"><a class="exi" href="#expand"> </a></td>
1524 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1525 <div class="fixedFont">
1526 <span class="attributes"></span><b class="itemname">removeListener</b>
1528 (<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>)
1535 <div class="short">Removes a listener</div>
1548 <dl class="detailList">
1549 <dt class="heading">Parameters:</dt>
1552 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1555 <dd>The type of event to listen for</dd>
1558 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1561 <dd>The handler to remove</dd>
1564 <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>
1567 <dd>(optional) The scope (this object) for the handler</dd>
1585 <td class="msource">
1587 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1593 <tr class="method-row config-row-alt0 expandable">
1594 <td class="micon"><a class="exi" href="#expand"> </a></td>
1598 <a id="Roo.Component-method-render" name=".render"></a>
1599 <div class="fixedFont">
1600 <span class="attributes"></span><b class="itemname">render</b>
1602 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1609 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1615 If this is a lazy rendering component, render it to its container element.
1622 <dl class="detailList">
1623 <dt class="heading">Parameters:</dt>
1626 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1629 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1647 <td class="msource">
1649 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1655 <tr class="method-row config-row-alt1 expandable">
1656 <td class="micon"><a class="exi" href="#expand"> </a></td>
1660 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1661 <div class="fixedFont">
1662 <span class="attributes"></span><b class="itemname">setDisabled</b>
1664 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1671 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1677 Convenience function for setting disabled/enabled by boolean.
1684 <dl class="detailList">
1685 <dt class="heading">Parameters:</dt>
1688 <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>
1709 <td class="msource">
1711 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1717 <tr class="method-row config-row-alt0 expandable">
1718 <td class="micon"><a class="exi" href="#expand"> </a></td>
1722 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1723 <div class="fixedFont">
1724 <span class="attributes"></span><b class="itemname">setVisible</b>
1726 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1732 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1741 <div class="short">Convenience function to hide or show this component by boolean.</div>
1747 Convenience function to hide or show this component by boolean.
1754 <dl class="detailList">
1755 <dt class="heading">Parameters:</dt>
1758 <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>
1761 <dd>True to show, false to hide</dd>
1769 <dl class="detailList">
1770 <dt class="heading">Returns:</dt>
1772 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1786 <td class="msource">
1788 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1794 <tr class="method-row config-row-alt1 expandable">
1795 <td class="micon"><a class="exi" href="#expand"> </a></td>
1799 <a id="Roo.Component-method-show" name=".show"></a>
1800 <div class="fixedFont">
1801 <span class="attributes"></span><b class="itemname">show</b>
1809 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1818 <div class="short">Show this component.</div>
1824 Show this component.
1835 <dl class="detailList">
1836 <dt class="heading">Returns:</dt>
1838 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1852 <td class="msource">
1854 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1860 <tr class="method-row config-row-alt0 expandable">
1861 <td class="micon"><a class="exi" href="#expand"> </a></td>
1865 <a id="Roo.util.Observable-method-un" name=".un"></a>
1866 <div class="fixedFont">
1867 <span class="attributes"></span><b class="itemname">un</b>
1869 (<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>)
1876 <div class="short">Removes a listener (shorthand for removeListener)</div>
1882 Removes a listener (shorthand for removeListener)
1889 <dl class="detailList">
1890 <dt class="heading">Parameters:</dt>
1893 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1896 <dd>The type of event to listen for</dd>
1899 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1902 <dd>The handler to remove</dd>
1905 <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>
1908 <dd>(optional) The scope (this object) for the handler</dd>
1926 <td class="msource">
1928 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1937 <!-- ============================== events summary / details ======================== -->
1940 <a id="Roo.bootstrap.NavSidebar-events"></a>
1949 <table cellspacing="0" class="member-table">
1950 <caption>Events</caption>
1953 <th class="sig-header" colspan="2">Event</th>
1954 <th class="msource-header">Defined By</th>
1963 <tr class="method-row expandable config-row-alt0">
1964 <td class="micon"><a class="exi" href="#expand"> </a></td>
1967 <a id="Roo.Component-event-*beforedestroy"></a>
1969 <div class="fixedFont">
1970 <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>)
1976 <div class="short">Fires before the component is destroyed.
1982 Fires before the component is destroyed. Return false to stop the destroy.
1988 <dl class="detailList">
1989 <dt class="heading">Parameters:</dt>
1992 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2013 <td class="msource">
2014 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2018 <tr class="method-row expandable config-row-alt1">
2019 <td class="micon"><a class="exi" href="#expand"> </a></td>
2022 <a id="Roo.Component-event-*beforehide"></a>
2024 <div class="fixedFont">
2025 <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>)
2031 <div class="short">Fires before the component is hidden.
2037 Fires before the component is hidden. Return false to stop the hide.
2043 <dl class="detailList">
2044 <dt class="heading">Parameters:</dt>
2047 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2068 <td class="msource">
2069 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2073 <tr class="method-row expandable config-row-alt0">
2074 <td class="micon"><a class="exi" href="#expand"> </a></td>
2077 <a id="Roo.Component-event-*beforerender"></a>
2079 <div class="fixedFont">
2080 <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>)
2086 <div class="short">Fires before the component is rendered.
2092 Fires before the component is rendered. Return false to stop the render.
2098 <dl class="detailList">
2099 <dt class="heading">Parameters:</dt>
2102 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2123 <td class="msource">
2124 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2128 <tr class="method-row expandable config-row-alt1">
2129 <td class="micon"><a class="exi" href="#expand"> </a></td>
2132 <a id="Roo.Component-event-*beforeshow"></a>
2134 <div class="fixedFont">
2135 <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>)
2141 <div class="short">Fires before the component is shown.
2147 Fires before the component is shown. Return false to stop the show.
2153 <dl class="detailList">
2154 <dt class="heading">Parameters:</dt>
2157 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2178 <td class="msource">
2179 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2183 <tr class="method-row expandable config-row-alt0">
2184 <td class="micon"><a class="exi" href="#expand"> </a></td>
2187 <a id="Roo.Component-event-*destroy"></a>
2189 <div class="fixedFont">
2190 <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>)
2196 <div class="short">Fires after the component is destroyed.
2202 Fires after the component is destroyed.
2208 <dl class="detailList">
2209 <dt class="heading">Parameters:</dt>
2212 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2233 <td class="msource">
2234 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2238 <tr class="method-row expandable config-row-alt1">
2239 <td class="micon"><a class="exi" href="#expand"> </a></td>
2242 <a id="Roo.Component-event-*disable"></a>
2244 <div class="fixedFont">
2245 <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>)
2251 <div class="short">Fires after the component is disabled.
2257 Fires after the component is disabled.
2263 <dl class="detailList">
2264 <dt class="heading">Parameters:</dt>
2267 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2288 <td class="msource">
2289 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2293 <tr class="method-row expandable config-row-alt0">
2294 <td class="micon"><a class="exi" href="#expand"> </a></td>
2297 <a id="Roo.Component-event-*enable"></a>
2299 <div class="fixedFont">
2300 <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>)
2306 <div class="short">Fires after the component is enabled.
2312 Fires after the component is enabled.
2318 <dl class="detailList">
2319 <dt class="heading">Parameters:</dt>
2322 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2343 <td class="msource">
2344 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2348 <tr class="method-row expandable config-row-alt1">
2349 <td class="micon"><a class="exi" href="#expand"> </a></td>
2352 <a id="Roo.Component-event-*hide"></a>
2354 <div class="fixedFont">
2355 <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>)
2361 <div class="short">Fires after the component is hidden.
2367 Fires after the component is hidden.
2373 <dl class="detailList">
2374 <dt class="heading">Parameters:</dt>
2377 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2398 <td class="msource">
2399 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2403 <tr class="method-row expandable config-row-alt0">
2404 <td class="micon"><a class="exi" href="#expand"> </a></td>
2407 <a id="Roo.Component-event-*render"></a>
2409 <div class="fixedFont">
2410 <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>)
2416 <div class="short">Fires after the component is rendered.
2422 Fires after the component is rendered.
2428 <dl class="detailList">
2429 <dt class="heading">Parameters:</dt>
2432 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2453 <td class="msource">
2454 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2458 <tr class="method-row expandable config-row-alt1">
2459 <td class="micon"><a class="exi" href="#expand"> </a></td>
2462 <a id="Roo.Component-event-*show"></a>
2464 <div class="fixedFont">
2465 <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>)
2471 <div class="short">Fires after the component is shown.
2477 Fires after the component is shown.
2483 <dl class="detailList">
2484 <dt class="heading">Parameters:</dt>
2487 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2508 <td class="msource">
2509 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2520 <!-- ============================== footer ================================= -->
2521 <div class="fineprint" style="clear:both">
2523 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Feb 05 2015 18:14:22 GMT+0800 (HKT)
2525 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>