123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363 |
- <!DOCTYPE html>
- <html>
- <head>
- <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
- <title>The source code</title>
- <link href="../resources/prettify/prettify.css" type="text/css" rel="stylesheet" />
- <script type="text/javascript" src="../resources/prettify/prettify.js"></script>
- <style type="text/css">
- .highlight { display: block; background-color: #ddd; }
- </style>
- <script type="text/javascript">
- function highlight() {
- document.getElementById(location.hash.replace(/#/, "")).className = "highlight";
- }
- </script>
- </head>
- <body onload="prettyPrint(); highlight();">
- <pre class="prettyprint lang-js"><span id='Ext-grid-plugin-RowEditing'>/**
- </span> * The Ext.grid.plugin.RowEditing plugin injects editing at a row level for a Grid. When editing begins,
- * a small floating dialog will be shown for the appropriate row. Each editable column will show a field
- * for editing. There is a button to save or cancel all changes for the edit.
- *
- * The field that will be used for the editor is defined at the
- * {@link Ext.grid.column.Column#editor editor}. The editor can be a field instance or a field configuration.
- * If an editor is not specified for a particular column then that column won't be editable and the value of
- * the column will be displayed. To provide a custom renderer for non-editable values, use the
- * {@link Ext.grid.column.Column#editRenderer editRenderer} configuration on the column.
- *
- * The editor may be shared for each column in the grid, or a different one may be specified for each column.
- * An appropriate field type should be chosen to match the data structure that it will be editing. For example,
- * to edit a date, it would be useful to specify {@link Ext.form.field.Date} as the editor.
- *
- * @example
- * Ext.create('Ext.data.Store', {
- * storeId:'simpsonsStore',
- * fields:['name', 'email', 'phone'],
- * data: [
- * {"name":"Lisa", "email":"lisa@simpsons.com", "phone":"555-111-1224"},
- * {"name":"Bart", "email":"bart@simpsons.com", "phone":"555-222-1234"},
- * {"name":"Homer", "email":"home@simpsons.com", "phone":"555-222-1244"},
- * {"name":"Marge", "email":"marge@simpsons.com", "phone":"555-222-1254"}
- * ]
- * });
- *
- * Ext.create('Ext.grid.Panel', {
- * title: 'Simpsons',
- * store: Ext.data.StoreManager.lookup('simpsonsStore'),
- * columns: [
- * {header: 'Name', dataIndex: 'name', editor: 'textfield'},
- * {header: 'Email', dataIndex: 'email', flex:1,
- * editor: {
- * xtype: 'textfield',
- * allowBlank: false
- * }
- * },
- * {header: 'Phone', dataIndex: 'phone'}
- * ],
- * selType: 'rowmodel',
- * plugins: [
- * Ext.create('Ext.grid.plugin.RowEditing', {
- * clicksToEdit: 1
- * })
- * ],
- * height: 200,
- * width: 400,
- * renderTo: Ext.getBody()
- * });
- *
- */
- Ext.define('Ext.grid.plugin.RowEditing', {
- extend: 'Ext.grid.plugin.Editing',
- alias: 'plugin.rowediting',
- requires: [
- 'Ext.grid.RowEditor'
- ],
- editStyle: 'row',
- <span id='Ext-grid-plugin-RowEditing-cfg-autoCancel'> /**
- </span> * @cfg {Boolean} autoCancel
- * True to automatically cancel any pending changes when the row editor begins editing a new row.
- * False to force the user to explicitly cancel the pending changes. Defaults to true.
- */
- autoCancel: true,
- <span id='Ext-grid-plugin-RowEditing-cfg-clicksToMoveEditor'> /**
- </span> * @cfg {Number} clicksToMoveEditor
- * The number of clicks to move the row editor to a new row while it is visible and actively editing another row.
- * This will default to the same value as {@link Ext.grid.plugin.Editing#clicksToEdit clicksToEdit}.
- */
- <span id='Ext-grid-plugin-RowEditing-cfg-errorSummary'> /**
- </span> * @cfg {Boolean} errorSummary
- * True to show a {@link Ext.tip.ToolTip tooltip} that summarizes all validation errors present
- * in the row editor. Set to false to prevent the tooltip from showing. Defaults to true.
- */
- errorSummary: true,
- constructor: function() {
- var me = this;
- me.callParent(arguments);
- if (!me.clicksToMoveEditor) {
- me.clicksToMoveEditor = me.clicksToEdit;
- }
- me.autoCancel = !!me.autoCancel;
- },
- init: function(grid) {
- this.callParent([grid]);
- },
- <span id='Ext-grid-plugin-RowEditing-method-destroy'> /**
- </span> * @private
- * AbstractComponent calls destroy on all its plugins at destroy time.
- */
- destroy: function() {
- var me = this;
- Ext.destroy(me.editor);
- me.callParent(arguments);
- },
- <span id='Ext-grid-plugin-RowEditing-method-startEdit'> /**
- </span> * Starts editing the specified record, using the specified Column definition to define which field is being edited.
- * @param {Ext.data.Model} record The Store data record which backs the row to be edited.
- * @param {Ext.data.Model} columnHeader The Column object defining the column to be edited.
- * @return `true` if editing was started, `false` otherwise.
- */
- startEdit: function(record, columnHeader) {
- var me = this,
- editor = me.getEditor();
- if ((editor.beforeEdit() !== false) && (me.callParent(arguments) !== false)) {
- editor.startEdit(me.context.record, me.context.column);
- return true;
- }
- return false;
- },
- // private
- cancelEdit: function() {
- var me = this;
- if (me.editing) {
- me.getEditor().cancelEdit();
- me.callParent(arguments);
- }
- },
- // private
- completeEdit: function() {
- var me = this;
- if (me.editing && me.validateEdit()) {
- me.editing = false;
- me.fireEvent('edit', me, me.context);
- }
- },
- // private
- validateEdit: function() {
- var me = this,
- editor = me.editor,
- context = me.context,
- record = context.record,
- newValues = {},
- originalValues = {},
- editors = editor.items.items,
- e,
- eLen = editors.length,
- name, item;
- for (e = 0; e < eLen; e++) {
- item = editors[e];
- name = item.name;
- newValues[name] = item.getValue();
- originalValues[name] = record.get(name);
- }
- Ext.apply(context, {
- newValues : newValues,
- originalValues : originalValues
- });
- return me.callParent(arguments) && me.getEditor().completeEdit();
- },
- // private
- getEditor: function() {
- var me = this;
- if (!me.editor) {
- me.editor = me.initEditor();
- }
- return me.editor;
- },
- // private
- initEditor: function() {
- var me = this,
- grid = me.grid,
- view = me.view,
- headerCt = grid.headerCt,
- btns = ['saveBtnText', 'cancelBtnText', 'errorsText', 'dirtyText'],
- b,
- bLen = btns.length,
- cfg = {
- autoCancel: me.autoCancel,
- errorSummary: me.errorSummary,
- fields: headerCt.getGridColumns(),
- hidden: true,
- view: view,
- // keep a reference..
- editingPlugin: me,
- renderTo: view.el
- },
- item;
- for (b = 0; b < bLen; b++) {
- item = btns[b];
- if (Ext.isDefined(me[item])) {
- cfg[item] = me[item];
- }
- }
- return Ext.create('Ext.grid.RowEditor', cfg);
- },
- // private
- initEditTriggers: function() {
- var me = this,
- view = me.view,
- moveEditorEvent = me.clicksToMoveEditor === 1 ? 'click' : 'dblclick';
- me.callParent(arguments);
- if (me.clicksToMoveEditor !== me.clicksToEdit) {
- me.mon(view, 'cell' + moveEditorEvent, me.moveEditorByClick, me);
- }
- view.on({
- render: function() {
- me.mon(me.grid.headerCt, {
- scope: me,
- columnresize: me.onColumnResize,
- columnhide: me.onColumnHide,
- columnshow: me.onColumnShow,
- columnmove: me.onColumnMove
- });
- },
- single: true
- });
- },
- startEditByClick: function() {
- var me = this;
- if (!me.editing || me.clicksToMoveEditor === me.clicksToEdit) {
- me.callParent(arguments);
- }
- },
- moveEditorByClick: function() {
- var me = this;
- if (me.editing) {
- me.superclass.onCellClick.apply(me, arguments);
- }
- },
-
- // private
- onColumnAdd: function(ct, column) {
- if (column.isHeader) {
- var me = this,
- editor;
- me.initFieldAccessors(column);
- // Only inform the editor about a new column if the editor has already been instantiated,
- // so do not use getEditor which instantiates the editor if not present.
- editor = me.editor;
- if (editor && editor.onColumnAdd) {
- editor.onColumnAdd(column);
- }
- }
- },
- // private
- onColumnRemove: function(ct, column) {
- if (column.isHeader) {
- var me = this,
- editor = me.getEditor();
- if (editor && editor.onColumnRemove) {
- editor.onColumnRemove(column);
- }
- me.removeFieldAccessors(column);
- }
- },
- // private
- onColumnResize: function(ct, column, width) {
- if (column.isHeader) {
- var me = this,
- editor = me.getEditor();
- if (editor && editor.onColumnResize) {
- editor.onColumnResize(column, width);
- }
- }
- },
- // private
- onColumnHide: function(ct, column) {
- // no isHeader check here since its already a columnhide event.
- var me = this,
- editor = me.getEditor();
- if (editor && editor.onColumnHide) {
- editor.onColumnHide(column);
- }
- },
- // private
- onColumnShow: function(ct, column) {
- // no isHeader check here since its already a columnshow event.
- var me = this,
- editor = me.getEditor();
- if (editor && editor.onColumnShow) {
- editor.onColumnShow(column);
- }
- },
- // private
- onColumnMove: function(ct, column, fromIdx, toIdx) {
- // no isHeader check here since its already a columnmove event.
- var me = this,
- editor = me.getEditor();
- if (editor && editor.onColumnMove) {
- // Must adjust the toIdx to account for removal if moving rightwards
- // because RowEditor.onColumnMove just calls Container.move which does not do this.
- editor.onColumnMove(column, fromIdx, toIdx - (toIdx > fromIdx ? 1 : 0));
- }
- },
- // private
- setColumnField: function(column, field) {
- var me = this,
- editor = me.getEditor();
-
- editor.removeField(column);
- me.callParent(arguments);
- me.getEditor().setField(column);
- }
- });
- </pre>
- </body>
- </html>
|