@refinitiv-ui/efx-grid 6.0.116 → 6.0.118

package/lib/tr-grid-contextmenu/es6/ContextMenu.js

@@ -308,6 +308,17 @@ ContextMenuPlugin.prototype.getMenuModel = function () {
 	return this._contextMenu;
 };
 
+/** @public
+* @ignore
+* @returns {Object}
+*/
+ContextMenuPlugin.prototype._getEventHandlers = function() {
+	return {
+		contextmenu: this._rightClickedHandler
+	};
+};
+
+
 /** @private
 * @param {Object} e
 * @return {!Object} Mouse related information

package/lib/tr-grid-contextmenu/es6/MenuEventAPI.d.ts

@@ -14,7 +14,7 @@ declare class MenuEventAPI {
 
     public getMenuItems(): any[]|null;
 
-    public findItem(id: number): (string)[] | any|null;
+    public findItem(id: number): any[]|null;
 
 }
 

package/lib/tr-grid-contextmenu/es6/MenuEventAPI.js

@@ -7,7 +7,7 @@
 * @param {Array} legacyColumnGroups
 */
 let MenuEventAPI = function (menuModel) {
-	this._model = menuModel;
+	this._model = menuModel || null; // for mapping string value
 	this._items = [];
 	this._runningId = 0;
 };
