@sapui5/sap.ui.export 1.98.0 → 1.101.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.98.0",
+	"version": "1.101.0",
 	"description": "SAPUI5 Library sap.ui.export",
 	"homepage": "https://sap.github.io/ui5-tooling/pages/SAPUI5/",
 	"author": "SAP SE (https://www.sap.com)",

package/src/sap/ui/export/.library

@@ -5,7 +5,7 @@
 	<vendor>SAP SE</vendor>
 	<copyright>SAPUI5
  * (c) Copyright 2009-2022 SAP SE. All rights reserved.</copyright>
-	<version>1.98.0</version>
+	<version>1.101.0</version>
 
 	<documentation>UI5 library: sap.ui.export</documentation>
 
@@ -34,7 +34,7 @@
 			</module-infos>
 			<all-in-one>
 				<!-- exclude third party bundles and the worker code -->
-				<exclude name="sap/ui/export/js/**" />
+				<exclude name="sap/ui/export/js/" />
 			</all-in-one>
 		</packaging>
 		<ownership xmlns="http://www.sap.com/ui5/buildext/ownership">

package/src/sap/ui/export/ExportBase.js

@@ -15,7 +15,7 @@ sap.ui.define([
 	 * @constructor The <code>sap.ui.export.ExportBase</code> class allows you to export table data from a UI5 application to a Portable Document Format (*.PDF) file.
 	 *
 	 * @author SAP SE
-	 * @version 1.98.0
+	 * @version 1.101.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase

package/src/sap/ui/export/ExportUtils.js

@@ -3,33 +3,23 @@
  * (c) Copyright 2009-2022 SAP SE. All rights reserved.
  */
 sap.ui.define([
-	'sap/ui/core/library',
-	'sap/m/library',
 	'./library',
-	'sap/ui/core/Core',
 	'sap/base/Log',
-	'sap/base/util/uid',
-	'sap/ui/core/Item',
+	'sap/ui/core/Core',
+	'sap/ui/core/Fragment',
+	'sap/ui/core/library',
 	'sap/ui/core/syncStyleClass',
 	'sap/ui/model/json/JSONModel',
-	'sap/m/Button',
-	'sap/m/CheckBox',
-	'sap/m/Dialog',
-	'sap/m/Input',
-	'sap/m/Label',
-	'sap/m/Select',
-	'sap/m/Text',
-	'sap/m/VBox',
-	'sap/ui/VersionInfo',
-	'sap/ui/util/openWindow'
-], function(coreLibrary, mLibrary, library, Core, Log, uid, Item, syncStyleClass, JSONModel, Button, CheckBox, Dialog, Input, Label, Select, Text, VBox, VersionInfo, openWindow) {
+	'sap/ui/model/resource/ResourceModel',
+	'sap/ui/util/openWindow',
+	'sap/ui/VersionInfo'
+], function(library, Log, Core, Fragment, coreLibrary, syncStyleClass, JSONModel, ResourceModel, openWindow, VersionInfo) {
 	'use strict';
 
 	// eslint-disable-next-line
 	/* global Blob, MouseEvent, FileReader, URL */
 
 	// Shortcuts
-	var ButtonType = mLibrary.ButtonType;
 	var ValueState = coreLibrary.ValueState;
 	var FileType = library.FileType;
 	var EdmType = library.EdmType;
@@ -54,22 +44,39 @@ sap.ui.define([
 	});
 
 	/* Returns the Export Settings used by the User Settings Dialog */
-	function getExportSettings(oCustomConfig, oResourceBundle, bDevMode) {
+	function getDefaultSettings(oCustomConfig, oResourceBundle, oExportCapabilities) {
 		var sSelectedKey;
+		var aSupportedFormats = Object.keys(oExportCapabilities);
+
 		var oDefaultConfig = {
 			fileName: 'Standard',
-			fileType: [
-				{key: 'xlsx'}
-			],
-			selectedFileType: 'xlsx',
+			fileType: [],
+			selectedFileType: 'XLSX',
+			selectedPaperSize: 'DIN_A4',
+			selectedOrientation: 'LANDSCAPE',
 			splitCells: false,
 			includeFilterSettings: false,
-			addDateTime: false
+			addDateTime: false,
+			doEnableAccessibility: false,
+			pdfArchive: false,
+			capabilities: oExportCapabilities,
+			fitToPage: false,
+			paperSize: [
+				{key: "DIN_A4", text: oResourceBundle.getText("PAPER_SIZE_A4")},
+				{key: "US_LETTER", text: oResourceBundle.getText("PAPER_SIZE_US_LETTER")}
+			],
+			orientation: [
+				{key:"LANDSCAPE", text: oResourceBundle.getText("ORIENTATION_LAND")},
+				{key:"PORTRAIT", text: oResourceBundle.getText("ORIENTATION_PORT")}
+			],
+			fontSize: 10,
+			signature: false,
+			signatureReason: ''
 		};
 
-		if (bDevMode) {
-			oDefaultConfig.fileType.push({key: 'pdf'});
-		}
+		aSupportedFormats.forEach(function(sFormat) {
+			oDefaultConfig.fileType.push({key: sFormat.toUpperCase()});
+		});
 
 		var oExportConfig = Object.assign({}, oDefaultConfig, oCustomConfig || {});
 
@@ -77,7 +84,7 @@ sap.ui.define([
 			sSelectedKey = null;
 
 			if (!oExportConfig.fileType[i].text) {
-				oExportConfig.fileType[i].text = oResourceBundle.getText(oExportConfig.fileType[i].key.toUpperCase() + '_FILETYPE');
+				oExportConfig.fileType[i].text = oResourceBundle.getText(oExportConfig.fileType[i].key + '_FILETYPE');
 			}
 			if (oExportConfig.fileType[i].key === oExportConfig.selectedFileType) {
 				sSelectedKey = oExportConfig.fileType[i].key;
@@ -90,11 +97,21 @@ sap.ui.define([
 		return oExportConfig;
 	}
 
+	function processExportSettings(oSettings) {
+		var oFinalSettings = {};
+
+		["fileName", "selectedFileType", "selectedPaperSize", "selectedOrientation", "splitCells", "includeFilterSettings", "addDateTime", "doEnableAccessibility", "fitToPage", "fontSize", "signature", "signatureReason", "pdfArchive"].forEach(function(sProperty) {
+			oFinalSettings[sProperty] = oSettings[sProperty];
+		});
+
+		return oFinalSettings;
+	}
+
 	/**
 	 * Utilities related to export to enable reuse in integration scenarios (e.g. tables).
 	 *
 	 * @author SAP SE
-	 * @version 1.98.0
+	 * @version 1.101.0
 	 *
 	 * @since 1.59
 	 * @name sap.ui.export.ExportUtils
@@ -146,146 +163,138 @@ sap.ui.define([
 		 * Creates the Export settings dialog that can be used for configuring the spreadsheet before exporting.
 		 *
 		 * @param {Object} mCustomConfig Initial configuration of the settings dialog
-		 * @param {sap.ui.core.Control} oOpener The opener of the dialog
-		 * @param {function} [fnCallback] Handler function that is called once the dialog has been opened. A reference to the dialog is passed as parameter
-		 * @param {boolean} [bDevMode] Flag that allows to activate settings that are currently in development
+		 * @param {Object} oExportCapabilities Definition of supported export features
+		 * @param {sap.ui.core.Control} [oOpener] The opener of the dialog
+		 * @param {function(sap.m.Dialog)} [fnCallback] Handler function that is called once the dialog has been opened. A reference to the dialog is passed as parameter
 		 *
 		 * @returns {Promise} Promise which resolves with the export settings defined by the user
 		 *
 		 * @static
 		 */
-		getExportSettingsViaDialog: function(mCustomConfig, oOpener, fnCallback, bDevMode) {
+		getExportSettingsViaDialog: function(mCustomConfig, oExportCapabilities, oOpener, fnCallback) {
 			return new Promise(function (fnResolve, fnReject) {
 				var oExportSettingsDialog;
 
 				oResourceBundlePromise.then(function (oResourceBundle) {
-
 					var oExportConfigModel = new JSONModel();
-					oExportConfigModel.setData(getExportSettings(mCustomConfig, oResourceBundle, bDevMode));
-
-					var sDialogId = uid();
-
-					oExportSettingsDialog = new Dialog({
-						id: sDialogId,
-						title: oResourceBundle.getText('EXPORT_SETTINGS_TITLE'),
-						horizontalScrolling: false,
-						verticalScrolling: false,
-						content: [
-							//TBD: Maybe use a form here for ACC purposes
-							new VBox({
-								// changing the render type to Bare in order to render the colon by resuing the style classes from Form layout
-								renderType: 'Bare',
-								width: '100%',
-								items: [
-									//TBD: Hide controls (visible=false) when functionality is not yet implemented
-									new Label({
-										text: oResourceBundle.getText('FILE_NAME'),
-										labelFor: sDialogId + '-fileName'
-									}),
-									new Input({
-										id: sDialogId + '-fileName',
-										value: '{/fileName}',
-										liveChange: function (oEvent) {
-											// user input validation for file name
-											var oInput = oEvent.getSource();
-											var sFileName = oEvent.getParameter('value');
-											var oRegEx = /[\\/:|?"*<>]/;
-											var oExportBtn = Core.byId(sDialogId + '-export');
-											var bValidate = oRegEx.test(sFileName);
-											if (bValidate) {
-												oInput.setValueState(ValueState.Error);
-												oInput.setValueStateText(oResourceBundle.getText('FILENAME_ERROR'));
-											} else if (sFileName.length > 100) {
-												oInput.setValueState(ValueState.Warning);
-												oInput.setValueStateText(oResourceBundle.getText('FILENAME_WARNING'));
-											} else {
-												oInput.setValueState(ValueState.None);
-												oInput.setValueStateText(null);
-											}
-											oExportBtn.setEnabled(!bValidate);
-										}
-									}).addStyleClass('sapUiTinyMarginBottom'),
-									new Label({
-										text: oResourceBundle.getText('SELECT_FORMAT'),
-										labelFor: sDialogId + '-fileType',
-										visible: !!bDevMode
-									}),
-									// sap.m.Select control disabled as there is only 1 option for now
-									// control must be enabled when more file types are supported
-									new Select({
-										id: sDialogId + '-fileType',
-										width: '100%',
-										selectedKey: '{/selectedFileType}',
-										items: {
-											path: '/fileType',
-											template: new Item({key: '{key}', text: '{text}'})
-										},
-										visible: !!bDevMode
-									}),
-									new CheckBox({
-										id: sDialogId + '-splitCells',
-										selected: '{/splitCells}',
-										text: oResourceBundle.getText('SPLIT_CELLS')
-									}),
-									new CheckBox({
-										id: sDialogId + '-includeFilterSettings',
-										selected: '{/includeFilterSettings}',
-										text: oResourceBundle.getText('INCLUDE_FILTER_SETTINGS')
-									}),
-									new CheckBox({
-										id: sDialogId + '-addDateTime',
-										selected: '{/addDateTime}',
-										text: oResourceBundle.getText('ADD_DATE_TIME'),
-										visible: false
-									})
-								]
-							// using the style class from Form layout to render colon after the label
-							}).addStyleClass('sapUiExportSettingsLabel')
-						],
-						endButton: new Button({
-							id: sDialogId + '-cancel',
-							text: oResourceBundle.getText('CANCEL_BUTTON'),
-							press: function () {
+
+					oExportConfigModel.setData(getDefaultSettings(mCustomConfig, oResourceBundle, oExportCapabilities));
+
+					Fragment.load({
+						name: 'sap.ui.export.fragments.SettingsDialog',
+						type: 'XML',
+						controller: {
+							isPDF: function(sValue) {
+								return sValue === FileType.PDF;
+							},
+							isXLSX: function(sValue) {
+								return sValue === FileType.XLSX;
+							},
+							onCancel: function() {
 								oExportSettingsDialog.close();
-							}
-						}),
-						beginButton: new Button({
-							id: sDialogId + '-export',
-							text: oResourceBundle.getText('EXPORT_BUTTON'),
-							type: ButtonType.Emphasized,
-							press: function () {
+							},
+							onExport: function() {
 								if (oExportSettingsDialog) {
 									oExportSettingsDialog._bSuccess = true;
 									oExportSettingsDialog.close();
-									fnResolve(oExportConfigModel.getData());
+									fnResolve(processExportSettings(oExportConfigModel.getData()));
 								}
+							},
+
+							/**
+							 * User input validation for file name
+							 *
+							 * @param {sap.ui.base.Event} oEvent LiveChange event of the Input control
+							 */
+							onFileNameChange: function(oEvent) {
+								var oInput = oEvent.getSource();
+								var sFileName = oEvent.getParameter('value');
+								var oRegEx = /[\\/:|?"*<>]/;
+								var oExportBtn = Core.byId('exportSettingsDialog-exportButton');
+								var bValidate = oRegEx.test(sFileName);
+								if (bValidate) {
+									oInput.setValueState(ValueState.Error);
+									oInput.setValueStateText(oResourceBundle.getText('FILENAME_ERROR'));
+								} else if (sFileName.length > 100) {
+									oInput.setValueState(ValueState.Warning);
+									oInput.setValueStateText(oResourceBundle.getText('FILENAME_WARNING'));
+								} else {
+									oInput.setValueState(ValueState.None);
+									oInput.setValueStateText(null);
+								}
+								oExportBtn.setEnabled(!bValidate);
+							},
+							onFileTypeChange: function(oEvent) {
+								var oSelectedItem = oEvent.getParameter("selectedItem");
+								if (oSelectedItem && oSelectedItem.getKey() === FileType.PDF) {
+									oExportConfigModel.setProperty("/splitCells", true);
+									oExportConfigModel.setProperty("/includeFilterSettings", false);
+								} else {
+									Core.byId('exportSettingsDialog-signatureReason').setVisible(false);
+									Core.byId('exportSettingsDialog-signatureReasonLabel').setVisible(false);
+								}
+							},
+							onFontSizeChange: function(oEvent) {
+								// user input validation for font size
+								var oInput = oEvent.getSource();
+								var sFontValue = oEvent.getParameter('value');
+								var oRegEx = /[^\d]/g;
+								var oExportBtn = Core.byId('exportSettingsDialog-exportButton');
+								var bValidate = oRegEx.test(sFontValue);
+								if (bValidate) {
+									oInput.setValueState(ValueState.Error);
+									oInput.setValueStateText(oResourceBundle.getText('NUMBER_ERROR'));
+								} else {
+									oInput.setValueState(ValueState.None);
+									oInput.setValueStateText(null);
+								}
+								oExportBtn.setEnabled(!bValidate);
+							},
+							onAfterClose: function() {
+								if (!oExportSettingsDialog._bSuccess) {
+									// Handle Cancel after close when export button was not pressed
+									// because a close could also be triggered via Esc
+									fnReject(null);
+								}
+								oExportSettingsDialog.destroy();
+								oExportSettingsDialog = null;
 							}
-						}),
-						afterClose: function () {
-							if (!oExportSettingsDialog._bSuccess) {
-								// Handle Cancel after close when export button was not pressed
-								// because a close could also be triggered via Esc
-								fnReject(null);
-							}
-							oExportSettingsDialog.destroy();
-							oExportSettingsDialog = null;
 						}
-					});
-					// using the style class from Form layout to render colon after the label
-					oExportSettingsDialog.addStyleClass('sapUiContentPadding sapUiExportSettings');
-					oExportSettingsDialog.setModel(oExportConfigModel);
-					if (oOpener) {
-						syncStyleClass('sapUiSizeCompact', oOpener, oExportSettingsDialog);
-					}
-					oExportSettingsDialog.open();
+					}).then(function(oDialog) {
+						oExportSettingsDialog = oDialog;
 
-					if (fnCallback) {
-						fnCallback(oExportSettingsDialog);
-					}
+						oExportSettingsDialog.setModel(oExportConfigModel);
+						oExportSettingsDialog.setModel(new ResourceModel({
+							bundle: oResourceBundle
+						}), 'i18n');
+
+						if (oOpener) {
+							syncStyleClass('sapUiSizeCompact', oOpener, oExportSettingsDialog);
+						}
+						oExportSettingsDialog.open();
+
+						if (fnCallback) {
+							fnCallback(oExportSettingsDialog);
+						}
+					});
 				});
 			});
 		},
 
+		/**
+		 * Returns a different representation of the filter
+		 * value in case the value is an instance of Date.
+		 * The resutl of Date.prototype.toString function is
+		 * too long and complex so we use the ISO-String
+		 * instead.
+		 *
+		 * @param {*} vValue Filter value that might get converted
+		 * @returns {*} The formatted value
+		 */
+		_getFormattedFilterValue: function(vValue)  {
+			return vValue instanceof Date ? vValue.toISOString() : vValue;
+		},
+
 		/**
 		 * Combines the filter operator with the value and
 		 * creates a textual representation.
@@ -297,15 +306,15 @@ sap.ui.define([
 		_getReadableFilterValue: function(oFilter) {
 			switch (oFilter.op || oFilter.name) {
 				case '==':
-					return '=' + oFilter.right.value;
+					return '=' + Utils._getFormattedFilterValue(oFilter.right.value);
 				case '>':
 				case '<':
 				case '!=':
 				case '<=':
 				case '>=':
-					return oFilter.op + oFilter.right.value;
+					return oFilter.op + Utils._getFormattedFilterValue(oFilter.right.value);
 				case 'between':
-					return oFilter.args[1].value + '...' + oFilter.args[2].value;
+					return Utils._getFormattedFilterValue(oFilter.args[1].value) + '...' + Utils._getFormattedFilterValue(oFilter.args[2].value);
 				case 'contains':
 					return '*' + oFilter.args[1].value + '*';
 				case 'endswith':
@@ -344,10 +353,11 @@ sap.ui.define([
 		 * subsequent filters.
 		 *
 		 * @param {Object} oLogicalFilter Filter object according to ListBinding#getFilterInfo
-		 * @returns {Array} Array containing all filter settings
+		 * @returns {Array} Array containing evaluated filter settings
 		 * @private
 		 */
 		_parseLogical: function(oLogicalFilter) {
+			var aFilters, sProperty;
 
 			/* Breakout behavior for between filter */
 			if (oLogicalFilter.op == '&&'
@@ -377,7 +387,27 @@ sap.ui.define([
 				});
 			}
 
-			return Utils._parseFilter(oLogicalFilter.left).concat(Utils._parseFilter(oLogicalFilter.right));
+			aFilters = Utils._parseFilter(oLogicalFilter.left).concat(Utils._parseFilter(oLogicalFilter.right));
+
+			/* Group logical OR filter on the same property */
+			if (oLogicalFilter.op === '||' && aFilters.length) {
+				sProperty = aFilters[0].key;
+
+				if (aFilters.every(function(item) { return item.key === sProperty; })) {
+					aFilters = [
+						{
+							key: sProperty,
+							value: aFilters.reduce(function(acc, item) {
+								var sSeparator = acc ? '; ' : '';
+
+								return acc + sSeparator + item.value;
+							}, '')
+						}
+					];
+				}
+			}
+
+			return aFilters;
 		},
 
 		/**
@@ -487,7 +517,25 @@ sap.ui.define([
 						});
 					}
 
+					/* Sort filter settings */
+					oFilterConfig.items.sort(function(firstElement, secondElement) {
+						var sFirstValue = firstElement.key.toLowerCase();
+						var sSecondValue = secondElement.key.toLowerCase();
+
+						if (sFirstValue > sSecondValue) {
+							return 1;
+						}
+
+						if (sFirstValue < sSecondValue) {
+							return -1;
+						}
+
+						return 0;
+					});
+
 					fnResolve(oFilterConfig);
+
+					return oResourceBundle;
 				});
 			});
 		},
@@ -808,7 +856,7 @@ sap.ui.define([
 				});
 
 				/* Validate string based properties (not column type String related) */
-				['inputFormat', 'unit', 'unitProperty', 'template', 'trueValue', 'falseValue'].forEach(function(sProperty) {
+				['inputFormat', 'unit', 'unitProperty', 'template', 'trueValue', 'falseValue', 'timezone', 'timezoneProperty'].forEach(function(sProperty) {
 					Utils._validateString(oColumn, sProperty);
 				});
 
@@ -832,11 +880,27 @@ sap.ui.define([
 				}
 
 				/* Validate utc property */
-				if (oColumn.utc != null && (oColumn.type === EdmType.Date || oColumn.type === EdmType.Time)) {
-					oColumn.utc = true; // Date and Time always use UTC
-				}
 				if (oColumn.type === EdmType.DateTime) {
-					Utils._validateProperty(oColumn, 'utc', 'boolean', true);
+
+					/*
+					 * Apply local time or UTC as fixed timezone
+					 * in case no timezone is defined. This also
+					 * serves as a fallback if timezoneProperty
+					 * is defined but the Line Item has no value
+					 * for the referenced property name.
+					 */
+					if (!oColumn.timezone) {
+						oColumn.timezone = oColumn.utc === false ? new Intl.DateTimeFormat().resolvedOptions().timeZone : 'UTC';
+					}
+
+					/* Remove obviously incorrect timezoneProperty settings */
+					if (oColumn.property === oColumn.timezoneProperty || (typeof oColumn.timezoneProperty === 'string' && oColumn.timezoneProperty.split(',').length > 1)) {
+						Log.warning(CLASS_NAME + ': Property timezoneProperty is invalid.');
+						delete oColumn.timezoneProperty;
+					}
+				} else if (typeof oColumn.utc === 'boolean') {
+					Log.warning(CLASS_NAME + ': Property utc is only supported for type DateTime.');
+					delete oColumn.utc;
 				}
 
 				/* Validate scale property */
@@ -911,7 +975,7 @@ sap.ui.define([
 		 *
 		 * @param {Object} oContext Context object
 		 * @param {string} [oContext.application] Name of the application (default: "SAP UI5")
-		 * @param {string} [oContext.version] Application version (default: "1.98.0")
+		 * @param {string} [oContext.version] Application version (default: "1.101.0")
 		 * @param {string} [oContext.title] Title that will be written to the file (NOT the filename)
 		 * @param {string} [oContext.modifiedBy] Optional user context that will be written to the file
 		 * @param {string} [oContext.sheetName] Name of the data sheet - Maximum length of 31 characters
@@ -1005,7 +1069,7 @@ sap.ui.define([
 				value = null;
 			}
 
-			oContext[sProperty] = value == null && defaultValue ? defaultValue : value;
+			oContext[sProperty] = value == null && typeof defaultValue !== 'undefined' ? defaultValue : value;
 		},
 
 		/**