@openui5/sap.ui.mdc 1.113.0 → 1.115.0

package/src/sap/ui/mdc/util/mapVersions.js

@@ -0,0 +1,225 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+    "sap/base/Log",
+    "sap/ui/core/Core"
+], function(
+    Log,
+    Core
+) {
+	"use strict";
+
+    var versionMappings = {
+        1: {
+            // ------------------------- FilterBarDelegate, ChartDelegate & TableDelegate -------------------------
+            addItem: function(fnCalled, Delegate, argList) {
+                if (!(typeof argList[0] === "string")) {
+                    var oControl = argList[1];
+                    var sProp = argList[0];
+                    argList[0] = oControl;
+                    argList[1] = sProp;
+                }
+                return fnCalled.apply(Delegate, argList);
+            },
+            removeItem: function(fnCalled, Delegate, argList) {
+                var oControl = argList[1];
+                var sProp = argList[0];
+                argList[0] = oControl;
+                argList[1] = sProp;
+                return fnCalled.apply(Delegate, argList);
+            },
+            addCondition: function(fnCalled, Delegate, argList) {
+                return fnCalled.call(Delegate, argList[1], argList[0], argList[2]);
+            },
+            removeCondition: function(fnCalled, Delegate, argList) {
+                return fnCalled.call(Delegate, argList[1], argList[0], argList[2]);
+            },
+            // ------------------------------------- ValueHelpDelegate ----------------------------------------------
+            retrieveContent: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            isSearchSupported: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            showTypeahead: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            updateBindingInfo: function(fnCalled, Delegate, argList) {
+                if (argList[0] && argList[0].getMetadata && argList[0].getMetadata().getName() === "sap.ui.mdc.ValueHelp") {
+                    argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                }
+                return fnCalled.apply(Delegate, argList);
+            },
+            updateBinding: function(fnCalled, Delegate, argList) {
+                if (argList[0] && argList[0].getMetadata && argList[0].getMetadata().getName() === "sap.ui.mdc.ValueHelp") {
+                    argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                }
+                return fnCalled.apply(Delegate, argList);
+            },
+            adjustSearch: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            executeFilter: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            checkListBindingPending: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            onConditionPropagation: function(fnCalled, Delegate, argList) {
+                var argListNew = [
+                    (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0],
+                    argList[0],
+                    argList[1],
+                    argList[2]
+                ];
+                return fnCalled.apply(Delegate, argListNew);
+            },
+            getInitialFilterConditions: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            isFilterableListItemSelected: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            modifySelectionBehaviour: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            // ------------------------------------- FieldBaseDelegate ----------------------------------------------
+            createConditionPayload: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            getTypesForConditions: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            getFilterConditions: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            isTypeaheadSupported: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            isInputValidationEnabled: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            isInvalidInputAllowed: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            getItemForValue: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            getDescription: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            }
+            ,
+            getDefaultValueHelpDelegate: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            // ------------------------------------- LinkDelegate ----------------------------------------------
+            fetchLinkItems: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            fetchLinkType: function(fnCalled, Delegate, argList) {
+                return fnCalled.apply(Delegate, [
+                    argList[0].getPayload(),
+                    argList[0]
+                ]);
+            },
+            fetchAdditionalContent: function(fnCalled, Delegate, argList) {
+                return fnCalled.apply(Delegate, [
+                    argList[0].getPayload(),
+                    argList[0]
+                ]);
+            },
+            modifyLinkItems: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            beforeNavigationCallback: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            // ------------------------------------- DelegateMixin ----------------------------------------------
+            getTypeUtil: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            },
+            getTypeMap: function(fnCalled, Delegate, argList) {
+                argList[0] = (argList[0] && argList[0].getPayload) ? argList[0].getPayload() : argList[0];
+                return fnCalled.apply(Delegate, argList);
+            }
+        }
+    };
+
+    var mapVersions = function(obj) {
+
+        Object.keys(obj).forEach(function (prop) {
+
+            var apiVersion;
+
+            var bNeedOldApiVersion =
+            ("sap.fe.core" in Core.getLoadedLibraries()) ||
+            ("sap.fe.macros" in Core.getLoadedLibraries()) ||
+            ("sap.sac.df" in Core.getLoadedLibraries());
+
+            if (bNeedOldApiVersion && !(obj.hasOwnProperty("apiVersion"))) {
+                apiVersion = 1;
+            } else {
+                apiVersion = obj.apiVersion || 2;
+            }
+
+            if (versionMappings[apiVersion] && versionMappings[apiVersion][prop] && obj[prop] instanceof Function) {
+
+                var fnDelegateMethod = obj[prop];
+
+                if (fnDelegateMethod.__mapped) {
+                    return obj;
+                }
+
+                var proxy = new Proxy(fnDelegateMethod, {
+                    apply: function(fnCalled, Delegate, argList) {
+                        if (apiVersion > 1) {
+                            return fnCalled.apply(Delegate, argList);
+                        } else {
+                            Log.warning("Your delegate is not migrated to apiVersion 2. The first parameter of the function " +
+                            " should always be the control instance. Please check the API documentation and adjust the delegate implementation accordingly.");
+                            return versionMappings[apiVersion][prop](fnCalled, Delegate, argList);
+                        }
+                    }
+                });
+
+                proxy.getOriginalMethod = function() {
+                    return fnDelegateMethod;
+                };
+
+                proxy.__mapped = true;
+                obj[prop] = proxy;
+            }
+        });
+
+        return obj;
+    };
+
+    return mapVersions;
+
+});

