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.Menu</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.Menu-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.Menu-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.Menu-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.Menu-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.Menu
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.bootstrap.Menu
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_Menu.js.html">Roo/bootstrap/Menu.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">Menu</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 Menu class - container for MenuItems
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.Menu';">[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.Menu.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.bootstrap.Menu-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">
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="Roo.Component-cfg-allowDomMove" name=".allowDomMove"></a>
164 <div class="fixedFont">
165 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
171 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
175 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</div>
183 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
189 <tr class="config-row expandable config-row-alt0">
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
193 <a id="Roo.bootstrap.Component-cfg-cls" name=".cls"></a>
194 <div class="fixedFont">
195 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
201 <div class="short">css class</div>
205 <div class="long">css class</div>
213 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.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.Component-cfg-disableClass" name=".disableClass"></a>
224 <div class="fixedFont">
225 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
231 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
235 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
243 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.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.Component-cfg-hideMode" name=".hideMode"></a>
254 <div class="fixedFont">
255 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
261 <div class="short">How this component should hidden.</div>
265 <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>
273 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.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.util.Observable-cfg-listeners" name=".listeners"></a>
284 <div class="fixedFont">
285 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
291 <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>
295 <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>
303 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</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.bootstrap.Component-cfg-style" name=".style"></a>
314 <div class="fixedFont">
315 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
321 <div class="short">any extra css</div>
325 <div class="long">any extra css</div>
333 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
339 <tr class="config-row expandable config-row-alt1 notInherited">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
343 <a id="Roo.bootstrap.Menu-cfg-type" name=".type"></a>
344 <div class="fixedFont">
345 <b class="itemname">type</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
351 <div class="short">type of menu</div>
355 <div class="long">type of menu</div>
369 <tr class="config-row expandable config-row-alt0">
370 <td class="micon"><a class="exi" href="#expand"> </a></td>
373 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
374 <div class="fixedFont">
375 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
381 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
385 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
393 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
409 <!-- ============================== public properties ==================== -->
413 <a id="Roo.bootstrap.Menu-props"></a>
419 <table cellspacing="0" class="member-table">
420 <caption class="Empty">Public Properties - Has None</caption>
426 <!-- ============================== methods summary / details ======================== -->
429 <a id="Roo.bootstrap.Menu-methods"></a>
430 <!-- constructor?? -->
437 <!-- then dynamics first -->
444 <table cellspacing="0" class="member-table">
445 <caption>Public Methods</caption>
447 <th class="sig-header" colspan="2">Method</th>
448 <th class="msource-header">Defined By</th>
458 <tr class="method-row config-row-alt0 expandable notInherited">
459 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.bootstrap-method-Menu" name=".Menu"></a>
464 <div class="fixedFont">
465 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">Menu</b>
467 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
475 <div class="short">Create a new Roo.bootstrap.Menu</div>
482 Create a new Roo.bootstrap.Menu
485 <dl class="detailList">
486 <dt class="heading">Parameters:</dt>
489 <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>
492 <dd>The config object</dd>
516 <tr class="method-row config-row-alt1 expandable">
517 <td class="micon"><a class="exi" href="#expand"> </a></td>
521 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
522 <div class="fixedFont">
523 <span class="attributes"></span><b class="itemname">addEvents</b>
525 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
532 <div class="short">Used to define events on this Observable</div>
538 Used to define events on this Observable
545 <dl class="detailList">
546 <dt class="heading">Parameters:</dt>
549 <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>
552 <dd>The object with the events defined</dd>
572 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
578 <tr class="method-row config-row-alt0 expandable">
579 <td class="micon"><a class="exi" href="#expand"> </a></td>
583 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
584 <div class="fixedFont">
585 <span class="attributes"></span><b class="itemname">addListener</b>
587 (<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>)
594 <div class="short">Appends an event handler to this component</div>
600 Appends an event handler to this component
607 <dl class="detailList">
608 <dt class="heading">Parameters:</dt>
611 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
614 <dd>The type of event to listen for</dd>
617 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
620 <dd>The method the event invokes</dd>
623 <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>
626 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
629 <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>
632 <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>
652 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
658 <tr class="method-row config-row-alt1 expandable">
659 <td class="micon"><a class="exi" href="#expand"> </a></td>
663 <a id="Roo.Component-method-destroy" name=".destroy"></a>
664 <div class="fixedFont">
665 <span class="attributes"></span><b class="itemname">destroy</b>
674 <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>
680 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}.
703 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
709 <tr class="method-row config-row-alt0 expandable">
710 <td class="micon"><a class="exi" href="#expand"> </a></td>
714 <a id="Roo.Component-method-disable" name=".disable"></a>
715 <div class="fixedFont">
716 <span class="attributes"></span><b class="itemname">disable</b>
724 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
733 <div class="short">Disable this component.</div>
739 Disable this component.
750 <dl class="detailList">
751 <dt class="heading">Returns:</dt>
753 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
769 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
775 <tr class="method-row config-row-alt1 expandable">
776 <td class="micon"><a class="exi" href="#expand"> </a></td>
780 <a id="Roo.Component-method-enable" name=".enable"></a>
781 <div class="fixedFont">
782 <span class="attributes"></span><b class="itemname">enable</b>
790 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
799 <div class="short">Enable this component.</div>
805 Enable this component.
816 <dl class="detailList">
817 <dt class="heading">Returns:</dt>
819 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
835 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
841 <tr class="method-row config-row-alt0 expandable">
842 <td class="micon"><a class="exi" href="#expand"> </a></td>
846 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
847 <div class="fixedFont">
848 <span class="attributes"></span><b class="itemname">fireEvent</b>
850 (<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>)
856 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
865 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
871 Fires the specified event with the passed parameters (minus the event name).
878 <dl class="detailList">
879 <dt class="heading">Parameters:</dt>
882 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
888 <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>
891 <dd>Variable number of parameters are passed to handlers</dd>
899 <dl class="detailList">
900 <dt class="heading">Returns:</dt>
902 <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>
918 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
924 <tr class="method-row config-row-alt1 expandable">
925 <td class="micon"><a class="exi" href="#expand"> </a></td>
929 <a id="Roo.Component-method-focus" name=".focus"></a>
930 <div class="fixedFont">
931 <span class="attributes"></span><b class="itemname">focus</b>
933 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
939 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
948 <div class="short">Try to focus this component.</div>
954 Try to focus this component.
961 <dl class="detailList">
962 <dt class="heading">Parameters:</dt>
965 <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>
968 <dd>True to also select the text in this component (if applicable)</dd>
976 <dl class="detailList">
977 <dt class="heading">Returns:</dt>
979 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
995 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1001 <tr class="method-row config-row-alt0 expandable">
1002 <td class="micon"><a class="exi" href="#expand"> </a></td>
1006 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1007 <div class="fixedFont">
1008 <span class="attributes"></span><b class="itemname">getEl</b>
1016 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1025 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1031 Returns the underlying {<b>link</b> Roo.Element}.
1042 <dl class="detailList">
1043 <dt class="heading">Returns:</dt>
1045 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1059 <td class="msource">
1061 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1067 <tr class="method-row config-row-alt1 expandable">
1068 <td class="micon"><a class="exi" href="#expand"> </a></td>
1072 <a id="Roo.Component-method-getId" name=".getId"></a>
1073 <div class="fixedFont">
1074 <span class="attributes"></span><b class="itemname">getId</b>
1082 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1091 <div class="short">Returns the id of this component.</div>
1097 Returns the id of this component.
1108 <dl class="detailList">
1109 <dt class="heading">Returns:</dt>
1111 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1125 <td class="msource">
1127 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1133 <tr class="method-row config-row-alt0 expandable">
1134 <td class="micon"><a class="exi" href="#expand"> </a></td>
1138 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1139 <div class="fixedFont">
1140 <span class="attributes"></span><b class="itemname">hasListener</b>
1142 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1148 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1157 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1163 Checks to see if this object has any listeners for a specified event
1170 <dl class="detailList">
1171 <dt class="heading">Parameters:</dt>
1174 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1177 <dd>The name of the event to check for</dd>
1185 <dl class="detailList">
1186 <dt class="heading">Returns:</dt>
1188 <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>
1202 <td class="msource">
1204 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1210 <tr class="method-row config-row-alt1 expandable">
1211 <td class="micon"><a class="exi" href="#expand"> </a></td>
1215 <a id="Roo.Component-method-hide" name=".hide"></a>
1216 <div class="fixedFont">
1217 <span class="attributes"></span><b class="itemname">hide</b>
1225 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1234 <div class="short">Hide this component.</div>
1240 Hide this component.
1251 <dl class="detailList">
1252 <dt class="heading">Returns:</dt>
1254 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1268 <td class="msource">
1270 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1276 <tr class="method-row config-row-alt0 expandable">
1277 <td class="micon"><a class="exi" href="#expand"> </a></td>
1281 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1282 <div class="fixedFont">
1283 <span class="attributes"></span><b class="itemname">isVisible</b>
1292 <div class="short">Returns true if this component is visible.</div>
1298 Returns true if this component is visible.
1319 <td class="msource">
1321 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1327 <tr class="method-row config-row-alt1 expandable">
1328 <td class="micon"><a class="exi" href="#expand"> </a></td>
1332 <a id="Roo.util.Observable-method-on" name=".on"></a>
1333 <div class="fixedFont">
1334 <span class="attributes"></span><b class="itemname">on</b>
1336 (<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>)
1343 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1349 Appends an event handler to this element (shorthand for addListener)
1356 <dl class="detailList">
1357 <dt class="heading">Parameters:</dt>
1360 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1363 <dd>The type of event to listen for</dd>
1366 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1369 <dd>The method the event invokes</dd>
1372 <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>
1375 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1378 <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>
1399 <td class="msource">
1401 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1407 <tr class="method-row config-row-alt0 expandable">
1408 <td class="micon"><a class="exi" href="#expand"> </a></td>
1412 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1413 <div class="fixedFont">
1414 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1423 <div class="short">Removes all listeners for this object</div>
1429 Removes all listeners for this object
1450 <td class="msource">
1452 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1458 <tr class="method-row config-row-alt1 expandable">
1459 <td class="micon"><a class="exi" href="#expand"> </a></td>
1463 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1464 <div class="fixedFont">
1465 <span class="attributes"></span><b class="itemname">removeListener</b>
1467 (<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>)
1474 <div class="short">Removes a listener</div>
1487 <dl class="detailList">
1488 <dt class="heading">Parameters:</dt>
1491 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1494 <dd>The type of event to listen for</dd>
1497 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1500 <dd>The handler to remove</dd>
1503 <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>
1506 <dd>(optional) The scope (this object) for the handler</dd>
1524 <td class="msource">
1526 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1532 <tr class="method-row config-row-alt0 expandable">
1533 <td class="micon"><a class="exi" href="#expand"> </a></td>
1537 <a id="Roo.Component-method-render" name=".render"></a>
1538 <div class="fixedFont">
1539 <span class="attributes"></span><b class="itemname">render</b>
1541 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1548 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1554 If this is a lazy rendering component, render it to its container element.
1561 <dl class="detailList">
1562 <dt class="heading">Parameters:</dt>
1565 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1568 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1586 <td class="msource">
1588 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1594 <tr class="method-row config-row-alt1 expandable">
1595 <td class="micon"><a class="exi" href="#expand"> </a></td>
1599 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1600 <div class="fixedFont">
1601 <span class="attributes"></span><b class="itemname">setDisabled</b>
1603 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1610 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1616 Convenience function for setting disabled/enabled by boolean.
1623 <dl class="detailList">
1624 <dt class="heading">Parameters:</dt>
1627 <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>
1648 <td class="msource">
1650 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1656 <tr class="method-row config-row-alt0 expandable">
1657 <td class="micon"><a class="exi" href="#expand"> </a></td>
1661 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1662 <div class="fixedFont">
1663 <span class="attributes"></span><b class="itemname">setVisible</b>
1665 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1671 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1680 <div class="short">Convenience function to hide or show this component by boolean.</div>
1686 Convenience function to hide or show this component by boolean.
1693 <dl class="detailList">
1694 <dt class="heading">Parameters:</dt>
1697 <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>
1700 <dd>True to show, false to hide</dd>
1708 <dl class="detailList">
1709 <dt class="heading">Returns:</dt>
1711 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1725 <td class="msource">
1727 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1733 <tr class="method-row config-row-alt1 expandable">
1734 <td class="micon"><a class="exi" href="#expand"> </a></td>
1738 <a id="Roo.Component-method-show" name=".show"></a>
1739 <div class="fixedFont">
1740 <span class="attributes"></span><b class="itemname">show</b>
1748 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1757 <div class="short">Show this component.</div>
1763 Show this component.
1774 <dl class="detailList">
1775 <dt class="heading">Returns:</dt>
1777 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1791 <td class="msource">
1793 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1799 <tr class="method-row config-row-alt0 expandable">
1800 <td class="micon"><a class="exi" href="#expand"> </a></td>
1804 <a id="Roo.util.Observable-method-un" name=".un"></a>
1805 <div class="fixedFont">
1806 <span class="attributes"></span><b class="itemname">un</b>
1808 (<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>)
1815 <div class="short">Removes a listener (shorthand for removeListener)</div>
1821 Removes a listener (shorthand for removeListener)
1828 <dl class="detailList">
1829 <dt class="heading">Parameters:</dt>
1832 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1835 <dd>The type of event to listen for</dd>
1838 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1841 <dd>The handler to remove</dd>
1844 <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>
1847 <dd>(optional) The scope (this object) for the handler</dd>
1865 <td class="msource">
1867 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1876 <!-- ============================== events summary / details ======================== -->
1879 <a id="Roo.bootstrap.Menu-events"></a>
1888 <table cellspacing="0" class="member-table">
1889 <caption>Events</caption>
1892 <th class="sig-header" colspan="2">Event</th>
1893 <th class="msource-header">Defined By</th>
1902 <tr class="method-row expandable config-row-alt0">
1903 <td class="micon"><a class="exi" href="#expand"> </a></td>
1906 <a id="Roo.Component-event-*beforedestroy"></a>
1908 <div class="fixedFont">
1909 <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>)
1915 <div class="short">Fires before the component is destroyed.
1921 Fires before the component is destroyed. Return false to stop the destroy.
1927 <dl class="detailList">
1928 <dt class="heading">Parameters:</dt>
1931 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1952 <td class="msource">
1953 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1957 <tr class="method-row expandable config-row-alt1">
1958 <td class="micon"><a class="exi" href="#expand"> </a></td>
1961 <a id="Roo.Component-event-*beforehide"></a>
1963 <div class="fixedFont">
1964 <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>)
1970 <div class="short">Fires before the component is hidden.
1976 Fires before the component is hidden. Return false to stop the hide.
1982 <dl class="detailList">
1983 <dt class="heading">Parameters:</dt>
1986 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2007 <td class="msource">
2008 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2012 <tr class="method-row expandable config-row-alt0">
2013 <td class="micon"><a class="exi" href="#expand"> </a></td>
2016 <a id="Roo.Component-event-*beforerender"></a>
2018 <div class="fixedFont">
2019 <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>)
2025 <div class="short">Fires before the component is rendered.
2031 Fires before the component is rendered. Return false to stop the render.
2037 <dl class="detailList">
2038 <dt class="heading">Parameters:</dt>
2041 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2062 <td class="msource">
2063 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2067 <tr class="method-row expandable config-row-alt1">
2068 <td class="micon"><a class="exi" href="#expand"> </a></td>
2071 <a id="Roo.Component-event-*beforeshow"></a>
2073 <div class="fixedFont">
2074 <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>)
2080 <div class="short">Fires before the component is shown.
2086 Fires before the component is shown. Return false to stop the show.
2092 <dl class="detailList">
2093 <dt class="heading">Parameters:</dt>
2096 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2117 <td class="msource">
2118 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2122 <tr class="method-row expandable config-row-alt0">
2123 <td class="micon"><a class="exi" href="#expand"> </a></td>
2126 <a id="Roo.Component-event-*destroy"></a>
2128 <div class="fixedFont">
2129 <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>)
2135 <div class="short">Fires after the component is destroyed.
2141 Fires after the component is destroyed.
2147 <dl class="detailList">
2148 <dt class="heading">Parameters:</dt>
2151 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2172 <td class="msource">
2173 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2177 <tr class="method-row expandable config-row-alt1">
2178 <td class="micon"><a class="exi" href="#expand"> </a></td>
2181 <a id="Roo.Component-event-*disable"></a>
2183 <div class="fixedFont">
2184 <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>)
2190 <div class="short">Fires after the component is disabled.
2196 Fires after the component is disabled.
2202 <dl class="detailList">
2203 <dt class="heading">Parameters:</dt>
2206 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2227 <td class="msource">
2228 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2232 <tr class="method-row expandable config-row-alt0">
2233 <td class="micon"><a class="exi" href="#expand"> </a></td>
2236 <a id="Roo.Component-event-*enable"></a>
2238 <div class="fixedFont">
2239 <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>)
2245 <div class="short">Fires after the component is enabled.
2251 Fires after the component is enabled.
2257 <dl class="detailList">
2258 <dt class="heading">Parameters:</dt>
2261 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2282 <td class="msource">
2283 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2287 <tr class="method-row expandable config-row-alt1">
2288 <td class="micon"><a class="exi" href="#expand"> </a></td>
2291 <a id="Roo.Component-event-*hide"></a>
2293 <div class="fixedFont">
2294 <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>)
2300 <div class="short">Fires after the component is hidden.
2306 Fires after the component is hidden.
2312 <dl class="detailList">
2313 <dt class="heading">Parameters:</dt>
2316 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2337 <td class="msource">
2338 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2342 <tr class="method-row expandable config-row-alt0">
2343 <td class="micon"><a class="exi" href="#expand"> </a></td>
2346 <a id="Roo.Component-event-*render"></a>
2348 <div class="fixedFont">
2349 <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>)
2355 <div class="short">Fires after the component is rendered.
2361 Fires after the component is rendered.
2367 <dl class="detailList">
2368 <dt class="heading">Parameters:</dt>
2371 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2392 <td class="msource">
2393 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2397 <tr class="method-row expandable config-row-alt1">
2398 <td class="micon"><a class="exi" href="#expand"> </a></td>
2401 <a id="Roo.Component-event-*show"></a>
2403 <div class="fixedFont">
2404 <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>)
2410 <div class="short">Fires after the component is shown.
2416 Fires after the component is shown.
2422 <dl class="detailList">
2423 <dt class="heading">Parameters:</dt>
2426 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2447 <td class="msource">
2448 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2459 <!-- ============================== footer ================================= -->
2460 <div class="fineprint" style="clear:both">
2462 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Mon Mar 03 2014 18:17:03 GMT+0800 (HKT)
2464 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>