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.Table</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.Table-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.bootstrap.Table-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.bootstrap.Table-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.bootstrap.Table-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.Table
54 <!-- ============================== class title / details ============================ -->
57 <h1 class="classTitle">
59 Class Roo.bootstrap.Table
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_Table.js.html">Roo/bootstrap/Table.js</a>.
71 <tr><td class="label">Class:</td><td class="hd-info">Table</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">
91 <!-- ============================== Class comment block... ========================== -->
93 <div class="comments">
94 <b>Class Comments / Notes</B> =>
95 <u onclick="parent.CommentDialog.showCommentId = 'Roo.bootstrap.Table';">[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.Table.html"></iframe>
103 <!-- ============================== config options ========================== -->
108 <div class="hr"></div>
109 <a id="Roo.bootstrap.Table-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">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
343 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
344 <div class="fixedFont">
345 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
351 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
355 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
363 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
379 <!-- ============================== public properties ==================== -->
383 <a id="Roo.bootstrap.Table-props"></a>
389 <table cellspacing="0" class="member-table">
390 <caption class="Empty">Public Properties - Has None</caption>
396 <!-- ============================== methods summary / details ======================== -->
399 <a id="Roo.bootstrap.Table-methods"></a>
400 <!-- constructor?? -->
407 <!-- then dynamics first -->
414 <table cellspacing="0" class="member-table">
415 <caption>Public Methods</caption>
417 <th class="sig-header" colspan="2">Method</th>
418 <th class="msource-header">Defined By</th>
428 <tr class="method-row config-row-alt0 expandable notInherited">
429 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo.bootstrap-method-Table" name=".Table"></a>
434 <div class="fixedFont">
435 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">Table</b>
437 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
445 <div class="short">Create a new Roo.bootstrap.Table</div>
452 Create a new Roo.bootstrap.Table
455 <dl class="detailList">
456 <dt class="heading">Parameters:</dt>
459 <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>
462 <dd>The config object</dd>
486 <tr class="method-row config-row-alt1 expandable">
487 <td class="micon"><a class="exi" href="#expand"> </a></td>
491 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
492 <div class="fixedFont">
493 <span class="attributes"></span><b class="itemname">addEvents</b>
495 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
502 <div class="short">Used to define events on this Observable</div>
508 Used to define events on this Observable
515 <dl class="detailList">
516 <dt class="heading">Parameters:</dt>
519 <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>
522 <dd>The object with the events defined</dd>
542 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
548 <tr class="method-row config-row-alt0 expandable">
549 <td class="micon"><a class="exi" href="#expand"> </a></td>
553 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
554 <div class="fixedFont">
555 <span class="attributes"></span><b class="itemname">addListener</b>
557 (<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>)
564 <div class="short">Appends an event handler to this component</div>
570 Appends an event handler to this component
577 <dl class="detailList">
578 <dt class="heading">Parameters:</dt>
581 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
584 <dd>The type of event to listen for</dd>
587 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
590 <dd>The method the event invokes</dd>
593 <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>
596 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
599 <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>
602 <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>
622 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
628 <tr class="method-row config-row-alt1 expandable">
629 <td class="micon"><a class="exi" href="#expand"> </a></td>
633 <a id="Roo.Component-method-destroy" name=".destroy"></a>
634 <div class="fixedFont">
635 <span class="attributes"></span><b class="itemname">destroy</b>
644 <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>
650 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}.
673 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
679 <tr class="method-row config-row-alt0 expandable">
680 <td class="micon"><a class="exi" href="#expand"> </a></td>
684 <a id="Roo.Component-method-disable" name=".disable"></a>
685 <div class="fixedFont">
686 <span class="attributes"></span><b class="itemname">disable</b>
694 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
703 <div class="short">Disable this component.</div>
709 Disable this component.
720 <dl class="detailList">
721 <dt class="heading">Returns:</dt>
723 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
739 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
745 <tr class="method-row config-row-alt1 expandable">
746 <td class="micon"><a class="exi" href="#expand"> </a></td>
750 <a id="Roo.Component-method-enable" name=".enable"></a>
751 <div class="fixedFont">
752 <span class="attributes"></span><b class="itemname">enable</b>
760 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
769 <div class="short">Enable this component.</div>
775 Enable this component.
786 <dl class="detailList">
787 <dt class="heading">Returns:</dt>
789 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
805 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
811 <tr class="method-row config-row-alt0 expandable">
812 <td class="micon"><a class="exi" href="#expand"> </a></td>
816 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
817 <div class="fixedFont">
818 <span class="attributes"></span><b class="itemname">fireEvent</b>
820 (<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>)
826 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
835 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
841 Fires the specified event with the passed parameters (minus the event name).
848 <dl class="detailList">
849 <dt class="heading">Parameters:</dt>
852 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
858 <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>
861 <dd>Variable number of parameters are passed to handlers</dd>
869 <dl class="detailList">
870 <dt class="heading">Returns:</dt>
872 <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>
888 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
894 <tr class="method-row config-row-alt1 expandable">
895 <td class="micon"><a class="exi" href="#expand"> </a></td>
899 <a id="Roo.Component-method-focus" name=".focus"></a>
900 <div class="fixedFont">
901 <span class="attributes"></span><b class="itemname">focus</b>
903 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
909 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
918 <div class="short">Try to focus this component.</div>
924 Try to focus this component.
931 <dl class="detailList">
932 <dt class="heading">Parameters:</dt>
935 <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>
938 <dd>True to also select the text in this component (if applicable)</dd>
946 <dl class="detailList">
947 <dt class="heading">Returns:</dt>
949 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
965 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
971 <tr class="method-row config-row-alt0 expandable">
972 <td class="micon"><a class="exi" href="#expand"> </a></td>
976 <a id="Roo.Component-method-getEl" name=".getEl"></a>
977 <div class="fixedFont">
978 <span class="attributes"></span><b class="itemname">getEl</b>
986 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
995 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1001 Returns the underlying {<b>link</b> Roo.Element}.
1012 <dl class="detailList">
1013 <dt class="heading">Returns:</dt>
1015 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1029 <td class="msource">
1031 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1037 <tr class="method-row config-row-alt1 expandable">
1038 <td class="micon"><a class="exi" href="#expand"> </a></td>
1042 <a id="Roo.Component-method-getId" name=".getId"></a>
1043 <div class="fixedFont">
1044 <span class="attributes"></span><b class="itemname">getId</b>
1052 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1061 <div class="short">Returns the id of this component.</div>
1067 Returns the id of this component.
1078 <dl class="detailList">
1079 <dt class="heading">Returns:</dt>
1081 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1095 <td class="msource">
1097 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1103 <tr class="method-row config-row-alt0 expandable">
1104 <td class="micon"><a class="exi" href="#expand"> </a></td>
1108 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1109 <div class="fixedFont">
1110 <span class="attributes"></span><b class="itemname">hasListener</b>
1112 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1118 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1127 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1133 Checks to see if this object has any listeners for a specified event
1140 <dl class="detailList">
1141 <dt class="heading">Parameters:</dt>
1144 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1147 <dd>The name of the event to check for</dd>
1155 <dl class="detailList">
1156 <dt class="heading">Returns:</dt>
1158 <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>
1172 <td class="msource">
1174 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1180 <tr class="method-row config-row-alt1 expandable">
1181 <td class="micon"><a class="exi" href="#expand"> </a></td>
1185 <a id="Roo.Component-method-hide" name=".hide"></a>
1186 <div class="fixedFont">
1187 <span class="attributes"></span><b class="itemname">hide</b>
1195 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1204 <div class="short">Hide this component.</div>
1210 Hide this component.
1221 <dl class="detailList">
1222 <dt class="heading">Returns:</dt>
1224 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1238 <td class="msource">
1240 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1246 <tr class="method-row config-row-alt0 expandable">
1247 <td class="micon"><a class="exi" href="#expand"> </a></td>
1251 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
1252 <div class="fixedFont">
1253 <span class="attributes"></span><b class="itemname">isVisible</b>
1262 <div class="short">Returns true if this component is visible.</div>
1268 Returns true if this component is visible.
1289 <td class="msource">
1291 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1297 <tr class="method-row config-row-alt1 expandable">
1298 <td class="micon"><a class="exi" href="#expand"> </a></td>
1302 <a id="Roo.util.Observable-method-on" name=".on"></a>
1303 <div class="fixedFont">
1304 <span class="attributes"></span><b class="itemname">on</b>
1306 (<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>)
1313 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1319 Appends an event handler to this element (shorthand for addListener)
1326 <dl class="detailList">
1327 <dt class="heading">Parameters:</dt>
1330 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1333 <dd>The type of event to listen for</dd>
1336 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1339 <dd>The method the event invokes</dd>
1342 <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>
1345 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1348 <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>
1369 <td class="msource">
1371 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1377 <tr class="method-row config-row-alt0 expandable">
1378 <td class="micon"><a class="exi" href="#expand"> </a></td>
1382 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1383 <div class="fixedFont">
1384 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1393 <div class="short">Removes all listeners for this object</div>
1399 Removes all listeners for this object
1420 <td class="msource">
1422 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1428 <tr class="method-row config-row-alt1 expandable">
1429 <td class="micon"><a class="exi" href="#expand"> </a></td>
1433 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1434 <div class="fixedFont">
1435 <span class="attributes"></span><b class="itemname">removeListener</b>
1437 (<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>)
1444 <div class="short">Removes a listener</div>
1457 <dl class="detailList">
1458 <dt class="heading">Parameters:</dt>
1461 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1464 <dd>The type of event to listen for</dd>
1467 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1470 <dd>The handler to remove</dd>
1473 <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>
1476 <dd>(optional) The scope (this object) for the handler</dd>
1494 <td class="msource">
1496 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1502 <tr class="method-row config-row-alt0 expandable">
1503 <td class="micon"><a class="exi" href="#expand"> </a></td>
1507 <a id="Roo.Component-method-render" name=".render"></a>
1508 <div class="fixedFont">
1509 <span class="attributes"></span><b class="itemname">render</b>
1511 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
1518 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
1524 If this is a lazy rendering component, render it to its container element.
1531 <dl class="detailList">
1532 <dt class="heading">Parameters:</dt>
1535 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
1538 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
1556 <td class="msource">
1558 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1564 <tr class="method-row config-row-alt1 expandable">
1565 <td class="micon"><a class="exi" href="#expand"> </a></td>
1569 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
1570 <div class="fixedFont">
1571 <span class="attributes"></span><b class="itemname">setDisabled</b>
1573 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
1580 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
1586 Convenience function for setting disabled/enabled by boolean.
1593 <dl class="detailList">
1594 <dt class="heading">Parameters:</dt>
1597 <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>
1618 <td class="msource">
1620 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1626 <tr class="method-row config-row-alt0 expandable">
1627 <td class="micon"><a class="exi" href="#expand"> </a></td>
1631 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
1632 <div class="fixedFont">
1633 <span class="attributes"></span><b class="itemname">setVisible</b>
1635 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
1641 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1650 <div class="short">Convenience function to hide or show this component by boolean.</div>
1656 Convenience function to hide or show this component by boolean.
1663 <dl class="detailList">
1664 <dt class="heading">Parameters:</dt>
1667 <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>
1670 <dd>True to show, false to hide</dd>
1678 <dl class="detailList">
1679 <dt class="heading">Returns:</dt>
1681 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1695 <td class="msource">
1697 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1703 <tr class="method-row config-row-alt1 expandable">
1704 <td class="micon"><a class="exi" href="#expand"> </a></td>
1708 <a id="Roo.Component-method-show" name=".show"></a>
1709 <div class="fixedFont">
1710 <span class="attributes"></span><b class="itemname">show</b>
1718 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1727 <div class="short">Show this component.</div>
1733 Show this component.
1744 <dl class="detailList">
1745 <dt class="heading">Returns:</dt>
1747 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1761 <td class="msource">
1763 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1769 <tr class="method-row config-row-alt0 expandable">
1770 <td class="micon"><a class="exi" href="#expand"> </a></td>
1774 <a id="Roo.util.Observable-method-un" name=".un"></a>
1775 <div class="fixedFont">
1776 <span class="attributes"></span><b class="itemname">un</b>
1778 (<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>)
1785 <div class="short">Removes a listener (shorthand for removeListener)</div>
1791 Removes a listener (shorthand for removeListener)
1798 <dl class="detailList">
1799 <dt class="heading">Parameters:</dt>
1802 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1805 <dd>The type of event to listen for</dd>
1808 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1811 <dd>The handler to remove</dd>
1814 <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>
1817 <dd>(optional) The scope (this object) for the handler</dd>
1835 <td class="msource">
1837 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1846 <!-- ============================== events summary / details ======================== -->
1849 <a id="Roo.bootstrap.Table-events"></a>
1858 <table cellspacing="0" class="member-table">
1859 <caption>Events</caption>
1862 <th class="sig-header" colspan="2">Event</th>
1863 <th class="msource-header">Defined By</th>
1872 <tr class="method-row expandable config-row-alt0">
1873 <td class="micon"><a class="exi" href="#expand"> </a></td>
1876 <a id="Roo.Component-event-*beforedestroy"></a>
1878 <div class="fixedFont">
1879 <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>)
1885 <div class="short">Fires before the component is destroyed.
1891 Fires before the component is destroyed. Return false to stop the destroy.
1897 <dl class="detailList">
1898 <dt class="heading">Parameters:</dt>
1901 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1922 <td class="msource">
1923 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1927 <tr class="method-row expandable config-row-alt1">
1928 <td class="micon"><a class="exi" href="#expand"> </a></td>
1931 <a id="Roo.Component-event-*beforehide"></a>
1933 <div class="fixedFont">
1934 <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>)
1940 <div class="short">Fires before the component is hidden.
1946 Fires before the component is hidden. Return false to stop the hide.
1952 <dl class="detailList">
1953 <dt class="heading">Parameters:</dt>
1956 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
1977 <td class="msource">
1978 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1982 <tr class="method-row expandable config-row-alt0">
1983 <td class="micon"><a class="exi" href="#expand"> </a></td>
1986 <a id="Roo.Component-event-*beforerender"></a>
1988 <div class="fixedFont">
1989 <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>)
1995 <div class="short">Fires before the component is rendered.
2001 Fires before the component is rendered. Return false to stop the render.
2007 <dl class="detailList">
2008 <dt class="heading">Parameters:</dt>
2011 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2032 <td class="msource">
2033 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2037 <tr class="method-row expandable config-row-alt1">
2038 <td class="micon"><a class="exi" href="#expand"> </a></td>
2041 <a id="Roo.Component-event-*beforeshow"></a>
2043 <div class="fixedFont">
2044 <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>)
2050 <div class="short">Fires before the component is shown.
2056 Fires before the component is shown. Return false to stop the show.
2062 <dl class="detailList">
2063 <dt class="heading">Parameters:</dt>
2066 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2087 <td class="msource">
2088 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2092 <tr class="method-row expandable config-row-alt0">
2093 <td class="micon"><a class="exi" href="#expand"> </a></td>
2096 <a id="Roo.Component-event-*destroy"></a>
2098 <div class="fixedFont">
2099 <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>)
2105 <div class="short">Fires after the component is destroyed.
2111 Fires after the component is destroyed.
2117 <dl class="detailList">
2118 <dt class="heading">Parameters:</dt>
2121 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2142 <td class="msource">
2143 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2147 <tr class="method-row expandable config-row-alt1">
2148 <td class="micon"><a class="exi" href="#expand"> </a></td>
2151 <a id="Roo.Component-event-*disable"></a>
2153 <div class="fixedFont">
2154 <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>)
2160 <div class="short">Fires after the component is disabled.
2166 Fires after the component is disabled.
2172 <dl class="detailList">
2173 <dt class="heading">Parameters:</dt>
2176 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2197 <td class="msource">
2198 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2202 <tr class="method-row expandable config-row-alt0">
2203 <td class="micon"><a class="exi" href="#expand"> </a></td>
2206 <a id="Roo.Component-event-*enable"></a>
2208 <div class="fixedFont">
2209 <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>)
2215 <div class="short">Fires after the component is enabled.
2221 Fires after the component is enabled.
2227 <dl class="detailList">
2228 <dt class="heading">Parameters:</dt>
2231 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2252 <td class="msource">
2253 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2257 <tr class="method-row expandable config-row-alt1">
2258 <td class="micon"><a class="exi" href="#expand"> </a></td>
2261 <a id="Roo.Component-event-*hide"></a>
2263 <div class="fixedFont">
2264 <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>)
2270 <div class="short">Fires after the component is hidden.
2276 Fires after the component is hidden.
2282 <dl class="detailList">
2283 <dt class="heading">Parameters:</dt>
2286 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2307 <td class="msource">
2308 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2312 <tr class="method-row expandable config-row-alt0">
2313 <td class="micon"><a class="exi" href="#expand"> </a></td>
2316 <a id="Roo.Component-event-*render"></a>
2318 <div class="fixedFont">
2319 <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>)
2325 <div class="short">Fires after the component is rendered.
2331 Fires after the component is rendered.
2337 <dl class="detailList">
2338 <dt class="heading">Parameters:</dt>
2341 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2362 <td class="msource">
2363 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2367 <tr class="method-row expandable config-row-alt1">
2368 <td class="micon"><a class="exi" href="#expand"> </a></td>
2371 <a id="Roo.Component-event-*show"></a>
2373 <div class="fixedFont">
2374 <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>)
2380 <div class="short">Fires after the component is shown.
2386 Fires after the component is shown.
2392 <dl class="detailList">
2393 <dt class="heading">Parameters:</dt>
2396 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2417 <td class="msource">
2418 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2429 <!-- ============================== footer ================================= -->
2430 <div class="fineprint" style="clear:both">
2432 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Tue Feb 25 2014 20:05:05 GMT+0800 (HKT)
2434 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>