@sapui5/sap.ui.export 1.98.0 → 1.101.0

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

@@ -16,17 +16,25 @@ sap.ui.define([
 	 * @constructor The <code>sap.ui.export.PortableDocument</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.PortableDocument
-	 * @extends sap.ui.base.ExportBase
+	 * @alias sap.ui.export.PortableDocument
+	 * @extends sap.ui.export.ExportBase
 	 * @private
 	 */
 	var PortableDocument = ExportBase.extend('sap.ui.export.PortableDocument', {
 
 		constructor: function(mSettings) {
 			ExportBase.call(this, mSettings);
+
+
+			/* Only apply supported properties */
+			['paperSize', 'orientation', 'font', 'fontSize', 'doEnableAccessibility', 'fitToPage', 'signature', 'signatureReason', 'pdfArchive'].forEach(function(sProperty) {
+				if (typeof mSettings[sProperty] !== 'undefined') {
+					this._mSettings[sProperty] = mSettings[sProperty];
+				}
+			}.bind(this));
 		}
 	});
 
@@ -127,50 +135,80 @@ sap.ui.define([
 	 * Creates the DocumentDescription based on the given export
 	 * settings and assigns a unique Id to it.
 	 *
-	 * @param {Object} oWorkbook Workbook settings of the export configuration
+	 * @param {Object} mSettings Export settings
 	 * @returns {Object} DocumentDescription object that contains all relevant export settings
 	 * @private
 	 */
-	PortableDocument.prototype._createDocumentDescription = function(oWorkbook) {
+	PortableDocument.prototype._createDocumentDescription = function(mSettings) {
+		var oWorkbook = mSettings.workbook;
 		var oDocumentDescription, oMetaInfo;
 
 		oDocumentDescription = {
 			"Title": oWorkbook.context.title,
 			"Format": {
-				"PaperSize": "DIN_A4",
-				"Orientation": "LANDSCAPE",
-				"FontSize": 12
+				"PaperSize": mSettings.paperSize,
+				"Orientation": mSettings.orientation,
+				"FontSize": Number(mSettings.fontSize),
+				"FitToPage": {
+					"IsEnabled": mSettings.fitToPage,
+					"MinimumFontSize": 4
+				}
+			},
+			"PDFStandard": {
+				"DoEnableAccessibility": mSettings.doEnableAccessibility,
+				"UsePDFAConformance": mSettings.pdfArchive
 			},
 			"Signature": {
-				"DoSign": true,
-				"Reason": ""
+				"DoSign": mSettings.signature,
+				"Reason": mSettings.signatureReason
 			},
 			"CoverPage": [],
 			"TableColumns": []
 		};
 
-		oMetaInfo = oWorkbook.context.metaInfo;
+		oMetaInfo = oWorkbook.context.metainfo;
 
 		/* Add metaInfo to CoverPage */
 		if (oMetaInfo instanceof Array) {
-			oMetaInfo.forEach(function(oGroup) {
-				var oCoverPageGroup = {
-					"Title": oGroup.name,
-					"Content": []
-				};
-
-				oGroup.items.forEach(function(oItem) {
-					oCoverPageGroup["Content"].push({
-						"Name": oItem.key,
-						"Value": oItem.value
+			if (mSettings.dataSource.version == 2) {
+				oMetaInfo.forEach(function(oGroup) {
+					oGroup.items.forEach(function(oItem) {
+						var oCoverPageGroup = {
+							"Title": oGroup.name,
+							"Name": oItem.key,
+							"Value": oItem.value
+						};
+						oDocumentDescription["CoverPage"].push(oCoverPageGroup);
 					});
 				});
-				oDocumentDescription["CoverPage"].push(oCoverPageGroup);
-			});
+			} else {
+				oMetaInfo.forEach(function(oGroup) {
+					var oCoverPageGroup = {
+						"Title": oGroup.name,
+						"Content": []
+					};
+
+					oGroup.items.forEach(function(oItem) {
+						oCoverPageGroup["Content"].push({
+							"Name": oItem.key,
+							"Value": oItem.value
+						});
+					});
+					oDocumentDescription["CoverPage"].push(oCoverPageGroup);
+				});
+			}
 		}
 
-		/* Add columns */
-		oWorkbook.columns.forEach(function(oColumn){
+		/* Eliminate duplicates and navigation properties before adding columns */
+		oWorkbook.columns.filter(function(oColumn, iIndex, aArray) {
+			var sProperty = Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property;
+
+			return aArray.findIndex(function(oOtherColumn) {
+				var sOtherProperty = Array.isArray(oOtherColumn.property) ? oOtherColumn.property[0] : oOtherColumn.property;
+
+				return sProperty === sOtherProperty;
+			}) === iIndex && !/^to_\w+\/\w+/.test(sProperty);
+		}).forEach(function(oColumn) {
 			oDocumentDescription["TableColumns"].push({
 				"Name": Array.isArray(oColumn.property) ? oColumn.property[0] : oColumn.property,
 				"Header": oColumn.label
@@ -220,7 +258,7 @@ sap.ui.define([
 			oContext = mSettings.workbook.context = {};
 		}
 
-		if (typeof oContext.title === 'string') {
+		if (typeof oContext.title === 'string' && oContext.title) {
 			return Promise.resolve();
 		}
 
@@ -236,48 +274,51 @@ sap.ui.define([
 	 *
 	 * @param {Object} oDocumentDescription DocumentDescription instance that is being created
 	 * @param {Object} oDataSource DataSource settings of the export configuration
-	 * @param {function} fnSuccess Success handler function
-	 * @param {function} fnError Error handler function
+	 *
+	 * @returns {Promise} A Promise that resolves with the newly created Id of the DocumentDescription
 	 */
-	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource, fnSuccess, fnError) {
+	PortableDocument.prototype.postDocumentDescription = function(oDocumentDescription, oDataSource) {
 		var oBinding, oModel, sPath;
 
 		oModel = this._getModel(oDataSource);
 		sPath = '/' + this._getEntitySetName(oDataSource);
 
 		if (!oModel || !oModel.isA(['sap.ui.model.odata.v4.ODataModel', 'sap.ui.model.odata.v2.ODataModel'])) {
-			fnError('Unsupported Model');
+			return Promise.reject('Unsupported Model');
 		}
 
-		if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
-			oBinding = oModel.bindList(sPath);
+		return new Promise(function(fnResolve, fnReject) {
 
-			oBinding.attachCreateCompleted(function(oEvent) {
-				var success = oEvent.getParameter('success');
+			if (oModel.isA('sap.ui.model.odata.v4.ODataModel')) {
+				oBinding = oModel.bindList(sPath);
 
-				if (success) {
-					fnSuccess(oEvent.getParameter('context').getObject()['Id']);
-				} else {
-					fnError();
-				}
-			});
+				oBinding.attachCreateCompleted(function(oEvent) {
+					var success = oEvent.getParameter('success');
 
-			oBinding.create(oDocumentDescription);
-		} else {
-			var bUseBatch = oModel.bUseBatch;
-
-			oModel.setUseBatch(false);
-			oModel.create(sPath, oDocumentDescription, {
-				success: function(oData) {
-					oModel.setUseBatch(bUseBatch);
-					fnSuccess(oData['Id']);
-				},
-				error: function(oError) {
-					oModel.setUseBatch(bUseBatch);
-					fnError(oError);
-				}
-			});
-		}
+					if (success) {
+						fnResolve(oEvent.getParameter('context').getObject()['Id']);
+					} else {
+						fnReject();
+					}
+				});
+
+				oBinding.create(oDocumentDescription);
+			} else {
+				var bUseBatch = oModel.bUseBatch;
+
+				oModel.setUseBatch(false);
+				oModel.create(sPath, oDocumentDescription, {
+					success: function(oData) {
+						oModel.setUseBatch(bUseBatch);
+						fnResolve(oData['Id']);
+					},
+					error: function(oError) {
+						oModel.setUseBatch(bUseBatch);
+						fnReject(oError);
+					}
+				});
+			}
+		});
 	};
 
 	/**
@@ -289,16 +330,33 @@ sap.ui.define([
 	 */
 	PortableDocument.prototype.createBuildPromise = function(mSettings) {
 		var that = this;
+		var oDocumentDescription;
+		var oBusyDialog;
+		var oResourceBundle = Core.getLibraryResourceBundle('sap.ui.export');
+
+		oBusyDialog = new sap.m.BusyDialog('PDFExportBusyDialog', {
+			title: oResourceBundle.getText("PROGRESS_TITLE"),
+			text: oResourceBundle.getText("PDF_GENERATION_IN_PROGRESS"),
+			showCancelButton: true,
+			close: function(oEvent) {
+				if (oEvent.getParameter("cancelPressed")) {
+					that.cancel();
+					oBusyDialog.destroy();
+					oBusyDialog = null;
+				}
+			}
+		});
 
-		return new Promise(function(fnResolve, fnReject) {
-			var oDocumentDescription;
-
-			oDocumentDescription = that._createDocumentDescription(mSettings.workbook);
-			that.postDocumentDescription(oDocumentDescription, mSettings.dataSource, fnResolve, fnReject);
+		oDocumentDescription = that._createDocumentDescription(mSettings);
 
-		}).then(function(sDocumentDescriptionId) {
-			return that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
+		return that.postDocumentDescription(oDocumentDescription, mSettings.dataSource).then(function(sDocumentDescriptionId) {
+			oBusyDialog.open();
+			return oBusyDialog && that.sendRequest(mSettings.dataSource.dataUrl, sDocumentDescriptionId).then(function(response) {
 				ExportUtils.saveAsFile(response, mSettings.fileName);
+				oBusyDialog && oBusyDialog.destroy();
+			}).catch(function(e) {
+				oBusyDialog && oBusyDialog.destroy();
+				new sap.m.MessageToast.show("Error during PDF export!");
 			});
 		});
 	};

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

@@ -83,7 +83,7 @@ sap.ui.define([
 		 *      <li><code>workbook.context</code> - Context object that will be applied to the generated file. It may contain the following fields:</li>
 		 *      <ul>
 		 *          <li><code>application</code> (string) - The application that creates the XLSX document (default: "SAP UI5")</li>
-		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.98.0")</li>
+		 *          <li><code>version</code> (string) - Application version that creates the XLSX document (default: "1.101.0")</li>
 		 *          <li><code>title</code> (string) - Title of the XLSX document (NOT the filename)</li>
 		 *          <li><code>modifiedBy</code> (string) - User context for the XLSX document</li>
 		 *          <li><code>sheetName</code> (string) - The label of the data sheet</li>
@@ -166,7 +166,7 @@ sap.ui.define([
 		 *       columns: aColumns,
 		 *       context: {
 		 *         application: 'Debug Test Application',
-		 *         version: '1.98.0',
+		 *         version: '1.101.0',
 		 *         title: 'Some random title',
 		 *         modifiedBy: 'John Doe',
 		 *         metaSheetName: 'Custom metadata',
@@ -278,7 +278,7 @@ sap.ui.define([
 		 * @constructor The <code>sap.ui.export.Spreadsheet</code> class allows you to export table data from a UI5 application to a spreadsheet file.
 		 *
 		 * @author SAP SE
-		 * @version 1.98.0
+		 * @version 1.101.0
 		 *
 		 * @since 1.50
 		 * @name sap.ui.export.Spreadsheet

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

@@ -20,10 +20,9 @@ sap.ui.define(['sap/base/Log', 'sap/ui/export/ExportUtils'], function(Log, Expor
 	/**
 	 * Utility class to perform spreadsheet export.
 	 *
-	 * @class Utility class to perform spreadsheet export
+	 * @namespace
 	 * @author SAP SE
-	 * @version 1.98.0
-	 * @static
+	 * @version 1.101.0
 	 *
 	 * @private
 	 * @since 1.50.0

package/src/sap/ui/export/fragments/SettingsDialog.fragment.xml

@@ -0,0 +1,52 @@
+<Dialog xmlns="sap.m" xmlns:core="sap.ui.core" id="exportSettingsDialog" title="{i18n>EXPORT_SETTINGS_TITLE}" horizontalScrolling="false" verticalScrolling="true" afterClose=".onAfterClose" class="sapUiContentPadding sapUiExportSettings">
+	<content>
+		<VBox renderType="Bare" width="100%" class="sapUiExportSettingsLabel">
+			<Label text="{i18n>FILE_NAME}" labelFor="exportSettingsDialog-fileName"/>
+			<Input id="exportSettingsDialog-fileName" value="{/fileName}" liveChange=".onFileNameChange" class="sapUiTinyMarginBottom"/>
+
+			<Label text="{i18n>SELECT_FORMAT}" labelFor="exportSettingsDialog-fileType" visible="{/devMode}"/>
+			<Select id="exportSettingsDialog-fileType" selectedKey="{/selectedFileType}" items="{path: '/fileType'}" change=".onFileTypeChange" width="100%" visible="{/devMode}">
+				<items>
+					<core:Item key="{key}" text="{text}"/>
+				</items>
+			</Select>
+
+			<CheckBox id="exportSettingsDialog-includeFilterSettings" selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/selectedFileType', formatter: '.isXLSX'}"/>
+			<CheckBox id="exportSettingsDialog-includeFilterSettings-PDF" enabled="{/capabilities/PDF/CoverPage}"  selected="{/includeFilterSettings}" text="{i18n>INCLUDE_FILTER_SETTINGS}"  visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_FILTER_SETTINGS}"/>
+			<CheckBox id="exportSettingsDialog-pdfArchive" enabled="{/capabilities/PDF/ArchiveFormat}" selected="{/pdfArchive}" text="{i18n>ARCHIVE_FORMAT}"  visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_ARCHIVE_FORMAT}"/>
+			<CheckBox id="exportSettingsDialog-splitCells" selected="{/splitCells}" text="{i18n>SPLIT_CELLS}" visible="{path:'/selectedFileType', formatter: '.isXLSX'}"/> <!-- Will be hidden in case of PDF because it needs to be true always -->
+			<CheckBox id="exportSettingsDialog-addDateTime" selected="{/addDateTime}" text="{i18n>ADD_DATE_TIME}" visible="false"/>
+
+			<!-- PDF Specific settings -->
+			<Label text="{i18n>PAPER_SIZE}" labelFor="exportSettingsDialog-papersize" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<Select id="exportSettingsDialog-papersize" selectedKey="{/selectedPaperSize}" items="{path: '/paperSize'}" width="100%" visible="{path:'/selectedFileType', formatter: '.isPDF'}">
+				<items>
+					<core:Item key="{key}" text="{text}"/>
+				</items>
+			</Select>
+
+			<Label text="{i18n>ORIENTATION}" labelFor="exportSettingsDialog-orientation" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<Select id="exportSettingsDialog-orientation" selectedKey="{/selectedOrientation}" items="{path: '/orientation'}" width="100%" visible="{path:'/selectedFileType', formatter: '.isPDF'}">
+				<items>
+					<core:Item key="{key}" text="{text}"/>
+				</items>
+			</Select>
+
+			<Label text="{i18n>FONT_SIZE}" labelFor="exportSettingsDialog-fontSize" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<Input id="exportSettingsDialog-fontSize" value="{/fontSize}" enabled="{/capabilities/PDF/FontSize}" liveChange=".onFontSizeChange" class="sapUiTinyMarginBottom" visible="{path:'/selectedFileType', formatter: '.isPDF'}" tooltip="{i18n>TOOLTIP_FONT_SIZE}"/>
+
+			<CheckBox id="exportSettingsDialog-accessibility" selected="{/doEnableAccessibility}" text="{i18n>ENABLE_ACCESSIBILITY}" tooltip="{i18n>TOOLTIP_PDF_ACCESSIBILITY}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<CheckBox id="exportSettingsDialog-fitToPage" enabled="{/capabilities/PDF/FitToPage}" selected="{/fitToPage}" text="{i18n>FITTOPAGE}" tooltip="{i18n>TOOLTIP_FITTOPAGE}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+			<CheckBox id="exportSettingsDialog-signature" enabled="{/capabilities/PDF/Signature}" selected="{/signature}" text="{i18n>ENABLE_SIGNATURE}" tooltip="{i18n>TOOLTIP_PDF_SIGNATURE}" visible="{path:'/selectedFileType', formatter: '.isPDF'}"/>
+
+			<Label id="exportSettingsDialog-signatureReasonLabel" text="{i18n>SIGNATURE_REASON}" labelFor="exportSettingsDialog-signatureReason" visible="{/signature}"/>
+			<Input id="exportSettingsDialog-signatureReason" value="{/signatureReason}" class="sapUiTinyMarginBottom" visible="{/signature}"/>
+		</VBox>
+	</content>
+	<beginButton>
+		<Button id="exportSettingsDialog-exportButton" press=".onExport" text="{i18n>EXPORT_BUTTON}" type="Emphasized"/>
+	</beginButton>
+	<endButton>
+		<Button id="exportSettingsDialog-cancelButton" press=".onCancel" text="{i18n>CANCEL_BUTTON}"/>
+	</endButton>
+</Dialog>