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.grid.GridView</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.grid.GridView-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.GridView-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.GridView-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.GridView-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 class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.GridView
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
57 Class Roo.grid.GridView
60 <table cellspacing="0" class="class-summary-table">
62 <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
64 <tr><td class="label">Defined In:</td><td class="hd-info">
66 <a href="./src/Roo_grid_GridView.js.html">Roo/grid/GridView.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">GridView</td></tr>
74 <tr><td class="label">Extends:</td><td class="hd-info">
75 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
83 <!-- ============================== class summary ========================== -->
84 <div class="description">
89 <!-- ============================== Class comment block... ========================== -->
91 <div class="comments">
92 <b>Class Comments / Notes</B> =>
93 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.GridView';">[Add Your comment/notes about this class]</u>
95 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
96 src="/blog.php/GtkDjsComments/Roo.grid.GridView.html"></iframe>
101 <!-- ============================== config options ========================== -->
106 <div class="hr"></div>
107 <a id="Roo.grid.GridView-configs"></a>
113 <table cellspacing="0" class="member-table">
114 <caption>Config Options (Usually are also Properties)</caption>
118 <th class="sig-header" colspan="2">Options</th>
120 <th class="msource-header">Defined By</th>
127 <tr class="config-row expandable config-row-alt0">
128 <td class="micon"><a class="exi" href="#expand"> </a></td>
131 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
132 <div class="fixedFont">
133 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
139 <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>
144 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>
154 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
170 <!-- ============================== public properties ==================== -->
174 <a id="Roo.grid.GridView-props"></a>
180 <table cellspacing="0" class="member-table">
181 <caption class="Empty">Public Properties - Has None</caption>
187 <!-- ============================== methods summary / details ======================== -->
190 <a id="Roo.grid.GridView-methods"></a>
191 <!-- constructor?? -->
198 <!-- then dynamics first -->
205 <table cellspacing="0" class="member-table">
206 <caption>Public Methods</caption>
208 <th class="sig-header" colspan="2">Method</th>
209 <th class="msource-header">Defined By</th>
219 <tr class="method-row config-row-alt0 expandable notInherited">
220 <td class="micon"><a class="exi" href="#expand"> </a></td>
224 <a id="Roo.grid-method-GridView" name=".GridView"></a>
225 <div class="fixedFont">
226 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">GridView</b>
228 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
236 <div class="short">Create a new Roo.grid.GridView</div>
243 Create a new Roo.grid.GridView
246 <dl class="detailList">
247 <dt class="heading">Parameters:</dt>
250 <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>
277 <tr class="method-row config-row-alt1 expandable">
278 <td class="micon"><a class="exi" href="#expand"> </a></td>
282 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
283 <div class="fixedFont">
284 <span class="attributes"></span><b class="itemname">addEvents</b>
286 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
293 <div class="short">Used to define events on this Observable</div>
299 Used to define events on this Observable
306 <dl class="detailList">
307 <dt class="heading">Parameters:</dt>
310 <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>
313 <dd>The object with the events defined</dd>
333 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
339 <tr class="method-row config-row-alt0 expandable">
340 <td class="micon"><a class="exi" href="#expand"> </a></td>
344 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
345 <div class="fixedFont">
346 <span class="attributes"></span><b class="itemname">addListener</b>
348 (<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>)
355 <div class="short">Appends an event handler to this component</div>
361 Appends an event handler to this component
368 <dl class="detailList">
369 <dt class="heading">Parameters:</dt>
372 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
375 <dd>The type of event to listen for</dd>
378 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
381 <dd>The method the event invokes</dd>
384 <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>
387 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
390 <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>
393 <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>
413 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
419 <tr class="method-row config-row-alt1 expandable notInherited">
420 <td class="micon"><a class="exi" href="#expand"> </a></td>
424 <a id="Roo.grid.GridView-method-autoSizeColumn" name=".autoSizeColumn"></a>
425 <div class="fixedFont">
426 <span class="attributes"></span><b class="itemname">autoSizeColumn</b>
428 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>colIndex</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>forceMinSize</i></B>)
435 <div class="short">Autofit a column to its content.</div>
441 Autofit a column to its content.
448 <dl class="detailList">
449 <dt class="heading">Parameters:</dt>
452 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
458 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>forceMinSize</b>
461 <dd>true to force the column to go smaller if possible</dd>
487 <tr class="method-row config-row-alt0 expandable notInherited">
488 <td class="micon"><a class="exi" href="#expand"> </a></td>
492 <a id="Roo.grid.GridView-method-autoSizeColumns" name=".autoSizeColumns"></a>
493 <div class="fixedFont">
494 <span class="attributes"></span><b class="itemname">autoSizeColumns</b>
503 <div class="short">Autofits all columns to their content and then expands to fit any extra space in the grid</div>
509 Autofits all columns to their content and then expands to fit any extra space in the grid
538 <tr class="method-row config-row-alt1 expandable notInherited">
539 <td class="micon"><a class="exi" href="#expand"> </a></td>
543 <a id="Roo.grid.GridView-method-ensureVisible" name=".ensureVisible"></a>
544 <div class="fixedFont">
545 <span class="attributes"></span><b class="itemname">ensureVisible</b>
547 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hscroll</i></B>)
554 <div class="short">Scrolls the specified cell into view</div>
560 Scrolls the specified cell into view
567 <dl class="detailList">
568 <dt class="heading">Parameters:</dt>
571 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
574 <dd>The row index</dd>
577 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
580 <dd>The column index</dd>
583 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>hscroll</b>
586 <dd>false to disable horizontal scrolling</dd>
612 <tr class="method-row config-row-alt0 expandable">
613 <td class="micon"><a class="exi" href="#expand"> </a></td>
617 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
618 <div class="fixedFont">
619 <span class="attributes"></span><b class="itemname">fireEvent</b>
621 (<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>)
627 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
636 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
642 Fires the specified event with the passed parameters (minus the event name).
649 <dl class="detailList">
650 <dt class="heading">Parameters:</dt>
653 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
659 <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>
662 <dd>Variable number of parameters are passed to handlers</dd>
670 <dl class="detailList">
671 <dt class="heading">Returns:</dt>
673 <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>
689 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
695 <tr class="method-row config-row-alt1 expandable notInherited">
696 <td class="micon"><a class="exi" href="#expand"> </a></td>
700 <a id="Roo.grid.GridView-method-fitColumns" name=".fitColumns"></a>
701 <div class="fixedFont">
702 <span class="attributes"></span><b class="itemname">fitColumns</b>
704 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reserveScrollSpace</i></B>)
711 <div class="short">Autofits all columns to the grid's width proportionate with their current size</div>
717 Autofits all columns to the grid's width proportionate with their current size
724 <dl class="detailList">
725 <dt class="heading">Parameters:</dt>
728 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>reserveScrollSpace</b>
731 <dd>Reserve space for a scrollbar</dd>
757 <tr class="method-row config-row-alt0 expandable notInherited">
758 <td class="micon"><a class="exi" href="#expand"> </a></td>
762 <a id="Roo.grid.GridView-method-focusCell" name=".focusCell"></a>
763 <div class="fixedFont">
764 <span class="attributes"></span><b class="itemname">focusCell</b>
766 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>col</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>hscroll</i></B>)
773 <div class="short">Focuses the specified cell.</div>
779 Focuses the specified cell.
786 <dl class="detailList">
787 <dt class="heading">Parameters:</dt>
790 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
793 <dd>The row index</dd>
796 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
799 <dd>The column index</dd>
802 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>hscroll</b>
805 <dd>false to disable horizontal scrolling</dd>
831 <tr class="method-row config-row-alt1 expandable notInherited">
832 <td class="micon"><a class="exi" href="#expand"> </a></td>
836 <a id="Roo.grid.GridView-method-focusRow" name=".focusRow"></a>
837 <div class="fixedFont">
838 <span class="attributes"></span><b class="itemname">focusRow</b>
840 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
847 <div class="short">Focuses the specified row.</div>
853 Focuses the specified row.
860 <dl class="detailList">
861 <dt class="heading">Parameters:</dt>
864 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
867 <dd>The row index</dd>
893 <tr class="method-row config-row-alt0 expandable notInherited">
894 <td class="micon"><a class="exi" href="#expand"> </a></td>
898 <a id="Roo.grid.GridView-method-getCell" name=".getCell"></a>
899 <div class="fixedFont">
900 <span class="attributes"></span><b class="itemname">getCell</b>
902 (Integer <B><i>rowIndex</i></B>, Integer <B><i>colIndex</i></B>)
908 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
917 <div class="short">Gets the 'td' of the cell</div>
923 Gets the 'td' of the cell
930 <dl class="detailList">
931 <dt class="heading">Parameters:</dt>
934 <span class="fixedFont">Integer</span> <b>rowIndex</b>
937 <dd>row to select</dd>
940 <span class="fixedFont">Integer</span> <b>colIndex</b>
943 <dd>column to select</dd>
951 <dl class="detailList">
952 <dt class="heading">Returns:</dt>
954 <dd><span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> </dd>
976 <tr class="method-row config-row-alt1 expandable notInherited">
977 <td class="micon"><a class="exi" href="#expand"> </a></td>
981 <a id="Roo.grid.GridView-method-getFooterPanel" name=".getFooterPanel"></a>
982 <div class="fixedFont">
983 <span class="attributes"></span><b class="itemname">getFooterPanel</b>
985 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
1000 <div class="short">Gets a panel in the footer of the grid that can be used for toolbars etc.</div>
1006 Gets a panel in the footer of the grid that can be used for toolbars etc.<br/>After modifying the contents of this panel a call to grid.autoSize() may be<br/>required to register any changes in size.
1013 <dl class="detailList">
1014 <dt class="heading">Parameters:</dt>
1017 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>doShow</b>
1020 <dd>By default the footer is hidden. Pass true to show the panel</dd>
1028 <dl class="detailList">
1029 <dt class="heading">Returns:</dt>
1031 <dd> Roo.Element</dd>
1045 <td class="msource">
1053 <tr class="method-row config-row-alt0 expandable notInherited">
1054 <td class="micon"><a class="exi" href="#expand"> </a></td>
1058 <a id="Roo.grid.GridView-method-getHeaderPanel" name=".getHeaderPanel"></a>
1059 <div class="fixedFont">
1060 <span class="attributes"></span><b class="itemname">getHeaderPanel</b>
1062 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
1077 <div class="short">Gets a panel in the header of the grid that can be used for toolbars etc.</div>
1083 Gets a panel in the header of the grid that can be used for toolbars etc.<br/>After modifying the contents of this panel a call to grid.autoSize() may be<br/>required to register any changes in size.
1090 <dl class="detailList">
1091 <dt class="heading">Parameters:</dt>
1094 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>doShow</b>
1097 <dd>By default the header is hidden. Pass true to show the panel</dd>
1105 <dl class="detailList">
1106 <dt class="heading">Returns:</dt>
1108 <dd> Roo.Element</dd>
1122 <td class="msource">
1130 <tr class="method-row config-row-alt1 expandable">
1131 <td class="micon"><a class="exi" href="#expand"> </a></td>
1135 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1136 <div class="fixedFont">
1137 <span class="attributes"></span><b class="itemname">hasListener</b>
1139 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1145 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1154 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1160 Checks to see if this object has any listeners for a specified event
1167 <dl class="detailList">
1168 <dt class="heading">Parameters:</dt>
1171 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1174 <dd>The name of the event to check for</dd>
1182 <dl class="detailList">
1183 <dt class="heading">Returns:</dt>
1185 <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>
1199 <td class="msource">
1201 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1207 <tr class="method-row config-row-alt0 expandable">
1208 <td class="micon"><a class="exi" href="#expand"> </a></td>
1212 <a id="Roo.util.Observable-method-on" name=".on"></a>
1213 <div class="fixedFont">
1214 <span class="attributes"></span><b class="itemname">on</b>
1216 (<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>)
1223 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1229 Appends an event handler to this element (shorthand for addListener)
1236 <dl class="detailList">
1237 <dt class="heading">Parameters:</dt>
1240 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1243 <dd>The type of event to listen for</dd>
1246 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1249 <dd>The method the event invokes</dd>
1252 <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>
1255 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1258 <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>
1279 <td class="msource">
1281 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1287 <tr class="method-row config-row-alt1 expandable">
1288 <td class="micon"><a class="exi" href="#expand"> </a></td>
1292 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1293 <div class="fixedFont">
1294 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1303 <div class="short">Removes all listeners for this object</div>
1309 Removes all listeners for this object
1330 <td class="msource">
1332 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1338 <tr class="method-row config-row-alt0 expandable notInherited">
1339 <td class="micon"><a class="exi" href="#expand"> </a></td>
1343 <a id="Roo.grid.GridView-method-refresh" name=".refresh"></a>
1344 <div class="fixedFont">
1345 <span class="attributes"></span><b class="itemname">refresh</b>
1347 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>headersToo</i></B>)
1354 <div class="short">Refreshes the grid</div>
1367 <dl class="detailList">
1368 <dt class="heading">Parameters:</dt>
1371 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>headersToo</b>
1392 <td class="msource">
1400 <tr class="method-row config-row-alt1 expandable">
1401 <td class="micon"><a class="exi" href="#expand"> </a></td>
1405 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1406 <div class="fixedFont">
1407 <span class="attributes"></span><b class="itemname">removeListener</b>
1409 (<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>)
1416 <div class="short">Removes a listener</div>
1429 <dl class="detailList">
1430 <dt class="heading">Parameters:</dt>
1433 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1436 <dd>The type of event to listen for</dd>
1439 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1442 <dd>The handler to remove</dd>
1445 <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>
1448 <dd>(optional) The scope (this object) for the handler</dd>
1466 <td class="msource">
1468 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1474 <tr class="method-row config-row-alt0 expandable notInherited">
1475 <td class="micon"><a class="exi" href="#expand"> </a></td>
1479 <a id="Roo.grid.GridView-method-scrollToTop" name=".scrollToTop"></a>
1480 <div class="fixedFont">
1481 <span class="attributes"></span><b class="itemname">scrollToTop</b>
1490 <div class="short">Scrolls the grid to the top</div>
1496 Scrolls the grid to the top
1517 <td class="msource">
1525 <tr class="method-row config-row-alt1 expandable">
1526 <td class="micon"><a class="exi" href="#expand"> </a></td>
1530 <a id="Roo.util.Observable-method-un" name=".un"></a>
1531 <div class="fixedFont">
1532 <span class="attributes"></span><b class="itemname">un</b>
1534 (<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>)
1541 <div class="short">Removes a listener (shorthand for removeListener)</div>
1547 Removes a listener (shorthand for removeListener)
1554 <dl class="detailList">
1555 <dt class="heading">Parameters:</dt>
1558 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1561 <dd>The type of event to listen for</dd>
1564 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1567 <dd>The handler to remove</dd>
1570 <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>
1573 <dd>(optional) The scope (this object) for the handler</dd>
1591 <td class="msource">
1593 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1602 <!-- ============================== events summary / details ======================== -->
1605 <a id="Roo.grid.GridView-events"></a>
1611 <table cellspacing="0" class="member-table">
1612 <caption class="Empty">Events - Has None</caption>
1623 <!-- ============================== footer ================================= -->
1624 <div class="fineprint" style="clear:both">
1626 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Thu Apr 28 2016 18:04:17 GMT+0800 (HKT)
1628 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>