examples/docs/output/Ext.ux.grid.RowEditor.html

   1 <div class="body-wrap" xmlns:ext="http://www.extjs.com"><div class="top-tools"><a class="inner-link" href="#Ext.ux.grid.RowEditor-props"><img src="resources/images/default/s.gif" class="item-icon icon-prop">Properties</a>&#13;<a class="inner-link" href="#Ext.ux.grid.RowEditor-methods"><img src="resources/images/default/s.gif" class="item-icon icon-method">Methods</a>&#13;<a class="inner-link" href="#Ext.ux.grid.RowEditor-events"><img src="resources/images/default/s.gif" class="item-icon icon-event">Events</a>&#13;<a class="bookmark" href="../docs/?class=Ext.ux.grid.RowEditor"><img src="resources/images/default/s.gif" class="item-icon icon-fav">Direct Link</a>&#13;</div><h1>Class <a href="source/ux-all-debug.html#cls-Ext.ux.grid.RowEditor">Ext.ux.grid.RowEditor</a></h1><table cellspacing="0"><tr><td class="label">Package:</td><td class="hd-info">Ext.ux.grid</td></tr><tr><td class="label">Defined In:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.grid.RowEditor">ux-all-debug.js</a></td></tr><tr><td class="label">Class:</td><td class="hd-info"><a href="source/ux-all-debug.html#cls-Ext.ux.grid.RowEditor">RowEditor</a></td></tr><tr><td class="label">Extends:</td><td class="hd-info">Object</td></tr></table><div class="description">Plugin (ptype = 'roweditor') that adds the ability to rapidly edit full rows in a grid.
   2 A validation mode may be enabled which uses AnchorTips to notify the user of all
   3 validation errors at once.</div><div class="hr"></div><a id="Ext.ux.grid.RowEditor-props"></a><h2>Public Properties</h2><div class="no-members">This class has no public properties.</div><a id="Ext.ux.grid.RowEditor-methods"></a><h2>Public Methods</h2><div class="no-members">This class has no public methods.</div><a id="Ext.ux.grid.RowEditor-events"></a><h2>Public Events</h2><table cellspacing="0" class="member-table"><tbody><tr><th colspan="2" class="sig-header">Event</th><th class="msource-header">Defined By</th></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-afteredit"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.grid.RowEditor-afteredit">afteredit</a></b> :
   4                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Object&nbsp;changes</code>,&nbsp;<code>Ext.data.Record&nbsp;r</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
   5     <div class="mdesc"><div class="short">Fired after a row is edited and passes validation.  This event is fired
   6 after the store's update event is fired with ...</div><div class="long">Fired after a row is edited and passes validation.  This event is fired
   7 after the store's update event is fired with this edit.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>changes</code> : Object<div class="sub-desc">Object with changes made to the record.</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The Record that was edited.</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-afteredit"></a><b><a href="source/RowEditor.html#event-Ext.ux.grid.RowEditor-afteredit">afteredit</a></b> :
   8                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Object&nbsp;changes</code>,&nbsp;<code>Ext.data.Record&nbsp;r</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
   9     <div class="mdesc"><div class="short">Fired after a row is edited and passes validation.  This event is fired
  10 after the store's update event is fired with ...</div><div class="long">Fired after a row is edited and passes validation.  This event is fired
  11 after the store's update event is fired with this edit.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>changes</code> : Object<div class="sub-desc">Object with changes made to the record.</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The Record that was edited.</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-beforeedit"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.grid.RowEditor-beforeedit">beforeedit</a></b> :
  12                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
  13     <div class="mdesc"><div class="short">Fired before the row editor is activated.
  14 If the listener returns false the editor will not be activated.</div><div class="long">Fired before the row editor is activated.
  15 If the listener returns <tt>false</tt> the editor will not be activated.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-beforeedit"></a><b><a href="source/RowEditor.html#event-Ext.ux.grid.RowEditor-beforeedit">beforeedit</a></b> :
  16                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
  17     <div class="mdesc"><div class="short">Fired before the row editor is activated.
  18 If the listener returns false the editor will not be activated.</div><div class="long">Fired before the row editor is activated.
  19 If the listener returns <tt>false</tt> the editor will not be activated.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-canceledit"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.grid.RowEditor-canceledit">canceledit</a></b> :
  20                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Boolean&nbsp;forced</code>&nbsp;)
  21     <div class="mdesc"><div class="short">Fired when the editor is cancelled.</div><div class="long">Fired when the editor is cancelled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>forced</code> : Boolean<div class="sub-desc">True if the cancel button is pressed, false is the editor was invalid.</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-canceledit"></a><b><a href="source/RowEditor.html#event-Ext.ux.grid.RowEditor-canceledit">canceledit</a></b> :
  22                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Boolean&nbsp;forced</code>&nbsp;)
  23     <div class="mdesc"><div class="short">Fired when the editor is cancelled.</div><div class="long">Fired when the editor is cancelled.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>forced</code> : Boolean<div class="sub-desc">True if the cancel button is pressed, false is the editor was invalid.</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-validateedit"></a><b><a href="source/ux-all-debug.html#event-Ext.ux.grid.RowEditor-validateedit">validateedit</a></b> :
  24                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Object&nbsp;changes</code>,&nbsp;<code>Ext.data.Record&nbsp;r</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
  25     <div class="mdesc"><div class="short">Fired after a row is edited and passes validation.
  26 If the listener returns false changes to the record will not be se...</div><div class="long">Fired after a row is edited and passes validation.
  27 If the listener returns <tt>false</tt> changes to the record will not be set.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>changes</code> : Object<div class="sub-desc">Object with changes made to the record.</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The Record that was edited.</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr><tr class="method-row expandable "><td class="micon"><a href="#expand" class="exi">&nbsp;</a></td><td class="sig"><a id="Ext.ux.grid.RowEditor-validateedit"></a><b><a href="source/RowEditor.html#event-Ext.ux.grid.RowEditor-validateedit">validateedit</a></b> :
  28                                       (&nbsp;<code>Ext.ux.grid.RowEditor&nbsp;roweditor</code>,&nbsp;<code>Object&nbsp;changes</code>,&nbsp;<code>Ext.data.Record&nbsp;r</code>,&nbsp;<code>Number&nbsp;rowIndex</code>&nbsp;)
  29     <div class="mdesc"><div class="short">Fired after a row is edited and passes validation.
  30 If the listener returns false changes to the record will not be se...</div><div class="long">Fired after a row is edited and passes validation.
  31 If the listener returns <tt>false</tt> changes to the record will not be set.<div class="mdetail-params"><strong style="font-weight: normal;">Listeners will be called with the following arguments:</strong><ul><li><code>roweditor</code> : Ext.ux.grid.RowEditor<div class="sub-desc">This object</div></li><li><code>changes</code> : Object<div class="sub-desc">Object with changes made to the record.</div></li><li><code>r</code> : Ext.data.Record<div class="sub-desc">The Record that was edited.</div></li><li><code>rowIndex</code> : Number<div class="sub-desc">The rowIndex of the row just edited</div></li></ul></div></div></div></td><td class="msource">RowEditor</td></tr></tbody></table></div>