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.Grid</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.Grid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
35 <a class="inner-link" href="#Roo.grid.Grid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
36 <a class="inner-link" href="#Roo.grid.Grid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
37 <a class="inner-link" href="#Roo.grid.Grid-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.Grid
52 <!-- ============================== class title / details ============================ -->
55 <h1 class="classTitle">
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_Grid.js.html">Roo/grid/Grid.js</a>.
69 <tr><td class="label">Class:</td><td class="hd-info">Grid</td></tr>
72 <tr><td class="label">Subclasses:</td><td class="hd-info">
73 <a href="./Roo.grid.EditorGrid.html#constructor" roo:cls="Roo.grid.EditorGrid.html#constructor">Roo.grid.EditorGrid</a>, <a href="./Roo.grid.PropertyGrid.html#constructor" roo:cls="Roo.grid.PropertyGrid.html#constructor">Roo.grid.PropertyGrid</a>
81 <tr><td class="label">Extends:</td><td class="hd-info">
82 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
90 <!-- ============================== class summary ========================== -->
91 <div class="description">
92 This class represents the primary interface of a component based grid control.<br/><br><br>Usage:<pre><code><br/> var grid = new Roo.grid.Grid("my-container-id", {<br/> ds: myDataStore,<br/> cm: myColModel,<br/> selModel: mySelectionModel,<br/> autoSizeColumns: true,<br/> monitorWindowResize: false,<br/> trackMouseOver: true<br/> });<br/> // set any options<br/> grid.render();<br/></code></pre><br/><b>Common Problems:</b><br/><br/>- Grid does not resize properly when going smaller: Setting overflow hidden on the container<br/>element will correct this<br/><br/>- If you get el.style[camel]= NaNpx or -2px or something related, be certain you have given your container element<br/>dimensions. The grid adapts to your container's size, if your container has no size defined then the results<br/>are unpredictable.<br/><br/>- Do not render the grid into an element with display:none. Try using visibility:hidden. Otherwise there is no way for the<br/>grid to calculate dimensions/offsets.<br/>
96 <!-- ============================== Class comment block... ========================== -->
98 <div class="comments">
99 <b>Class Comments / Notes</B> =>
100 <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.Grid';">[Add Your comment/notes about this class]</u>
102 <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
103 src="/blog.php/GtkDjsComments/Roo.grid.Grid.html"></iframe>
108 <!-- ============================== config options ========================== -->
113 <div class="hr"></div>
114 <a id="Roo.grid.Grid-configs"></a>
120 <table cellspacing="0" class="member-table">
121 <caption>Config Options (Usually are also Properties)</caption>
125 <th class="sig-header" colspan="2">Options</th>
127 <th class="msource-header">Defined By</th>
134 <tr class="config-row expandable config-row-alt0 notInherited">
135 <td class="micon"><a class="exi" href="#expand"> </a></td>
138 <a id="Roo.grid.Grid-cfg-autoExpandColumn" name=".autoExpandColumn"></a>
139 <div class="fixedFont">
140 <b class="itemname">autoExpandColumn</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
146 <div class="short">The id (or dataIndex) of a column in this grid that should expand to fill unused space.</div>
150 <div class="long">The id (or dataIndex) of a column in this grid that should expand to fill unused space. This id can not be 0. Default is false.</div>
164 <tr class="config-row expandable config-row-alt1 notInherited">
165 <td class="micon"><a class="exi" href="#expand"> </a></td>
168 <a id="Roo.grid.Grid-cfg-autoExpandMax" name=".autoExpandMax"></a>
169 <div class="fixedFont">
170 <b class="itemname">autoExpandMax</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
176 <div class="short">The maximum width the autoExpandColumn can have (if enabled).</div>
180 <div class="long">The maximum width the autoExpandColumn can have (if enabled). Default is 1000.</div>
194 <tr class="config-row expandable config-row-alt0 notInherited">
195 <td class="micon"><a class="exi" href="#expand"> </a></td>
198 <a id="Roo.grid.Grid-cfg-autoExpandMin" name=".autoExpandMin"></a>
199 <div class="fixedFont">
200 <b class="itemname">autoExpandMin</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
206 <div class="short">The minimum width the autoExpandColumn can have (if enabled).</div>
210 <div class="long">The minimum width the autoExpandColumn can have (if enabled).<br/>Default is 50.</div>
224 <tr class="config-row expandable config-row-alt1 notInherited">
225 <td class="micon"><a class="exi" href="#expand"> </a></td>
228 <a id="Roo.grid.Grid-cfg-autoHeight" name=".autoHeight"></a>
229 <div class="fixedFont">
230 <b class="itemname">autoHeight</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
236 <div class="short">True to fit the height of the grid container to the height of the data.</div>
240 <div class="long">True to fit the height of the grid container to the height of the data. Default is false.</div>
254 <tr class="config-row expandable config-row-alt0 notInherited">
255 <td class="micon"><a class="exi" href="#expand"> </a></td>
258 <a id="Roo.grid.Grid-cfg-autoSizeColumns" name=".autoSizeColumns"></a>
259 <div class="fixedFont">
260 <b class="itemname">autoSizeColumns</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
266 <div class="short">True to automatically resize the columns to fit their content<br/><b>on initial render.</div>
270 <div class="long">True to automatically resize the columns to fit their content<br/><b>on initial render.</b> It is more efficient to explicitly size the columns<br/>through the ColumnModel's {<b>link</b> Roo.grid.ColumnModel<b>width</b>} config option. Default is false.</div>
284 <tr class="config-row expandable config-row-alt1 notInherited">
285 <td class="micon"><a class="exi" href="#expand"> </a></td>
288 <a id="Roo.grid.Grid-cfg-autoSizeHeaders" name=".autoSizeHeaders"></a>
289 <div class="fixedFont">
290 <b class="itemname">autoSizeHeaders</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
296 <div class="short">True to measure headers with column data when auto sizing columns.</div>
300 <div class="long">True to measure headers with column data when auto sizing columns. Default is true.</div>
314 <tr class="config-row expandable config-row-alt0 notInherited">
315 <td class="micon"><a class="exi" href="#expand"> </a></td>
318 <a id="Roo.grid.Grid-cfg-autoWidth" name=".autoWidth"></a>
319 <div class="fixedFont">
320 <b class="itemname">autoWidth</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
326 <div class="short">True to set the grid's width to the default total width of the grid's columns instead<br/>of a fixed width.</div>
330 <div class="long">True to set the grid's width to the default total width of the grid's columns instead<br/>of a fixed width. Default is false.</div>
344 <tr class="config-row expandable config-row-alt1 notInherited">
345 <td class="micon"><a class="exi" href="#expand"> </a></td>
348 <a id="Roo.grid.Grid-cfg-ddGroup" name=".ddGroup"></a>
349 <div class="fixedFont">
350 <b class="itemname">ddGroup</b> : <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
356 <div class="short">- drag drop group.</div>
360 <div class="long">- drag drop group.</div>
374 <tr class="config-row expandable config-row-alt0 notInherited">
375 <td class="micon"><a class="exi" href="#expand"> </a></td>
378 <a id="Roo.grid.Grid-cfg-enableColumnHide" name=".enableColumnHide"></a>
379 <div class="fixedFont">
380 <b class="itemname">enableColumnHide</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
386 <div class="short">True to enable hiding of columns with the header context menu.</div>
390 <div class="long">True to enable hiding of columns with the header context menu. Default is true.</div>
404 <tr class="config-row expandable config-row-alt1 notInherited">
405 <td class="micon"><a class="exi" href="#expand"> </a></td>
408 <a id="Roo.grid.Grid-cfg-enableColumnMove" name=".enableColumnMove"></a>
409 <div class="fixedFont">
410 <b class="itemname">enableColumnMove</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
416 <div class="short">True to enable drag and drop reorder of columns.</div>
420 <div class="long">True to enable drag and drop reorder of columns. Default is true.</div>
434 <tr class="config-row expandable config-row-alt0 notInherited">
435 <td class="micon"><a class="exi" href="#expand"> </a></td>
438 <a id="Roo.grid.Grid-cfg-enableDrag" name=".enableDrag"></a>
439 <div class="fixedFont">
440 <b class="itemname">enableDrag</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
446 <div class="short">True to enable drag of rows.</div>
450 <div class="long">True to enable drag of rows. Default is false. (double check if this is needed?)</div>
464 <tr class="config-row expandable config-row-alt1 notInherited">
465 <td class="micon"><a class="exi" href="#expand"> </a></td>
468 <a id="Roo.grid.Grid-cfg-enableDragDrop" name=".enableDragDrop"></a>
469 <div class="fixedFont">
470 <b class="itemname">enableDragDrop</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
476 <div class="short">True to enable drag and drop of rows.</div>
480 <div class="long">True to enable drag and drop of rows. Default is false.</div>
494 <tr class="config-row expandable config-row-alt0 notInherited">
495 <td class="micon"><a class="exi" href="#expand"> </a></td>
498 <a id="Roo.grid.Grid-cfg-enableRowHeightSync" name=".enableRowHeightSync"></a>
499 <div class="fixedFont">
500 <b class="itemname">enableRowHeightSync</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
506 <div class="short">True to manually sync row heights across locked and not locked rows.</div>
510 <div class="long">True to manually sync row heights across locked and not locked rows. Default is false.</div>
524 <tr class="config-row expandable config-row-alt1">
525 <td class="micon"><a class="exi" href="#expand"> </a></td>
528 <a id="Roo.util.Observable-cfg-listeners" name=".listeners"></a>
529 <div class="fixedFont">
530 <b class="itemname">listeners</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
536 <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>
540 <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>
548 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
554 <tr class="config-row expandable config-row-alt0 notInherited">
555 <td class="micon"><a class="exi" href="#expand"> </a></td>
558 <a id="Roo.grid.Grid-cfg-loadMask" name=".loadMask"></a>
559 <div class="fixedFont">
560 <b class="itemname">loadMask</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
566 <div class="short">An {<b>link</b> Roo.LoadMask} config or true to mask the grid while loading.</div>
570 <div class="long">An {<b>link</b> Roo.LoadMask} config or true to mask the grid while loading. Default is false.</div>
584 <tr class="config-row expandable config-row-alt1 notInherited">
585 <td class="micon"><a class="exi" href="#expand"> </a></td>
588 <a id="Roo.grid.Grid-cfg-maxHeight" name=".maxHeight"></a>
589 <div class="fixedFont">
590 <b class="itemname">maxHeight</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
596 <div class="short">Sets the maximum height of the grid - ignored if autoHeight is not on.</div>
600 <div class="long">Sets the maximum height of the grid - ignored if autoHeight is not on.</div>
614 <tr class="config-row expandable config-row-alt0 notInherited">
615 <td class="micon"><a class="exi" href="#expand"> </a></td>
618 <a id="Roo.grid.Grid-cfg-maxRowsToMeasure" name=".maxRowsToMeasure"></a>
619 <div class="fixedFont">
620 <b class="itemname">maxRowsToMeasure</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
626 <div class="short">If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of<br/>rows measured to get a columns size.</div>
630 <div class="long">If autoSizeColumns is on, maxRowsToMeasure can be used to limit the number of<br/>rows measured to get a columns size. Default is 0 (all rows).</div>
644 <tr class="config-row expandable config-row-alt1 notInherited">
645 <td class="micon"><a class="exi" href="#expand"> </a></td>
648 <a id="Roo.grid.Grid-cfg-minColumnWidth" name=".minColumnWidth"></a>
649 <div class="fixedFont">
650 <b class="itemname">minColumnWidth</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
656 <div class="short">The minimum width a column can be resized to.</div>
660 <div class="long">The minimum width a column can be resized to. Default is 25.</div>
674 <tr class="config-row expandable config-row-alt0 notInherited">
675 <td class="micon"><a class="exi" href="#expand"> </a></td>
678 <a id="Roo.grid.Grid-cfg-monitorWindowResize" name=".monitorWindowResize"></a>
679 <div class="fixedFont">
680 <b class="itemname">monitorWindowResize</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
686 <div class="short">True to autoSize the grid when the window resizes.</div>
690 <div class="long">True to autoSize the grid when the window resizes. Default is true.</div>
704 <tr class="config-row expandable config-row-alt1 notInherited">
705 <td class="micon"><a class="exi" href="#expand"> </a></td>
708 <a id="Roo.grid.Grid-cfg-stripeRows" name=".stripeRows"></a>
709 <div class="fixedFont">
710 <b class="itemname">stripeRows</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
716 <div class="short">True to stripe the rows.</div>
720 <div class="long">True to stripe the rows. Default is true.</div>
734 <tr class="config-row expandable config-row-alt0 notInherited">
735 <td class="micon"><a class="exi" href="#expand"> </a></td>
738 <a id="Roo.grid.Grid-cfg-trackMouseOver" name=".trackMouseOver"></a>
739 <div class="fixedFont">
740 <b class="itemname">trackMouseOver</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
746 <div class="short">True to highlight rows when the mouse is over.</div>
750 <div class="long">True to highlight rows when the mouse is over. Default is true.</div>
764 <tr class="config-row expandable config-row-alt1 notInherited">
765 <td class="micon"><a class="exi" href="#expand"> </a></td>
768 <a id="Roo.grid.Grid-cfg-view" name=".view"></a>
769 <div class="fixedFont">
770 <b class="itemname">view</b> : <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a>
776 <div class="short">The {<b>link</b> Roo.grid.GridView} used by the grid.</div>
780 <div class="long">The {<b>link</b> Roo.grid.GridView} used by the grid. This can be set before a call to render().</div>
804 <!-- ============================== public properties ==================== -->
808 <a id="Roo.grid.Grid-props"></a>
814 <table cellspacing="0" class="member-table">
815 <caption class="Empty">Public Properties - Has None</caption>
821 <!-- ============================== methods summary / details ======================== -->
824 <a id="Roo.grid.Grid-methods"></a>
825 <!-- constructor?? -->
832 <!-- then dynamics first -->
839 <table cellspacing="0" class="member-table">
840 <caption>Public Methods</caption>
842 <th class="sig-header" colspan="2">Method</th>
843 <th class="msource-header">Defined By</th>
853 <tr class="method-row config-row-alt0 expandable notInherited">
854 <td class="micon"><a class="exi" href="#expand"> </a></td>
858 <a id="Roo.grid-method-Grid" name=".Grid"></a>
859 <div class="fixedFont">
860 <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">Grid</b>
862 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element <B><i>container</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>config</i></B>)
870 <div class="short">Create a new Roo.grid.Grid</div>
877 Create a new Roo.grid.Grid
880 <dl class="detailList">
881 <dt class="heading">Parameters:</dt>
884 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>container</b>
887 <dd>The element into which this grid will be rendered -<br/>The container MUST have some type of size defined for the grid to fill. The container will be<br/>automatically set to position relative if it isn't already.</dd>
890 <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>
893 <dd>A config object that sets properties on this grid.</dd>
917 <tr class="method-row config-row-alt1 expandable">
918 <td class="micon"><a class="exi" href="#expand"> </a></td>
922 <a id="Roo.util.Observable-method-addEvents" name=".addEvents"></a>
923 <div class="fixedFont">
924 <span class="attributes"></span><b class="itemname">addEvents</b>
926 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>object</i></B>)
933 <div class="short">Used to define events on this Observable</div>
939 Used to define events on this Observable
946 <dl class="detailList">
947 <dt class="heading">Parameters:</dt>
950 <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>
953 <dd>The object with the events defined</dd>
973 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
979 <tr class="method-row config-row-alt0 expandable">
980 <td class="micon"><a class="exi" href="#expand"> </a></td>
984 <a id="Roo.util.Observable-method-addListener" name=".addListener"></a>
985 <div class="fixedFont">
986 <span class="attributes"></span><b class="itemname">addListener</b>
988 (<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>)
995 <div class="short">Appends an event handler to this component</div>
1001 Appends an event handler to this component
1008 <dl class="detailList">
1009 <dt class="heading">Parameters:</dt>
1012 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1015 <dd>The type of event to listen for</dd>
1018 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1021 <dd>The method the event invokes</dd>
1024 <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>
1027 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1030 <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>
1033 <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>
1051 <td class="msource">
1053 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1059 <tr class="method-row config-row-alt1 expandable notInherited">
1060 <td class="micon"><a class="exi" href="#expand"> </a></td>
1064 <a id="Roo.grid.Grid-method-autoSize" name=".autoSize"></a>
1065 <div class="fixedFont">
1066 <span class="attributes"></span><b class="itemname">autoSize</b>
1075 <div class="short">Causes the grid to manually recalculate its dimensions.</div>
1081 Causes the grid to manually recalculate its dimensions. Generally this is done automatically,<br/>but if manual update is required this method will initiate it.
1102 <td class="msource">
1110 <tr class="method-row config-row-alt0 expandable notInherited">
1111 <td class="micon"><a class="exi" href="#expand"> </a></td>
1115 <a id="Roo.grid.Grid-method-destroy" name=".destroy"></a>
1116 <div class="fixedFont">
1117 <span class="attributes"></span><b class="itemname">destroy</b>
1119 (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a> <B><i>removeEl</i></B>)
1126 <div class="short">Destroy this grid.</div>
1139 <dl class="detailList">
1140 <dt class="heading">Parameters:</dt>
1143 <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a></span> <b>removeEl</b>
1146 <dd>True to remove the element</dd>
1164 <td class="msource">
1172 <tr class="method-row config-row-alt1 expandable">
1173 <td class="micon"><a class="exi" href="#expand"> </a></td>
1177 <a id="Roo.util.Observable-method-fireEvent" name=".fireEvent"></a>
1178 <div class="fixedFont">
1179 <span class="attributes"></span><b class="itemname">fireEvent</b>
1181 (<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>)
1187 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1196 <div class="short">Fires the specified event with the passed parameters (minus the event name).</div>
1202 Fires the specified event with the passed parameters (minus the event name).
1209 <dl class="detailList">
1210 <dt class="heading">Parameters:</dt>
1213 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1219 <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>
1222 <dd>Variable number of parameters are passed to handlers</dd>
1230 <dl class="detailList">
1231 <dt class="heading">Returns:</dt>
1233 <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>
1247 <td class="msource">
1249 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1255 <tr class="method-row config-row-alt0 expandable notInherited">
1256 <td class="micon"><a class="exi" href="#expand"> </a></td>
1260 <a id="Roo.grid.Grid-method-getColumnModel" name=".getColumnModel"></a>
1261 <div class="fixedFont">
1262 <span class="attributes"></span><b class="itemname">getColumnModel</b>
1279 <div class="short">Returns the grid's ColumnModel.</div>
1285 Returns the grid's ColumnModel.
1296 <dl class="detailList">
1297 <dt class="heading">Returns:</dt>
1299 <dd><span class="fixedFont">ColumnModel</span> </dd>
1313 <td class="msource">
1321 <tr class="method-row config-row-alt1 expandable notInherited">
1322 <td class="micon"><a class="exi" href="#expand"> </a></td>
1326 <a id="Roo.grid.Grid-method-getDataSource" name=".getDataSource"></a>
1327 <div class="fixedFont">
1328 <span class="attributes"></span><b class="itemname">getDataSource</b>
1345 <div class="short">Returns the grid's DataSource.</div>
1351 Returns the grid's DataSource.
1362 <dl class="detailList">
1363 <dt class="heading">Returns:</dt>
1365 <dd><span class="fixedFont">DataSource</span> </dd>
1379 <td class="msource">
1387 <tr class="method-row config-row-alt0 expandable notInherited">
1388 <td class="micon"><a class="exi" href="#expand"> </a></td>
1392 <a id="Roo.grid.Grid-method-getDragDropText" name=".getDragDropText"></a>
1393 <div class="fixedFont">
1394 <span class="attributes"></span><b class="itemname">getDragDropText</b>
1402 <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>
1411 <div class="short">Called to get grid's drag proxy text, by default returns this.ddText.</div>
1417 Called to get grid's drag proxy text, by default returns this.ddText.
1428 <dl class="detailList">
1429 <dt class="heading">Returns:</dt>
1431 <dd><span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> </dd>
1445 <td class="msource">
1453 <tr class="method-row config-row-alt1 expandable notInherited">
1454 <td class="micon"><a class="exi" href="#expand"> </a></td>
1458 <a id="Roo.grid.Grid-method-getGridEl" name=".getGridEl"></a>
1459 <div class="fixedFont">
1460 <span class="attributes"></span><b class="itemname">getGridEl</b>
1477 <div class="short">Returns the grid's underlying element.</div>
1483 Returns the grid's underlying element.
1494 <dl class="detailList">
1495 <dt class="heading">Returns:</dt>
1497 <dd><span class="fixedFont">Element</span> The element</dd>
1511 <td class="msource">
1519 <tr class="method-row config-row-alt0 expandable notInherited">
1520 <td class="micon"><a class="exi" href="#expand"> </a></td>
1524 <a id="Roo.grid.Grid-method-getSelectionModel" name=".getSelectionModel"></a>
1525 <div class="fixedFont">
1526 <span class="attributes"></span><b class="itemname">getSelectionModel</b>
1543 <div class="short">Returns the grid's SelectionModel.</div>
1549 Returns the grid's SelectionModel.
1560 <dl class="detailList">
1561 <dt class="heading">Returns:</dt>
1563 <dd><span class="fixedFont">SelectionModel</span> </dd>
1577 <td class="msource">
1585 <tr class="method-row config-row-alt1 expandable notInherited">
1586 <td class="micon"><a class="exi" href="#expand"> </a></td>
1590 <a id="Roo.grid.Grid-method-getView" name=".getView"></a>
1591 <div class="fixedFont">
1592 <span class="attributes"></span><b class="itemname">getView</b>
1609 <div class="short">Returns the grid's GridView object.</div>
1615 Returns the grid's GridView object.
1626 <dl class="detailList">
1627 <dt class="heading">Returns:</dt>
1629 <dd><span class="fixedFont">GridView</span> </dd>
1643 <td class="msource">
1651 <tr class="method-row config-row-alt0 expandable">
1652 <td class="micon"><a class="exi" href="#expand"> </a></td>
1656 <a id="Roo.util.Observable-method-hasListener" name=".hasListener"></a>
1657 <div class="fixedFont">
1658 <span class="attributes"></span><b class="itemname">hasListener</b>
1660 (<a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>eventName</i></B>)
1666 <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Boolean">Boolean</a>
1675 <div class="short">Checks to see if this object has any listeners for a specified event</div>
1681 Checks to see if this object has any listeners for a specified event
1688 <dl class="detailList">
1689 <dt class="heading">Parameters:</dt>
1692 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1695 <dd>The name of the event to check for</dd>
1703 <dl class="detailList">
1704 <dt class="heading">Returns:</dt>
1706 <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>
1720 <td class="msource">
1722 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1728 <tr class="method-row config-row-alt1 expandable">
1729 <td class="micon"><a class="exi" href="#expand"> </a></td>
1733 <a id="Roo.util.Observable-method-on" name=".on"></a>
1734 <div class="fixedFont">
1735 <span class="attributes"></span><b class="itemname">on</b>
1737 (<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>)
1744 <div class="short">Appends an event handler to this element (shorthand for addListener)</div>
1750 Appends an event handler to this element (shorthand for addListener)
1757 <dl class="detailList">
1758 <dt class="heading">Parameters:</dt>
1761 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1764 <dd>The type of event to listen for</dd>
1767 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1770 <dd>The method the event invokes</dd>
1773 <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>
1776 <dd>(optional) The scope in which to execute the handler<br/>function. The handler function's "this" context.</dd>
1779 <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>
1800 <td class="msource">
1802 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1808 <tr class="method-row config-row-alt0 expandable">
1809 <td class="micon"><a class="exi" href="#expand"> </a></td>
1813 <a id="Roo.util.Observable-method-purgeListeners" name=".purgeListeners"></a>
1814 <div class="fixedFont">
1815 <span class="attributes"></span><b class="itemname">purgeListeners</b>
1824 <div class="short">Removes all listeners for this object</div>
1830 Removes all listeners for this object
1851 <td class="msource">
1853 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
1859 <tr class="method-row config-row-alt1 expandable notInherited">
1860 <td class="micon"><a class="exi" href="#expand"> </a></td>
1864 <a id="Roo.grid.Grid-method-reconfigure" name=".reconfigure"></a>
1865 <div class="fixedFont">
1866 <span class="attributes"></span><b class="itemname">reconfigure</b>
1868 (<a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a> <B><i>dataSource</i></B>, <a href="./Roo.grid.ColumnModel.html#constructor" roo:cls="Roo.grid.ColumnModel.html#constructor">Roo.grid.ColumnModel</a> <B><i>The</i></B>)
1875 <div class="short">Reconfigures the grid to use a different Store and Column Model.</div>
1881 Reconfigures the grid to use a different Store and Column Model.<br/>The View will be bound to the new objects and refreshed.
1888 <dl class="detailList">
1889 <dt class="heading">Parameters:</dt>
1892 <span class="fixedFont"><a href="./Roo.data.Store.html#constructor" roo:cls="Roo.data.Store.html#constructor">Roo.data.Store</a></span> <b>dataSource</b>
1895 <dd>The new {<b>link</b> Roo.data.Store} object</dd>
1898 <span class="fixedFont"><a href="./Roo.grid.ColumnModel.html#constructor" roo:cls="Roo.grid.ColumnModel.html#constructor">Roo.grid.ColumnModel</a></span> <b>The</b>
1901 <dd>new {<b>link</b> Roo.grid.ColumnModel} object</dd>
1919 <td class="msource">
1927 <tr class="method-row config-row-alt0 expandable">
1928 <td class="micon"><a class="exi" href="#expand"> </a></td>
1932 <a id="Roo.util.Observable-method-removeListener" name=".removeListener"></a>
1933 <div class="fixedFont">
1934 <span class="attributes"></span><b class="itemname">removeListener</b>
1936 (<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>)
1943 <div class="short">Removes a listener</div>
1956 <dl class="detailList">
1957 <dt class="heading">Parameters:</dt>
1960 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
1963 <dd>The type of event to listen for</dd>
1966 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
1969 <dd>The handler to remove</dd>
1972 <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>
1975 <dd>(optional) The scope (this object) for the handler</dd>
1993 <td class="msource">
1995 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2001 <tr class="method-row config-row-alt1 expandable notInherited">
2002 <td class="micon"><a class="exi" href="#expand"> </a></td>
2006 <a id="Roo.grid.Grid-method-render" name=".render"></a>
2007 <div class="fixedFont">
2008 <span class="attributes"></span><b class="itemname">render</b>
2016 <a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>
2025 <div class="short">Called once after all setup has been completed and the grid is ready to be rendered.</div>
2031 Called once after all setup has been completed and the grid is ready to be rendered.
2042 <dl class="detailList">
2043 <dt class="heading">Returns:</dt>
2045 <dd><span class="fixedFont"><a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a></span> this</dd>
2059 <td class="msource">
2067 <tr class="method-row config-row-alt0 expandable">
2068 <td class="micon"><a class="exi" href="#expand"> </a></td>
2072 <a id="Roo.util.Observable-method-un" name=".un"></a>
2073 <div class="fixedFont">
2074 <span class="attributes"></span><b class="itemname">un</b>
2076 (<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>)
2083 <div class="short">Removes a listener (shorthand for removeListener)</div>
2089 Removes a listener (shorthand for removeListener)
2096 <dl class="detailList">
2097 <dt class="heading">Parameters:</dt>
2100 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>eventName</b>
2103 <dd>The type of event to listen for</dd>
2106 <span class="fixedFont"><a href="./Function.html#constructor" roo:cls="Function.html#constructor">Function</a></span> <b>handler</b>
2109 <dd>The handler to remove</dd>
2112 <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>
2115 <dd>(optional) The scope (this object) for the handler</dd>
2133 <td class="msource">
2135 <a href="./Roo.util.Observable.html#constructor" roo:cls="Roo.util.Observable.html#constructor">Roo.util.Observable</a>
2144 <!-- ============================== events summary / details ======================== -->
2147 <a id="Roo.grid.Grid-events"></a>
2156 <table cellspacing="0" class="member-table">
2157 <caption>Events</caption>
2160 <th class="sig-header" colspan="2">Event</th>
2161 <th class="msource-header">Defined By</th>
2170 <tr class="method-row expandable config-row-alt0 notInherited">
2171 <td class="micon"><a class="exi" href="#expand"> </a></td>
2174 <a id="Roo.grid.Grid-event-*bodyscroll"></a>
2176 <div class="fixedFont">
2177 <b class="itemname">bodyscroll</b> (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>scrollLeft</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>scrollTop</i></B>)
2183 <div class="short">Fires when the body element is scrolled
2189 Fires when the body element is scrolled
2195 <dl class="detailList">
2196 <dt class="heading">Parameters:</dt>
2199 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>scrollLeft</b>
2205 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>scrollTop</b>
2226 <td class="msource">
2231 <tr class="method-row expandable config-row-alt1 notInherited">
2232 <td class="micon"><a class="exi" href="#expand"> </a></td>
2235 <a id="Roo.grid.Grid-event-*cellclick"></a>
2237 <div class="fixedFont">
2238 <b class="itemname">cellclick</b> (Grid <B><i>this</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>)
2244 <div class="short">Fires when a cell is clicked
2250 Fires when a cell is clicked
2256 <dl class="detailList">
2257 <dt class="heading">Parameters:</dt>
2260 <span class="fixedFont">Grid</span> <b>this</b>
2266 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2272 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
2278 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2299 <td class="msource">
2304 <tr class="method-row expandable config-row-alt0 notInherited">
2305 <td class="micon"><a class="exi" href="#expand"> </a></td>
2308 <a id="Roo.grid.Grid-event-*cellcontextmenu"></a>
2310 <div class="fixedFont">
2311 <b class="itemname">cellcontextmenu</b> (Grid <B><i>this</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>cellIndex</i></B>, <a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2317 <div class="short">Fires when a cell is right clicked
2323 Fires when a cell is right clicked
2329 <dl class="detailList">
2330 <dt class="heading">Parameters:</dt>
2333 <span class="fixedFont">Grid</span> <b>this</b>
2339 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2345 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>cellIndex</b>
2351 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2372 <td class="msource">
2377 <tr class="method-row expandable config-row-alt1 notInherited">
2378 <td class="micon"><a class="exi" href="#expand"> </a></td>
2381 <a id="Roo.grid.Grid-event-*celldblclick"></a>
2383 <div class="fixedFont">
2384 <b class="itemname">celldblclick</b> (Grid <B><i>this</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>)
2390 <div class="short">Fires when a cell is double clicked
2396 Fires when a cell is double clicked
2402 <dl class="detailList">
2403 <dt class="heading">Parameters:</dt>
2406 <span class="fixedFont">Grid</span> <b>this</b>
2412 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
2418 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
2424 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2445 <td class="msource">
2450 <tr class="method-row expandable config-row-alt0 notInherited">
2451 <td class="micon"><a class="exi" href="#expand"> </a></td>
2454 <a id="Roo.grid.Grid-event-*click"></a>
2456 <div class="fixedFont">
2457 <b class="itemname">click</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2463 <div class="short">The raw click event for the entire grid.
2469 The raw click event for the entire grid.
2475 <dl class="detailList">
2476 <dt class="heading">Parameters:</dt>
2479 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2500 <td class="msource">
2505 <tr class="method-row expandable config-row-alt1 notInherited">
2506 <td class="micon"><a class="exi" href="#expand"> </a></td>
2509 <a id="Roo.grid.Grid-event-*columnmove"></a>
2511 <div class="fixedFont">
2512 <b class="itemname">columnmove</b> (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>oldIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newIndex</i></B>)
2518 <div class="short">Fires when the user moves a column
2524 Fires when the user moves a column
2530 <dl class="detailList">
2531 <dt class="heading">Parameters:</dt>
2534 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>oldIndex</b>
2540 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newIndex</b>
2561 <td class="msource">
2566 <tr class="method-row expandable config-row-alt0 notInherited">
2567 <td class="micon"><a class="exi" href="#expand"> </a></td>
2570 <a id="Roo.grid.Grid-event-*columnresize"></a>
2572 <div class="fixedFont">
2573 <b class="itemname">columnresize</b> (<a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>columnIndex</i></B>, <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a> <B><i>newSize</i></B>)
2579 <div class="short">Fires when the user resizes a column
2585 Fires when the user resizes a column
2591 <dl class="detailList">
2592 <dt class="heading">Parameters:</dt>
2595 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
2601 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>newSize</b>
2622 <td class="msource">
2627 <tr class="method-row expandable config-row-alt1 notInherited">
2628 <td class="micon"><a class="exi" href="#expand"> </a></td>
2631 <a id="Roo.grid.Grid-event-*contextmenu"></a>
2633 <div class="fixedFont">
2634 <b class="itemname">contextmenu</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2640 <div class="short">The raw contextmenu event for the entire grid.
2646 The raw contextmenu event for the entire grid.
2652 <dl class="detailList">
2653 <dt class="heading">Parameters:</dt>
2656 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2677 <td class="msource">
2682 <tr class="method-row expandable config-row-alt0 notInherited">
2683 <td class="micon"><a class="exi" href="#expand"> </a></td>
2686 <a id="Roo.grid.Grid-event-*dblclick"></a>
2688 <div class="fixedFont">
2689 <b class="itemname">dblclick</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
2695 <div class="short">The raw dblclick event for the entire grid.
2701 The raw dblclick event for the entire grid.
2707 <dl class="detailList">
2708 <dt class="heading">Parameters:</dt>
2711 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
2732 <td class="msource">
2737 <tr class="method-row expandable config-row-alt1 notInherited">
2738 <td class="micon"><a class="exi" href="#expand"> </a></td>
2741 <a id="Roo.grid.Grid-event-*dragdrop"></a>
2743 <div class="fixedFont">
2744 <b class="itemname">dragdrop</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>targetId</i></B>, event <B><i>e</i></B>)
2750 <div class="short">Fires when dragged row(s) are dropped on a valid DD target
2756 Fires when dragged row(s) are dropped on a valid DD target
2762 <dl class="detailList">
2763 <dt class="heading">Parameters:</dt>
2766 <span class="fixedFont">Grid</span> <b>this</b>
2772 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
2775 <dd>The drag drop object</dd>
2778 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>targetId</b>
2781 <dd>The target drag drop object</dd>
2784 <span class="fixedFont">event</span> <b>e</b>
2787 <dd>The raw browser event</dd>
2805 <td class="msource">
2810 <tr class="method-row expandable config-row-alt0 notInherited">
2811 <td class="micon"><a class="exi" href="#expand"> </a></td>
2814 <a id="Roo.grid.Grid-event-*dragenter
2815 Fires when the dragged row(s) first cross another DD target while being dragged"></a>
2817 <div class="fixedFont">
2818 <b class="itemname">dragenter
2819 Fires when the dragged row(s) first cross another DD target while being dragged</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>targetId</i></B>, event <B><i>e</i></B>)
2837 <dl class="detailList">
2838 <dt class="heading">Parameters:</dt>
2841 <span class="fixedFont">Grid</span> <b>this</b>
2847 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
2850 <dd>The drag drop object</dd>
2853 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>targetId</b>
2856 <dd>The target drag drop object</dd>
2859 <span class="fixedFont">event</span> <b>e</b>
2862 <dd>The raw browser event</dd>
2880 <td class="msource">
2885 <tr class="method-row expandable config-row-alt1 notInherited">
2886 <td class="micon"><a class="exi" href="#expand"> </a></td>
2889 <a id="Roo.grid.Grid-event-*dragout"></a>
2891 <div class="fixedFont">
2892 <b class="itemname">dragout</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>targetId</i></B>, event <B><i>e</i></B>)
2898 <div class="short">Fires when the dragged row(s) leave another DD target while being dragged
2904 Fires when the dragged row(s) leave another DD target while being dragged
2910 <dl class="detailList">
2911 <dt class="heading">Parameters:</dt>
2914 <span class="fixedFont">Grid</span> <b>this</b>
2920 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
2923 <dd>The drag drop object</dd>
2926 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>targetId</b>
2929 <dd>The target drag drop object</dd>
2932 <span class="fixedFont">event</span> <b>e</b>
2935 <dd>The raw browser event</dd>
2953 <td class="msource">
2958 <tr class="method-row expandable config-row-alt0 notInherited">
2959 <td class="micon"><a class="exi" href="#expand"> </a></td>
2962 <a id="Roo.grid.Grid-event-*dragover"></a>
2964 <div class="fixedFont">
2965 <b class="itemname">dragover</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, <a href="./String.html#constructor" roo:cls="String.html#constructor">String</a> <B><i>targetId</i></B>, event <B><i>e</i></B>)
2971 <div class="short">Fires while row(s) are being dragged.
2977 Fires while row(s) are being dragged. "targetId" is the id of the Yahoo.util.DD object the selected rows are being dragged over.
2983 <dl class="detailList">
2984 <dt class="heading">Parameters:</dt>
2987 <span class="fixedFont">Grid</span> <b>this</b>
2993 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
2996 <dd>The drag drop object</dd>
2999 <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a></span> <b>targetId</b>
3002 <dd>The target drag drop object</dd>
3005 <span class="fixedFont">event</span> <b>e</b>
3008 <dd>The raw browser event</dd>
3026 <td class="msource">
3031 <tr class="method-row expandable config-row-alt1 notInherited">
3032 <td class="micon"><a class="exi" href="#expand"> </a></td>
3035 <a id="Roo.grid.Grid-event-*enddrag"></a>
3037 <div class="fixedFont">
3038 <b class="itemname">enddrag</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, event <B><i>e</i></B>)
3044 <div class="short">Fires when a drag operation is complete
3050 Fires when a drag operation is complete
3056 <dl class="detailList">
3057 <dt class="heading">Parameters:</dt>
3060 <span class="fixedFont">Grid</span> <b>this</b>
3066 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
3069 <dd>The drag drop object</dd>
3072 <span class="fixedFont">event</span> <b>e</b>
3075 <dd>The raw browser event</dd>
3093 <td class="msource">
3098 <tr class="method-row expandable config-row-alt0 notInherited">
3099 <td class="micon"><a class="exi" href="#expand"> </a></td>
3102 <a id="Roo.grid.Grid-event-*headerclick"></a>
3104 <div class="fixedFont">
3105 <b class="itemname">headerclick</b> (Grid <B><i>this</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>)
3111 <div class="short">Fires when a header is clicked
3117 Fires when a header is clicked
3123 <dl class="detailList">
3124 <dt class="heading">Parameters:</dt>
3127 <span class="fixedFont">Grid</span> <b>this</b>
3133 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3139 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3160 <td class="msource">
3165 <tr class="method-row expandable config-row-alt1 notInherited">
3166 <td class="micon"><a class="exi" href="#expand"> </a></td>
3169 <a id="Roo.grid.Grid-event-*headercontextmenu"></a>
3171 <div class="fixedFont">
3172 <b class="itemname">headercontextmenu</b> (Grid <B><i>this</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>)
3178 <div class="short">Fires when a header is right clicked
3184 Fires when a header is right clicked
3190 <dl class="detailList">
3191 <dt class="heading">Parameters:</dt>
3194 <span class="fixedFont">Grid</span> <b>this</b>
3200 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>columnIndex</b>
3206 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3227 <td class="msource">
3232 <tr class="method-row expandable config-row-alt0 notInherited">
3233 <td class="micon"><a class="exi" href="#expand"> </a></td>
3236 <a id="Roo.grid.Grid-event-*headerdblclick"></a>
3238 <div class="fixedFont">
3239 <b class="itemname">headerdblclick</b> (Grid <B><i>this</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>)
3245 <div class="short">Fires when a header cell is double clicked
3251 Fires when a header cell is double clicked
3257 <dl class="detailList">
3258 <dt class="heading">Parameters:</dt>
3261 <span class="fixedFont">Grid</span> <b>this</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.grid.Grid-event-*keydown"></a>
3305 <div class="fixedFont">
3306 <b class="itemname">keydown</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">The raw keydown event for the entire grid.
3318 The raw keydown event for the entire grid.
3324 <dl class="detailList">
3325 <dt class="heading">Parameters:</dt>
3328 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3349 <td class="msource">
3354 <tr class="method-row expandable config-row-alt0 notInherited">
3355 <td class="micon"><a class="exi" href="#expand"> </a></td>
3358 <a id="Roo.grid.Grid-event-*keypress"></a>
3360 <div class="fixedFont">
3361 <b class="itemname">keypress</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3367 <div class="short">The raw keypress event for the entire grid.
3373 The raw keypress event for the entire grid.
3379 <dl class="detailList">
3380 <dt class="heading">Parameters:</dt>
3383 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3404 <td class="msource">
3409 <tr class="method-row expandable config-row-alt1 notInherited">
3410 <td class="micon"><a class="exi" href="#expand"> </a></td>
3413 <a id="Roo.grid.Grid-event-*mousedown"></a>
3415 <div class="fixedFont">
3416 <b class="itemname">mousedown</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3422 <div class="short">The raw mousedown event for the entire grid.
3428 The raw mousedown event for the entire grid.
3434 <dl class="detailList">
3435 <dt class="heading">Parameters:</dt>
3438 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3459 <td class="msource">
3464 <tr class="method-row expandable config-row-alt0 notInherited">
3465 <td class="micon"><a class="exi" href="#expand"> </a></td>
3468 <a id="Roo.grid.Grid-event-*mouseout"></a>
3470 <div class="fixedFont">
3471 <b class="itemname">mouseout</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3477 <div class="short">The raw mouseout event for the entire grid.
3483 The raw mouseout event for the entire grid.
3489 <dl class="detailList">
3490 <dt class="heading">Parameters:</dt>
3493 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3514 <td class="msource">
3519 <tr class="method-row expandable config-row-alt1 notInherited">
3520 <td class="micon"><a class="exi" href="#expand"> </a></td>
3523 <a id="Roo.grid.Grid-event-*mouseover"></a>
3525 <div class="fixedFont">
3526 <b class="itemname">mouseover</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3532 <div class="short">The raw mouseover event for the entire grid.
3538 The raw mouseover event for the entire grid.
3544 <dl class="detailList">
3545 <dt class="heading">Parameters:</dt>
3548 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3569 <td class="msource">
3574 <tr class="method-row expandable config-row-alt0 notInherited">
3575 <td class="micon"><a class="exi" href="#expand"> </a></td>
3578 <a id="Roo.grid.Grid-event-*mouseup"></a>
3580 <div class="fixedFont">
3581 <b class="itemname">mouseup</b> (<a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a> <B><i>e</i></B>)
3587 <div class="short">The raw mouseup event for the entire grid.
3593 The raw mouseup event for the entire grid.
3599 <dl class="detailList">
3600 <dt class="heading">Parameters:</dt>
3603 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3624 <td class="msource">
3629 <tr class="method-row expandable config-row-alt1 notInherited">
3630 <td class="micon"><a class="exi" href="#expand"> </a></td>
3633 <a id="Roo.grid.Grid-event-*render"></a>
3635 <div class="fixedFont">
3636 <b class="itemname">render</b> (Grid <B><i>grid</i></B>)
3642 <div class="short">Fires when the grid is rendered
3648 Fires when the grid is rendered
3654 <dl class="detailList">
3655 <dt class="heading">Parameters:</dt>
3658 <span class="fixedFont">Grid</span> <b>grid</b>
3679 <td class="msource">
3684 <tr class="method-row expandable config-row-alt0 notInherited">
3685 <td class="micon"><a class="exi" href="#expand"> </a></td>
3688 <a id="Roo.grid.Grid-event-*rowclick"></a>
3690 <div class="fixedFont">
3691 <b class="itemname">rowclick</b> (Grid <B><i>this</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>)
3697 <div class="short">Fires when a row is clicked
3703 Fires when a row is clicked
3709 <dl class="detailList">
3710 <dt class="heading">Parameters:</dt>
3713 <span class="fixedFont">Grid</span> <b>this</b>
3719 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3725 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3746 <td class="msource">
3751 <tr class="method-row expandable config-row-alt1 notInherited">
3752 <td class="micon"><a class="exi" href="#expand"> </a></td>
3755 <a id="Roo.grid.Grid-event-*rowcontextmenu"></a>
3757 <div class="fixedFont">
3758 <b class="itemname">rowcontextmenu</b> (Grid <B><i>this</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>)
3764 <div class="short">Fires when a row is right clicked
3770 Fires when a row is right clicked
3776 <dl class="detailList">
3777 <dt class="heading">Parameters:</dt>
3780 <span class="fixedFont">Grid</span> <b>this</b>
3786 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3792 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3813 <td class="msource">
3818 <tr class="method-row expandable config-row-alt0 notInherited">
3819 <td class="micon"><a class="exi" href="#expand"> </a></td>
3822 <a id="Roo.grid.Grid-event-*rowdblclick"></a>
3824 <div class="fixedFont">
3825 <b class="itemname">rowdblclick</b> (Grid <B><i>this</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>)
3831 <div class="short">Fires when a row is double clicked
3837 Fires when a row is double clicked
3843 <dl class="detailList">
3844 <dt class="heading">Parameters:</dt>
3847 <span class="fixedFont">Grid</span> <b>this</b>
3853 <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
3859 <span class="fixedFont"><a href="./Roo.EventObject.html#constructor" roo:cls="Roo.EventObject.html#constructor">Roo.EventObject</a></span> <b>e</b>
3880 <td class="msource">
3885 <tr class="method-row expandable config-row-alt1 notInherited">
3886 <td class="micon"><a class="exi" href="#expand"> </a></td>
3889 <a id="Roo.grid.Grid-event-*startdrag"></a>
3891 <div class="fixedFont">
3892 <b class="itemname">startdrag</b> (Grid <B><i>this</i></B>, Roo.GridDD <B><i>dd</i></B>, event <B><i>e</i></B>)
3898 <div class="short">Fires when row(s) start being dragged
3904 Fires when row(s) start being dragged
3910 <dl class="detailList">
3911 <dt class="heading">Parameters:</dt>
3914 <span class="fixedFont">Grid</span> <b>this</b>
3920 <span class="fixedFont">Roo.GridDD</span> <b>dd</b>
3923 <dd>The drag drop object</dd>
3926 <span class="fixedFont">event</span> <b>e</b>
3929 <dd>The raw browser event</dd>
3947 <td class="msource">
3959 <!-- ============================== footer ================================= -->
3960 <div class="fineprint" style="clear:both">
3962 Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Wed Nov 10 2010 15:19:23 GMT+0800 (HKT)
3964 <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>