@openui5/sap.ui.mdc 1.95.0 → 1.96.3

package/src/sap/ui/mdc/Link.js

@@ -45,7 +45,7 @@ sap.ui.define([
 	 * @extends sap.ui.mdc.field.FieldInfoBase
 	 *
 	 * @author SAP SE
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 *
 	 * @constructor
 	 * @alias sap.ui.mdc.Link
@@ -200,7 +200,7 @@ sap.ui.define([
 
 	/**
 	 * Function that is called in the <code>createPopover</code> function of {@link sap.ui.mdc.field.FieldInfoBase}.
-	 * @param {Function} fnGetAutoClosedControl Function returning the <code>Popover</code> control that is created in <code>createPopover</code>
+	 * @param {Function} [fnGetAutoClosedControl] Function returning the <code>Popover</code> control that is created in <code>createPopover</code>
 	 * @returns {sap.ui.mdc.link.Panel} Popover panel which is to be displayed after clicking the link
 	 * @protected
 	 * @ui5-restricted sap.ui.mdc

package/src/sap/ui/mdc/MultiValueField.js

@@ -35,7 +35,7 @@ sap.ui.define([
 	 * @constructor
 	 * @alias sap.ui.mdc.MultiValueField
 	 * @author SAP SE
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 * @since 1.93.0
 	 *
 	 * @private

package/src/sap/ui/mdc/Table.js

@@ -37,7 +37,9 @@ sap.ui.define([
 	"sap/ui/mdc/p13n/subcontroller/GroupController",
 	"sap/ui/mdc/p13n/subcontroller/AggregateController",
 	"sap/m/ColumnPopoverSelectListItem",
-	"sap/ui/mdc/p13n/subcontroller/ColumnWidthController"
+	"sap/m/ColumnPopoverActionItem",
+	"sap/ui/mdc/p13n/subcontroller/ColumnWidthController",
+	"sap/ui/mdc/actiontoolbar/ActionToolbarAction"
 ], function(
 	Control,
 	ActionToolbar,
@@ -71,7 +73,9 @@ sap.ui.define([
 	GroupController,
 	AggregateController,
 	ColumnPopoverSelectListItem,
-	ColumnWidthController
+	ColumnPopoverActionItem,
+	ColumnWidthController,
+	ActionToolbarAction
 ) {
 	"use strict";
 
@@ -117,7 +121,6 @@ sap.ui.define([
 	 *        <b>Note:</b> The control is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.
 	 * @extends sap.ui.mdc.Control
 	 * @author SAP SE
-	 * @constructor The API/behavior is not finalized and hence this control should not be used for productive usage.
 	 * @private
 	 * @experimental
 	 * @since 1.58
@@ -352,6 +355,16 @@ sap.ui.define([
 					group: "Behavior",
 					defaultValue: false
 				},
+				/**
+				 * Determines whether the Paste button is enabled.
+				 *
+				 * @since 1.96
+				 */
+				enablePaste: {
+					type: "boolean",
+					group: "Behavior",
+					defaultValue: true
+				},
 				/**
 				 * Defines the multi-selection mode for the control.
 				 * If this property is set to the <code>Default</code> value, the <code>ResponsiveTable</code> type control renders
@@ -373,7 +386,7 @@ sap.ui.define([
 				 * The calculated column widths can have a minimum of 3rem and a maximum of 20rem.
 				 *
 				 * <b>Note:</b> To customize the automatic column width calculation the <code>visualSettings.widthSettings</code> key of the <code>PropertyInfo</code> can be used.
-				 * To avoid the heuristic column width calculation for a particular column, the <code>visualSettings.widthSettings</code> key of the <code>PropertyInfo</code> can be set to <code>false</code>.
+				 * To avoid the heuristic column width calculation for a particular column, the <code>visualSettings.widthSettings</code> key of the <code>PropertyInfo</code> must be set to <code>null</code>.
 				 * This feature has no effect if the <code>width</code> property of the column is bound or its value is set.
 				 *
 				 * @since 1.95
@@ -1407,17 +1420,26 @@ sap.ui.define([
 		if ((bShowPasteButton = !!bShowPasteButton) == this.getShowPasteButton()) {
 			return this;
 		}
-
 		this.setProperty("showPasteButton", bShowPasteButton, true);
 		if (bShowPasteButton && !this._oPasteButton && this._oToolbar) {
 			this._oToolbar.insertEnd(this._getPasteButton(), 0);
+			this._oPasteButton.setEnabled(this.getEnablePaste());
 		} else if (this._oPasteButton) {
 			this._oPasteButton.setVisible(bShowPasteButton);
+			this._oPasteButton.setEnabled(this.getEnablePaste());
 		}
 
 		return this;
 	};
 
+	Table.prototype.setEnablePaste = function(bEnablePaste) {
+		this.setProperty("enablePaste", bEnablePaste, true);
+		if (this._oPasteButton) {
+			this._oPasteButton.setEnabled(this.getEnablePaste());
+		}
+		return this;
+	};
+
 	Table.prototype._createToolbar = function() {
 		if (this.isDestroyStarted() || this.isDestroyed()) {
 			return;
@@ -1681,6 +1703,7 @@ sap.ui.define([
 	 * @private
 	 */
 	Table.prototype._onExport = function(mCustomConfig) {
+		var that = this;
 		return this._createExportColumnConfiguration(mCustomConfig).then(function(aResult) {
 			var aSheetColumns = aResult[0];
 			var oPropertyHelper = aResult[1];
@@ -1691,21 +1714,22 @@ sap.ui.define([
 					MessageBox.error(Core.getLibraryResourceBundle("sap.ui.mdc").getText("table.NO_COLS_EXPORT"), {
 						styleClass: (this.$() && this.$().closest(".sapUiSizeCompact").length) ? "sapUiSizeCompact" : ""
 					});
-				}.bind(this));
+				}.bind(that));
 				return;
 			}
 
-			var oRowBinding = this._getRowBinding();
+			var oRowBinding = that._getRowBinding();
 			var mExportSettings = {
 				workbook: {
 					columns: aSheetColumns
 				},
 				dataSource: oRowBinding,
-				fileName: mCustomConfig ? mCustomConfig.fileName : this.getHeader()
+				fileType: mCustomConfig.selectedFileType == "pdf" ? "PDF" : "XLSX",
+				fileName: mCustomConfig ? mCustomConfig.fileName : that.getHeader()
 			};
 
-			this._loadExportLibrary().then(function() {
-				sap.ui.require(["sap/ui/export/ExportUtils", "sap/ui/export/Spreadsheet"], function(ExportUtils, Spreadsheet) {
+			that._loadExportLibrary().then(function() {
+				sap.ui.require(["sap/ui/export/ExportUtils"], function(ExportUtils) {
 					var oProcessor = Promise.resolve();
 
 					if (mCustomConfig.includeFilterSettings) {
@@ -1734,22 +1758,23 @@ sap.ui.define([
 							mUserSettings.includeFilterSettings = mCustomConfig.includeFilterSettings;
 						}
 
-						var oSheet = new Spreadsheet(mExportSettings);
-						oSheet.attachBeforeExport(function(oEvent) {
+						ExportUtils.getExportInstance(mExportSettings).then(function(oSheet){
+							oSheet.attachBeforeExport(function(oEvent) {
 							var oExportSettings = oEvent.getParameter("exportSettings");
 
-							this.fireBeforeExport({
+							that.fireBeforeExport({
 								exportSettings: oExportSettings,
 								userExportSettings: mUserSettings
+							  });
+						    }, that);
+							oSheet.build().finally(function() {
+								oSheet.destroy();
 							});
-						}, this);
-						oSheet.build().finally(function() {
-							oSheet.destroy();
 						});
-					}.bind(this));
-				}.bind(this));
-			}.bind(this));
-		}.bind(this));
+					});
+				});
+			});
+		});
 	};
 
 	/**
@@ -1757,12 +1782,13 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	Table.prototype._onExportAs = function() {
+	Table.prototype._onExportAs = function(mCustomConfig) {
 		var that = this;
 
 		this._loadExportLibrary().then(function() {
 			sap.ui.require(['sap/ui/export/ExportUtils'], function(ExportUtils) {
-				ExportUtils.getExportSettingsViaDialog(that._cachedExportSettings, that).then(function(oUserInput) {
+				var bEnablePDFExport = new URL(window.location.href).search.indexOf("sap-ui-xx-enablePDFExport=true");
+				ExportUtils.getExportSettingsViaDialog(that._cachedExportSettings, that, undefined, bEnablePDFExport).then(function(oUserInput) {
 					that._cachedExportSettings = oUserInput;
 					that._onExport(oUserInput);
 				});
@@ -1923,6 +1949,11 @@ sap.ui.define([
 		} else {
 			oTableType.disableColumnResizer(this, this._oTable);
 		}
+
+		var aMDCColumns = this.getColumns();
+		aMDCColumns.forEach(function(oColumn) {
+			oColumn.updateColumnResizing(bEnableColumnResizer);
+		}, this);
 	};
 
 	Table.prototype._updateSelectionBehavior = function() {
@@ -1951,6 +1982,10 @@ sap.ui.define([
 	};
 
 	Table.prototype._onColumnPress = function(oColumn) {
+		if (this._bSuppressOpenMenu) {
+			return;
+		}
+
 		var oParent = oColumn.getParent(),
 			iIndex = oParent.indexOfColumn(oColumn),
 			oMDCColumn = this.getColumns()[iIndex],
@@ -2025,7 +2060,15 @@ sap.ui.define([
 			aHeaderItems.forEach(function(oItem) {
 				this._createPopover(oItem, oColumn);
 			}, this);
-			this._oPopover && this._oPopover.openBy(oColumn);
+
+			if (this._oPopover) {
+				this._oPopover.openBy(oColumn);
+				this._oPopover.getAggregation("_popover").attachAfterClose(function() {
+					this._bSuppressOpenMenu = false;
+				}, this);
+				this._bSuppressOpenMenu = true;
+			}
+
 		}.bind(this));
 	};
 
@@ -2163,7 +2206,7 @@ sap.ui.define([
 			width: oMDCColumn.getWidth(),
 			minWidth: Math.round(oMDCColumn.getMinWidth() * parseFloat(MLibrary.BaseFontSize)),
 			hAlign: oMDCColumn.getHAlign(),
-			label: oMDCColumn.getColumnHeaderControl(this._bMobileTable),
+			label: oMDCColumn.getColumnHeaderControl(this._bMobileTable, this.getEnableColumnResize()),
 			resizable: this.getEnableColumnResize(),
 			autoResizable: this.getEnableColumnResize()
 		});
@@ -2181,7 +2224,7 @@ sap.ui.define([
 			width: oMDCColumn.getWidth(),
 			autoPopinWidth: oMDCColumn.getMinWidth(),
 			hAlign: oMDCColumn.getHAlign(),
-			header: oMDCColumn.getColumnHeaderControl(this._bMobileTable),
+			header: oMDCColumn.getColumnHeaderControl(this._bMobileTable, this.getEnableColumnResize()),
 			importance: oMDCColumn.getImportance(),
 			popinDisplay: "Inline"
 		});
@@ -2667,6 +2710,9 @@ sap.ui.define([
 	// Called when a paste event is fired from the inner table
 	// Fires the MDCTable paste event
 	Table.prototype._onInnerTablePaste = function(oEvent) {
+		if (!this.getEnablePaste()) {
+			return;
+		}
 		this.firePaste({
 			data: oEvent.getParameter("data")
 		});
@@ -2701,6 +2747,16 @@ sap.ui.define([
 		Control.prototype.exit.apply(this, arguments);
 	};
 
+	Table.prototype.addAction = function(oControl) {
+		if (oControl.getMetadata().getName() !== "sap.ui.mdc.actiontoolbar.ActionToolbarAction") {
+			oControl = new ActionToolbarAction(oControl.getId() + "-action", {
+				action: oControl
+			});
+		}
+
+		return Control.prototype.addAggregation.apply(this, ["actions", oControl]);
+	};
+
 	return Table;
 
 });

package/src/sap/ui/mdc/ValueHelp.js

@@ -69,7 +69,7 @@ sap.ui.define([
 	 * @class Element for the <code>FieldHelp</code> association in the <code>FieldBase</code> controls.
 	 * @extends sap.ui.mdc.Element
 	 * @implements sap.ui.core.PopupInterface
-	 * @version 1.95.0
+	 * @version 1.96.3
 	 * @constructor
 	 * @abstract
 	 * @private
@@ -252,15 +252,30 @@ sap.ui.define([
 				 */
 				closed: {},
 
+				/**
+				 * This event is fired after the user navigated in the value help.
+				 */
 				navigated: {
 					parameters: {
+						/**
+						 * True if the focus should be set back to the field.
+						 */
 						bLeaveFocus: { type: "boolean" },
+						/**
+						 * Navigated condition.
+						 *
+						 * <b>Note:</b> A condition must have the structure of {@link sap.ui.mdc.condition.ConditionObject ConditionObject}.
+						 */
 						condition: { type: "object" },
-						value: { type: "string" },
-						key: { type: "string" },
+						/**
+						 * ID of the navigated item. (This is needed to set the corresponding aria-attribute)
+						 */
 						itemId: { type: "string" }
 					}
 				},
+				/**
+				 * This event is fired if the user wants to switch from typeahead to value help.
+				 */
 				switchToValueHelp: {}
 			},
 			defaultProperty: "filterValue"
