@openui5/sap.ui.mdc 1.99.1 → 1.102.0

package/src/sap/ui/mdc/p13n/StateUtil.js

@@ -4,7 +4,8 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
 */
 sap.ui.define([
-], function() {
+	"sap/ui/mdc/p13n/Engine"
+], function(Engine) {
 	"use strict";
 
 	/**
@@ -43,11 +44,15 @@ sap.ui.define([
 		*	<li><code>aggregated</code> - Set to <code>false</code>  to remove an aggregation.</li>
 		*	</ul>
 		*
+		*	<b>Note:</b>To improve the performance, you should avoid additional calls of the control’s delegate.
+		*	To do this, the <code>propertyInfo</code> property of the relevant control can be enriched with the properties used in the provided state.
+		*
+		*
 		* @private
 		* @ui5-restricted sap.fe
 		* @MDC_PUBLIC_CANDIDATE
 		*
-		* @param {object} oControl The control that is used to create changes and to which changes are made
+		* @param {sap.ui.mdc.Control} oControl The control that is used to create changes and to which changes are made
 		* @param {object} oState The state in which the control is represented
 		*
 		* @example
@@ -95,7 +100,8 @@ sap.ui.define([
 		* @returns {Promise} <code>Promise</code> that resolves after all changes have been applied
 		*/
 		applyExternalState: function(oControl, oState){
-			return oControl.getEngine().applyState(oControl, StateUtil._internalizeKeys(oState));
+			var oInternalState = Engine.getInstance().internalizeKeys(oControl, oState);
+			return Engine.getInstance().applyState(oControl, oInternalState);
 		},
 
 		/**
@@ -108,13 +114,33 @@ sap.ui.define([
 		 * @private
 		 * @ui5-restricted sap.fe
 		 * @MDC_PUBLIC_CANDIDATE
-		 * @param {object} oControl The control instance implementing IxState to retrieve the externalized state
+		 * @param {sap.ui.mdc.Control} oControl The control instance implementing IxState to retrieve the externalized state
 		 *
 		 * @returns {Promise} <code>Promise</code> that resolves after the current state has been retrieved
 		 */
 		retrieveExternalState: function(oControl) {
-			return oControl.getEngine().retrieveState(oControl).then(function(oEngineState){
-				return StateUtil._externalizeKeys(oEngineState);
+			return Engine.getInstance().retrieveState(oControl).then(function(oEngineState){
+				return Engine.getInstance().externalizeKeys(oControl, oEngineState);
+			});
+		},
+
+		/**
+		 * Creates a delta between two states.
+		 *
+		 * @private
+		 * @ui5-restricted sap.fe
+		 *
+		 * @MDC_PUBLIC_CANDIDATE
+		 * @param {sap.ui.mdc.Control} oControl The control instance implementing IxState
+		 * @param {object} oOldState The prior state
+		 * @param {object} oNewState The new state
+		 *
+		 * @returns {Promise} <code>Promise</code> that resolves after the current state has been diffed
+		 */
+		diffState: function(oControl, oOldState, oNewState) {
+			return sap.ui.mdc.p13n.Engine.getInstance().diffState(oControl, Engine.getInstance().internalizeKeys(oControl, oOldState), Engine.getInstance().internalizeKeys(oControl, oNewState))
+			.then(function(oEngineStateDiff){
+				return Engine.getInstance().externalizeKeys(oControl, oEngineStateDiff);
 			});
 		},
 
@@ -128,7 +154,7 @@ sap.ui.define([
 		 * @param {function} fnListener fnFunction The handler function to call when the event occurs
 		 */
 		attachStateChange: function(fnListener) {
-			sap.ui.mdc.p13n.Engine.getInstance().stateHandlerRegistry.attachChange(fnListener);
+			Engine.getInstance().stateHandlerRegistry.attachChange(fnListener);
 		},
 
 		/**
@@ -141,50 +167,7 @@ sap.ui.define([
 		 * @param {function} fnListener fnFunction The handler function to detach from the event
 		 */
 		detachStateChange: function(fnListener) {
-			sap.ui.mdc.p13n.Engine.getInstance().stateHandlerRegistry.detachChange(fnListener);
-		},
-
-		_externalizeKeys: function(oInternalState) {
-			var mKeysForState = {
-				Sort: "sorters",
-				Group: "groupLevels",
-				Aggregate: "aggregations",
-				Filter: "filter",
-				Item: "items",
-				Column: "items",
-				ColumnWidth: "supplementaryConfig"
-			};
-			var oTransformedState = {};
-
-			Object.keys(oInternalState).forEach(function(sProvidedEngineKey){
-				var sExternalKey = mKeysForState[sProvidedEngineKey];
-				var sTransformedKey = sExternalKey || sProvidedEngineKey;//no external key --> provide internal key
-				oTransformedState[sTransformedKey] = oInternalState[sProvidedEngineKey];
-			});
-			return oTransformedState;
-		},
-
-		_internalizeKeys: function(oExternalState) {
-			var mKeysForEngine = {
-				sorters: ["Sort"],
-				groupLevels: ["Group"],
-				aggregations: ["Aggregate"],
-				filter: ["Filter"],
-				items: ["Item", "Column"],
-				supplementaryConfig: ["ColumnWidth"]
-			};
-
-			var oTransformedState = {};
-
-			Object.keys(oExternalState).forEach(function(sProvidedEngineKey){
-				if (mKeysForEngine[sProvidedEngineKey]) {
-					mKeysForEngine[sProvidedEngineKey].forEach(function(sTransformedKey){
-						oTransformedState[sTransformedKey] = oExternalState[sProvidedEngineKey];
-					});
-				}
-			});
-
-			return oTransformedState;
+			Engine.getInstance().stateHandlerRegistry.detachChange(fnListener);
 		}
 
 	};

package/src/sap/ui/mdc/p13n/UIManager.js

@@ -10,8 +10,9 @@ sap.ui.define([
 	"sap/m/p13n/Container",
 	"sap/m/p13n/AbstractContainerItem",
 	"sap/base/util/UriParameters",
-	"sap/base/Log"
-], function (BaseObject, P13nBuilder, P13nContainer, AbstractContainerItem, SAPUriParameters, Log) {
+	"sap/base/Log",
+	"sap/ui/thirdparty/jquery"
+], function (BaseObject, P13nBuilder, P13nContainer, AbstractContainerItem, SAPUriParameters, Log, jQuery) {
 	"use strict";
 
 	var ERROR_INSTANCING = "UIManager: This class is a singleton and should not be used without an AdaptationProvider. Please use 'sap.ui.mdc.p13n.Engine.getInstance().uimanager' instead";
@@ -20,7 +21,7 @@ sap.ui.define([
 	var oUIManager;
 
 	//Used for experimental features (such as livemode)
-	var oURLParams = new SAPUriParameters(window.location.search);
+	var oURLParams = SAPUriParameters.fromQuery(window.location.search);
 
 	/**
 	 * Constructor for a new UIManager.
@@ -32,7 +33,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
@@ -73,7 +74,7 @@ sap.ui.define([
 		this.bLiveMode = false;
 
 		//!!!Warning: experimental and only for testing purposes!!!----------
-		if (oURLParams.getAll("sap-ui-xx-p13nLiveMode")[0] === "true"){
+		if (oURLParams.get("sap-ui-xx-p13nLiveMode") === "true"){
 			this.bLiveMode = true;
 			Log.warning("Please note that the p13n liveMode is experimental");
 		}
@@ -101,7 +102,7 @@ sap.ui.define([
 	 * @ui5-restricted sap.ui.mdc
 	 *
 	 * @param {sap.ui.mdc.Control} vControl The registered control instance
-	 * @param {string} sKey The key for the according Controller
+	 * @param {string|string[]} vKey The key for the according Controller
 	 * @param {Object[]} aCustomInfo A custom set of propertyinfos as base to create the UI
 	 *
 	 * @returns {Promise} A Promise resolving in the P13n UI.
@@ -157,8 +158,8 @@ sap.ui.define([
 	 *
 	 * @private
 	 *
-	 * @param {sap.ui.mdc.Control} vControl The registered control instance.
-	 * @param {string} aKeys The registerd key to get the corresponding Controller.
+	 * @param {sap.ui.mdc.Control} oControl The registered control instance.
+	 * @param {string} aKeys The registered key to get the corresponding Controller.
 	 *
 	 * @returns {Promise} A Promise resolving in the according container
 	 * (Depending on the Controllers livemode config).
@@ -207,7 +208,11 @@ sap.ui.define([
 		}.bind(this));
 
 		return Promise.all(aPAdaptationUI).then(function(aUIs){
-			var oPopupContent = bUseP13nContainer ? new P13nContainer() : aUIs[0].panel;
+			var oPopupContent = bUseP13nContainer ? new P13nContainer({
+				afterViewSwitch: function(oEvt) {
+					this.oAdaptationProvider.validateP13n(oControl, oEvt.getParameter("target"), oEvt.getSource().getCurrentViewContent());
+				}.bind(this)
+			}) : aUIs[0].panel;
 			if (bUseP13nContainer) {
 				aUIs.forEach(function(mUI){
 					if (mUI.panel) {
@@ -233,9 +238,10 @@ sap.ui.define([
 	 *
 	 * @private
 	 *
-	 * @param {sap.ui.mdc.Control} vControl The registered control instance.
-	 * @param {string} sKey The registerd key to get the corresponding Controller.
-	 * @param {sap.ui.core.Control} oPanel The control instance which is set in the content area of the container.
+	 * @param {sap.ui.mdc.Control} oControl The registered control instance.
+	 * @param {string[]} aKeys The registered keys to get the corresponding Controller.
+	 * @param {*} oPopupContent
+	 * @param {*} oUISettings
 	 *
 	 * @returns {Promise} Returns a Promise resolving in the container instance
 	 */
@@ -297,9 +303,10 @@ sap.ui.define([
 	 *
 	 * @private
 	 *
-	 * @param {sap.ui.mdc.Control} vControl The registered control instance.
-	 * @param {string} sKey The registerd key to get the corresponding Controller.
+	 * @param {sap.ui.mdc.Control} oControl The registered control instance.
+	 * @param {string[]} aKeys The registerd key to get the corresponding Controller.
 	 * @param {sap.ui.core.Control} oPanel The control instance which is set in the content area of the container.
+	 * @param {object} mUISettings
 	 *
 	 * @returns {sap.m.ResponsivePopover} The popover instance.
 	 */

package/src/sap/ui/mdc/p13n/modification/ModificationHandler.js

@@ -76,180 +76,6 @@ sap.ui.define([
 		return false;
 	};
 
-	/**
-	 * Enhances the $aggregactionconfig object for a given mdc control instance.
-	 *
-	 * @param {sap.ui.core.Element} oControl The according element which should be checked
-	 * @param {object} oModificationPayload An object providing a modification handler specific payload
-	 * @param {object} oModificationPayload.name The affected property name
-	 * @param {object} oModificationPayload.controlMeta Object describing which config is affected
-	 * @param {object} oModificationPayload.controlMeta.aggregation The affected aggregation name (such as <code>columns</code> or <code>filterItems</code>)
-	 * @param {object} oModificationPayload.controlMeta.property The affected property name (such as <code>width</code> or <code>lable</code>)
-	 * @param {object} oModificationPayload.value The value that should be written in nthe xConfig
-	 * @param {object} [oModificationPayload.propertyBag] Optional propertybag for different modification handler derivations
-	 *
-	 * @returns {Promise<object>} Promise resolving to the adapted xConfig object
-	 */
-	ModificationHandler.prototype.enhanceConfig = function(oControl, oModificationPayload) {
-		var mPropertyBag = oModificationPayload.propertyBag;
-		var oModifier = mPropertyBag ? mPropertyBag.modifier : JsControlTreeModifier;
-		var sPropertyInfoKey = oModificationPayload.name;
-		var mControlMeta = oModificationPayload.controlMeta;
-
-		var sAffectedAggregation = mControlMeta.aggregation;
-		var sAffectedProperty = mControlMeta.property;
-
-		var vValue = oModificationPayload.value;
-		var oControlMetadata;
-		var sAggregationName;
-		var oXConfig;
-
-		return oModifier.getControlMetadata(oControl)
-			.then(function(oRetrievedControlMetadata) {
-				oControlMetadata = oRetrievedControlMetadata;
-				sAggregationName = sAffectedAggregation ? sAffectedAggregation : oControlMetadata.getDefaultAggregation().name;
-				return oModifier.getAggregation(oControl, "customData");
-			})
-			.then(function(aCustomData) {
-
-				return Promise.all(aCustomData.map(function(oCustomData){
-					return oModifier.getProperty(oCustomData, "key");
-				})).then(function(aCustomDataKeys){
-					return aCustomData.reduce(function(oResult, mCustomData, iIndex){
-						return aCustomDataKeys[iIndex] === "xConfig" ? mCustomData : oResult;
-					}, undefined);
-				});
-			})
-			.then(function(oRetrievedXConfig) {
-				oXConfig = oRetrievedXConfig;
-				if (oXConfig) {
-					return oModifier.getProperty(oXConfig, "value");
-				}
-				return {
-					aggregations: {}
-				};
-			})
-			.then(function(oConfig) {
-				if (!oConfig.aggregations.hasOwnProperty(sAggregationName)) {
-					if (oControlMetadata.hasAggregation(sAggregationName)) {
-						oConfig.aggregations[sAggregationName] = {};
-					} else {
-						throw new Error("The aggregation " + sAggregationName + " does not exist for" + oControl);
-					}
-				}
-
-				if (!oConfig.aggregations.hasOwnProperty(sPropertyInfoKey)) {
-					oConfig.aggregations[sAggregationName][sPropertyInfoKey] = {};
-				}
-
-				if (vValue !== null) {
-					oConfig.aggregations[sAggregationName][sPropertyInfoKey][sAffectedProperty] = vValue;
-				} else {
-					delete oConfig.aggregations[sAggregationName][sPropertyInfoKey][sAffectedProperty];
-
-					//Delete empty property name object
-					if (Object.keys(oConfig.aggregations[sAggregationName][sPropertyInfoKey]).length === 0) {
-						delete oConfig.aggregations[sAggregationName][sPropertyInfoKey];
-
-						//Delete empty aggregation name object
-						if (Object.keys(oConfig.aggregations[sAggregationName]).length === 0) {
-							delete oConfig.aggregations[sAggregationName];
-						}
-					}
-				}
-
-				var oAppComponent = mPropertyBag ? mPropertyBag.appComponent : undefined;
-
-				if (!oControl._pXConfigCreation) {
-					oControl._pXConfigCreation = oModifier.createAndAddCustomData(oControl, "xConfig", oConfig, oAppComponent);
-					return oControl._pXConfigCreation
-					.then(function(){
-						return oConfig;
-					});
-				} else {
-					oControl._pXConfigCreation
-					.then(function(oCustomData){
-						oModifier.setProperty(oCustomData, "value", oConfig);
-						return oConfig;
-					});
-				}
-			});
-	};
-
-	/**
-	 * Returns a copy of the xConfig object
-	 *
-	 * @param {sap.ui.core.Element} oControl The according element which should be checked
-	 * @param {object} [oModificationPayload] An object providing a modification handler specific payload
-	 * @param {object} [oModificationPayload.propertyBag] Optional propertybag for different modification handler derivations
-	 *
-	 * @returns {Promise<object>|object} A promise resolving to the adapted xConfig object or the object directly
-	 */
-	ModificationHandler.prototype.readConfig = function(oControl, oModificationPayload) {
-		var oConfig, oAggregationConfig;
-
-		if (oModificationPayload) {
-			var oModifier = oModificationPayload.propertyBag ? oModificationPayload.propertyBag.modifier : JsControlTreeModifier;
-			return oModifier.getAggregation(oControl, "customData")
-				.then(function(aCustomData) {
-					return Promise.all(aCustomData.map(function(oCustomData){
-						return oModifier.getProperty(oCustomData, "key");
-					})).then(function(aCustomDataKeys){
-						return aCustomData.reduce(function(oResult, mCustomData, iIndex){
-							return aCustomDataKeys[iIndex] === "xConfig" ? mCustomData : oResult;
-						}, undefined);
-					});
-				})
-				.then(function(oAggregationConfig) {
-					if (oAggregationConfig) {
-						return oModifier.getProperty(oAggregationConfig, "value")
-							.then(function(oValue) {
-								return merge({}, oValue);
-							});
-					}
-					return null;
-				});
-		}
-
-		// These functions are used instead of the modifier to avoid that the
-		// entire call stack is changed to async when it's not needed
-		var fnGetAggregationSync = function(oParent, sAggregationName) {
-			var fnFindAggregation = function(oControl, sAggregationName) {
-				if (oControl) {
-					if (oControl.getMetadata) {
-						var oMetadata = oControl.getMetadata();
-						var oAggregations = oMetadata.getAllAggregations();
-						if (oAggregations) {
-							return oAggregations[sAggregationName];
-						}
-					}
-				}
-				return undefined;
-			};
-
-			var oAggregation = fnFindAggregation(oParent, sAggregationName);
-			if (oAggregation) {
-				return oParent[oAggregation._sGetter]();
-			}
-			return undefined;
-		};
-
-		var fnGetPropertySync = function(oControl, sPropertyName) {
-			var oMetadata = oControl.getMetadata().getPropertyLikeSetting(sPropertyName);
-			if (oMetadata) {
-				var sPropertyGetter = oMetadata._sGetter;
-				return oControl[sPropertyGetter]();
-			}
-			return undefined;
-		};
-
-		oAggregationConfig = fnGetAggregationSync(oControl, "customData").find(function(oCustomData){
-			return fnGetPropertySync(oCustomData, "key") == "xConfig";
-		});
-		oConfig = oAggregationConfig ? merge({}, fnGetPropertySync(oAggregationConfig, "value")) : null;
-		return oConfig;
-	};
-
 	ModificationHandler.getInstance = function() {
 		if (!oModificationHandler){
 			oModificationHandler = new ModificationHandler();

package/src/sap/ui/mdc/p13n/modules/DefaultProviderRegistry.js

@@ -25,16 +25,16 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
 	 * @experimental As of version 1.89
 	 * @since 1.89
-	 * @alias sap.ui.mdc.p13n.DefaultProviderRegistry
+	 * @alias sap.ui.mdc.p13n.modules.DefaultProviderRegistry
 	 */
 	var DefaultProviderRegistry = BaseObject.extend("sap.ui.mdc.p13n.modules.DefaultProviderRegistry", {
-		constructor: function() {
+		constructor: function(oEngine) {
 
 			if (oDefaultProviderRegistry) {
 				throw Error(ERROR_INSTANCING);
@@ -42,6 +42,7 @@ sap.ui.define([
 
 			BaseObject.call(this);
 			this._mDefaultProviders = {};
+			this._oEngine = oEngine;
 		}
 	});
 
@@ -54,27 +55,29 @@ sap.ui.define([
 			this._mDefaultProviders[sProviderName].destroy();
 			delete this._mDefaultProviders[sProviderName];
 		}.bind(this));
+		this._oEngine = null;
 		BaseObject.prototype.destroy.apply(this, arguments);
+		oDefaultProviderRegistry = null;
 	};
 
 	/**
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
 	 *
-	 * Attaches a control to a default persistence provider held inside the DefaultProviderRegistry for the given <code>PersistenceMode</code>
+	 * Attaches an element to a default persistence provider held inside the DefaultProviderRegistry for the given <code>PersistenceMode</code>
 	 *
-	 * @param {sap.ui.mdc.Control|string} vControl The control instance or a control id.
+	 * @param {sap.ui.core.Element|string} vElement The control instance or an element id.
 	 * @param {sap.ui.mdc.enum.PersistenceMode} sPersistenceMode Desired persistence mode for the retrieved persistence provider
 	 * @returns {sap.ui.mdc.p13n.PersistenceProvider} Returns a persistence provider instance, if possible
 	 */
-	DefaultProviderRegistry.prototype.attach = function (vControl, sPersistenceMode) {
-		if (vControl.getEngine().isRegisteredForModification(vControl)) { // Modification settings for a registered control are only determined once in the Engine
-			throw new Error("DefaultProviderRegistry: You must not change the modificationSettings for an already registered control");
+	DefaultProviderRegistry.prototype.attach = function (vElement, sPersistenceMode) {
+		if (this._oEngine.isRegisteredForModification(vElement)) { // Modification settings for a registered element are only determined once in the Engine
+			throw new Error("DefaultProviderRegistry: You must not change the modificationSettings for an already registered element");
 		}
 		var oDefaultProvider = this._retrieveDefaultProvider(sPersistenceMode);
-		var sControlId = typeof vControl === "string" ? vControl : vControl.getId();
+		var sControlId = typeof vElement === "string" ? vElement : vElement.getId();
 		if (oDefaultProvider.getFor().indexOf(sControlId) === -1) {
-			oDefaultProvider.addFor(vControl);
+			oDefaultProvider.addFor(vElement);
 		}
 
 		return oDefaultProvider;
@@ -115,9 +118,9 @@ sap.ui.define([
 	 *
 	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
 	 */
-	 DefaultProviderRegistry.getInstance = function() {
+	 DefaultProviderRegistry.getInstance = function(oEngine) {
 		if (!oDefaultProviderRegistry) {
-			oDefaultProviderRegistry = new DefaultProviderRegistry();
+			oDefaultProviderRegistry = new DefaultProviderRegistry(oEngine);
 		}
 		return oDefaultProviderRegistry;
 	};