@sapui5/sap.ui.export 1.99.1 → 1.102.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@sapui5/sap.ui.export",
-	"version": "1.99.1",
+	"version": "1.102.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.99.1</version>
+	<version>1.102.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

@@ -12,10 +12,22 @@ sap.ui.define([
 	'use strict';
 
 	/**
-	 * @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.
+	 * Base class for specific SAPUI5 export implementations. This class contains abstract functions that need to be implemented.
+	 *
+	 * @param {object} mSettings - Export settings
+	 * @param {object} mSettings.workbook - Data and formatting related export settings
+	 * @param {object|sap.ui.model.ListBinding} mSettings.dataSource - Source of export data.
+	 * 	      A data source properties map or <code>sap.ui.model.ListBinding</code> can be provided.
+	 * 	      An instance of <code>sap.ui.model.ListBinding</code> has to implement a
+	 * 	      <code>#getDownloadUrl</code> function.
+	 * @param {int} [mSettings.count] - The maximal number of records to export
+	 * @param {string} [mSettings.fileName] - Optional file name for the exported file
+	 * @param {sap.ui.export.FileType} [mSettings.fileType] - <code>FileType</code> that is used to identify the file-ending and MIME-type of the file
+	 *
+	 * @constructor The <code>sap.ui.export.ExportBase</code> class allows you to export table data from a UI5 application to certain formats. This class is an abstract class that requires specific implementations for each file format.
 	 *
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 *
 	 * @since 1.96
 	 * @name sap.ui.export.ExportBase
@@ -50,7 +62,7 @@ sap.ui.define([
 	 * @param {sap.ui.base.Event} oEvent
 	 * @param {sap.ui.base.EventProvider} oEvent.getSource
 	 * @param {object} oEvent.getParameters
-	 * @param {ArrayBuffer} oEvent.getParameter.exportSettings - Contains export-related configuration
+	 * @param {object} oEvent.getParameter.exportSettings - Contains export-related configuration
 	 *
 	 * @since 1.96
 	 * @public
@@ -128,9 +140,9 @@ sap.ui.define([
 	 * Sets the data source configuration that will be used for exporting the data. If the passed parameter is null,
 	 * the call will be ignored.
 	 *
-	 * @param {Object|sap.ui.model.ListBinding|sap.ui.model.TreeBinding} oDataSource Possible types are a data
+	 * @param {object|sap.ui.model.ListBinding|sap.ui.model.TreeBinding} oDataSource Possible types are a data
 	 * source configuration, a <code>sap.ui.model.ListBinding</code> or <code>sap.ui.model.TreeBinding</code>
-	 * @returns {Object|null} - Valid dataSource object or null in case the dataSource configuration is not supported
+	 * @returns {object|null} - Valid dataSource object or null in case the dataSource configuration is not supported
 	 *
 	 * @function
 	 * @abstract
@@ -144,7 +156,7 @@ sap.ui.define([
 	/**
 	 * Applies default settings to the export configuration.
 	 *
-	 * @param {Object} mSettings Export settings that will be adjusted
+	 * @param {object} mSettings Export settings that will be adjusted
 	 *
 	 * @function
 	 * @abstract
@@ -156,7 +168,7 @@ sap.ui.define([
 	/**
 	 * Creates a Promise that will be resolved after the export has been finished.
 	 *
-	 * @param {Object} mSettings Validated export configuration
+	 * @param {object} mSettings Validated export configuration
 	 *
 	 * @function
 	 * @abstract
@@ -165,6 +177,16 @@ sap.ui.define([
 		throw new Error('Abstract function not implemented');
 	};
 
+	/**
+	 * Returns the specific MIME type
+	 *
+	 * @function
+	 * @abstract
+	 */
+	ExportBase.prototype.getMimeType = function() {
+		throw new Error('Abstract function not implemented');
+	};
+
 	/**
 	 * Triggers the export process of the specific format.
 	 *

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

@@ -7,13 +7,14 @@
  * Export progress dialog
  * @private
  */
-sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Button', 'sap/m/ProgressIndicator', 'sap/m/Text', 'sap/m/MessageBox', 'sap/ui/core/format/NumberFormat'],
-		function(coreLibrary, MLibrary, Dialog, Button, ProgressIndicator, Text, MessageBox, NumberFormat) {
+sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Button', 'sap/m/ProgressIndicator', 'sap/m/Text', 'sap/m/Link', 'sap/m/VBox', 'sap/m/MessageBox', 'sap/ui/core/format/NumberFormat'],
+		function(coreLibrary, MLibrary, Dialog, Button, ProgressIndicator, Text, Link, VBox, MessageBox, NumberFormat) {
 	'use strict';
 
 	var ValueState = coreLibrary.ValueState;
 
 	var DialogType = MLibrary.DialogType;
+	var ButtonType = MLibrary.ButtonType;
 
 	/* Async call to resource bundle */
 	var oResourceBundlePromise = sap.ui.getCore().getLibraryResourceBundle("sap.ui.export", true);
@@ -28,9 +29,9 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 		return new Promise(function(fnResolve, fnReject) {
 			var dialog;
 
-			oResourceBundlePromise.then(function(oResourceBundleResolve) {
+			oResourceBundlePromise.then(function(oResourceBundle) {
 				var cancelButton = new Button({
-					text : oResourceBundleResolve.getText("CANCEL_BUTTON"),
+					text : oResourceBundle.getText("CANCEL_BUTTON"),
 					press : function() {
 						if (dialog && dialog.oncancel) {
 							dialog.oncancel();
@@ -48,9 +49,9 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 				});
 				progressIndicator.addStyleClass("sapUiMediumMarginTop");
 
-				var oMessage = new Text({text : oResourceBundleResolve.getText("PROGRESS_FETCHING_MSG")});
+				var oMessage = new Text({text : oResourceBundle.getText("PROGRESS_FETCHING_MSG")});
 				dialog = new Dialog({
-					title : oResourceBundleResolve.getText("PROGRESS_TITLE"),
+					title : oResourceBundle.getText("PROGRESS_TITLE"),
 					type : DialogType.Message,
 					contentWidth : "500px",
 					content : [
@@ -61,9 +62,14 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 					ariaLabelledBy: [oMessage]
 				});
 
-				dialog.updateStatus = function(iFetched, iTotal) {
+				dialog.updateStatus = function(iFetched, iTotal, sMessage) {
 					var iPercentage;
 
+					if (typeof iFetched === 'string' && iFetched) {
+						sMessage = iFetched;
+						oMessage.setText(sMessage);
+					}
+
 					if (!isNaN(iFetched) & !isNaN(iTotal)) {
 						iPercentage = iFetched / iTotal * 100;
 					}
@@ -71,7 +77,7 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 					/* Update status text to reflect the current step (bundle instead of fetching data) */
 					if (iPercentage >= 100) {
 						cancelButton.setEnabled(false);
-						oMessage.setText(oResourceBundleResolve.getText("PROGRESS_BUNDLE_MSG"));
+						oMessage.setText(sMessage || oResourceBundle.getText("PROGRESS_BUNDLE_MSG"));
 					}
 
 					progressIndicator.setPercentValue(iPercentage);
@@ -111,7 +117,7 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 	function showWarningDialog(mParams) {
 		return new Promise(function(fnResolve, fnReject) {
 
-			oResourceBundlePromise.then(function(oResourceBundleResolve) {
+			oResourceBundlePromise.then(function(oResourceBundle) {
 				var bContinue, oWarningDialog, oWarningText, sWarningText, oNumberFormat, sRowsFormatted;
 
 				oNumberFormat = NumberFormat.getIntegerInstance({groupingEnabled: true});
@@ -119,17 +125,17 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 				sWarningText = '';
 
 				if (!mParams.rows) {
-					sWarningText = oResourceBundleResolve.getText("NO_COUNT_WARNING_MSG");
+					sWarningText = oResourceBundle.getText("NO_COUNT_WARNING_MSG");
 				} else {
 					sRowsFormatted = oNumberFormat.format(mParams.rows);
 
 					if (mParams.sizeLimit) {
-						sWarningText = oResourceBundleResolve.getText("SIZE_WARNING_MSG", [sRowsFormatted, mParams.columns]);
+						sWarningText = oResourceBundle.getText("SIZE_WARNING_MSG", [sRowsFormatted, mParams.columns]);
 					}
 
 					if (mParams.cutOff) {
 						sWarningText += sWarningText === '' ? '' : '\n\n'; // Add line breaks if there is already a message
-						sWarningText += oResourceBundleResolve.getText("MSG_WARNING_CUT_OFF", [sRowsFormatted]);
+						sWarningText += oResourceBundle.getText("MSG_WARNING_CUT_OFF", [sRowsFormatted]);
 					}
 				}
 
@@ -137,19 +143,21 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 					text: sWarningText
 				});
 				oWarningDialog = new Dialog({
-					title: oResourceBundleResolve.getText('PROGRESS_TITLE'),
+					title: oResourceBundle.getText('PROGRESS_TITLE'),
 					type: DialogType.Message,
 					state: ValueState.Warning,
 					content: oWarningText,
 					ariaLabelledBy: oWarningText,
-					beginButton: new Button({
-						text: oResourceBundleResolve.getText("CANCEL_BUTTON"),
+					endButton: new Button({
+						type: ButtonType.Transparent,
+						text: oResourceBundle.getText("CANCEL_BUTTON"),
 						press: function () {
 							oWarningDialog.close();
 						}
 					}),
-					endButton: new Button({
-						text: oResourceBundleResolve.getText("EXPORT_BUTTON"),
+					beginButton: new Button({
+						type: ButtonType.Emphasized,
+						text: oResourceBundle.getText("EXPORT_BUTTON"),
 						press: function () {
 							bContinue = true;
 							oWarningDialog.close();
@@ -172,16 +180,16 @@ sap.ui.define(['sap/ui/core/library', 'sap/m/library', 'sap/m/Dialog', 'sap/m/Bu
 	 * @param {string} sMessage Error message that will be shown in the error dialog
 	 */
 	function showErrorMessage(sMessage) {
-		oResourceBundlePromise.then(function(oResourceBundleResolve) {
-			var errorMessage = sMessage || oResourceBundleResolve.getText('PROGRESS_ERROR_DEFAULT');
+		oResourceBundlePromise.then(function(oResourceBundle) {
+			var errorMessage = sMessage || oResourceBundle.getText('PROGRESS_ERROR_DEFAULT');
 
 			// Replace technical error message in case of "out of memory"
 			if (sMessage.toLowerCase().indexOf('invalid string length') > -1) {
-				errorMessage = oResourceBundleResolve.getText('MSG_ERROR_OUT_OF_MEMORY');
+				errorMessage = oResourceBundle.getText('MSG_ERROR_OUT_OF_MEMORY');
 			}
 
-			MessageBox.error(oResourceBundleResolve.getText("PROGRESS_ERROR_MSG") + "\n\n" + errorMessage, {
-				title : oResourceBundleResolve.getText("PROGRESS_ERROR_TITLE")
+			MessageBox.error(oResourceBundle.getText("PROGRESS_ERROR_MSG") + "\n\n" + errorMessage, {
+				title : oResourceBundle.getText("PROGRESS_ERROR_TITLE")
 			});
 		});
 	}