package/src/sap/ui/mdc/valuehelp/Dialog.js

@@ -13,7 +13,7 @@ sap.ui.define([
 	'sap/m/FlexItemData',
 	'sap/ui/model/resource/ResourceModel',
 	'sap/ui/mdc/util/Common',
-	'sap/ui/mdc/enum/SelectType',
+	'sap/ui/mdc/enums/ValueHelpSelectionType',
 	'sap/base/strings/formatMessage',
 	'sap/ui/core/library',
 	'sap/ui/core/InvisibleMessage'
@@ -26,13 +26,24 @@ sap.ui.define([
 	FlexItemData,
 	ResourceModel,
 	Common,
-	SelectType,
+	ValueHelpSelectionType,
 	formatMessage,
 	coreLibrary,
 	InvisibleMessage
 ) {
 	"use strict";
 
+	/**
+	 * Object to label gropus on value help dialog.
+	 *
+	 * @static
+	 * @constant
+	 * @typedef {object} sap.ui.mdc.valuehelp.content.GroupLabel
+	 * @property {string} label Label with counter. The placeholder for counter needs to defined wihl <code>{0}</code>
+	 * @property {string} nnLabel Label without counter
+	 * @public
+	 */
+
 	// translation utils
 	var oMessageBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
 	sap.ui.getCore().attachLocalizationChanged(function() {
@@ -50,14 +61,11 @@ sap.ui.define([
 	 * @param {object} [mSettings] Initial settings for the new control
 	 * @class Container for the {@link sap.ui.mdc.ValueHelp ValueHelp} element showing a dialog.
 	 * @extends sap.ui.mdc.valuehelp.base.Container
-	 * @version 1.113.0
+	 * @version 1.115.0
 	 * @constructor
 	 * @abstract
-	 * @private
-	 * @ui5-restricted sap.fe
-	 * @MDC_PUBLIC_CANDIDATE
+	 * @public
 	 * @since 1.95.0
-	 * @experimental As of version 1.95
 	 * @alias sap.ui.mdc.valuehelp.Dialog
 	 */
 	var Dialog = Container.extend("sap.ui.mdc.valuehelp.Dialog", /** @lends sap.ui.mdc.valuehelp.Dialog.prototype */
@@ -85,8 +93,19 @@ sap.ui.define([
 				},
 				/**
 				 * Configuration for groups (collective search).
+				 *
+				 * The object needs to contain an entry for every possible group. The labels of every group need to have a structure of {@link sap.ui.mdc.valuehelp.content.GroupLabel}.
+				 * If no configuration is provided a standard text "search and select" is used.
+				 *
+				 * <b>Sample:</b>
+				 * <pre>
+				 * {
+				 * group1: {label: "Label 1", nnLabel: "Label 1 ({0})"},
+				 * group2: {label: "Label 2", nnLabel: "Label 2 ({0})"}
+				 * }
+				 * </pre>
 				 */
-				groupConfig: { // TODO: explain in JS-Doc
+				groupConfig: {
 					type: "object",
 					defaultValue: {}
 				}
@@ -122,7 +141,7 @@ sap.ui.define([
 
 	Dialog.prototype._handleContentSelectionChange = function (sNextId) {
 		this.fireRequestDelegateContent({container: this.getId(), contentId: sNextId});
-		return this._getRetrieveDelegateContentPromise().then(function () {
+		return this.getRetrieveDelegateContentPromise().then(function () {
 			var sCurrentContentKey = this.getProperty("_selectedContentKey");
 			var aContents = this.getContent();
 			var oCurrentContent = sCurrentContentKey && aContents && aContents.find(function (oContent) {
@@ -133,7 +152,7 @@ sap.ui.define([
 					oCurrentContent.setCollectiveSearchSelect(undefined); // remove collective search from Filterbar
 				}
 				oCurrentContent.onHide();
-				this._unbindContent(oCurrentContent);
+				this.unbindContentFromContainer(oCurrentContent);
 			}
 			return this._renderSelectedContent(sNextId);
 		}.bind(this));
@@ -149,7 +168,7 @@ sap.ui.define([
 		if (oOrigin) {
 			var aContent = this.getContent();
 			var iIndex = aContent.indexOf(oOrigin);
-			if (this._oIconTabBar && iIndex !== -1 && !this._bIsBeingDestroyed) {
+			if (this._oIconTabBar && iIndex !== -1 && !this.isDestroyStarted()) {
 				// Content invalidated -> invalidate corresponding IconTabFilter
 				var aItems = this._oIconTabBar.getItems();
 				if (aItems[iIndex]) {
@@ -162,19 +181,19 @@ sap.ui.define([
 
 	};
 
-	Dialog.prototype._getUIAreaForContent = function() {
+	Dialog.prototype.getUIAreaForContent = function() {
 		var oDialog = this.getAggregation("_container");
 		if (oDialog) {
 			return oDialog.getUIArea();
 		}
-		return Container.prototype._getUIAreaForContent.apply(this, arguments);
+		return Container.prototype.getUIAreaForContent.apply(this, arguments);
 	};
 
-	Dialog.prototype._handleConfirmed = function (oEvent) {
+	Dialog.prototype.handleConfirmed = function (oEvent) {
 		this.fireConfirm({close: true});
 	};
 
-	Dialog.prototype._handleClosed = function (oEvent) {
+	Dialog.prototype.handleClosed = function (oEvent) {
 
 		var oContent = this.getSelectedContent();
 
@@ -189,10 +208,10 @@ sap.ui.define([
 		// Reset selection to initial key for retrieveContent calls before it is opened again.
 		this.setProperty("_selectedContentKey", this._sInitialContentKey);
 
-		Container.prototype._handleClosed.apply(this, arguments);
+		Container.prototype.handleClosed.apply(this, arguments);
 	};
 
-	Dialog.prototype._getContainer = function () {
+	Dialog.prototype.getContainerControl = function () {
 		if (!this.getModel("$i18n")) {
 			// if ResourceModel not provided from outside create own one
 			this.setModel(new ResourceModel({ bundleName: "sap/ui/mdc/messagebundle", async: false }), "$i18n");
@@ -224,7 +243,7 @@ sap.ui.define([
 						text: this._oResourceBundle.getText("valuehelp.OK"),
 						enabled: "{$valueHelp>/_valid}",
 						type: ButtonType.Emphasized,
-						press: this._handleConfirmed.bind(this),
+						press: this.handleConfirmed.bind(this),
 						visible: { parts: ['$valueHelp>/_config/maxConditions', '$help>/_quickSelectEnabled'], formatter: function(iMaxConditions, bQuickSelectEnabled) {
 							return iMaxConditions !== 1 || !bQuickSelectEnabled;
 						}}
@@ -232,7 +251,7 @@ sap.ui.define([
 
 					this.oButtonCancel = new Button(this.getId() + "-cancel", {
 						text: this._oResourceBundle.getText("valuehelp.CANCEL"),
-						press: this._handleCanceled.bind(this)
+						press: this.handleCanceled.bind(this)
 					});
 
 					this._oManagedObjectModel = new ManagedObjectModel(this);
@@ -258,8 +277,8 @@ sap.ui.define([
 						stretch: Device.system.phone,
 						resizable: true,
 						draggable: true,
-						afterOpen: this._handleOpened.bind(this),
-						afterClose: this._handleClosed.bind(this),
+						afterOpen: this.handleOpened.bind(this),
+						afterClose: this.handleClosed.bind(this),
 						buttons: [this.oButtonOK, this.oButtonCancel]
 					});
 
@@ -285,7 +304,7 @@ sap.ui.define([
 		return oDialog;
 	};
 
-	Dialog.prototype._placeContent = function (oDialog) {
+	Dialog.prototype.placeContent = function (oDialog) {
 
 		var oContentArea = oDialog.getContent()[0];
 		var aSelectableContents = this.getProperty("_selectableContents");
@@ -326,17 +345,17 @@ sap.ui.define([
 		});
 	};
 
-	Dialog.prototype._handleSelect = function (oEvent) {
-		Container.prototype._handleSelect.apply(this, arguments);
+	Dialog.prototype.handleSelect = function (oEvent) {
+		Container.prototype.handleSelect.apply(this, arguments);
 
-		if (this.getProperty("_quickSelectEnabled") && this._isSingleSelect()) {
+		if (this.getProperty("_quickSelectEnabled") && this.isSingleSelect()) {
 			if (oEvent.getParameter("type") === "Add") {
 				this.fireConfirm({close: true});
 			}
 		}
 	};
 
-	Dialog.prototype._observeChanges = function (oChanges) {
+	Dialog.prototype.observeChanges = function (oChanges) {
 		if (oChanges.name === "content") {
 			var aContent = this.getContent();
 			this.setProperty("_quickSelectEnabled", aContent && aContent.every(function (oContent) {
@@ -364,7 +383,7 @@ sap.ui.define([
 			}
 		}
 
-		Container.prototype._observeChanges.apply(this, arguments);
+		Container.prototype.observeChanges.apply(this, arguments);
 	};
 
 	Dialog.prototype._updateInitialContentKey = function () {
@@ -613,7 +632,7 @@ sap.ui.define([
 									aRemovedConditions.push(aConditions[iIndex]);
 								});
 
-								this.fireSelect({type: SelectType.Remove, conditions: aRemovedConditions});
+								this.fireSelect({type: ValueHelpSelectionType.Remove, conditions: aRemovedConditions});
 							}
 
 						}.bind(this),
@@ -639,7 +658,7 @@ sap.ui.define([
 
 					this.oRemoveAllBtn = new Button(this.getId() + "-TokenRemoveAll", {
 						press: function(oEvent) {
-							this.fireSelect({type: SelectType.Set, conditions: []});
+							this.fireSelect({type: ValueHelpSelectionType.Set, conditions: []});
 
 							this.oInvisibleMessage.announce(oMessageBundle.getText("valuehelp.REMOVEALLTOKEN_ANNOUNCE"), InvisibleMessageMode.Polite);
 						}.bind(this),
@@ -688,7 +707,7 @@ sap.ui.define([
 			valueType: oConfig.dataType,
 			operators: oConfig.operators,
 			display: oConfig.display,
-			fieldHelpID: oParent && oParent.getId(), // needed to get description for Token (if not provided)
+			valueHelpID: oParent && oParent.getId(), // needed to get description for Token (if not provided)
 			control: oControl,
 			delegate: oControl && oControl.getControlDelegate && oControl.getControlDelegate(),
 			delegateName: oControl && oControl.getDelegate && oControl.getDelegate() && oControl.getDelegate().name,
@@ -716,7 +735,7 @@ sap.ui.define([
 
 	}
 
-	Dialog.prototype._open = function (oDialog) {
+	Dialog.prototype.openContainer = function (oDialog) {
 
 		this._mAlreadyShownContents = {};
 
@@ -778,7 +797,7 @@ sap.ui.define([
 		var bInitial = !this._mAlreadyShownContents[sNextContentId];
 
 		return Promise.all(aNecessaryPromises).then(function () {
-			this._bindContent(oNextContent);
+			this.bindContentToContainer(oNextContent);
 		}.bind(this)).then(function () {
 			return Promise.resolve(oNextContent.onBeforeShow(bInitial));
 		}).then(function () {
@@ -809,7 +828,7 @@ sap.ui.define([
 		}.bind(this));
 	};
 
-	Dialog.prototype._close = function () {
+	Dialog.prototype.closeContainer = function () {
 		var oContainer = this.getAggregation("_container");
 		if (oContainer) {
 			oContainer.close();