--- /dev/null
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
+
+
+<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
+
+ <head>
+ <meta http-equiv="content-type" content="text/html; charset=undefined" />
+ <meta name="generator" content="JsDoc Toolkit" />
+
+
+ <title>JsDoc Reference - Roo.grid.EditorGrid</title>
+
+
+ <link rel="stylesheet" type="text/css" href="../../css/roojs.css" />
+ <link rel="stylesheet" type="text/css" href="../default.css" />
+
+
+ <script type="text/javascript" src="../page.js">
+
+ </script>
+
+
+ </head>
+
+ <body onload="RooDocsPage.onload();">
+
+
+<div class="body-wrap">
+
+ <!-- ============================== links to methods. ================================= -->
+
+ <div class="top-tools">
+ <!--
+ <a class="inner-link" href="#Roo.grid.EditorGrid-props"><img src="resources/s.gif" class="item-icon icon-prop">Properties</a>
+ <a class="inner-link" href="#Roo.grid.EditorGrid-methods"><img src="resources/s.gif" class="item-icon icon-method">Methods</a>
+ <a class="inner-link" href="#Roo.grid.EditorGrid-events"><img src="resources/s.gif" class="item-icon icon-event">Events</a>
+ <a class="inner-link" href="#Roo.grid.EditorGrid-configs"><img src="resources/s.gif" class="item-icon icon-config">Config Options</a>
+ <a class="bookmark" href="NEED_TO_CREATE_DIRECT_LINK_HREF"><img src="resources/s.gif" class="item-icon icon-fav">Direct Link</a>
+ -->
+ </div>
+
+
+<!-- ============================== inheritance Block. ================================= -->
+
+ <div class="inheritance res-block">
+ <pre class="res-block-inner"><a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>
+<img src="../../images/default/s.gif" height="1" width="20"/><img class="elbow" src="../../images/default/tree/elbow-end.gif"/>Roo.grid.EditorGrid
+
+ </pre>
+ </div>
+
+<!-- ============================== class title / details ============================ -->
+
+
+ <h1 class="classTitle">
+
+ Class Roo.grid.EditorGrid
+ </h1>
+
+ <table cellspacing="0" class="class-summary-table">
+
+ <tr><td class="label">Package:</td><td class="hd-info">Roo.grid</td></tr>
+
+ <tr><td class="label">Defined In:</td><td class="hd-info">
+
+ <a href="./src/Roo_grid_EditorGrid.js.html">Roo/grid/EditorGrid.js</a>.
+
+ </td></tr>
+ <tr><td class="label">Class:</td><td class="hd-info">EditorGrid</td></tr>
+
+
+
+
+ <tr><td class="label">Extends:</td><td class="hd-info">
+ <a href="./Roo.grid.Grid.html#constructor" roo:cls="Roo.grid.Grid.html#constructor">Roo.grid.Grid</a>
+
+ </td></tr>
+
+
+ </table>
+
+
+<!-- ============================== class summary ========================== -->
+ <div class="description">
+ Class for creating and editable grid.
+ </div>
+
+
+<!-- ============================== Class comment block... ========================== -->
+
+<div class="comments">
+ <b>Class Comments / Notes</B> =>
+ <u onclick="parent.CommentDialog.showCommentId = 'Roo.grid.EditorGrid';">[Add Your comment/notes about this class]</u>
+ <br/>
+ <iframe frameborder="0" id="comments-Roo.grid" style="border: none;width:100%;"
+ src="/blog.php/GtkDjsComments/Roo.grid.EditorGrid.html"></iframe>
+</div>
+
+
+
+<!-- ============================== config options ========================== -->
+
+
+
+
+ <div class="hr"></div>
+ <a id="Roo.grid.EditorGrid-configs"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Config Options (Usually are also Properties)</caption>
+
+
+ <tr>
+ <th class="sig-header" colspan="2">Options</th>
+
+ <th class="msource-header">Defined By</th>
+ </tr>
+
+
+
+
+
+ <tr class="config-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+ <td class="sig">
+
+ <a id="Roo.grid.EditorGrid-cfg-clicksToEdit" name=".clicksToEdit"></a>
+ <div class="fixedFont">
+ <b class="itemname">clicksToEdit</b> : <a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a>
+
+
+ </div>
+
+ <div class="mdesc">
+ <div class="short">The number of clicks on a cell required to display the cell's editor (defaults to 2)</div>
+ </div>
+
+ <div class="mdesc">
+ <div class="long">The number of clicks on a cell required to display the cell's editor (defaults to 2)</div>
+ </div>
+
+
+
+ </td>
+ <td class="msource">
+
+ Roo.grid.EditorGrid
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+
+
+
+
+ <!-- ============================== public properties ==================== -->
+
+
+
+ <a id="Roo.grid.EditorGrid-props"></a>
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption class="Empty">Public Properties - Has None</caption>
+ </table>
+
+
+
+
+ <!-- ============================== methods summary / details ======================== -->
+
+
+ <a id="Roo.grid.EditorGrid-methods"></a>
+ <!-- constructor?? -->
+
+ <!-- static's first
+
+
+ -->
+
+ <!-- then dynamics first -->
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Public Methods</caption>
+ <tr>
+ <th class="sig-header" colspan="2">Method</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+
+
+
+
+
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.grid-method-EditorGrid" name=".EditorGrid"></a>
+ <div class="fixedFont">
+ <span class="attributes">new <B>Roo.grid.</B></span><b class="itemname">EditorGrid</b>
+
+ (<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>dataSource</i></B>, <a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>colModel</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+
+ <div class="short">Create a new Roo.grid.EditorGrid</div>
+
+
+ <div class="long">
+
+
+
+ Create a new Roo.grid.EditorGrid
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./String.html#constructor" roo:cls="String.html#constructor">String</a>/HTMLElement/Roo.Element</span> <b>container</b>
+
+ </dt>
+ <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>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>dataSource</b>
+
+ </dt>
+ <dd>The data model to bind to</dd>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>colModel</b>
+
+ </dt>
+ <dd>The column model with info about this grid's columns</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt1 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.grid.EditorGrid-method-startEditing" name=".startEditing"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">startEditing</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>colIndex</i></B>)
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Starts editing the specified for the specified row/column</div>
+
+
+
+ <div class="long">
+
+ Starts editing the specified for the specified row/column
+
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>rowIndex</b>
+
+ </dt>
+ <dd></dd>
+
+ <dt>
+ <span class="fixedFont"><a href="./Number.html#constructor" roo:cls="Number.html#constructor">Number</a></span> <b>colIndex</b>
+
+ </dt>
+ <dd></dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.grid.EditorGrid
+
+ </td>
+ </tr>
+
+
+ <tr class="method-row config-row-alt0 expandable notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+
+ <td class="sig">
+ <a id="Roo.grid.EditorGrid-method-stopEditing" name=".stopEditing"></a>
+ <div class="fixedFont">
+ <span class="attributes"></span><b class="itemname">stopEditing</b>
+
+ ()
+
+
+
+ </div>
+ <div class="mdesc">
+
+ <div class="short">Stops any active editing</div>
+
+
+
+ <div class="long">
+
+ Stops any active editing
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+
+ Roo.grid.EditorGrid
+
+ </td>
+ </tr>
+
+
+ </table>
+
+
+ <!-- ============================== events summary / details ======================== -->
+
+
+ <a id="Roo.grid.EditorGrid-events"></a>
+
+
+
+
+
+
+
+
+ <table cellspacing="0" class="member-table">
+ <caption>Events</caption>
+ <thead>
+ <tr>
+ <th class="sig-header" colspan="2">Event</th>
+ <th class="msource-header">Defined By</th>
+
+ </tr>
+ </thead>
+
+
+
+
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.grid.EditorGrid-event-*afteredit"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">afteredit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after a cell is edited.
+
+ </div>
+
+ <div class="long">
+
+ Fires after a cell is edited. <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value being set</li><br/><li>originalValue - The original value for the field, before the edit.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/></ul>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
+
+ </dt>
+ <dd>An edit event (see above for description)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.grid.EditorGrid
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt1 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.grid.EditorGrid-event-*beforeedit"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">beforeedit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires before cell editing is triggered.
+
+ </div>
+
+ <div class="long">
+
+ Fires before cell editing is triggered. The edit event object has the following properties <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value for the field being edited.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/><li>cancel - Set this to true to cancel the edit or return false from your handler.</li><br/></ul>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
+
+ </dt>
+ <dd>An edit event (see above for description)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.grid.EditorGrid
+ </td>
+ </tr>
+
+ <tr class="method-row expandable config-row-alt0 notInherited">
+ <td class="micon"><a class="exi" href="#expand"> </a></td>
+
+ <td class="sig">
+ <a id="Roo.grid.EditorGrid-event-*validateedit"></a>
+
+ <div class="fixedFont">
+ <b class="itemname">validateedit</b> (<a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a> <B><i>e</i></B>)
+
+ </div>
+
+ <div class="mdesc">
+
+ <div class="short">Fires after a cell is edited, but before the value is set in the record.
+
+ </div>
+
+ <div class="long">
+
+ Fires after a cell is edited, but before the value is set in the record. <br/>You can use this to modify the value being set in the field, Return false<br/>to cancel the change. The edit event object has the following properties <br /><br/><ul style="padding:5px;padding-left:16px;"><br/><li>editor - This editor</li><br/><li>grid - This grid</li><br/><li>record - The record being edited</li><br/><li>field - The field name being edited</li><br/><li>value - The value being set</li><br/><li>originalValue - The original value for the field, before the edit.</li><br/><li>row - The grid row index</li><br/><li>column - The grid column index</li><br/><li>cancel - Set this to true to cancel the edit or return false from your handler.</li><br/></ul>
+
+
+
+
+
+ <dl class="detailList">
+ <dt class="heading">Parameters:</dt>
+
+ <dt>
+ <span class="fixedFont"><a href="http://developer.mozilla.org/en/docs/Core_JavaScript_1.5_Reference:Global_Objects:Object">Object</a></span> <b>e</b>
+
+ </dt>
+ <dd>An edit event (see above for description)</dd>
+
+ </dl>
+
+
+
+
+
+
+
+
+
+
+
+ </div>
+ </div>
+
+ </td>
+ <td class="msource">
+ Roo.grid.EditorGrid
+ </td>
+ </tr>
+
+
+ </table>
+
+
+
+
+
+<!-- ============================== footer ================================= -->
+ <div class="fineprint" style="clear:both">
+
+ Documentation generated by <a href="http://www.akbkhome.com" target="_blankt">Introspection Doc Generator</a> on Fri Jul 16 2010 15:55:28 GMT+0800 (HKT)
+ Based on
+ <a href="http://www.jsdoctoolkit.org/" target="_blank">JsDoc Toolkit</a>
+ </div>
+ </body>
+</html>