Add editCell to gridPro

packages/grid-pro/src/vaadin-grid-pro-inline-editing-mixin.d.ts

@@ -39,4 +39,6 @@ export declare class InlineEditingMixinClass {
   protected _stopEdit(shouldCancel?: boolean, shouldRestoreFocus?: boolean): void;
 
   protected _switchEditCell(e: KeyboardEvent): void;
+
+  public editCell(row: Number, col: Number, userOriginated: Boolean): void;
 }

packages/grid-pro/src/vaadin-grid-pro-inline-editing-mixin.js

@@ -455,6 +455,63 @@ export const InlineEditingMixin = (superClass) =>
       super._updateItem(row, item);
     }
 
+    /**
+     * @param {Number | String} row
+     * @param {Number | String} col
+     * @param {Boolean} userOriginated
+     * @public
+     */
+    editCell(row, col, userOriginated) {
+      if (userOriginated && this.hasAttribute('disabled')) {
+        throw new Error('Grid is disabled.');
+      }
+
+      const columns = this._getColumns().filter((col) => !col.hidden);
+
+      let colIdx = -1;
+      // If col is not a number, maybe it's because the id was passed instead
+      if (isNaN(col)) {
+        const matchingColumn = columns.filter((c) => c.id == col);
+        if (!matchingColumn || matchingColumn.length == 0) {
+          throw new Error(`col with id ${col} was not found`);
+        }
+        colIdx = columns.indexOf(matchingColumn[0]);
+      } else {
+        colIdx = col;
+      }
+
+      let rowIdx = -1;
+      // If row is not a number, maybe it's because the item was passed instead
+      if (isNaN(row)) {
+        if (!Object.hasOwnProperty.call(row, 'key') || isNaN(row.key)) {
+          throw new Error('Invalid object passed as row item.');
+        }
+        rowIdx = row.key - 1;
+      } else {
+        rowIdx = row;
+      }
+
+      // Make sure col[colIdx] exists and is editable:
+      if (colIdx > columns.length || colIdx < 0) {
+        throw new Error('Invalid colIdx (out of bounds)');
+      }
+
+      const column = columns[colIdx];
+      if (!this._isEditColumn(column)) {
+        throw new Error('Column is not editable');
+      }
+
+      // Get rows (excluding header)
+      const tRows = this.$.table.getElementsByTagName('tbody').items.rows;
+
+      // Make sure row[rowIdx] exists
+      if (rowIdx > tRows.length || rowIdx < 0) {
+        throw new Error('Invalid rowIdx (out of bounds)');
+      }
+
+      this._startEdit(tRows[rowIdx].cells[colIdx], column);
+    }
+
     /**
      * Fired before exiting the cell edit mode, if the value has been changed.
      * If the default is prevented, value change would not be applied.

packages/grid-pro/test/edit-column-renderer.test.js

@@ -289,4 +289,119 @@ describe('edit column renderer', () => {
       expect(grid.items[0].name).to.equal('New');
     });
   });
+
+  describe('programatically enter edit mode', () => {
+    let grid;
+
+    beforeEach(() => {
+      grid = fixtureSync(`
+        <vaadin-grid-pro>
+          <vaadin-grid-pro-edit-column path="name" id="name"></vaadin-grid-pro-edit-column>
+          <vaadin-grid-pro-column path="age"></vaadin-grid-pro-column>
+          <vaadin-grid-column>
+            <template>[[item.name]]</template>
+          </vaadin-grid-column>
+        </vaadin-grid-pro>
+      `);
+      const column = grid.firstElementChild;
+      grid.items = createItems();
+
+      column.renderer = function (root, owner, model) {
+        root.innerHTML = '';
+        const wrapper = document.createElement('div');
+        const text = document.createTextNode(model.index + ' ' + model.item.name);
+        wrapper.appendChild(text);
+        root.appendChild(wrapper);
+      };
+
+      flushGrid(grid);
+    });
+
+    it('enter edit mode programatically should fail for user originated call when grid is disabled', () => {
+      grid.setAttribute('disabled', true);
+      expect(() => {
+        grid.editCell(10, 10, true);
+      }).to.throw(Error, 'Grid is disabled.');
+
+      expect(() => {
+        grid.editCell(0, 0, false);
+      }).to.not.throw(Error, 'Grid is disabled.');
+    });
+
+    it('enter edit mode programatically should fail for non-existing indexes', () => {
+      expect(() => {
+        grid.editCell(0, 10, false);
+      }).to.throw(Error, /out of bounds/);
+
+      expect(() => {
+        grid.editCell(10, 0, false);
+      }).to.throw(Error, /out of bounds/);
+    });
+
+    it('enter edit mode programatically should fail for non-existing column (by id)', () => {
+      expect(() => {
+        grid.editCell(0, 'name', false);
+      }).to.not.throw(Error, 'col with id name was not found');
+
+      expect(() => {
+        grid.editCell(10, 'invalid', false);
+      }).to.throw(Error, 'col with id invalid was not found');
+    });
+
+    it('enter edit mode programatically should fail for non-existing row (by key)', () => {
+      expect(() => {
+        grid.editCell({ key: 1 }, 0, false);
+      }).to.not.throw(Error, 'Invalid object passed as row item.');
+
+      expect(() => {
+        grid.editCell('invalid', 0, false);
+      }).to.throw(Error, 'Invalid object passed as row item.');
+
+      expect(() => {
+        grid.editCell({ key: 'invalid' }, 0, false);
+      }).to.throw(Error, 'Invalid object passed as row item.');
+
+      expect(() => {
+        grid.editCell({ key: -1 }, 0, false);
+      }).to.throw(Error, 'Invalid rowIdx (out of bounds)');
+    });
+
+    it('enter edit mode programatically should fail for non-editable columns', () => {
+      expect(() => {
+        grid.editCell(0, 0, false);
+      }).to.not.throw(Error, 'Column is not editable');
+
+      expect(() => {
+        grid.editCell(0, 1, false);
+      }).to.throw(Error, 'Column is not editable');
+    });
+
+    it('enter edit mode programatically (x,y) should call _startEdit', () => {
+      const cell = getContainerCell(grid.$.items, 0, 0);
+      grid.editCell(0, 0, false);
+      const editor = getCellEditor(cell);
+      expect(editor).to.be.ok;
+    });
+
+    it('enter edit mode programatically (x,colId) should call _startEdit', () => {
+      const cell = getContainerCell(grid.$.items, 0, 0);
+      grid.editCell(0, 'name', false);
+      const editor = getCellEditor(cell);
+      expect(editor).to.be.ok;
+    });
+
+    it('enter edit mode programatically (rowKey,y) should call _startEdit', () => {
+      const cell = getContainerCell(grid.$.items, 0, 0);
+      grid.editCell({ key: 1 }, 0, false);
+      const editor = getCellEditor(cell);
+      expect(editor).to.be.ok;
+    });
+
+    it('enter edit mode programatically (rowKey,colId) should call _startEdit', () => {
+      const cell = getContainerCell(grid.$.items, 0, 0);
+      grid.editCell({ key: 1 }, 'name', false);
+      const editor = getCellEditor(cell);
+      expect(editor).to.be.ok;
+    });
+  });
 });