@@ -48,8 +48,10 @@ MenuEventAPI.prototype._addItem = function (item, level) {
 	if (typeof item === "string") { // The item is referencing another item
 		if (item === "SEPARATOR" || item.match(/-{3,}/)) { // Special keyword
 			this.addSeparator();
-		} else {
-			this._addItem(this._model.items[item], level + 1);
+		} else if(this._model) {
+			if(this._model.items) {
+				this._addItem(this._model.items[item], level + 1);
+			}
 		}
 	} else if (Array.isArray(item)) { // The item is an item list
 		let len = item.length;
@@ -67,7 +69,8 @@ MenuEventAPI.prototype.addSeparator = function () {
 	this._items.push({ type: "separator" });
 };
 
-/** @public
+/** Get immidiate child menu items
+* @public
 * @returns {Array}
 */
 MenuEventAPI.prototype.getMenuItems = function () {
@@ -76,7 +79,7 @@ MenuEventAPI.prototype.getMenuItems = function () {
 
 /** @public
 * @param {number} id
-* @returns {Array.<string> | Object}
+* @returns {Array} Array of items (ordered by leaf node to root node)
 */
 MenuEventAPI.prototype.findItem = function (id) { // For internal use
 	return this._findItem(id, this._items);
@@ -85,13 +88,15 @@ MenuEventAPI.prototype.findItem = function (id) { // For internal use
 /** @private
 * @param {number} id
 * @param {Array.<string> | Object} item
-* @returns {string}
+* @returns {Array}
 */
 MenuEventAPI.prototype._findItem = function (id, item) {
-	let foundItemPath;
 	if (!item) {
 		return null;
-	} else if (Array.isArray(item)) {
+	}
+
+	let foundItemPath;
+	if (Array.isArray(item)) {
 		let len = item.length;
 		for (let i = 0; i < len; ++i) {
 			foundItemPath = this._findItem(id, item[i]);

package/lib/tr-grid-contextmenu/es6/MenuItem.d.ts

@@ -3,7 +3,7 @@ import Ext from "../../tr-grid-util/es6/Ext.js";
 
 declare class MenuItem extends EventDispatcher {
 
-    constructor(options: any);
+    constructor(options?: any);
 
     public dispose(): void;
 
@@ -33,6 +33,8 @@ declare class MenuItem extends EventDispatcher {
 
     public getElement(): Element|null;
 
+    public getOptions(): any;
+
 }
 
 export default MenuItem;

package/lib/tr-grid-contextmenu/es6/MenuItem.js

@@ -3,7 +3,7 @@ import Ext from "../../tr-grid-util/es6/Ext.js";
 
 /** @constructor
 * @extends {EventDispatcher}
-* @param {Object} options
+* @param {Object=} options
 */
 let MenuItem = function (options) {
 	let t = this;
@@ -11,7 +11,12 @@ let MenuItem = function (options) {
 	t._onItemHovered = t._onItemHovered.bind(t);
 	t._onItemClicked = t._onItemClicked.bind(t);
 
-	t._init(options);
+	let li = document.createElement("li");
+	li.className = "tr-contextmenu-item";
+	li.addEventListener("mouseover", t._onItemHovered);
+	li.addEventListener("click", t._onItemClicked);
+	t._elem = li;
+
 	t._config(options);
 };
 Ext.inherits(MenuItem, EventDispatcher);
@@ -23,25 +28,31 @@ MenuItem.prototype._elem;
 /** @type {Object}
 * @private
 */
-MenuItem.prototype._options;
+MenuItem.prototype._options = null;
 /** @type {boolean}
 * @private
 */
 MenuItem.prototype._isSelectable = true;
-
-/** @private
-* @param {Object} options
+/** @type {string}
+* @private
 */
-MenuItem.prototype._init = function(options) {
-	let t = this;
-
-	let li = document.createElement("li");
-	li.className = "tr-contextmenu-item";
-	li.addEventListener("mouseover", t._onItemHovered);
-	li.addEventListener("click", t._onItemClicked);
-	t._elem = li;
-	t._options = options;
-};
+MenuItem.prototype._id = "";
+/** @type {string}
+* @private
+*/
+MenuItem.prototype._type = "";
+/** @type {string}
+* @private
+*/
+MenuItem.prototype._text = "";
+/** @type {*}
+* @private
+*/
+MenuItem.prototype._value = null;
+/** @type {Array}
+* @private
+*/
+MenuItem.prototype._items = null;
 
 /** @public */
 MenuItem.prototype.dispose = function() {
@@ -49,40 +60,46 @@ MenuItem.prototype.dispose = function() {
 	t.removeAllEventListeners();
 	t._elem.removeEventListener("mouseover", t._onItemHovered);
 	t._elem.removeEventListener("click", t._onItemClicked);
-	t._elem.parentNode.removeChild(t._elem);
+
+	let pn = t._elem.parentNode;
+	if(pn) {
+		pn.removeChild(t._elem);
+	}
+	t._elem = t._options = t._value = t._items = null;
 };
 
 /** @private
-* @param {*} opt_model
+* @param {*=} options
 */
-MenuItem.prototype._config = function(opt_model) {
-	if (!opt_model) opt_model = {};
-
-	let pref;
+MenuItem.prototype._config = function(options) {
+	if (!options) {
+		options = {};
+	}
 
 	let t = this;
+	t._options = options;
 
-	pref = opt_model["id"];
+	let pref = options["id"];
 	if (pref) {
 		t.setId(pref);
 	}
 
-	pref = opt_model["type"];
+	pref = options["type"];
 	if (pref) {
 		t.setType(pref);
 	}
 
-	pref = opt_model["text"];
+	pref = options["text"];
 	if (pref) {
 		t.setText(pref);
 	}
 
-	pref = opt_model["value"];
-	if (pref) {
+	pref = options["value"];
+	if (pref != null) {
 		t.setValue(pref);
 	}
 
-	pref = opt_model["isDisabled"];
+	pref = options["isDisabled"];
 	if (pref != null) {
 		if (pref === true) {
 			t.setSelectable(false);
@@ -91,7 +108,7 @@ MenuItem.prototype._config = function(opt_model) {
 		}
 	}
 
-	pref = opt_model["isSelectable"];
+	pref = options["isSelectable"];
 	if (pref != null) {
 		if (pref === false) {
 			t.setSelectable(false);
@@ -100,7 +117,7 @@ MenuItem.prototype._config = function(opt_model) {
 		}
 	}
 
-	pref = opt_model["items"];
+	pref = options["items"];
 	if (Array.isArray(pref)) {
 		t.setItems(pref);
 	}
@@ -133,6 +150,17 @@ MenuItem.prototype._onItemClicked = function(e) {
 	t._dispatch("itemClicked", e);
 };
 
+/** @public
+* @ignore
+* @returns {Object}
+*/
+MenuItem.prototype._getEventHandlers = function() {
+	return {
+		mouseover: this._onItemHovered,
+		click: this._onItemClicked
+	};
+};
+
 /** @public
 * @param {*} id
 */
@@ -146,7 +174,7 @@ MenuItem.prototype.setId = function(id) {
 * @returns {*}
 */
 MenuItem.prototype.getId = function() {
-	return this._id;
+	return this._id || "";
 };
 
 /** @public
@@ -162,7 +190,7 @@ MenuItem.prototype.setText = function(text) {
 * @returns {string}
 */
 MenuItem.prototype.getText = function() {
-	return this._text;
+	return this._text || "";
 };
 
 /** @public
@@ -206,8 +234,13 @@ MenuItem.prototype.isSelectable = function() {
 */
 MenuItem.prototype.setItems = function(items) {
 	let t = this;
-	t._items = items;
-	t._elem.classList.add("has-child");
+	if(Array.isArray(items)) {
+		t._items = items;
+		t._elem.classList.add("has-child");
+	} else {
+		t._items = null;
+		t._elem.classList.remove("has-child");
+	}
 };
 
 /** @public
@@ -229,7 +262,7 @@ MenuItem.prototype.setType = function(type) {
 * @returns {string}
 */
 MenuItem.prototype.getType = function() {
-	return this._type;
+	return this._type || "";
 };
 
 /** @public
@@ -239,6 +272,13 @@ MenuItem.prototype.getElement = function() {
 	return this._elem;
 };
 
+/** @public
+* @returns {Object}
+*/
+MenuItem.prototype.getOptions = function() {
+	return this._options;
+};
+
 
 
 export default MenuItem;

package/lib/tr-grid-contextmenu/es6/PopupMenu.d.ts

@@ -21,7 +21,11 @@ declare class PopupMenu extends EventDispatcher {
 
     public addPopupChild(element: Element|null, popupMenu: PopupMenu|null): void;
 
-    public setMenu(menuItems: (any)[]|null): void;
+    public setMenu(menuOptions: (any)[]|null): void;
+
+    public getMenuItems(): (MenuItem)[]|null;
+
+    public getChildPopups(): (PopupMenu)[]|null;
 
 }
 

package/lib/tr-grid-contextmenu/es6/PopupMenu.js

@@ -30,11 +30,11 @@ PopupMenu.prototype._evtArg;
 /** @type {Array.<PopupMenu>}
 * @private
 */
-PopupMenu.prototype._children;
+PopupMenu.prototype._nestedPopups;
 /** @type {Array.<MenuItem>}
 * @private
 */
-PopupMenu.prototype._childrenItem;
+PopupMenu.prototype._menuItems;
 /** @type {Element}
 * @private
 */
@@ -59,6 +59,10 @@ PopupMenu.prototype._ulElem;
 * @private
 */
 PopupMenu.prototype._isMounted;
+/** @type {string}
+* @private
+*/
+PopupMenu.prototype._id = "";
 
 /** @private
 * @param {Element} parentElement
@@ -76,8 +80,8 @@ PopupMenu.prototype._init = function(parentElement) {
 	t._popup.setPositioning("custom");
 	t._ulElem = ul;
 
-	t._children = [];
-	t._childrenItem = [];
+	t._nestedPopups = [];
+	t._menuItems = [];
 	t._x = 0;
 	t._y = 0;
 	t._isMounted = true;
@@ -107,21 +111,24 @@ PopupMenu.prototype.dispose = function () {
 	}
 };
 
-/** @private */
+/** @private
+* @function
+* @param {*} obj
+*/
+let _disposeObject = function(obj) {
+	if(obj) {
+		obj.dispose();
+	}
+};
+
+/** @private
+*/
 PopupMenu.prototype._disposeChildren = function () {
 	let t = this;
-	t._children.forEach(function (child) {
-		if (child) {
-			child.dispose();
-		}
-	});
-	t._childrenItem.forEach(function (child) {
-		if (child) {
-			child.dispose();
-		}
-	});
-	t._children.length = 0;
-	t._childrenItem.length = 0;
+	t._nestedPopups.forEach(_disposeObject);
+	t._menuItems.forEach(_disposeObject);
+	t._nestedPopups.length = 0;
+	t._menuItems.length = 0;
 };
 
 /** @public */
@@ -162,9 +169,11 @@ PopupMenu.prototype.setPosition = function(positioning, x, y) {
 		let sx = (window.scrollX != null) ? window.scrollX : window.pageXOffset;
 		let sy = (window.scrollY != null) ? window.scrollY : window.pageYOffset;
 		let rb = ww + sx; // view port right bound
-		let bb = wh + sy; // view port bottom boundnd
-		let aw = t._popup._elem.offsetWidth;
-		let ah = t._popup._elem.offsetHeight;
+		let bb = wh + sy; // view port bottom bound
+
+		let popupElem = t._popup.getElement();
+		let aw = popupElem.offsetWidth;
+		let ah = popupElem.offsetHeight;
 
 		if (x + aw > rb) { // Do not overflow right bound
 			x = rb - aw;
@@ -173,8 +182,8 @@ PopupMenu.prototype.setPosition = function(positioning, x, y) {
 			y = bb - ah;
 		}
 
-		t._popup._elem.style.left = (x - sx) + "px"; // Due to fixed position we have to subtract window scrolling
-		t._popup._elem.style.top = (y - sy) + "px";
+		popupElem.style.left = (x - sx) + "px"; // Due to fixed position we have to subtract window scrolling
+		popupElem.style.top = (y - sy) + "px";
 	}
 };
 
@@ -186,32 +195,30 @@ PopupMenu.prototype.addPopupChild = function(element, popupMenu) {
 	if (popupMenu instanceof PopupMenu) {
 		popupMenu.attachTo(element, "right");
 		this._popup.addFocusElement(popupMenu._popup);
-		this._children.push(popupMenu);
+		this._nestedPopups.push(popupMenu);
 	}
 };
 
 /** @public
-* @param {Array.<Object>} menuItems
+* @param {Array.<Object>} menuOptions Array of MenuItem options
 */
-PopupMenu.prototype.setMenu = function (menuItems) {
-	if (!menuItems || !Array.isArray(menuItems)) { return; }
-
+PopupMenu.prototype.setMenu = function (menuOptions) {
 	let t = this;
 
-	// Clear existing before set a new items.
-	if (Array.isArray(t._menuItems)) {
+	// Clear existing before set a new items
+	if (t._menuItems.length) {
 		t._disposeChildren();
 	}
 
-	t._menuItems = menuItems;
-
-	for (let i = 0; i < menuItems.length; i++) {
-		let item = menuItems[i];
+	if (!menuOptions || !Array.isArray(menuOptions)) {
+		return;
+	}
 
-		let menuItem = new MenuItem(item);
+	for (let i = 0; i < menuOptions.length; i++) {
+		let menuItem = new MenuItem(menuOptions[i]);
 		menuItem.addEventListener("itemHovered", t._hoveredItem);
 		menuItem.addEventListener("itemClicked", t._clickedItem);
-		t._childrenItem.push(menuItem);
+		t._menuItems.push(menuItem);
 
 		if (Array.isArray(menuItem.getItems())) {
 			let pm = new PopupMenu(t._parentElement);
@@ -225,22 +232,32 @@ PopupMenu.prototype.setMenu = function (menuItems) {
 		t._ulElem.appendChild(menuItem.getElement());
 	}
 };
+/** @public
+* @returns {Array.<MenuItem>}
+*/
+PopupMenu.prototype.getMenuItems = function () {
+	return this._menuItems;
+};
+/** @public
+* @returns {Array.<PopupMenu>}
+*/
+PopupMenu.prototype.getChildPopups = function () {
+	return this._nestedPopups;
+};
 
 /** @private
 * @param {Event} e
 */
 PopupMenu.prototype._hoveredChildItem = function (e) {
-	let t = this;
-	t._dispatch("itemHovered", e);
+	this._dispatch("itemHovered", e);
 };
 
 /** @private
 * @param {Event} e
 */
 PopupMenu.prototype._clickedChildItem = function (e) {
-	let t = this;
-	t._dispatch("itemClicked", e);
-	t.hide();
+	this._dispatch("itemClicked", e);
+	this.hide();
 };
 
 /** @private
@@ -249,18 +266,20 @@ PopupMenu.prototype._clickedChildItem = function (e) {
 PopupMenu.prototype._hoveredItem = function (e) {
 	let t = this;
 	let evt = t._evtArg;
-	let element = e.srcElement;
-	let children = t._children;
-
-	if (element && !!children.length) {
-		for (let i = 0; i < children.length; i++) {
-			let child = children[i];
-			if (child._id === element.getAttribute("id")) {
-				child.show();
+	let elem = e.srcElement;
+
+	if (elem) {
+		let pms = t._nestedPopups;
+		let pmCount = pms.length;
+		let elemId = elem.getAttribute("id");
+		for (let i = 0; i < pmCount; i++) {
+			let pm = pms[i];
+			if (pm._id === elemId) {
+				pm.show();
 			} else {
-				child.hide();
+				pm.hide();
 			}
-		}
+		} // WARNING: evt or _evtArg is not customized to reflect the item that is hovered
 	} else {
 		evt = e;
 	}
@@ -273,15 +292,7 @@ PopupMenu.prototype._hoveredItem = function (e) {
 */
 PopupMenu.prototype._clickedItem = function(e) {
 	let t = this;
-	if (e.item && e.item.id) {
-		for (let i = 0; i < t._menuItems.length; i++) {
-			let menuItem = t._menuItems[i];
-			if (menuItem.id === e.item.id) {
-				t._evtArg["item"] = menuItem;
-				break;
-			}
-		}
-	}
+	t._evtArg["item"] = e["item"];
 	t._dispatch("itemClicked", t._evtArg);
 	t.hide();
 };

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

@@ -6,6 +6,7 @@ import { ElfUtil } from "../../tr-grid-util/es6/ElfUtil.js";
 import { isTouchDevice, injectCss, prettifyCss } from "../../tr-grid-util/es6/Util.js";
 import { ElfDate } from "../../tr-grid-util/es6/ElfDate.js";
 import { CoralItems } from "../../tr-grid-util/es6/CoralItems.js";
+import { Conflator } from "../../tr-grid-util/es6/Conflator.js";
 
 declare namespace InCellEditingPlugin {
 
@@ -85,6 +86,8 @@ declare class InCellEditingPlugin extends GridPlugin {
 
     public showStarterText(bool?: boolean|null): void;
 
+    public _requestUpdateStarterText(): void;
+
     public isEditing(): boolean;
 
     public getTextBox(columnIndex?: number|null, grid?: any): Element|null;