@refinitiv-ui/efx-grid 6.0.105 → 6.0.107

package/lib/tr-grid-printer/es6/GridPrinter.js

@@ -9,7 +9,7 @@ import { SectionWriter } from "./SectionWriter.js";
 /** @private
 * @type {Node}
 */
-var _dummyNode = null;
+let _dummyNode = null;
 
 
 /** TODO: Move this logic to PrintTrait
@@ -17,9 +17,9 @@ var _dummyNode = null;
 * @param {Object=} options
 * @return {!Object}
 */
-var _getPageSize = function (options) {
-	var pageWidth = 0;
-	var pageHeight = 0;
+let _getPageSize = function (options) {
+	let pageWidth = 0;
+	let pageHeight = 0;
 
 	if (options) {
 		if (options["pageWidth"]) {
@@ -50,7 +50,7 @@ var _getPageSize = function (options) {
 * @param {Node} nodeA
 * @param {Node} nodeB
 */
-var swapNode = function (nodeA, nodeB) {
+let swapNode = function (nodeA, nodeB) {
 	if (!nodeA || !nodeB || !nodeA.parentNode || !nodeB.parentNode) {
 		Dom.removeParent(nodeA);
 		Dom.removeParent(nodeB);
@@ -69,9 +69,9 @@ var swapNode = function (nodeA, nodeB) {
 * @param {Node} fromNode
 * @param {Node} toNode
 */
-var copyNode = function (fromNode, toNode) {
+let copyNode = function (fromNode, toNode) {
 	if (fromNode && toNode) {
-		var i, attrs;
+		let i, attrs;
 		if (toNode.hasAttributes()) {
 			attrs = toNode.attributes;
 			for (i = attrs.length; --i >= 0;) {
@@ -88,8 +88,8 @@ var copyNode = function (fromNode, toNode) {
 
 		Dom.removeChildren(toNode);
 
-		var chdr = fromNode.childNodes;
-		var childCount = chdr.length;
+		let chdr = fromNode.childNodes;
+		let childCount = chdr.length;
 		for (i = 0; i < childCount; ++i) {
 			toNode.appendChild(chdr[i].cloneNode(true));
 		}
@@ -101,14 +101,14 @@ var copyNode = function (fromNode, toNode) {
 * @param {number} colIndex
 * @param {string} alignment
 */
-var _setColumnAlignment = function (tbl, colIndex, alignment) {
+let _setColumnAlignment = function (tbl, colIndex, alignment) {
 	if (!alignment || alignment === "default") {
 		return;
 	}
-	var cells = tbl.getCellsInColumn(colIndex);
+	let cells = tbl.getCellsInColumn(colIndex);
 	if (!cells) return;
-	for (var i = cells.length; --i >= 0;) {
-		var cell = cells[i];
+	for (let i = cells.length; --i >= 0;) {
+		let cell = cells[i];
 		cell.classList.add("tr-align-" + alignment);
 	}
 };
@@ -117,8 +117,8 @@ var _setColumnAlignment = function (tbl, colIndex, alignment) {
 * @param {*} grid grid element, currently supports atlas-blotter, ef-grid, tr.CompositeGrid, rt.Grid and Core
 * @return {Object} core grid
 */
-var _getCoreGrid = function (grid) {
-	var core = null;
+let _getCoreGrid = function (grid) {
+	let core = null;
 	try {
 		if (grid.api) { // ef-grid or atlas-blotter
 			core = grid.api.getCoreGrid();
@@ -136,7 +136,7 @@ var _getCoreGrid = function (grid) {
 
 /** @namespace
 */
-var GridPrinter = {};
+let GridPrinter = {};
 /** @private
 * @type {string}
 */
@@ -156,7 +156,7 @@ GridPrinter._grid = null;
 /** @type {boolean}
 * @private
 */
-GridPrinter._isObserving = false;
+GridPrinter._manualObs = false;
 /** @type {!Object}
 * @private
 */
@@ -177,14 +177,16 @@ GridPrinter.setPrintOptions = function (options) {
 * @param {HTMLIFrameElement=} iFrameElement If not specified, current window is used instead. Specify null to un-observe existing window object.
 */
 GridPrinter.observe = function (iFrameElement) {
-	var pt = GridPrinter._getPrintTrait();
+	let pt = GridPrinter.getPrintTrait();
 	pt.observe(iFrameElement);
-	GridPrinter._isObserving = pt.isObserving();
+	GridPrinter._manualObs = pt.isObserving();
 };
 /** @public
 */
 GridPrinter.unobserve = function () {
-	GridPrinter._getPrintTrait().unobserve();
+	let pt = GridPrinter.getPrintTrait();
+	pt.unobserve();
+	GridPrinter._manualObs = pt.isObserving();
 };
 /** @public
 * @param {boolean=} bool
@@ -199,7 +201,7 @@ GridPrinter.enableDebugMode = function (bool) {
 * @return {!Object}
 */
 GridPrinter.getPreFlightInfo = function (grid, options) {
-	var pfInfo = options || {};
+	let pfInfo = options || {};
 	if (!pfInfo.pageCount) {
 		pfInfo.pageCount = 0;
 	}
@@ -207,7 +209,7 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 		return pfInfo;
 	}
 
-	var colCount = grid.getColumnCount();
+	let colCount = grid.getColumnCount();
 	if (!colCount) {
 		return pfInfo;
 	}
@@ -219,14 +221,14 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 		options.pageHeight = GridPrinter._options["pageHeight"];
 	}
 
-	var pageSize = _getPageSize(options);
-	var pageWidth = pfInfo.pageWidth = pageSize.pageWidth;
-	var pageHeight = pfInfo.pageHeight = pageSize.pageHeight;
+	let pageSize = _getPageSize(options);
+	let pageWidth = pfInfo.pageWidth = pageSize.pageWidth;
+	let pageHeight = pfInfo.pageHeight = pageSize.pageHeight;
 
 	// Find primary column that will exist in every page
-	var c;
-	var primaryColIndex = 0;
-	var identifierCol = GridPrinter._options["identifierField"] || GridPrinter._options["primaryColumn"];
+	let c;
+	let primaryColIndex = 0;
+	let identifierCol = GridPrinter._options["identifierField"] || GridPrinter._options["primaryColumn"];
 	// if(typeof identifierCol === "string") {
 	// for(c = 0; c < colCount; ++c) {
 	// if() {
@@ -237,21 +239,21 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 		primaryColIndex = identifierCol;
 	}
 
-	var primaryCol = pfInfo.primaryColumn = GridPrinter._newColInfo(grid, primaryColIndex);
+	let primaryCol = pfInfo.primaryColumn = GridPrinter._newColInfo(grid, primaryColIndex);
 
 	// Collect properties from all visible columns
 	// Create a column set that fit the page width
 	// Create multiple column sets for single grid
-	var colSets = []; // Each set will fit a single page
-	var colSet, colInfo;
-	// var defaultMinWidth = 50; // WARNING: Hardcoded value
-	var availSpace = 0;
+	let colSets = []; // Each set will fit a single page
+	let colSet, colInfo;
+	// let defaultMinWidth = 50; // WARNING: Hardcoded value
+	let availSpace = 0;
 	for (c = 0; c < colCount; ++c) {
 		if (c == primaryCol.index) {
 			continue;
 		}
 
-		var colVisible = grid.isColumnVisible(c);
+		let colVisible = grid.isColumnVisible(c);
 		if (!colVisible) {
 			continue;
 		}
@@ -272,7 +274,7 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 	}
 
 
-	var colSetCount = colSets.length;
+	let colSetCount = colSets.length;
 	if (!colSetCount) {
 		colSetCount = 1;
 		colSets.push([primaryCol]);
@@ -280,10 +282,10 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 	pfInfo.columnSets = colSets;
 
 	// Resolve scalable columns and width
-	for (var i = 0; i < colSetCount; ++i) {
+	for (let i = 0; i < colSetCount; ++i) {
 		colSet = colSets[i];
 		colCount = colSet.columns.length;
-		var scalableColumns = [];
+		let scalableColumns = [];
 		availSpace = pageWidth;
 		for (c = 0; c < colCount; ++c) {
 			colInfo = colSet.columns[c];
@@ -293,16 +295,16 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 				availSpace -= colInfo.width;
 			}
 		}
-		var scalableColCount = scalableColumns.length;
+		let scalableColCount = scalableColumns.length;
 		if (scalableColCount) {
-			var avgWidth = (availSpace / scalableColCount); // TODO: Take min width into account
+			let avgWidth = (availSpace / scalableColCount); // TODO: Take min width into account
 			for (c = 0; c < scalableColCount; ++c) {
 				scalableColumns[c].width = (avgWidth * (c + 1) | 0) - (avgWidth * c | 0);
 			}
 		}
 
-		var totalWidth = 0;
-		var widths = colSet.widths = new Array(colCount);
+		let totalWidth = 0;
+		let widths = colSet.widths = new Array(colCount);
 		for (c = 0; c < colCount; ++c) {
 			colInfo = colSet.columns[c];
 			widths[c] = colInfo.width;
@@ -312,21 +314,21 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 	}
 
 	// Find total row count per table. Remove all empty rows after the last occupied row.
-	var dv = grid.getDataSource();
-	var totalRowCount = pfInfo.totalRowcount = dv.getVisibleRowCount();
+	let dv = grid.getDataSource();
+	let totalRowCount = pfInfo.totalRowcount = dv.getVisibleRowCount();
 
 	// Find cutoff point for each page
-	var titleSect = grid.getSection("title");
-	var headerHeight = pfInfo.headerHeight = (titleSect.isVisible()) ? titleSect.getDefaultRowHeight() : 0;
-	var rowHeight = pfInfo.rowHeight = grid.getSection("content").getDefaultRowHeight();
-	var maxRowPerPage = (pageHeight - headerHeight) / rowHeight | 0;
+	let titleSect = grid.getSection("title");
+	let headerHeight = pfInfo.headerHeight = (titleSect.isVisible()) ? titleSect.getDefaultRowHeight() : 0;
+	let rowHeight = pfInfo.rowHeight = grid.getSection("content").getDefaultRowHeight();
+	let maxRowPerPage = (pageHeight - headerHeight) / rowHeight | 0;
 	if (!(maxRowPerPage > 0)) { // NaN, negative number, or zero is not allowed.
 		maxRowPerPage = 1; // number of content rows
 	}
 	pfInfo.maxRowPerPage = maxRowPerPage;
 
-	var gridCount = pfInfo.gridCount = Math.ceil(totalRowCount / maxRowPerPage); // Number of grid require to render all of the rows. Grid must fit a single page
-	// var lastPageRowCount = totalRowCount - (totalRowCount / maxRowPerPage | 0);
+	let gridCount = pfInfo.gridCount = Math.ceil(totalRowCount / maxRowPerPage); // Number of grid require to render all of the rows. Grid must fit a single page
+	// let lastPageRowCount = totalRowCount - (totalRowCount / maxRowPerPage | 0);
 	pfInfo.pageCount = gridCount * colSetCount;
 
 
@@ -334,10 +336,10 @@ GridPrinter.getPreFlightInfo = function (grid, options) {
 	// if(colSetCount == 1 && pageCount > 1) {
 	// availSpace = pageWidth;
 	// tableWidth = tables[0]._width;
-	// var numGridPerPage = Math.floor(pageWidth / tableWidth);
+	// let numGridPerPage = Math.floor(pageWidth / tableWidth);
 
-	// var margin = 4;
-	// var takenSpace = numTablePerPage * tableWidth + (numTablePerPage - 1) * margin;
+	// let margin = 4;
+	// let takenSpace = numTablePerPage * tableWidth + (numTablePerPage - 1) * margin;
 	// if(takenSpace > pageWidth) {
 	// numGridPerPage--; // There is not enough space for margin
 	// }
@@ -367,46 +369,47 @@ GridPrinter.createPrintElement = function (grid, options) {
 		return null;
 	}
 
-	var pfInfo = options || GridPrinter._printInfo;
+	let pfInfo = options || GridPrinter._printInfo;
 	if (!pfInfo || !pfInfo._calculated) {
 		pfInfo = GridPrinter.getPreFlightInfo(grid, pfInfo);
 	}
 
 	// TODO: Check if we need to recalculate everything again
-	var maxRowPerPage = pfInfo.maxRowPerPage;
-	var totalRowCount = pfInfo.totalRowcount;
-	var rowHeight = pfInfo.rowHeight;
-	var headerHeight = pfInfo.headerHeight;
-	var colSets = pfInfo.columnSets;
-	var colSetCount = pfInfo.columnSets.length;
-	var primaryColumn = pfInfo.primaryColumn;
-	var gridCount = pfInfo.gridCount;
-	var contentWriter = new SectionWriter(); // content section
-	var headerWriter = new SectionWriter();
-
-	var gridContentSection = grid.getSectionSettings("content");
+	let maxRowPerPage = pfInfo.maxRowPerPage;
+	let totalRowCount = pfInfo.totalRowcount;
+	let rowHeight = pfInfo.rowHeight;
+	let headerHeight = pfInfo.headerHeight;
+	let colSets = pfInfo.columnSets;
+	let colSetCount = pfInfo.columnSets.length;
+	let primaryColumn = pfInfo.primaryColumn;
+	let gridCount = pfInfo.gridCount;
+	let contentWriter = new SectionWriter(); // content section
+	let headerWriter = new SectionWriter();
+
+	let gridContentSection = grid.getSectionSettings("content");
 	gridContentSection.snapshot(contentWriter);
 
-	var gridHeaderSection = grid.getSectionSettings("title");
+	let gridHeaderSection = grid.getSectionSettings("title");
 	if (gridHeaderSection) {
 		gridHeaderSection.snapshot(headerWriter);
 	}
 
 	// Begin element construction
-	var tables = [];
-	for (var t = 0; t < gridCount; ++t) { // For each table
-		var rowStart = t * maxRowPerPage;
-		var rowEnd = rowStart + maxRowPerPage;
+	let tables = [];
+	let t;
+	for (t = 0; t < gridCount; ++t) { // For each table
+		let rowStart = t * maxRowPerPage;
+		let rowEnd = rowStart + maxRowPerPage;
 		if (rowEnd > totalRowCount) {
 			rowEnd = totalRowCount;
 		}
-		var rowCount = rowEnd - rowStart;
+		let rowCount = rowEnd - rowStart;
 
-		for (var s = 0; s < colSetCount; ++s) { // For each column set
-			var colSet = colSets[s];
-			var colCount = colSet.columns.length;
-			var c, col, colIndex;
-			var tbl = new Table(null, {
+		for (let s = 0; s < colSetCount; ++s) { // For each column set
+			let colSet = colSets[s];
+			let colCount = colSet.columns.length;
+			let c, col, colIndex;
+			let tbl = new Table(null, {
 				colCount: colCount,
 				rowCount: rowCount,
 				rowHeight: rowHeight
@@ -416,7 +419,7 @@ GridPrinter.createPrintElement = function (grid, options) {
 
 			if (headerHeight) {
 				tbl.addHeaderRows(); // TODO: support multiple rows
-				var thead = tbl.getHeader();
+				let thead = tbl.getHeader();
 				thead.setDefaultRowHeight(headerHeight);
 
 				// Render header columns
@@ -434,12 +437,12 @@ GridPrinter.createPrintElement = function (grid, options) {
 			for (c = 0; c < colCount; ++c) { // Populate each cell
 				col = colSet.columns[c];
 				colIndex = col.index;
-				var isPrimary = colIndex === primaryColumn.index;
+				let isPrimary = colIndex === primaryColumn.index;
 
-				for (var r = 0; r < rowCount; ++r) {
-					var rowIndex = rowStart + r;
-					var masterCell = contentWriter.getCellElement(colIndex, rowIndex);
-					var cell = tbl.getCell(c, r);
+				for (let r = 0; r < rowCount; ++r) {
+					let rowIndex = rowStart + r;
+					let masterCell = contentWriter.getCellElement(colIndex, rowIndex);
+					let cell = tbl.getCell(c, r);
 					if (isPrimary) {
 						copyNode(masterCell, cell);
 					} else {
@@ -456,8 +459,8 @@ GridPrinter.createPrintElement = function (grid, options) {
 	}
 
 	// Produce the root element to be appended to the page
-	var pageCount = pfInfo.pageCount;
-	var rootElem = document.createElement("div");
+	let pageCount = pfInfo.pageCount;
+	let rootElem = document.createElement("div");
 	rootElem.className = "tr-printing-root";
 	rootElem.style.display = "block"; // This will beat any CSS selector
 	for (t = 0; t < pageCount; ++t) {
@@ -650,7 +653,7 @@ GridPrinter._applyCss = function () {
 * @param {*} grid grid element, currently supports efx-grid, atlas-blotter, ef-grid, tr.CompositeGrid, rt.Grid and Core
 */
 GridPrinter.print = function (grid) {
-	var core = null;
+	let core = null;
 	if (grid) {
 		GridPrinter._applyCss();
 		core = _getCoreGrid(grid);
@@ -659,8 +662,8 @@ GridPrinter.print = function (grid) {
 	if (core) {
 		GridPrinter._grid = core;
 
-		var pt = GridPrinter._getPrintTrait(); // initialize
-		if (!GridPrinter._isObserving) {
+		let pt = GridPrinter.getPrintTrait(); // initialize
+		if (!GridPrinter._manualObs) {
 			pt.observe(); // Observe current window
 		}
 
@@ -671,20 +674,35 @@ GridPrinter.print = function (grid) {
 };
 
 
-/** @private
+/** @public
+* @ignore
 * @return {!PrintTrait}
 */
-GridPrinter._getPrintTrait = function () {
-	var pt = GridPrinter._printTrait;
+GridPrinter.getPrintTrait = function () {
+	let pt = GridPrinter._printTrait;
 	if (!pt) {
-		pt = GridPrinter._printTrait = new PrintTrait();
-		// TODO: this._printTrait.fixPaperSize(); // WORKAROUND: We cannot detect the change in paper size during the browser's preview dialog.
+		pt = new PrintTrait();
+		GridPrinter.setPrintTrait(pt);
+	}
+	return pt;
+};
+/** @public
+* @ignore
+* @param {PrintTrait} pt
+*/
+GridPrinter.setPrintTrait = function (pt) {
+	if(GridPrinter._printTrait && GridPrinter._printTrait !== pt) {
+		GridPrinter._printTrait.dispose();
+	}
+
+	GridPrinter._printTrait = pt || null;
+	if (pt) {
+		// TODO: pt.fixPaperSize(); // WORKAROUND: We cannot detect the change in paper size during the browser's preview dialog.
 
 		pt.addEventListener('pageCounting', GridPrinter._onPageCounting);
 		pt.addEventListener('beforeprint', GridPrinter._onBeforePrint);
 		pt.addEventListener('afterprint', GridPrinter._onAfterPrint);
 	}
-	return pt;
 };
 /** @private
 * @param {tr.Grid} grid
@@ -692,12 +710,12 @@ GridPrinter._getPrintTrait = function () {
 * @return {!Object}
 */
 GridPrinter._newColInfo = function (grid, idx) {
-	var minWidth = grid.getMinimumColumnWidth(idx);
+	let minWidth = grid.getMinimumColumnWidth(idx);
 	if (minWidth <= 0) {
 		minWidth = 50; // WARNING: Hard-coded value
 	}
-	var scalability = grid.getColumnScalability(idx);
-	var width = scalability ? minWidth : grid.getColumnWidth(idx);
+	let scalability = grid.getColumnScalability(idx);
+	let width = scalability ? minWidth : grid.getColumnWidth(idx);
 
 	return {
 		"index": idx,
@@ -741,7 +759,7 @@ GridPrinter._onBeforePrint = function (e) {
 	if (GridPrinter._printInfo && GridPrinter._printInfo.pageCount) {
 		GridPrinter._printElem = GridPrinter.createPrintElement(GridPrinter._grid, GridPrinter._printInfo); // TODO: Use new sizes given from PrintTrait
 
-		// var elem = GridPrinter._printTrait.createClientBox(e.pageWidth, e.pageHeight);
+		// let elem = GridPrinter._printTrait.createClientBox(e.pageWidth, e.pageHeight);
 		e.bodyElement.appendChild(GridPrinter._printElem);
 	}
 };
@@ -751,8 +769,8 @@ GridPrinter._onBeforePrint = function (e) {
 GridPrinter._onAfterPrint = function (e) {
 	GridPrinter._removePrintElements();
 
-	if (!GridPrinter._isObserving) {
-		GridPrinter._getPrintTrait().unobserve();
+	if (!GridPrinter._manualObs) {
+		GridPrinter.getPrintTrait().unobserve();
 	}
 
 	GridPrinter._printInfo = null;

package/lib/tr-grid-printer/es6/PrintTrait.d.ts

@@ -35,4 +35,5 @@ declare class PrintTrait {
 
 }
 
+export default PrintTrait;
 export { PrintTrait };