X-Git-Url: http://git.ithinksw.org/extjs.git/blobdiff_plain/7a654f8d43fdb43d78b63d90528bed6e86b608cc..HEAD:/docs/source/Editing.html diff --git a/docs/source/Editing.html b/docs/source/Editing.html index b866990a..00b62133 100644 --- a/docs/source/Editing.html +++ b/docs/source/Editing.html @@ -1,15 +1,27 @@ -
+ +-/** - * @class Ext.grid.plugin.Editing - -This class provides an abstract grid editing plugin on selected {@link Ext.grid.column.Column columns}. -The editable columns are specified by providing an {@link Ext.grid.column.Column#editor editor} -in the {@link Ext.grid.column.Column column configuration}. - -*Note:* This class should not be used directly. See {@link Ext.grid.plugin.CellEditing} and -{@link Ext.grid.plugin.RowEditing}. - - * @markdown + + + + +\ No newline at end of file +}); +The source code + + + + + + +/** + * This class provides an abstract grid editing plugin on selected {@link Ext.grid.column.Column columns}. + * The editable columns are specified by providing an {@link Ext.grid.column.Column#editor editor} + * in the {@link Ext.grid.column.Column column configuration}. + * + * **Note:** This class should not be used directly. See {@link Ext.grid.plugin.CellEditing} and + * {@link Ext.grid.plugin.RowEditing}. */ Ext.define('Ext.grid.plugin.Editing', { alias: 'editing.editing', @@ -23,9 +35,9 @@ Ext.define('Ext.grid.plugin.Editing', { observable: 'Ext.util.Observable' }, - /** + /** * @cfg {Number} clicksToEdit - * The number of clicks on a grid required to display the editor (defaults to 2). + * The number of clicks on a grid required to display the editor. */ clicksToEdit: 2, @@ -61,7 +73,8 @@ Ext.define('Ext.grid.plugin.Editing', { me.grid = grid; me.view = grid.view; me.initEvents(); - me.initFieldAccessors(me.view.getGridColumns()); + me.mon(grid, 'reconfigure', me.onReconfigure, me); + me.onReconfigure(); grid.relayEvents(me, ['beforeedit', 'edit', 'validateedit']); // Marks the grid as editable, so that the SelectionModel @@ -70,7 +83,15 @@ Ext.define('Ext.grid.plugin.Editing', { grid.editingPlugin = grid.view.editingPlugin = me; }, - /** + /** + * Fires after the grid is reconfigured + * @private + */ + onReconfigure: function(){ + this.initFieldAccessors(this.view.getGridColumns()); + }, + + /** * @private * AbstractComponent calls destroy on all its plugins at destroy time. */ @@ -233,18 +254,19 @@ Ext.define('Ext.grid.plugin.Editing', { this.startEdit(record, view.getHeaderAtIndex(colIdx)); }, - /** + /** * @private - * @abstract. Template method called before editing begins. + * @template + * Template method called before editing begins. * @param {Object} context The current editing context * @return {Boolean} Return false to cancel the editing process */ beforeEdit: Ext.emptyFn, - /** - * Start editing the specified record, using the specified Column definition to define which field is being edited. - * @param {Model} record The Store data record which backs the row to be edited. - * @param {Model} columnHeader The Column object defining the column to be edited. + /** + * Starts editing the specified record, using the specified Column definition to define which field is being edited. + * @param {Ext.data.Model/Number} record The Store data record which backs the row to be edited, or index of the record in Store. + * @param {Ext.grid.column.Column/Number} columnHeader The Column object defining the column to be edited, or index of the column. */ startEdit: function(record, columnHeader) { var me = this, @@ -258,8 +280,9 @@ Ext.define('Ext.grid.plugin.Editing', { me.editing = true; }, - /** - * @private Collects all information necessary for any subclasses to perform their editing functions. + /** + * @private + * Collects all information necessary for any subclasses to perform their editing functions. * @param record * @param columnHeader * @returns {Object} The editing context based upon the passed record and column @@ -300,15 +323,15 @@ Ext.define('Ext.grid.plugin.Editing', { }; }, - /** - * Cancel any active edit that is in progress. + /** + * Cancels any active edit that is in progress. */ cancelEdit: function() { this.editing = false; }, - /** - * Complete the edit if there is an active edit in progress. + /** + * Completes the edit if there is an active edit in progress. */ completeEdit: function() { var me = this; @@ -328,4 +351,7 @@ Ext.define('Ext.grid.plugin.Editing', { return me.fireEvent('validateedit', me, context) !== false && !context.cancel; } -});