@refinitiv-ui/efx-grid 6.0.118 → 6.0.120

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

@@ -547,6 +547,13 @@ ColumnDefinition.getDataType = function(field) {
 	return "";
 };
 /** @public
+* @ignore
+* @return {boolean|string|null}
+*/
+ColumnDefinition.prototype.getTooltipValue = function() {
+	return this._tooltip;
+};
+/** @public
 * @return {string}
 */
 ColumnDefinition.prototype.getTooltip = function() {

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

@@ -274,11 +274,11 @@ let _hasFieldOrId = function(colDef, str) {
 };
 
 /** Compare the difference in the 'id' property.
- * @private
- * @param {Object} obj1
- * @param {Object} obj2
- * @returns {boolean} If the id property of two objects is equal, the return will be true, otherwise it will be false.
- */
+* @private
+* @param {Object} obj1
+* @param {Object} obj2
+* @returns {boolean} If the id property of two objects is equal, the return will be true, otherwise it will be false.
+*/
 let _hasMatchingId = function(obj1, obj2) {
 	if(!obj1 || !obj2 || !obj1.id || !obj2.id) { // Handle nullable, if the object or id have null, it's means difference value
 		return false;
@@ -286,6 +286,25 @@ let _hasMatchingId = function(obj1, obj2) {
 	return obj1.id === obj2.id;
 };
 
+/** @private
+* @param {Object} e
+*/
+let _preventDefault = function(e) {
+	if(e) {
+		e.preventDefault();
+	}
+};
+/** @private
+* @param {number=} id
+* @returns {number} Always return 0
+*/
+let _clearTimeout = function(id) {
+	if(id) {
+		clearTimeout(id);
+	}
+	return 0;
+};
+
 /** @constructor
 * @extends {EventDispatcher}
 * @param {(Element|null)=} placeholder
@@ -596,10 +615,6 @@ Grid.prototype._topSection = true;
 * @private
 */
 Grid.prototype._focusingArgs = null;
-/** @type {number}
-* @private
-*/
-Grid.prototype._scrolledRow = -1;
 /** @type {boolean}
 * @private
 */
@@ -614,10 +629,8 @@ Grid.prototype.dispose = function() {
 		clearInterval(this._autoLayoutTimer);
 		this._autoLayoutTimer = 0;
 	}
-	if(this._pollingTimerId) {
-		clearTimeout(this._pollingTimerId);
-		this._pollingTimerId = 0;
-	}
+	this._pollingTimerId = _clearTimeout(this._pollingTimerId);
+
 	this.removeAllColumns(); // Some conflators are reset
 	this.removeAllRows(); // Some conflators are reset
 	this._sorter.dispose();
@@ -640,9 +653,8 @@ Grid.prototype.dispose = function() {
 	}
 
 	if(this._focusingArgs) {
-		if(this._focusingArgs.id) {
-			clearTimeout(this._focusingArgs.id);
-		}
+		_clearTimeout(this._focusingArgs.id);
+		_clearTimeout(this._focusingArgs.timeoutId);
 		this._focusingArgs = null;
 	}
 };
@@ -947,6 +959,7 @@ Grid.prototype.initialize = function(gridOption) {
 	this.addListener(gridOption, "beforeContentBinding");
 	this.addListener(gridOption, "firstRendered");
 	this.addListener(gridOption, "afterContentBinding");
+	this.addListener(gridOption, "tabNavigation");
 
 	if(gridOption["autoDateConversion"]) {
 		t._autoDateConversion = true;
@@ -2290,9 +2303,46 @@ Grid.prototype.setColumnSorter = function(colRef, func) {
 * @param {!RowDefinition} rowDef
 */
 Grid.prototype._initDuplicateRicData = function(rowDef) {
+	if(!rowDef) {
+		return;
+	}
+	let rowDefs = this._connector.getRowDefByRic(rowDef.getSymbol());
+	if(rowDefs && rowDefs.length > 0) { // Found at least 1 Duplicate chain/ric data
+		let firstRowDef = rowDefs[0];
+		rowDef.copyRowData(firstRowDef);
+		if(rowDef.isChain()) {
+			let children = firstRowDef.getChildren();
+			if(children && children.length > 0) {
+				setTimeout(this._cloneChain.bind(this, rowDef), 0); // Need to delay to wait row inserted
+			}
+		}
+	}
+};
+
+/** @private
+* @param {Object} rowDef
+* @param {Array<Object>} children
+*/
+Grid.prototype._cloneChain = function(rowDef) {
 	let rowDefs = this._connector.getRowDefByRic(rowDef.getSymbol());
-	if(rowDefs) {
-		rowDef.copyRowData(rowDefs[0]);
+	let firstRowDef = rowDefs ? rowDefs[0] : null;
+	let constituents = firstRowDef ? firstRowDef.getChildren() : null;
+
+	if(!constituents) {
+		return;
+	}
+	let count = constituents.length;
+	if(count < 0 ) {
+		return;
+	}
+
+	let subId = rowDef.getData(SUB_ID);
+	for (let i = 0; i < count; i++) {
+		let childRowDef = constituents[i];
+		let rowData = childRowDef.cloneRowData();
+		rowData["SUB_ID"] = subId;
+		let rid = subId + rowData["RIC"];
+		this._dc.setRowData(rid, rowData);
 	}
 };
 /** @public
@@ -3426,12 +3476,15 @@ Grid.prototype._renderColumnHeader = function(colIndex, arg) {
 	let colName = colDef.getName();
 	let colTooltip = colDef.getTooltip();
 	let headerAlignment = colDef.getHeaderAlignment();
+	let tooltipValue = colDef.getTooltipValue();
 
 	for(let r = 0; r < rowCount; ++r) {
 		let tCell = tSection.getCell(colIndex, r, false);
 		// Default behaviors
 		tCell.setContent(colName);
-		tCell.setTooltip(colTooltip);
+		tCell.setTooltipInfo("columnDefault", tooltipValue);
+		tCell.setTooltipInfo("columnTooltip", colTooltip);
+		tCell.updateTooltip();
 		tCell.setStyle("textAlign", headerAlignment);
 
 		if(customRenderer) {
@@ -4179,38 +4232,49 @@ Grid.prototype.getVScrollView = function () {
 	return this._grid.getVScrollView();
 };
 
-/** @private
-* @param {Element} el
-* @return {boolean}
-*/
-function isFocusableContent(el) {
-	if(el) {
-		return (el.tagName !== "SPAN" && !el.disabled);
-	}
-	return false;
-}
 /** @private
 * @param {Object} cell
+* @param {Object} args
 * @return {boolean}
 */
-function focusCell(cell) {
+Grid.prototype._focusCell = function(cell, args) {
 	if(cell) {
 		let cellContent = cell.getContent();
-		if(cellContent && isFocusableContent(cellContent)) {
-			cellContent.focus();
-			return true;
+		if(cellContent) {
+			let nfe = null;
+			if(this.hasListener("tabNavigation")) {
+				let tabNavArg = {
+					"shiftKey": args.shiftKey,
+					"activeElement": args.activeElement,
+					"cellContent": cellContent,
+					"cell": cell,
+					"colIndex": args.colIndex,
+					"rowIndex": args.rowIndex,
+					"field": args.fields ? args.fields[args.colIndex] : ""
+				};
+				this._dispatch("tabNavigation", tabNavArg);
+				nfe = tabNavArg.nextFocusableElement;
+			} else if(cellContent.tagName !== "SPAN") {
+				nfe = cellContent;
+			}
+
+			if(nfe && nfe !== args.activeElement && !nfe.disabled) {
+				nfe.focus();
+				return true;
+			}
 		}
 	}
 	return false;
-}
+};
 /** @private
 */
 Grid.prototype._onVScroll = function() {
 	let args = this._focusingArgs;
 	if(args) {
+		args.timeoutId = _clearTimeout(args.timeoutId);
 		this._focusingArgs = null;
 		let cell = this._grid.getCell("content", args.colIndex, args.rowIndex);
-		if(!focusCell(cell)) {
+		if(!this._focusCell(cell, args)) {
 			if(args.shiftKey) {
 				this._focusPrevCellContent(args);
 			} else {
@@ -4221,6 +4285,11 @@ Grid.prototype._onVScroll = function() {
 };
 /** @private
 */
+Grid.prototype._onScrollTimeout = function() {
+	this._focusingArgs = null;
+};
+/** @private
+*/
 Grid.prototype._selfScrollToRow = function() {
 	let args = this._focusingArgs;
 	if(args) {
@@ -4230,20 +4299,14 @@ Grid.prototype._selfScrollToRow = function() {
 };
 /** @private
 * @param {Object} args
-* @param {number} colIndex
-* @param {number} rowIndex
 */
-Grid.prototype._requestScroll = function(args, colIndex, rowIndex) {
-	if(this._focusingArgs || this._scrolledRow === args.rowIndex) {
-		return; // Avoid infinite loop
+Grid.prototype._requestScroll = function(args) {
+	if(!this._focusingArgs) {
+		this._focusingArgs = args;
+		args.event = null; // The event is invalid after the scroll
+		args.id = setTimeout(this._selfScrollToRow, 0); // Avoid event loop protection
+		args.timeoutId = setTimeout(this._onScrollTimeout, 100); // To avoid a fail case where scroll cannot be performed
 	}
-
-	this._scrolledRow = args.rowIndex;
-	this._focusingArgs = args;
-	args.colIndex = colIndex;
-	args.rowIndex = rowIndex;
-	args.event = null; // The event is invalid after the scroll
-	args.id = setTimeout(this._selfScrollToRow); // Avoid event loop protection
 };
 /** @private
 * @param {Object} args
@@ -4267,28 +4330,27 @@ Grid.prototype._focusNextCellContent = function(args) {
 			startIdx = i;
 		}
 	}
-	// If the current focus is on a valid content, starts on the next cell
-	if(args.event && args.validContent) {
-		startIdx++;
-	}
 
 	let grid = this._grid;
 	let section = grid.getSection("content");
 	let viewInfo = grid.getVerticalViewInfo();
 	let lastFullRow = viewInfo.lastFullRow;
 	let rowCount = this.getRowCount();
+
+	args.fields = grid.getColumnFields();
 	for(let r = rowIndex; r < rowCount; r++) {
+		args.rowIndex = r;
 		for(i = startIdx; i < len; i++) {
 			let c = focusableColIndices[i];
+			args.colIndex = c;
 			if(r > lastFullRow) {
-				this._requestScroll(args, c, r);
+				_preventDefault(args.event);
+				this._requestScroll(args);
 				return;
 			} else {
 				let cell = section.getCell(c, r);
-				if(focusCell(cell)) {
-					if(args.event) {
-						args.event.preventDefault();
-					}
+				if(this._focusCell(cell, args)) {
+					_preventDefault(args.event);
 					return;
 				}
 			}
@@ -4296,9 +4358,8 @@ Grid.prototype._focusNextCellContent = function(args) {
 		startIdx = 0;
 	}
 
-	if(args.validContent) { // The current focus on the last focusable content
-		this._grid.getHiddenInput().focus();
-	}
+	// The current focus on the last focusable content
+	this._grid.getHiddenInput().focus();
 };
 /** @private
 * @param {Object} args
@@ -4322,27 +4383,26 @@ Grid.prototype._focusPrevCellContent = function(args) {
 			startIdx = i;
 		}
 	}
-	// If the current focus is on a valid content, starts on the next cell
-	if(args.event && args.validContent) {
-		--startIdx;
-	}
 
 	let grid = this._grid;
 	let section = grid.getSection("content");
 	let viewInfo = grid.getVerticalViewInfo();
 	let firstFullRow = viewInfo.firstFullRow;
+
+	args.fields = this.getColumnFields();
 	for(let r = rowIndex; r >= 0; r--) {
+		args.rowIndex = r;
 		for(i = startIdx; i >= 0; i--) {
 			let c = focusableColIndices[i];
+			args.colIndex = c;
 			if(r < firstFullRow) {
-				this._requestScroll(args, c, r);
+				_preventDefault(args.event);
+				this._requestScroll(args);
 				return;
 			} else {
 				let cell = section.getCell(c, r);
-				if(focusCell(cell)) {
-					if(args.event) {
-						args.event.preventDefault();
-					}
+				if(this._focusCell(cell, args)) {
+					_preventDefault(args.event);
 					return;
 				}
 			}
@@ -4350,15 +4410,18 @@ Grid.prototype._focusPrevCellContent = function(args) {
 		startIdx = len - 1;
 	}
 
-	if(args.validContent) { // The current focus on the last focusable content
-		this._grid.getHiddenInput(true).focus();
-	}
+	// The current focus on the last focusable content
+	this._grid.getHiddenInput(true).focus();
 };
 
 /** @private
 * @param {Object} e
 */
 Grid.prototype._onTabNavigation = function(e) {
+	if(this._focusingArgs) {
+		return; // Cannot do another tab navigation while waiting for scrolling
+	}
+
 	let colDefs = this.getColumnDefinitions();
 	let colCount = colDefs.length;
 
@@ -4373,19 +4436,8 @@ Grid.prototype._onTabNavigation = function(e) {
 		return;
 	}
 
-	this._scrolledRow = -1; // Reset the scroll loop protector
 	let keyEvt = e.event;
 	let pos = this.getRelativePosition(keyEvt);
-	let validContent = true;
-	let activeElement = e.activeElement;
-	if(activeElement) {
-		validContent = !activeElement.classList.contains("valigner");
-	}
-
-	if(validContent) {
-		let content = pos["cell"] ? pos["cell"].getContent() : null;
-		validContent = isFocusableContent(content);
-	}
 	let startingRowIndex = pos["rowIndex"];
 	if(e.onTheEdge) {
 		let viewInfo = this._grid.getVerticalViewInfo();
@@ -4397,7 +4449,7 @@ Grid.prototype._onTabNavigation = function(e) {
 		colIndex: pos["colIndex"],
 		rowIndex: startingRowIndex,
 		focusableColIndices: focusableColIndices,
-		validContent: validContent
+		activeElement: e.activeElement
 	};
 
 	if(keyEvt.shiftKey) {
@@ -4407,5 +4459,15 @@ Grid.prototype._onTabNavigation = function(e) {
 	}
 };
 
+/** @public
+* @ignore
+* @return {!Object}
+*/
+Grid.prototype._getEventHandlers = function() {
+	return {
+		"tabNavigation": this._onTabNavigation
+	};
+};
+
 export { Grid };
 export default Grid;

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

@@ -64,6 +64,8 @@ declare class RowDefinition {
 
     public copyRowData(srcRowDef: RowDefinition|null): void;
 
+    public cloneRowData(obj?: any, exceptionObj?: any): any;
+
     public setRowData(data: { [key: string]:  any }): void;
 
     public setData(field: string, value: any): void;

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

@@ -704,28 +704,38 @@ RowDefinition.prototype.updateRowData = function(data, indexToFieldMap) {
 */
 RowDefinition.prototype.copyRowData = function(srcRowDef) {
 	if(srcRowDef && srcRowDef !== this) {
-		let field;
-		let uncopiable_fields = {
-			"ROW_DEF": 1,
-			"SUB_ID": 1
-		};
-		let staticValues = this._staticValues;
-		for(field in staticValues) {
-			uncopiable_fields[field] = 1;
-		}
-		staticValues = srcRowDef._staticValues;
-		for(field in staticValues) {
-			uncopiable_fields[field] = 1;
-		}
-
-		let srcRowData = srcRowDef.getRowData();
 		let rowData = this.getRowData();
-		for(field in srcRowData) {
-			if(!uncopiable_fields[field]) {
-				rowData[field] = srcRowData[field]; // There is no dataChanged event fired
-			}
+		srcRowDef.cloneRowData(rowData, this._staticValues);
+	}
+};
+/** @public
+ * @param {Object=} obj
+ * @param {Object=} exceptionObj
+ * @return {!Object}
+*/
+RowDefinition.prototype.cloneRowData = function(obj, exceptionObj) {
+	let rowObj = obj || {};
+	let field;
+	let uncopiable_fields = {
+		"ROW_DEF": 1,
+		"SUB_ID": 1
+	};
+	let staticValues = this._staticValues;
+	for(field in staticValues) {
+		uncopiable_fields[field] = 1;
+	}
+
+	for(field in exceptionObj) {
+		uncopiable_fields[field] = 1;
+	}
+
+	let rowData = this.getRowData();
+	for(field in rowData) {
+		if(!uncopiable_fields[field]) {
+			rowObj[field] = rowData[field];
 		}
 	}
+	return rowObj;
 };
 /** @public
 * @param {Object.<string, *>} data

package/lib/tr-grid-auto-tooltip/es6/AutoTooltip.js

@@ -417,28 +417,31 @@ AutoTooltipPlugin.prototype._updateNonContentSection = function (section, colInd
 		var elem = cell.getContent();
 		if(!elem) { return false; }
 
-		// Set tooltip only if text's length is longer than column width.
-		var tooltip = cell.getAttribute("tooltip") || cell.getTooltip();
+		var tooltipInfo = cell.getTooltipInfo();
+		if(tooltipInfo) {
+			if(tooltipInfo["userTooltip"] != null ||
+				tooltipInfo["groupHeaderDefault"] != null ||
+				tooltipInfo["columnDefault"] != null) {
+
+				cell.setTooltipInfo("clippedText", false);
+				cell.removeAttribute("ef-title");
+				continue;
+			}
+		}
 
+		// Set tooltip only if text's length is longer than column width.
 		var sw = elem.scrollWidth;
 		if(sw && sw > elem.offsetWidth) {
-			if(!tooltip) {
-				tooltip = cell.getTextContent(); // TODO: Allow custom tooltip text
-				cell._autoTooltip = true;
-			}
-		} else {
-			if(cell._autoTooltip) {
-				tooltip = "";
-				cell._autoTooltip = false;
-			}
-		}
+			cell.setTooltipInfo("clippedText", true);
 
-		cell.setTooltip(tooltip); // TODO: Avoiding using getter and setter in the same loop
-		if(tooltip) {
-			cell.setAttribute("ef-title", tooltip); // to make sure ef-title value will actually change
+			var tooltip = cell.getTextContent();
+			cell.setTooltipInfo("clippedTextTooltip", tooltip);
+			cell.setAttribute("ef-title", tooltip);
 		} else {
+			cell.setTooltipInfo("clippedText", false);
 			cell.removeAttribute("ef-title");
 		}
+		cell.updateTooltip();
 	}
 	return true;
 };

package/lib/tr-grid-column-grouping/es6/ColumnGrouping.js

@@ -516,6 +516,9 @@ ColumnGroupingPlugin.prototype._applyGrouping = function () {
 						cell.removeClass("no-sort");
 						cell.removeClass("selected-group");
 						cell.removeAttribute("group-id");
+						cell.setTooltipInfo("groupHeaderDefault", false);
+						cell.setTooltipInfo("groupHeaderTooltip", null);
+						cell.updateTooltip();
 					}
 				}
 			}
@@ -909,7 +912,9 @@ ColumnGroupingPlugin.prototype._renderGroup = function(groupDef, section) {
 	if(cell) {
 		// Overide the defaults
 		cell.setStyle("text-align", groupDef["alignment"] || "");
-		cell.setTooltip(ColumnGroupingPlugin._getTooltip(groupDef));
+		cell.setTooltipInfo("groupHeaderDefault", groupDef["tooltip"]);
+		cell.setTooltipInfo("groupHeaderTooltip", ColumnGroupingPlugin._getTooltip(groupDef));
+		cell.updateTooltip();
 		cell.setContent(groupDef["name"] || groupDef["title"]);
 
 		// Additional cell settings must be removed in the _applyGrouping() method

package/lib/tr-grid-column-stack/es6/ColumnStack.js

@@ -297,7 +297,8 @@ ColumnStackPlugin._styles = prettifyCss([
 		"cursor: pointer;" // change the mouse cursor on the collapsed stack icon to allow for expansion but disallow sorting
 	],
 	".tr-grid .collapsed .cell.grouping .floating-panel .stack-icon", [
-		"margin-left: 0;"
+		"margin-left: 0;",
+		"margin-right: 0;"
 	],
 	".stack-icon", [
 		"color: var(--grid-title-filter-icon-color);"

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

@@ -106,9 +106,9 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public isColumnEditable(colIndex: number): boolean;
 
-    public enableReadonly(bool: boolean): void;
+    public enableReadonly(enabled?: boolean|null): void;
 
-    public disableReadonly(bool: boolean): void;
+    public disableReadonly(disabled?: boolean|null): void;
 
     public openRowEditor(rowIndex: number, grid?: any): void;
 

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

@@ -1387,17 +1387,22 @@ InCellEditingPlugin.prototype.isColumnEditable = function (colIndex) {
 
 /**
 * @public
-* @param {boolean} bool
+* @param {boolean=} enabled
 */
-InCellEditingPlugin.prototype.enableReadonly = function (bool) {
-	this._readonly = bool !== false;
+InCellEditingPlugin.prototype.enableReadonly = function (enabled) {
+	this._readonly = enabled !== false;
+	if(this._readonly) {
+		this._updateStaterText(false);
+	} else {
+		this._updateStaterText();
+	}
 };
 /**
 * @public
-* @param {boolean} bool
+* @param {boolean=} disabled
 */
-InCellEditingPlugin.prototype.disableReadonly = function () {
-	this.enableReadonly(false);
+InCellEditingPlugin.prototype.disableReadonly = function (disabled) {
+	this.enableReadonly(disabled === false);
 };
 /** @public
 * @description Supply an keyboard input. This is for testing purpose.

package/lib/tr-grid-row-dragging/es6/RowDragging.d.ts

@@ -73,8 +73,6 @@ declare class RowDraggingPlugin extends GridPlugin {
 
     public setJETDragContent(content: any): void;
 
-    public setJETDragContent(content: any): void;
-
 }
 
 export default RowDraggingPlugin;