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>
111 <table cellspacing="0" class="member-table">
112 <caption class="Empty">Config Options - Has None</caption>
126 <!-- ============================== public properties ==================== -->
130 <a id="Roo.grid.GridView-props"></a>
136 <table cellspacing="0" class="member-table">
137 <caption class="Empty">Public Properties - Has None</caption>
143 <!-- ============================== methods summary / details ======================== -->
146 <a id="Roo.grid.GridView-methods"></a>
147 <!-- constructor?? -->
154 <!-- then dynamics first -->
161 <table cellspacing="0" class="member-table">
162 <caption>Public Methods</caption>
164 <th class="sig-header" colspan="2">Method</th>
165 <th class="msource-header">Defined By</th>
175 <tr class="method-row config-row-alt0 expandable notInherited">
176 <td class="micon"><a class="exi" href="#expand"> </a></td>
180 <a id="Roo.grid-method-GridView" name=".GridView"></a>
181 <div class="fixedFont">
182 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">GridView</b>
184 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
192 <div class="short">Create a new Roo.grid.GridView</div>
199 Create a new Roo.grid.GridView
202 <dl class="detailList">
203 <dt class="heading">Parameters:</dt>
206 <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>
233 <tr class="method-row config-row-alt1 expandable notInherited">
234 <td class="micon"><a class="exi" href="#expand"> </a></td>
238 <a id="Roo.grid.GridView-method-autoSizeColumn" name=".autoSizeColumn"></a>
239 <div class="fixedFont">
240 <span class="attributes"></span><b class="itemname">autoSizeColumn</b>
242 (<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>)
249 <div class="short">Autofit a column to its content.</div>
255 Autofit a column to its content.
262 <dl class="detailList">
263 <dt class="heading">Parameters:</dt>
266 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
272 <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>
275 <dd>true to force the column to go smaller if possible</dd>
301 <tr class="method-row config-row-alt0 expandable notInherited">
302 <td class="micon"><a class="exi" href="#expand"> </a></td>
306 <a id="Roo.grid.GridView-method-autoSizeColumns" name=".autoSizeColumns"></a>
307 <div class="fixedFont">
308 <span class="attributes"></span><b class="itemname">autoSizeColumns</b>
317 <div class="short">Autofits all columns to their content and then expands to fit any extra space in the grid</div>
323 Autofits all columns to their content and then expands to fit any extra space in the grid
352 <tr class="method-row config-row-alt1 expandable notInherited">
353 <td class="micon"><a class="exi" href="#expand"> </a></td>
357 <a id="Roo.grid.GridView-method-ensureVisible" name=".ensureVisible"></a>
358 <div class="fixedFont">
359 <span class="attributes"></span><b class="itemname">ensureVisible</b>
361 (<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>)
368 <div class="short">Scrolls the specified cell into view</div>
374 Scrolls the specified cell into view
381 <dl class="detailList">
382 <dt class="heading">Parameters:</dt>
385 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
388 <dd>The row index</dd>
391 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
394 <dd>The column index</dd>
397 <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>
400 <dd>false to disable horizontal scrolling</dd>
426 <tr class="method-row config-row-alt0 expandable notInherited">
427 <td class="micon"><a class="exi" href="#expand"> </a></td>
431 <a id="Roo.grid.GridView-method-fitColumns" name=".fitColumns"></a>
432 <div class="fixedFont">
433 <span class="attributes"></span><b class="itemname">fitColumns</b>
435 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>reserveScrollSpace</i></B>)
442 <div class="short">Autofits all columns to the grid's width proportionate with their current size</div>
448 Autofits all columns to the grid's width proportionate with their current size
455 <dl class="detailList">
456 <dt class="heading">Parameters:</dt>
459 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>reserveScrollSpace</b>
462 <dd>Reserve space for a scrollbar</dd>
488 <tr class="method-row config-row-alt1 expandable notInherited">
489 <td class="micon"><a class="exi" href="#expand"> </a></td>
493 <a id="Roo.grid.GridView-method-focusCell" name=".focusCell"></a>
494 <div class="fixedFont">
495 <span class="attributes"></span><b class="itemname">focusCell</b>
497 (<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>)
504 <div class="short">Focuses the specified cell.</div>
510 Focuses the specified cell.
517 <dl class="detailList">
518 <dt class="heading">Parameters:</dt>
521 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
524 <dd>The row index</dd>
527 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>col</b>
530 <dd>The column index</dd>
533 <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>
536 <dd>false to disable horizontal scrolling</dd>
562 <tr class="method-row config-row-alt0 expandable notInherited">
563 <td class="micon"><a class="exi" href="#expand"> </a></td>
567 <a id="Roo.grid.GridView-method-focusRow" name=".focusRow"></a>
568 <div class="fixedFont">
569 <span class="attributes"></span><b class="itemname">focusRow</b>
571 (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>row</i></B>)
578 <div class="short">Focuses the specified row.</div>
584 Focuses the specified row.
591 <dl class="detailList">
592 <dt class="heading">Parameters:</dt>
595 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>row</b>
598 <dd>The row index</dd>
624 <tr class="method-row config-row-alt1 expandable notInherited">
625 <td class="micon"><a class="exi" href="#expand"> </a></td>
629 <a id="Roo.grid.GridView-method-getFooterPanel" name=".getFooterPanel"></a>
630 <div class="fixedFont">
631 <span class="attributes"></span><b class="itemname">getFooterPanel</b>
633 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
648 <div class="short">Gets a panel in the footer of the grid that can be used for toolbars etc.</div>
654 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.
661 <dl class="detailList">
662 <dt class="heading">Parameters:</dt>
665 <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>
668 <dd>By default the footer is hidden. Pass true to show the panel</dd>
676 <dl class="detailList">
677 <dt class="heading">Returns:</dt>
679 <dd> Roo.Element</dd>
701 <tr class="method-row config-row-alt0 expandable notInherited">
702 <td class="micon"><a class="exi" href="#expand"> </a></td>
706 <a id="Roo.grid.GridView-method-getHeaderPanel" name=".getHeaderPanel"></a>
707 <div class="fixedFont">
708 <span class="attributes"></span><b class="itemname">getHeaderPanel</b>
710 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>doShow</i></B>)
725 <div class="short">Gets a panel in the header of the grid that can be used for toolbars etc.</div>
731 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.
738 <dl class="detailList">
739 <dt class="heading">Parameters:</dt>
742 <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>
745 <dd>By default the header is hidden. Pass true to show the panel</dd>
753 <dl class="detailList">
754 <dt class="heading">Returns:</dt>
756 <dd> Roo.Element</dd>
778 <tr class="method-row config-row-alt1 expandable notInherited">
779 <td class="micon"><a class="exi" href="#expand"> </a></td>
783 <a id="Roo.grid.GridView-method-refresh" name=".refresh"></a>
784 <div class="fixedFont">
785 <span class="attributes"></span><b class="itemname">refresh</b>
787 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>headersToo</i></B>)
794 <div class="short">Refreshes the grid</div>
807 <dl class="detailList">
808 <dt class="heading">Parameters:</dt>
811 <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>
840 <tr class="method-row config-row-alt0 expandable notInherited">
841 <td class="micon"><a class="exi" href="#expand"> </a></td>
845 <a id="Roo.grid.GridView-method-rowClass" name=".rowClass"></a>
846 <div class="fixedFont">
847 <span class="attributes"></span><b class="itemname">rowClass</b>
849 (Record <B><i>record</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>index</i></B>)
856 <div class="short">Override this function to apply custom css classes to rows during rendering</div>
862 Override this function to apply custom css classes to rows during rendering
869 <dl class="detailList">
870 <dt class="heading">Parameters:</dt>
873 <span class="fixedFont">Record</span> <b>record</b>
879 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>index</b>
908 <tr class="method-row config-row-alt1 expandable notInherited">
909 <td class="micon"><a class="exi" href="#expand"> </a></td>
913 <a id="Roo.grid.GridView-method-scrollToTop" name=".scrollToTop"></a>
914 <div class="fixedFont">
915 <span class="attributes"></span><b class="itemname">scrollToTop</b>
924 <div class="short">Scrolls the grid to the top</div>
930 Scrolls the grid to the top
962 <!-- ============================== events summary / details ======================== -->
965 <a id="Roo.grid.GridView-events"></a>
971 <table cellspacing="0" class="member-table">
972 <caption class="Empty">Events - Has None</caption>
983 <!-- ============================== footer ================================= -->
984 <div class="fineprint" style="clear:both">
986 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 16:37:11 GMT+0800 (HKT)
988 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>