@refinitiv-ui/efx-grid 6.0.159 → 6.0.160

package/lib/rt-grid/es6/Grid.d.ts

@@ -266,6 +266,8 @@ declare class Grid extends EventDispatcher {
 
     public setStaticData(rowRef: Grid.RowReference|null, field: string, value: any): void;
 
+    public clearColumnData(colRefs: Grid.ColumnReference|(Grid.ColumnReference)[]|null): void;
+
     public getColumnIndex(colRef: Grid.ColumnReference|null): number;
 
     public getColumnIndices(colRefs: (Grid.ColumnReference)[]|null): (number)[];

package/lib/rt-grid/es6/Grid.js

@@ -3274,22 +3274,46 @@ Grid.prototype._getRowId = function(rowRef) {
 	return "";
 };
 
+/** Clear all existing data from the specified column(s).
+* @public
+* @param {Grid~ColumnReference|Array.<Grid~ColumnReference>} colRefs
+*/
+Grid.prototype.clearColumnData = function(colRefs) {
+	let colIndices = this.getColumnIndices(colRefs);
+	let colCount = colIndices.length;
+	if(!colCount) {
+		return;
+	}
+	let emptyData = {};
+	for(let c = 0; c < colCount; ++c) {
+		let colIndex = colIndices[c];
+		let field = this.getColumnField(colIndex);
+		if(field) {
+			emptyData[field] = null;
+		}
+	}
+
+	let rowDefs = this.getAllRowDefinitions();
+	let rowCount = rowDefs.length;
+	for(let r = 0; r < rowCount; ++r) {
+		rowDefs[r].setRowData(emptyData); // There is a conflator caching the data change in DataCache
+	}
+};
+
 /** @public
 * @param {Grid~ColumnReference} colRef
 * @return {number}
 */
 Grid.prototype.getColumnIndex = function(colRef) {
-	if(colRef) {
-		if(colRef instanceof ColumnDefinition) {
-			let colCount = this.getColumnCount();
-			for(let i = 0; i < colCount; ++i) {
-				let colDef = this.getColumnDefinition(i);
-				if(colDef === colRef) {
-					return i;
-				}
+	if(colRef instanceof ColumnDefinition) {
+		let colCount = this.getColumnCount();
+		for(let i = 0; i < colCount; ++i) {
+			let colDef = this.getColumnDefinition(i);
+			if(colDef === colRef) {
+				return i;
 			}
-			return -1;
 		}
+		return -1;
 	}
 	return this._grid.getColumnIndex(colRef);
 };
@@ -3300,14 +3324,16 @@ Grid.prototype.getColumnIndex = function(colRef) {
 */
 Grid.prototype.getColumnIndices = function(colRefs) {
 	let ary = [];
-	let colCount = this.getColumnCount();
-	let inputAry = Array.isArray(colRefs) ? colRefs : [colRefs];
-	let len = inputAry.length;
-	// Verify user input
-	for(let i = 0; i < len; ++i) {
-		let colIndex = this.getColumnIndex(inputAry[i]);
-		if(colIndex >= 0 && colIndex < colCount) {
-			ary.push(colIndex); // WARNING: We have not checked for duplication
+	if(colRefs || colRefs === 0) {
+		let colCount = this.getColumnCount();
+		let inputAry = Array.isArray(colRefs) ? colRefs : [colRefs];
+		let len = inputAry.length;
+		// Verify user input
+		for(let i = 0; i < len; ++i) {
+			let colIndex = this.getColumnIndex(inputAry[i]);
+			if(colIndex >= 0 && colIndex < colCount) {
+				ary.push(colIndex); // WARNING: We have not checked for duplication
+			}
 		}
 	}
 	return ary;

package/lib/tr-grid-in-cell-editing/es6/InCellEditing.d.ts

@@ -108,6 +108,8 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public isColumnEditable(colIndex: number): boolean;
 
+    public setColumnEditability(colIndex: number, bool?: (boolean|null)|null): void;
+
     public enableReadonly(enabled?: boolean|null): void;
 
     public disableReadonly(disabled?: boolean|null): void;

package/lib/tr-grid-in-cell-editing/es6/InCellEditing.js

@@ -86,7 +86,8 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 /** @event InCellEditingPlugin#editorClosed
 * @description Fired after the text editor has been closed and all operations are done. This is useful to clean up left over resource and get result text entered.
 * @type {Object}
-* @property {string=} text Text that user has entered
+* @property {*=} text Converted value from the text that user has entered. The value is used for the commit.
+* @property {string=} enteredText Text that user has entered. The text is not used for the commit. The text will be undefined, if the text has not been changed from the initial text at the opening.
 * @property {boolean=} groupHeader This value is set to true if the editing row is a group header.
 * @property {boolean=} segmentSeparator This value is set to true if the editing row is a segment separator.
 * @property {Object} suggestionDetail Suggestion detail for auto suggest "item-select" event
@@ -97,7 +98,8 @@ import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 /** @event InCellEditingPlugin#beforeCommit
 * @description Fired before the actual text commit (i.e. after user press enter). This is used for validating or modifying user input, and canceling the operation
 * @type {Object}
-* @property {string=} text Text that user has entered
+* @property {*=} text Converted value (with appropriate data type) from the text that user has entered. The value will be committed or stored on Grid.
+* @property {string=} enteredText Text that user has entered. The text will NOT be committed or stored on Grid. The text will be undefined, if the text has not been changed from the initial text at the opening.
 * @property {boolean=} cancel Set to true to cancel the commit operation.
 * @property {boolean=} groupHeader This value is set to true if the editing row is a group header.
 * @property {boolean=} segmentSeparator This value is set to true if the editing row is a segment separator.
@@ -1388,6 +1390,15 @@ InCellEditingPlugin.prototype.isColumnEditable = function (colIndex) {
 	let val = this._getColumnOption(colIndex, "editableContent");
 	return val == null ? this._editableContent : val;
 };
+/** Change editability of the specified column at runtime
+* @public
+* @param {number} colIndex
+* @param {(boolean|null)=} bool If null or undefined value is specified, the editability will be decided by other extension settings
+*/
+InCellEditingPlugin.prototype.setColumnEditability = function (colIndex, bool) {
+	let colData = this._newColumnData(colIndex);
+	colData["editableContent"] = (bool != null) ? bool : null;
+};
 
 /**
 * @public
@@ -1479,6 +1490,20 @@ InCellEditingPlugin.prototype._onDoubleClick = function (e, opt_host) {
 	t.openEditor(arg.colIndex, arg.rowIndex, arg.section, host);
 };
 
+/** @private
+* @param {Object} section Section (LayoutGrid) object
+* @returns {string} bgColor
+*/
+InCellEditingPlugin.prototype._getSectionBGColor = function (section) {
+	if(this._elfVersion || this._inlineStyling) {
+		let computedStyle = section.getComputedStyle();
+		if(computedStyle) {
+			return computedStyle.backgroundColor;
+		}
+	}
+	return "";
+};
+
 /** @private
 * @param {Element} e
 * @param {Object} host core grid object
@@ -1570,10 +1595,7 @@ InCellEditingPlugin.prototype._openEditor = function (e, host, arg) {
 	}
 
 	let editorStyle = editor.style;
-	if(this._elfVersion || t._inlineStyling) {
-		editorStyle.backgroundColor = section.getComputedStyle().backgroundColor;
-	}
-
+	editorStyle.backgroundColor = this._getSectionBGColor(section);
 	let rowH = section.getRowHeight(rowIndex);
 	let width = cell.getWidth();
 	if(!host.isPinnedColumn(colIndex)) {
@@ -1657,10 +1679,10 @@ InCellEditingPlugin.prototype._openEditor = function (e, host, arg) {
 	t._editing = true; // Editing state cannot be false until a text has been committed or cancelled
 };
 
-/** Using to open row editor.
+/** Open the row editor on the specified row
 * @public
-* @param {number} rowIndex
-* @param {Object=} grid core grid object
+* @param {number} rowIndex Row index of a row to be opened.
+* @param {Object=} grid Core grid object used mainly for multi-table configuration. No need to supply this parameter for default single grid configuration.
 * @fires InCellEditingPlugin#rowEditorOpened
 */
 InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
@@ -1670,6 +1692,9 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 	if(t._getRowIndex(t._activeRowId) === rowIndex || !grid || t._readonly) {
 		return;
 	}
+	if(grid.isDisposed()) {
+		return;
+	}
 
 	t.closeRowEditor(false, grid);
 	t._commitText(false);
@@ -1680,7 +1705,7 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 	let dataSource = grid.getDataSource();
 	let colCount = section.getColumnCount();
 	let isBottom = (rowIndex + 1) >= section.getRowCount();
-	let sectionBGColor = (this._elfVersion || t._inlineStyling) ? section.getComputedStyle().backgroundColor : null;
+	let sectionBGColor = this._getSectionBGColor(section);
 	let rowH = section.getRowHeight(rowIndex);
 
 	// if normally parent popup will be document.body
@@ -1744,9 +1769,7 @@ InCellEditingPlugin.prototype.openRowEditor = function (rowIndex, grid) {
 
 		let editor = inCellCache["editor"];
 		let editorStyle = editor.style;
-		if(sectionBGColor) {
-			editorStyle.backgroundColor = sectionBGColor;
-		}
+		editorStyle.backgroundColor = sectionBGColor;
 		editorStyle.height = rowH + "px";
 
 		// row editing mode does not support balloon mode
@@ -2105,7 +2128,11 @@ InCellEditingPlugin.prototype._commitText = function (committed, suggestionDetai
 	arg["section"].removeClass("edit-mode");
 	t._editing = false;
 
-	let enteredValue = arg["text"] = this.getValue();
+	let enteredValue = arg["text"] = t.getValue();
+	let enteredText = t.getText();
+	if(enteredText !== t._initialText) {
+		arg["enteredText"] = enteredText;
+	}
 	let groupHeader = arg["groupHeader"] || false;
 
 	if(committed){
@@ -2123,7 +2150,7 @@ InCellEditingPlugin.prototype._commitText = function (committed, suggestionDetai
 			let sectionType = sectionSettings.getType();
 			// case edit content
 			if("content" === sectionType) {
-				if(this._realTimeGrid && arg["field"] === "X_RIC_NAME") {
+				if(t._realTimeGrid && arg["field"] === "X_RIC_NAME") {
 					let ricOpt = null;
 					if(suggestionDetail) {
 						let suggestionVal = suggestionDetail["value"];
@@ -2135,11 +2162,11 @@ InCellEditingPlugin.prototype._commitText = function (committed, suggestionDetai
 						}
 					}
 
-					this._realTimeGrid.setRic(arg["rowId"], enteredValue, ricOpt);
+					t._realTimeGrid.setRic(arg["rowId"], enteredValue, ricOpt);
 				} else {
 					let dv = sectionSettings.getDataSource();
 					if(dv) {
-						if(this._realTimeGrid) {
+						if(t._realTimeGrid) {
 							t._setStaticData(dv, arg["rowIndex"], arg["field"], enteredValue);
 						} else {
 							t._setData(dv, arg["rowIndex"], arg["field"], enteredValue);
@@ -2151,7 +2178,7 @@ InCellEditingPlugin.prototype._commitText = function (committed, suggestionDetai
 					t._activeCell.setContent(enteredValue);
 				}
 			} else if("title" === sectionType) {
-				let gridApi = this.getGridApi();
+				let gridApi = t.getGridApi();
 				if(gridApi) {
 					gridApi.setColumnName(arg["colIndex"], enteredValue);
 				}
@@ -2174,7 +2201,7 @@ InCellEditingPlugin.prototype._commitText = function (committed, suggestionDetai
 	Dom.removeParent(t._customElement);
 
 	let grid = arg["grid"];
-	this._requestUpdateStarterText(); // Need to updaate starter text when text commit
+	t._requestUpdateStarterText(); // Need to updaate starter text when text commit
 	if(grid) {
 		t._freezeScrolling(grid, false);
 		grid.focus();

package/lib/types/es6/InCellEditing.d.ts

@@ -108,6 +108,8 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public isColumnEditable(colIndex: number): boolean;
 
+    public setColumnEditability(colIndex: number, bool?: (boolean|null)|null): void;
+
     public enableReadonly(enabled?: boolean|null): void;
 
     public disableReadonly(disabled?: boolean|null): void;

package/lib/types/es6/RealtimeGrid/Grid.d.ts

@@ -303,6 +303,8 @@ declare class Grid extends EventDispatcher {
 
     public setStaticData(rowRef: Grid.RowReference|null, field: string, value: any): void;
 
+    public clearColumnData(colRefs: Grid.ColumnReference|(Grid.ColumnReference)[]|null): void;
+
     public getColumnIndex(colRef: Grid.ColumnReference|null): number;
 
     public getColumnIndices(colRefs: (Grid.ColumnReference)[]|null): (number)[];

package/lib/versions.json

@@ -19,7 +19,7 @@
 	"tr-grid-contextmenu": "1.0.44",
 	"tr-grid-filter-input": "0.9.43",
 	"tr-grid-heat-map": "1.0.30",
-	"tr-grid-in-cell-editing": "1.0.93",
+	"tr-grid-in-cell-editing": "1.0.94",
 	"tr-grid-pagination": "1.0.24",
 	"tr-grid-percent-bar": "1.0.24",
 	"tr-grid-range-bar": "2.0.9",

package/package.json

@@ -69,5 +69,5 @@
 	"publishConfig": {
 		"access": "public"
 	},
-	"version": "6.0.159"
+	"version": "6.0.160"
 }