@@ -404,8 +419,8 @@ sap.ui.define([
 		return this._retrievePromise("delegateContent--" + oContainer.getId(), function() {
 			var oDelegatePromise = this._getControlDelegatePromise();
 			return oDelegatePromise.then(function (oDelegateModule) {
-				return oDelegateModule.retrieveContent(oContainer); // TODO: wait until In/OutParameter bindings finished?
-			});
+				return oDelegateModule.retrieveContent(this.getPayload(), oContainer); // TODO: wait until In/OutParameter bindings finished?
+			}.bind(this));
 		}.bind(this));
 	};
 
@@ -633,7 +648,6 @@ sap.ui.define([
 	 * belongs to, not by the application.
 	 *
 	 * @param {int} iStep Number of steps for navigation (e.g. 1 means next item, -1 means previous item)
-	 * @returns {Promise<object>} Promise returning object of navigated item (condition and itemId)
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc.field.FieldBase
@@ -652,7 +666,7 @@ sap.ui.define([
 			};
 			var oNavigatePromise = this._retrievePromise("navigate");
 			var oExistingPromise = oNavigatePromise && !oNavigatePromise.isSettled() && oNavigatePromise.getInternalPromise();
-			return this._addPromise("navigate", oExistingPromise ? oExistingPromise.then(_fnOnNavigatable) : this._retrieveDelegateContent(oTypeahead).then(_fnOnNavigatable));
+			this._addPromise("navigate", oExistingPromise ? oExistingPromise.then(_fnOnNavigatable) : this._retrieveDelegateContent(oTypeahead).then(_fnOnNavigatable));
 		}
 	};
 
@@ -697,9 +711,10 @@ sap.ui.define([
 	 * @param {sap.ui.model.Context} [oConfig.bindingContext] <code>BindingContext</code> of the checked field. Inside a table the <code>ValueHelp</code> element might be connected to a different row.
 	 * @param {boolean} [oConfig.checkKeyFirst] If set, the value help checks first if the value fits a key // TODO: not longer needed?
 	 * @param {boolean} oConfig.checkKey If set, the value help checks only if there is an item with the given key. This is set to <code>false</code> if the value cannot be a valid key because of type validation.
-	 * @param {boolean} oConfig.checkDescription If set, the field help checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
+	 * @param {boolean} oConfig.checkDescription If set, the value help checks only if there is an item with the given description. This is set to <code>false</code> if only the key is used in the field.
 	 * @param {sap.ui.mdc.condition.ConditionModel} [oConfig.conditionModel] <code>ConditionModel</code>, in case of <code>FilterField</code>
 	 * @param {string} [oConfig.conditionModelName] Name of the <code>ConditionModel</code>, in case of <code>FilterField</code>
+	 * @param {boolean} [oConfig.caseSensitive] If set, the check is done case sensitive
 	 * @returns {Promise<sap.ui.mdc.field.FieldHelpItem>} Promise returning object containing description, key, in and out parameters.
 	 * @throws {sap.ui.model.FormatException|sap.ui.model.ParseException} if entry is not found or not unique
 	 *
@@ -750,12 +765,11 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc.field.FieldBase
 	 * @ui5-metamodel This method also will be described in the UI5 (legacy) designtime metamodel
 	 */
-	ValueHelp.prototype.isValidationSupported = function(oConfig) { // isUsableForValidation also necessary?
+	ValueHelp.prototype.isValidationSupported = function() { // isUsableForValidation also necessary?
 
 		var oTypeahead = this.getTypeahead();
-		if (oTypeahead) {
-			return oTypeahead.isValidationSupported();
-		}
+
+		return oTypeahead && oTypeahead.isValidationSupported();
 
 	};
 
@@ -801,11 +815,11 @@ sap.ui.define([
 				}
 				if (bUpdate) {
 					var vNewValue;
+					var oNewCondition;
 					if (bUseConditions) {
 						if (!Array.isArray(vValue)) {
 							throw new Error("Value on OutParameter must be an array " + oOutParameter);
 						}
-						var oNewCondition;
 						vNewValue = merge([], vValue);
 					} else {
 						vNewValue = vValue;
@@ -1226,9 +1240,10 @@ sap.ui.define([
 
 		var aBindings = [];
 		var bBindingChanged = false;
+		var oMyBindingContext;
 
 		if (oBindingContext) {
-			var oMyBindingContext = this.oBindingContexts[undefined]; // as getBindingContext returns propagated Context if own context don't fit to model
+			oMyBindingContext = this.oBindingContexts[undefined]; // as getBindingContext returns propagated Context if own context don't fit to model
 			if (oBindingContext && Context.hasChanged(oMyBindingContext, oBindingContext)) {
 				bBindingChanged = true;
 			}

package/src/sap/ui/mdc/ValueHelpDelegate.js

@@ -4,35 +4,141 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
+// ---------------------------------------------------------------------------------------
+// Helper class used to execute model specific logic in ValueHelp
+// ---------------------------------------------------------------------------------------
+
 sap.ui.define([
-	'sap/ui/mdc/BaseDelegate'
+	"sap/ui/mdc/BaseDelegate",
+	"sap/ui/model/FilterType"
 ], function(
-	BaseDelegate
+	BaseDelegate,
+	FilterType
 ) {
 	"use strict";
 
+	/**
+	 * @class Delegate class for {@link sap.ui.mdc.ValueHelp ValueHelp}.<br>
+	 * <b>Note:</b> The class is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.
+	 *
+	 * @author SAP SE
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 * @experimental As of version 1.95
+	 * @since 1.95.0
+	 * @alias sap.ui.mdc.ValueHelpDelegate
+	 */
 	var ValueHelpDelegate = Object.assign({}, BaseDelegate);
 
-	ValueHelpDelegate.retrieveContent = function (oContainer) {
+	/**
+	 * Requests the content of the value help.
+	 *
+	 * This function is called when the value help is opened or a key or description is requested.
+	 *
+	 * So, depending on the value help content used, all content controls and data need to be assigned.
+	 * Once they are assigned and the data is set, the returned <code>Promise</code> needs to be resolved.
+	 * Only then does the value help continue opening or reading data.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.mdc.valuehelp.base.Container} oContainer Container instance
+	 * @returns {Promise} Promise that is resolved if all content is available
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	ValueHelpDelegate.retrieveContent = function (oPayload, oContainer) {
 		return Promise.resolve();
 	};
 
+	/**
+	 * Checks if a <code>ListBinding</code> supports $Search.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding ListBinding
+	 * @returns {boolean} true if $search is supported
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
 	ValueHelpDelegate.isSearchSupported = function(oPayload, oListBinding) {
 		return false;
 	};
 
+	/**
+	 * Executes a search in a <code>ListBinding</code>.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding ListBinding
+	 * @param {string} sSearch Search string
+	 * @returns {Promise} Promise that is resolved if search is executed
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
 	ValueHelpDelegate.executeSearch = function(oPayload, oListBinding, sSearch) {
 		return Promise.resolve();
 	};
 
+	/**
+	 * Executes a filter in a <code>ListBinding</code>.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding List binding
+	 * @param {sap.ui.model.Filter} oFilter Filter
+	 * @param {int} iRequestedItems Number of requested items
+	 * @returns {Promise<sap.ui.model.ListBinding>} Promise that is resolved if search is executed
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
 	ValueHelpDelegate.executeFilter = function(oPayload, oListBinding, oFilter, iRequestedItems) {
-		return Promise.resolve(oListBinding);
+
+		if (oListBinding.isA("sap.ui.model.json.JSONListBinding")) { // TODO: find way unique for all ListBindings
+			oListBinding.filter(oFilter, FilterType.Application);
+			return Promise.resolve(oListBinding);
+		} else { // oData V2
+			var fnResolve;
+			var fnCallback = function() {
+				fnResolve(oListBinding);
+			};
+			oListBinding.attachEventOnce("dataReceived", fnCallback);
+			oListBinding.initialize();
+			oListBinding.filter(oFilter, FilterType.Application);
+			oListBinding.getContexts(0, iRequestedItems); // trigger request. not all entries needed, we only need to know if there is one, none or more
+			return new Promise(function(fResolve, fReject) {
+				fnResolve = fResolve;
+			});
+		}
+
 	};
 
+	/**
+	 * Checks if at least one <code>PropertyBinding</code> is waiting for an update.
+	 * As long as the value has not been set for <code>PropertyBinding</code>,
+	 * <code>ValueHelp</code> needs to wait.
+	 *
+	 * This check is used when selecting the description for a key if in parameters are used.
+	 * The description can only be determined if the values of the in parameters are known.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.PropertyBinding[]} aBindings <code>PropertyBinding</code> array to check
+	 * @returns {null|Promise} <code>Promise</code> that is resolved once every <code>PropertyBinding</code> has been updated
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
 	ValueHelpDelegate.checkBindingsPending = function(oPayload, aBindings) {
 		return null;
 	};
 
+	/**
+	 * Checks if the <code>ListBinding</code> is waiting for an update.
+	 * As long as the context has not been set for <code>ListBinding</code>,
+	 * <code>FieldValueHelp</code> needs to wait.
+	 *
+	 * @param {object} oPayload Payload for delegate
+	 * @param {sap.ui.model.ListBinding} oListBinding <code>ListBinding</code> to check
+	 * @param {object} oListBindingInfo <code>ListBindingInfo</code> to check
+	 * @returns {boolean|Promise<boolean>} <code>Promise</code> that is resolved once <code>ListBinding</code> has been updated
+	 * @private
+	 * @ui5-restricted sap.ui.mdc.ValueHelp
+	 */
 	ValueHelpDelegate.checkListBindingPending = function(oPayload, oListBinding, oListBindingInfo) {
 		return false;
 	};