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 notInherited">
130 <td class="micon"><a class="exi" href="#expand"> </a></td>
133 <a id="Roo.bootstrap.Table-cfg-CellSelection" name=".CellSelection"></a>
134 <div class="fixedFont">
135 <b class="itemname">CellSelection</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
141 <div class="short">(true|false) default false</div>
145 <div class="long">(true|false) default false</div>
159 <tr class="config-row expandable config-row-alt1 notInherited">
160 <td class="micon"><a class="exi" href="#expand"> </a></td>
163 <a id="Roo.bootstrap.Table-cfg-RowSelection" name=".RowSelection"></a>
164 <div class="fixedFont">
165 <b class="itemname">RowSelection</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
171 <div class="short">(true|false) default false</div>
175 <div class="long">(true|false) default false</div>
189 <tr class="config-row expandable config-row-alt0">
190 <td class="micon"><a class="exi" href="#expand"> </a></td>
193 <a id="Roo.Component-cfg-actionMode" name=".actionMode"></a>
194 <div class="fixedFont">
195 <b class="itemname">actionMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
201 <div class="short">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
205 <div class="long">which property holds the element that used for hide() / show() / disable() / enable()<br/>default is 'el'</div>
213 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
219 <tr class="config-row expandable config-row-alt1 notInherited">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
223 <a id="Roo.bootstrap.Table-cfg-align" name=".align"></a>
224 <div class="fixedFont">
225 <b class="itemname">align</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
231 <div class="short">(left|center|right) Specifies the alignment of a table according to surrounding text</div>
235 <div class="long">(left|center|right) Specifies the alignment of a table according to surrounding text</div>
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-allowDomMove" name=".allowDomMove"></a>
254 <div class="fixedFont">
255 <b class="itemname">allowDomMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
261 <div class="short">Whether the component can move the Dom node when rendering (defaults to true).</div>
265 <div class="long">Whether the component can move the Dom node when rendering (defaults to true).</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 notInherited">
280 <td class="micon"><a class="exi" href="#expand"> </a></td>
283 <a id="Roo.bootstrap.Table-cfg-bgcolor" name=".bgcolor"></a>
284 <div class="fixedFont">
285 <b class="itemname">bgcolor</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
291 <div class="short">Specifies the background color for a table</div>
295 <div class="long">Specifies the background color for a table</div>
309 <tr class="config-row expandable config-row-alt0 notInherited">
310 <td class="micon"><a class="exi" href="#expand"> </a></td>
313 <a id="Roo.bootstrap.Table-cfg-border" name=".border"></a>
314 <div class="fixedFont">
315 <b class="itemname">border</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
321 <div class="short">Specifies whether the table cells should have borders or not</div>
325 <div class="long">Specifies whether the table cells should have borders or not</div>
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.Table-cfg-bordered" name=".bordered"></a>
344 <div class="fixedFont">
345 <b class="itemname">bordered</b> : boolean
351 <div class="short">Add borders to the table</div>
355 <div class="long">Add borders to the table</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-can_build_overlaid" name=".can_build_overlaid"></a>
374 <div class="fixedFont">
375 <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>
381 <div class="short">True if element can be rebuild from a HTML page</div>
385 <div class="long">True if element can be rebuild from a HTML page</div>
393 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
399 <tr class="config-row expandable config-row-alt1 notInherited">
400 <td class="micon"><a class="exi" href="#expand"> </a></td>
403 <a id="Roo.bootstrap.Table-cfg-cellpadding" name=".cellpadding"></a>
404 <div class="fixedFont">
405 <b class="itemname">cellpadding</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
411 <div class="short">Specifies the space between the cell wall and the cell content</div>
415 <div class="long">Specifies the space between the cell wall and the cell content</div>
429 <tr class="config-row expandable config-row-alt0 notInherited">
430 <td class="micon"><a class="exi" href="#expand"> </a></td>
433 <a id="Roo.bootstrap.Table-cfg-cellspacing" name=".cellspacing"></a>
434 <div class="fixedFont">
435 <b class="itemname">cellspacing</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
441 <div class="short">Specifies the space between cells</div>
445 <div class="long">Specifies the space between cells</div>
459 <tr class="config-row expandable config-row-alt1 notInherited">
460 <td class="micon"><a class="exi" href="#expand"> </a></td>
463 <a id="Roo.bootstrap.Table-cfg-cls" name=".cls"></a>
464 <div class="fixedFont">
465 <b class="itemname">cls</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
471 <div class="short">table class</div>
475 <div class="long">table class</div>
489 <tr class="config-row expandable config-row-alt0 notInherited">
490 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="Roo.bootstrap.Table-cfg-condensed" name=".condensed"></a>
494 <div class="fixedFont">
495 <b class="itemname">condensed</b> : boolean
501 <div class="short">Format condensed</div>
505 <div class="long">Format condensed</div>
519 <tr class="config-row expandable config-row-alt1">
520 <td class="micon"><a class="exi" href="#expand"> </a></td>
523 <a id="Roo.bootstrap.Component-cfg-dataId" name=".dataId"></a>
524 <div class="fixedFont">
525 <b class="itemname">dataId</b> : string
531 <div class="short">cutomer id</div>
535 <div class="long">cutomer id</div>
543 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
549 <tr class="config-row expandable config-row-alt0">
550 <td class="micon"><a class="exi" href="#expand"> </a></td>
553 <a id="Roo.Component-cfg-disableClass" name=".disableClass"></a>
554 <div class="fixedFont">
555 <b class="itemname">disableClass</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
561 <div class="short">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
565 <div class="long">CSS class added to the component when it is disabled (defaults to "x-item-disabled").</div>
573 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
579 <tr class="config-row expandable config-row-alt1 notInherited">
580 <td class="micon"><a class="exi" href="#expand"> </a></td>
583 <a id="Roo.bootstrap.Table-cfg-footer" name=".footer"></a>
584 <div class="fixedFont">
585 <b class="itemname">footer</b> : <a href="./Roo.bootstrap.PagingToolbar.html#constructor" roo:cls="Roo.bootstrap.PagingToolbar.html#constructor">Roo.bootstrap.PagingToolbar</a>
591 <div class="short">a paging toolbar</div>
595 <div class="long">a paging toolbar</div>
609 <tr class="config-row expandable config-row-alt0 notInherited">
610 <td class="micon"><a class="exi" href="#expand"> </a></td>
613 <a id="Roo.bootstrap.Table-cfg-frame" name=".frame"></a>
614 <div class="fixedFont">
615 <b class="itemname">frame</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
621 <div class="short">Specifies which parts of the outside borders that should be visible</div>
625 <div class="long">Specifies which parts of the outside borders that should be visible</div>
639 <tr class="config-row expandable config-row-alt1">
640 <td class="micon"><a class="exi" href="#expand"> </a></td>
643 <a id="Roo.Component-cfg-hideMode" name=".hideMode"></a>
644 <div class="fixedFont">
645 <b class="itemname">hideMode</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
651 <div class="short">How this component should hidden.</div>
655 <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>
663 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
669 <tr class="config-row expandable config-row-alt0 notInherited">
670 <td class="micon"><a class="exi" href="#expand"> </a></td>
673 <a id="Roo.bootstrap.Table-cfg-hover" name=".hover"></a>
674 <div class="fixedFont">
675 <b class="itemname">hover</b> : boolean
681 <div class="short">Add hover highlighting</div>
685 <div class="long">Add hover highlighting</div>
699 <tr class="config-row expandable config-row-alt1 notInherited">
700 <td class="micon"><a class="exi" href="#expand"> </a></td>
703 <a id="Roo.bootstrap.Table-cfg-layout" name=".layout"></a>
704 <div class="fixedFont">
705 <b class="itemname">layout</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
711 <div class="short">table layout (auto | fixed | initial | inherit)</div>
715 <div class="long">table layout (auto | fixed | initial | inherit)</div>
729 <tr class="config-row expandable config-row-alt0">
730 <td class="micon"><a class="exi" href="#expand"> </a></td>
733 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
734 <div class="fixedFont">
735 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
741 <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>
745 <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>
753 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
759 <tr class="config-row expandable config-row-alt1 notInherited">
760 <td class="micon"><a class="exi" href="#expand"> </a></td>
763 <a id="Roo.bootstrap.Table-cfg-loadMask" name=".loadMask"></a>
764 <div class="fixedFont">
765 <b class="itemname">loadMask</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
771 <div class="short">(true|false) default false</div>
775 <div class="long">(true|false) default false</div>
789 <tr class="config-row expandable config-row-alt0">
790 <td class="micon"><a class="exi" href="#expand"> </a></td>
793 <a id="Roo.bootstrap.Component-cfg-name" name=".name"></a>
794 <div class="fixedFont">
795 <b class="itemname">name</b> : string
801 <div class="short">Specifies name attribute</div>
805 <div class="long">Specifies name attribute</div>
813 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
819 <tr class="config-row expandable config-row-alt1 notInherited">
820 <td class="micon"><a class="exi" href="#expand"> </a></td>
823 <a id="Roo.bootstrap.Table-cfg-responsive" name=".responsive"></a>
824 <div class="fixedFont">
825 <b class="itemname">responsive</b> : boolean
831 <div class="short">Format condensed</div>
835 <div class="long">Format condensed</div>
849 <tr class="config-row expandable config-row-alt0 notInherited">
850 <td class="micon"><a class="exi" href="#expand"> </a></td>
853 <a id="Roo.bootstrap.Table-cfg-rules" name=".rules"></a>
854 <div class="fixedFont">
855 <b class="itemname">rules</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
861 <div class="short">Specifies which parts of the inside borders that should be visible</div>
865 <div class="long">Specifies which parts of the inside borders that should be visible</div>
879 <tr class="config-row expandable config-row-alt1 notInherited">
880 <td class="micon"><a class="exi" href="#expand"> </a></td>
883 <a id="Roo.bootstrap.Table-cfg-sortable" name=".sortable"></a>
884 <div class="fixedFont">
885 <b class="itemname">sortable</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
891 <div class="short">Specifies that the table should be sortable</div>
895 <div class="long">Specifies that the table should be sortable</div>
909 <tr class="config-row expandable config-row-alt0 notInherited">
910 <td class="micon"><a class="exi" href="#expand"> </a></td>
913 <a id="Roo.bootstrap.Table-cfg-striped" name=".striped"></a>
914 <div class="fixedFont">
915 <b class="itemname">striped</b> : boolean
921 <div class="short">Should the rows be alternative striped</div>
925 <div class="long">Should the rows be alternative striped</div>
939 <tr class="config-row expandable config-row-alt1">
940 <td class="micon"><a class="exi" href="#expand"> </a></td>
943 <a id="Roo.bootstrap.Component-cfg-style" name=".style"></a>
944 <div class="fixedFont">
945 <b class="itemname">style</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
951 <div class="short">any extra css</div>
955 <div class="long">any extra css</div>
963 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
969 <tr class="config-row expandable config-row-alt0 notInherited">
970 <td class="micon"><a class="exi" href="#expand"> </a></td>
973 <a id="Roo.bootstrap.Table-cfg-summary" name=".summary"></a>
974 <div class="fixedFont">
975 <b class="itemname">summary</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
981 <div class="short">Specifies a summary of the content of a table</div>
985 <div class="long">Specifies a summary of the content of a table</div>
999 <tr class="config-row expandable config-row-alt1 notInherited">
1000 <td class="micon"><a class="exi" href="#expand"> </a></td>
1003 <a id="Roo.bootstrap.Table-cfg-tfoot" name=".tfoot"></a>
1004 <div class="fixedFont">
1005 <b class="itemname">tfoot</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1011 <div class="short">(true|false) generate tfoot, default true</div>
1015 <div class="long">(true|false) generate tfoot, default true</div>
1021 <td class="msource">
1029 <tr class="config-row expandable config-row-alt0 notInherited">
1030 <td class="micon"><a class="exi" href="#expand"> </a></td>
1033 <a id="Roo.bootstrap.Table-cfg-thead" name=".thead"></a>
1034 <div class="fixedFont">
1035 <b class="itemname">thead</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1041 <div class="short">(true|false) generate thead, default true</div>
1045 <div class="long">(true|false) generate thead, default true</div>
1051 <td class="msource">
1059 <tr class="config-row expandable config-row-alt1 notInherited">
1060 <td class="micon"><a class="exi" href="#expand"> </a></td>
1063 <a id="Roo.bootstrap.Table-cfg-width" name=".width"></a>
1064 <div class="fixedFont">
1065 <b class="itemname">width</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
1071 <div class="short">Specifies the width of a table</div>
1075 <div class="long">Specifies the width of a table</div>
1081 <td class="msource">
1089 <tr class="config-row expandable config-row-alt0">
1090 <td class="micon"><a class="exi" href="#expand"> </a></td>
1093 <a id="Roo.bootstrap.Component-cfg-xattr" name=".xattr"></a>
1094 <div class="fixedFont">
1095 <b class="itemname">xattr</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
1101 <div class="short">extra attributes to add to 'element' (used by builder to store stuff.</div>
1105 <div class="long">extra attributes to add to 'element' (used by builder to store stuff.)</div>
1111 <td class="msource">
1113 <a href="./Roo.bootstrap.Component.html#constructor" roo:cls="Roo.bootstrap.Component.html#constructor">Roo.bootstrap.Component</a>
1129 <!-- ============================== public properties ==================== -->
1133 <a id="Roo.bootstrap.Table-props"></a>
1139 <table cellspacing="0" class="member-table">
1140 <caption class="Empty">Public Properties - Has None</caption>
1146 <!-- ============================== methods summary / details ======================== -->
1149 <a id="Roo.bootstrap.Table-methods"></a>
1150 <!-- constructor?? -->
1157 <!-- then dynamics first -->
1164 <table cellspacing="0" class="member-table">
1165 <caption>Public Methods</caption>
1167 <th class="sig-header" colspan="2">Method</th>
1168 <th class="msource-header">Defined By</th>
1178 <tr class="method-row config-row-alt0 expandable notInherited">
1179 <td class="micon"><a class="exi" href="#expand"> </a></td>
1183 <a id="Roo.bootstrap-method-Table" name=".Table"></a>
1184 <div class="fixedFont">
1185 <span class="attributes">new <B>Roo.bootstrap.</B></span><b class="itemname">Table</b>
1187 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
1195 <div class="short">Create a new Roo.bootstrap.Table</div>
1202 Create a new Roo.bootstrap.Table
1205 <dl class="detailList">
1206 <dt class="heading">Parameters:</dt>
1209 <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>
1212 <dd>The config object</dd>
1230 <td class="msource">
1236 <tr class="method-row config-row-alt1 expandable">
1237 <td class="micon"><a class="exi" href="#expand"> </a></td>
1241 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
1242 <div class="fixedFont">
1243 <span class="attributes"></span><b class="itemname">addEvents</b>
1245 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
1252 <div class="short">Used to define events on this Observable</div>
1258 Used to define events on this Observable
1265 <dl class="detailList">
1266 <dt class="heading">Parameters:</dt>
1269 <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>
1272 <dd>The object with the events defined</dd>
1290 <td class="msource">
1292 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1298 <tr class="method-row config-row-alt0 expandable">
1299 <td class="micon"><a class="exi" href="#expand"> </a></td>
1303 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
1304 <div class="fixedFont">
1305 <span class="attributes"></span><b class="itemname">addListener</b>
1307 (<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>)
1314 <div class="short">Appends an event handler to this component</div>
1320 Appends an event handler to this component
1327 <dl class="detailList">
1328 <dt class="heading">Parameters:</dt>
1331 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1334 <dd>The type of event to listen for</dd>
1337 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1340 <dd>The method the event invokes</dd>
1343 <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>
1346 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1349 <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>
1352 <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>
1370 <td class="msource">
1372 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1378 <tr class="method-row config-row-alt1 expandable">
1379 <td class="micon"><a class="exi" href="#expand"> </a></td>
1383 <a id="Roo.Component-method-destroy" name=".destroy"></a>
1384 <div class="fixedFont">
1385 <span class="attributes"></span><b class="itemname">destroy</b>
1394 <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>
1400 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}.
1421 <td class="msource">
1423 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1429 <tr class="method-row config-row-alt0 expandable">
1430 <td class="micon"><a class="exi" href="#expand"> </a></td>
1434 <a id="Roo.Component-method-disable" name=".disable"></a>
1435 <div class="fixedFont">
1436 <span class="attributes"></span><b class="itemname">disable</b>
1444 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1453 <div class="short">Disable this component.</div>
1459 Disable this component.
1470 <dl class="detailList">
1471 <dt class="heading">Returns:</dt>
1473 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1487 <td class="msource">
1489 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1495 <tr class="method-row config-row-alt1 expandable">
1496 <td class="micon"><a class="exi" href="#expand"> </a></td>
1500 <a id="Roo.Component-method-enable" name=".enable"></a>
1501 <div class="fixedFont">
1502 <span class="attributes"></span><b class="itemname">enable</b>
1510 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1519 <div class="short">Enable this component.</div>
1525 Enable this component.
1536 <dl class="detailList">
1537 <dt class="heading">Returns:</dt>
1539 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1553 <td class="msource">
1555 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1561 <tr class="method-row config-row-alt0 expandable">
1562 <td class="micon"><a class="exi" href="#expand"> </a></td>
1566 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1567 <div class="fixedFont">
1568 <span class="attributes"></span><b class="itemname">fireEvent</b>
1570 (<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>)
1576 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1585 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1591 Fires the specified event with the passed parameters (minus the event name).
1598 <dl class="detailList">
1599 <dt class="heading">Parameters:</dt>
1602 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1608 <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>
1611 <dd>Variable number of parameters are passed to handlers</dd>
1619 <dl class="detailList">
1620 <dt class="heading">Returns:</dt>
1622 <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>
1636 <td class="msource">
1638 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1644 <tr class="method-row config-row-alt1 expandable">
1645 <td class="micon"><a class="exi" href="#expand"> </a></td>
1649 <a id="Roo.Component-method-focus" name=".focus"></a>
1650 <div class="fixedFont">
1651 <span class="attributes"></span><b class="itemname">focus</b>
1653 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>selectText</i></B>)
1659 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1668 <div class="short">Try to focus this component.</div>
1674 Try to focus this component.
1681 <dl class="detailList">
1682 <dt class="heading">Parameters:</dt>
1685 <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>
1688 <dd>True to also select the text in this component (if applicable)</dd>
1696 <dl class="detailList">
1697 <dt class="heading">Returns:</dt>
1699 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1713 <td class="msource">
1715 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1721 <tr class="method-row config-row-alt0 expandable">
1722 <td class="micon"><a class="exi" href="#expand"> </a></td>
1726 <a id="Roo.Component-method-getEl" name=".getEl"></a>
1727 <div class="fixedFont">
1728 <span class="attributes"></span><b class="itemname">getEl</b>
1736 <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a>
1745 <div class="short">Returns the underlying {<b>link</b> Roo.Element}.</div>
1751 Returns the underlying {<b>link</b> Roo.Element}.
1762 <dl class="detailList">
1763 <dt class="heading">Returns:</dt>
1765 <dd><span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> The element</dd>
1779 <td class="msource">
1781 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1787 <tr class="method-row config-row-alt1 expandable">
1788 <td class="micon"><a class="exi" href="#expand"> </a></td>
1792 <a id="Roo.Component-method-getId" name=".getId"></a>
1793 <div class="fixedFont">
1794 <span class="attributes"></span><b class="itemname">getId</b>
1802 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1811 <div class="short">Returns the id of this component.</div>
1817 Returns the id of this component.
1828 <dl class="detailList">
1829 <dt class="heading">Returns:</dt>
1831 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1845 <td class="msource">
1847 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1853 <tr class="method-row config-row-alt0 expandable">
1854 <td class="micon"><a class="exi" href="#expand"> </a></td>
1858 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1859 <div class="fixedFont">
1860 <span class="attributes"></span><b class="itemname">hasListener</b>
1862 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1868 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1877 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1883 Checks to see if this object has any listeners for a specified event
1890 <dl class="detailList">
1891 <dt class="heading">Parameters:</dt>
1894 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1897 <dd>The name of the event to check for</dd>
1905 <dl class="detailList">
1906 <dt class="heading">Returns:</dt>
1908 <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>
1922 <td class="msource">
1924 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1930 <tr class="method-row config-row-alt1 expandable">
1931 <td class="micon"><a class="exi" href="#expand"> </a></td>
1935 <a id="Roo.Component-method-hide" name=".hide"></a>
1936 <div class="fixedFont">
1937 <span class="attributes"></span><b class="itemname">hide</b>
1945 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1954 <div class="short">Hide this component.</div>
1960 Hide this component.
1971 <dl class="detailList">
1972 <dt class="heading">Returns:</dt>
1974 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
1988 <td class="msource">
1990 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
1996 <tr class="method-row config-row-alt0 expandable">
1997 <td class="micon"><a class="exi" href="#expand"> </a></td>
2001 <a id="Roo.Component-method-isVisible" name=".isVisible"></a>
2002 <div class="fixedFont">
2003 <span class="attributes"></span><b class="itemname">isVisible</b>
2012 <div class="short">Returns true if this component is visible.</div>
2018 Returns true if this component is visible.
2039 <td class="msource">
2041 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2047 <tr class="method-row config-row-alt1 expandable">
2048 <td class="micon"><a class="exi" href="#expand"> </a></td>
2052 <a id="Roo.util.Observable-method-on" name=".on"></a>
2053 <div class="fixedFont">
2054 <span class="attributes"></span><b class="itemname">on</b>
2056 (<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>)
2063 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
2069 Appends an event handler to this element (shorthand for addListener)
2076 <dl class="detailList">
2077 <dt class="heading">Parameters:</dt>
2080 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2083 <dd>The type of event to listen for</dd>
2086 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2089 <dd>The method the event invokes</dd>
2092 <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>
2095 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
2098 <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>
2119 <td class="msource">
2121 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2127 <tr class="method-row config-row-alt0 expandable">
2128 <td class="micon"><a class="exi" href="#expand"> </a></td>
2132 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
2133 <div class="fixedFont">
2134 <span class="attributes"></span><b class="itemname">purgeListeners</b>
2143 <div class="short">Removes all listeners for this object</div>
2149 Removes all listeners for this object
2170 <td class="msource">
2172 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2178 <tr class="method-row config-row-alt1 expandable">
2179 <td class="micon"><a class="exi" href="#expand"> </a></td>
2183 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
2184 <div class="fixedFont">
2185 <span class="attributes"></span><b class="itemname">removeListener</b>
2187 (<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>)
2194 <div class="short">Removes a listener</div>
2207 <dl class="detailList">
2208 <dt class="heading">Parameters:</dt>
2211 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2214 <dd>The type of event to listen for</dd>
2217 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2220 <dd>The handler to remove</dd>
2223 <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>
2226 <dd>(optional) The scope (this object) for the handler</dd>
2244 <td class="msource">
2246 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2252 <tr class="method-row config-row-alt0 expandable">
2253 <td class="micon"><a class="exi" href="#expand"> </a></td>
2257 <a id="Roo.Component-method-render" name=".render"></a>
2258 <div class="fixedFont">
2259 <span class="attributes"></span><b class="itemname">render</b>
2261 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element <B><i>container</i></B>)
2268 <div class="short">If this is a lazy rendering component, render it to its container element.</div>
2274 If this is a lazy rendering component, render it to its container element.
2281 <dl class="detailList">
2282 <dt class="heading">Parameters:</dt>
2285 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Element</span> <b>container</b>
2288 <dd>(optional) The element this component should be rendered into. If it is being applied to existing markup, this should be left off.</dd>
2306 <td class="msource">
2308 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2314 <tr class="method-row config-row-alt1 expandable">
2315 <td class="micon"><a class="exi" href="#expand"> </a></td>
2319 <a id="Roo.Component-method-setDisabled" name=".setDisabled"></a>
2320 <div class="fixedFont">
2321 <span class="attributes"></span><b class="itemname">setDisabled</b>
2323 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>disabled</i></B>)
2330 <div class="short">Convenience function for setting disabled/enabled by boolean.</div>
2336 Convenience function for setting disabled/enabled by boolean.
2343 <dl class="detailList">
2344 <dt class="heading">Parameters:</dt>
2347 <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>
2368 <td class="msource">
2370 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2376 <tr class="method-row config-row-alt0 expandable">
2377 <td class="micon"><a class="exi" href="#expand"> </a></td>
2381 <a id="Roo.Component-method-setVisible" name=".setVisible"></a>
2382 <div class="fixedFont">
2383 <span class="attributes"></span><b class="itemname">setVisible</b>
2385 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>visible</i></B>)
2391 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2400 <div class="short">Convenience function to hide or show this component by boolean.</div>
2406 Convenience function to hide or show this component by boolean.
2413 <dl class="detailList">
2414 <dt class="heading">Parameters:</dt>
2417 <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>
2420 <dd>True to show, false to hide</dd>
2428 <dl class="detailList">
2429 <dt class="heading">Returns:</dt>
2431 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2445 <td class="msource">
2447 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2453 <tr class="method-row config-row-alt1 expandable">
2454 <td class="micon"><a class="exi" href="#expand"> </a></td>
2458 <a id="Roo.Component-method-show" name=".show"></a>
2459 <div class="fixedFont">
2460 <span class="attributes"></span><b class="itemname">show</b>
2468 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2477 <div class="short">Show this component.</div>
2483 Show this component.
2494 <dl class="detailList">
2495 <dt class="heading">Returns:</dt>
2497 <dd><span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> this</dd>
2511 <td class="msource">
2513 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2519 <tr class="method-row config-row-alt0 expandable">
2520 <td class="micon"><a class="exi" href="#expand"> </a></td>
2524 <a id="Roo.util.Observable-method-un" name=".un"></a>
2525 <div class="fixedFont">
2526 <span class="attributes"></span><b class="itemname">un</b>
2528 (<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>)
2535 <div class="short">Removes a listener (shorthand for removeListener)</div>
2541 Removes a listener (shorthand for removeListener)
2548 <dl class="detailList">
2549 <dt class="heading">Parameters:</dt>
2552 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2555 <dd>The type of event to listen for</dd>
2558 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2561 <dd>The handler to remove</dd>
2564 <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>
2567 <dd>(optional) The scope (this object) for the handler</dd>
2585 <td class="msource">
2587 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2596 <!-- ============================== events summary / details ======================== -->
2599 <a id="Roo.bootstrap.Table-events"></a>
2608 <table cellspacing="0" class="member-table">
2609 <caption>Events</caption>
2612 <th class="sig-header" colspan="2">Event</th>
2613 <th class="msource-header">Defined By</th>
2622 <tr class="method-row expandable config-row-alt0">
2623 <td class="micon"><a class="exi" href="#expand"> </a></td>
2626 <a id="Roo.Component-event-*beforedestroy"></a>
2628 <div class="fixedFont">
2629 <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>)
2635 <div class="short">Fires before the component is destroyed.
2641 Fires before the component is destroyed. Return false to stop the destroy.
2647 <dl class="detailList">
2648 <dt class="heading">Parameters:</dt>
2651 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2672 <td class="msource">
2673 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2677 <tr class="method-row expandable config-row-alt1">
2678 <td class="micon"><a class="exi" href="#expand"> </a></td>
2681 <a id="Roo.Component-event-*beforehide"></a>
2683 <div class="fixedFont">
2684 <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>)
2690 <div class="short">Fires before the component is hidden.
2696 Fires before the component is hidden. Return false to stop the hide.
2702 <dl class="detailList">
2703 <dt class="heading">Parameters:</dt>
2706 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2727 <td class="msource">
2728 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2732 <tr class="method-row expandable config-row-alt0">
2733 <td class="micon"><a class="exi" href="#expand"> </a></td>
2736 <a id="Roo.Component-event-*beforerender"></a>
2738 <div class="fixedFont">
2739 <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>)
2745 <div class="short">Fires before the component is rendered.
2751 Fires before the component is rendered. Return false to stop the render.
2757 <dl class="detailList">
2758 <dt class="heading">Parameters:</dt>
2761 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2782 <td class="msource">
2783 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2787 <tr class="method-row expandable config-row-alt1">
2788 <td class="micon"><a class="exi" href="#expand"> </a></td>
2791 <a id="Roo.Component-event-*beforeshow"></a>
2793 <div class="fixedFont">
2794 <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>)
2800 <div class="short">Fires before the component is shown.
2806 Fires before the component is shown. Return false to stop the show.
2812 <dl class="detailList">
2813 <dt class="heading">Parameters:</dt>
2816 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
2837 <td class="msource">
2838 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
2842 <tr class="method-row expandable config-row-alt0 notInherited">
2843 <td class="micon"><a class="exi" href="#expand"> </a></td>
2846 <a id="Roo.bootstrap.Table-event-*cellclick"></a>
2848 <div class="fixedFont">
2849 <b class="itemname">cellclick</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2855 <div class="short">Fires when a cell is clicked
2861 Fires when a cell is clicked
2867 <dl class="detailList">
2868 <dt class="heading">Parameters:</dt>
2871 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
2877 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
2883 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2889 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
2895 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2916 <td class="msource">
2921 <tr class="method-row expandable config-row-alt1 notInherited">
2922 <td class="micon"><a class="exi" href="#expand"> </a></td>
2925 <a id="Roo.bootstrap.Table-event-*celldblclick"></a>
2927 <div class="fixedFont">
2928 <b class="itemname">celldblclick</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2934 <div class="short">Fires when a cell is double clicked
2940 Fires when a cell is double clicked
2946 <dl class="detailList">
2947 <dt class="heading">Parameters:</dt>
2950 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
2956 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
2962 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2968 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
2974 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2995 <td class="msource">
3000 <tr class="method-row expandable config-row-alt0">
3001 <td class="micon"><a class="exi" href="#expand"> </a></td>
3004 <a id="Roo.Component-event-*destroy"></a>
3006 <div class="fixedFont">
3007 <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>)
3013 <div class="short">Fires after the component is destroyed.
3019 Fires after the component is destroyed.
3025 <dl class="detailList">
3026 <dt class="heading">Parameters:</dt>
3029 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3050 <td class="msource">
3051 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3055 <tr class="method-row expandable config-row-alt1">
3056 <td class="micon"><a class="exi" href="#expand"> </a></td>
3059 <a id="Roo.Component-event-*disable"></a>
3061 <div class="fixedFont">
3062 <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>)
3068 <div class="short">Fires after the component is disabled.
3074 Fires after the component is disabled.
3080 <dl class="detailList">
3081 <dt class="heading">Parameters:</dt>
3084 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3105 <td class="msource">
3106 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3110 <tr class="method-row expandable config-row-alt0">
3111 <td class="micon"><a class="exi" href="#expand"> </a></td>
3114 <a id="Roo.Component-event-*enable"></a>
3116 <div class="fixedFont">
3117 <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>)
3123 <div class="short">Fires after the component is enabled.
3129 Fires after the component is enabled.
3135 <dl class="detailList">
3136 <dt class="heading">Parameters:</dt>
3139 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3160 <td class="msource">
3161 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3165 <tr class="method-row expandable config-row-alt1">
3166 <td class="micon"><a class="exi" href="#expand"> </a></td>
3169 <a id="Roo.Component-event-*hide"></a>
3171 <div class="fixedFont">
3172 <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>)
3178 <div class="short">Fires after the component is hidden.
3184 Fires after the component is hidden.
3190 <dl class="detailList">
3191 <dt class="heading">Parameters:</dt>
3194 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3215 <td class="msource">
3216 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3220 <tr class="method-row expandable config-row-alt0 notInherited">
3221 <td class="micon"><a class="exi" href="#expand"> </a></td>
3224 <a id="Roo.bootstrap.Table-event-*mouseout"></a>
3226 <div class="fixedFont">
3227 <b class="itemname">mouseout</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3233 <div class="short">Fires when a mouseout occur
3239 Fires when a mouseout occur
3245 <dl class="detailList">
3246 <dt class="heading">Parameters:</dt>
3249 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
3255 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
3261 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3267 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3273 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3294 <td class="msource">
3299 <tr class="method-row expandable config-row-alt1 notInherited">
3300 <td class="micon"><a class="exi" href="#expand"> </a></td>
3303 <a id="Roo.bootstrap.Table-event-*mouseover"></a>
3305 <div class="fixedFont">
3306 <b class="itemname">mouseover</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3312 <div class="short">Fires when a mouseover occur
3318 Fires when a mouseover occur
3324 <dl class="detailList">
3325 <dt class="heading">Parameters:</dt>
3328 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
3334 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
3340 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3346 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3352 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3373 <td class="msource">
3378 <tr class="method-row expandable config-row-alt0">
3379 <td class="micon"><a class="exi" href="#expand"> </a></td>
3382 <a id="Roo.Component-event-*render"></a>
3384 <div class="fixedFont">
3385 <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>)
3391 <div class="short">Fires after the component is rendered.
3397 Fires after the component is rendered.
3403 <dl class="detailList">
3404 <dt class="heading">Parameters:</dt>
3407 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3428 <td class="msource">
3429 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3433 <tr class="method-row expandable config-row-alt1 notInherited">
3434 <td class="micon"><a class="exi" href="#expand"> </a></td>
3437 <a id="Roo.bootstrap.Table-event-*rowclass"></a>
3439 <div class="fixedFont">
3440 <b class="itemname">rowclass</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>rowcfg</i></B>)
3446 <div class="short">Fires when a row is rendered, so you can change add a style to it.
3452 Fires when a row is rendered, so you can change add a style to it.
3458 <dl class="detailList">
3459 <dt class="heading">Parameters:</dt>
3462 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
3468 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>rowcfg</b>
3471 <dd>contains record rowIndex colIndex and rowClass - set rowClass to add a style.</dd>
3489 <td class="msource">
3494 <tr class="method-row expandable config-row-alt0 notInherited">
3495 <td class="micon"><a class="exi" href="#expand"> </a></td>
3498 <a id="Roo.bootstrap.Table-event-*rowclick"></a>
3500 <div class="fixedFont">
3501 <b class="itemname">rowclick</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3507 <div class="short">Fires when a row is clicked
3513 Fires when a row is clicked
3519 <dl class="detailList">
3520 <dt class="heading">Parameters:</dt>
3523 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
3529 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
3535 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3541 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3562 <td class="msource">
3567 <tr class="method-row expandable config-row-alt1 notInherited">
3568 <td class="micon"><a class="exi" href="#expand"> </a></td>
3571 <a id="Roo.bootstrap.Table-event-*rowdblclick"></a>
3573 <div class="fixedFont">
3574 <b class="itemname">rowdblclick</b> (<a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a> <B><i>this</i></B>, <a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a> <B><i>el</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>rowIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3580 <div class="short">Fires when a row is double clicked
3586 Fires when a row is double clicked
3592 <dl class="detailList">
3593 <dt class="heading">Parameters:</dt>
3596 <span class="fixedFont"><a href="./Roo.bootstrap.Table.html#constructor" roo:cls="Roo.bootstrap.Table.html#constructor">Roo.bootstrap.Table</a></span> <b>this</b>
3602 <span class="fixedFont"><a href="./Roo.Element.html#constructor" roo:cls="Roo.Element.html#constructor">Roo.Element</a></span> <b>el</b>
3608 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3614 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3635 <td class="msource">
3640 <tr class="method-row expandable config-row-alt0">
3641 <td class="micon"><a class="exi" href="#expand"> </a></td>
3644 <a id="Roo.Component-event-*show"></a>
3646 <div class="fixedFont">
3647 <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>)
3653 <div class="short">Fires after the component is shown.
3659 Fires after the component is shown.
3665 <dl class="detailList">
3666 <dt class="heading">Parameters:</dt>
3669 <span class="fixedFont"><a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a></span> <b>this</b>
3690 <td class="msource">
3691 <a href="./Roo.Component.html#constructor" roo:cls="Roo.Component.html#constructor">Roo.Component</a>
3702 <!-- ============================== footer ================================= -->
3703 <div class="fineprint" style="clear:both">
3705 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Feb 12 2015 14:00:49 GMT+0800 (HKT)
3707 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>