@openui5/sap.m 1.109.0 → 1.111.0

package/src/sap/m/p13n/SelectionController.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -29,10 +29,9 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @public
-	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!
 	 * @alias sap.m.p13n.SelectionController
 	 */
 	var SelectionController = BaseObject.extend("sap.m.p13n.SelectionController",{
@@ -41,6 +40,13 @@ sap.ui.define([
 
             this._oAdaptationControl = mSettings.control;
 
+            /**
+             * The 'stableKeys' can be provided in the constructor to exclude the keys from the p13n UI, while still respecting them in the
+             * delta logic. For instance by ignoring the first column of a TreeTable in the p13n dialog while still not removing this column
+             * on closing the dialog.
+             */
+            this._aStableKeys = mSettings.stableKeys || [];
+
             if (!this._oAdaptationControl) {
                 throw new Error("Always provide atleast a 'control' configuration when creating a new p13n controller!");
             }
@@ -172,6 +178,15 @@ sap.ui.define([
             ? mPropertyBag.changedState.filter(fnFilterUnselected) :
             this._getFilledArray(mPropertyBag.existingState, mPropertyBag.changedState, sPresenceAttribute).filter(fnFilterUnselected);
 
+        this._aStableKeys.forEach(function(sKey, iIndex){
+            var mExistingState = this.arrayToMap(this.getCurrentState());
+            var mNewState = this.arrayToMap(aNewStatePrepared);
+            var iStableIndex = mExistingState[sKey] || (iIndex - 1);
+
+            if (!mNewState.hasOwnProperty(sKey)) {
+                aNewStatePrepared.splice(iStableIndex, 0,mExistingState[sKey]);
+            }
+        }.bind(this));
         mPropertyBag.changedState = aNewStatePrepared;
 
         //Example: Dialog Ok --> don't trigger unnecessary flex change processing
@@ -362,7 +377,7 @@ sap.ui.define([
             var oExisting = mItemState[oProperty.name || oProperty.key];
             mItem.visible = this._fSelector ? this._fSelector(oProperty) : (!!oExisting);
             mItem.position =  oExisting ? oExisting.position : -1;
-            return !(oProperty.visible === false);
+            return !(oProperty.visible === false || (this._aStableKeys.indexOf(oProperty.name || oProperty.key) > -1));
         }.bind(this));
 
         this.sortP13nData({
@@ -405,9 +420,8 @@ sap.ui.define([
 		var aNewItemsPrepared = merge([], aPreviousItems);
 		var aNewItemState = merge([], aNewItems);
 
-		var mExistingItems = this.arrayToMap(aPreviousItems);
-
 		aNewItemState.forEach(function (oItem) {
+            var mExistingItems = this.arrayToMap(aNewItemsPrepared);
 			var oExistingItem = mExistingItems[oItem.key];
 			if (!oItem.hasOwnProperty(sRemoveProperty) || oItem[sRemoveProperty]) {
 				var iNewPosition = oItem.position;
@@ -424,7 +438,7 @@ sap.ui.define([
 			} else if (oExistingItem) {//check if exists before delete
 				aNewItemsPrepared[oExistingItem.position][sRemoveProperty] = false;
 			}
-		});
+		}.bind(this));
 
 		return aNewItemsPrepared;
 	};
@@ -438,8 +452,8 @@ sap.ui.define([
             var iIndex = oStateDiffContent.index;
             delete oStateDiffContent.index;
 
-            //set the position attribute in case to an explicit move
-            if (oChange.changeSpecificData.changeType === this.getChangeOperations()["move"]) {
+            //set the position in case its explicitly provided and different to the current position
+            if (iIndex !== undefined) {
                 oStateDiffContent.position = iIndex;
             }
 

package/src/sap/m/p13n/SelectionPanel.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([
@@ -48,10 +48,9 @@ sap.ui.define([
 	 * @extends sap.m.p13n.BasePanel
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @public
-	 * @experimental Since 1.96.
 	 * @since 1.96
 	 * @alias sap.m.p13n.SelectionPanel
 	 */
@@ -100,6 +99,9 @@ sap.ui.define([
 				/**
 				 * An optional callback that may be used to display additional custom content in each selectable item.
 				 * This factory can be toggled by executing the {@link sap.m.p13n.SelectionPanel#showFactory} method.
+				 *
+				 * <b>Note:</b>: The <code>getIdForLabel</code> method can be imlplemented on the returned control instance
+				 * to return a focusable children control to provide the <code>labelFor</code> reference for the associated text.
 				 */
 				itemFactory: {
 					type: "function"
@@ -132,7 +134,12 @@ sap.ui.define([
 	SelectionPanel.prototype._getListTemplate = function() {
 		var oColumnListItem = new ColumnListItem({
 			selected: "{" + this.P13N_MODEL + ">" + this.PRESENCE_ATTRIBUTE + "}",
-			type: ListType.Active,
+			type: {
+				path: this.P13N_MODEL + ">" + this.PRESENCE_ATTRIBUTE,
+				formatter: function(bSelected) {
+					return bSelected ? ListType.Active : ListType.Inactive;
+				}
+			},
 			cells: [
 				new VBox({
 					items: [
@@ -256,7 +263,9 @@ sap.ui.define([
 		}
 		//Store (new) hovered item and set its icon to visible: false + add move buttons to it
 		var oIcon = oHoveredItem.getCells()[1].getItems()[0];
-		oIcon.setVisible(false);
+		if (oHoveredItem.getSelected()) {
+			oIcon.setVisible(false);
+		}
 		this._oHoveredItem = oHoveredItem;
 		this._updateEnableOfMoveButtons(oHoveredItem, false);
 		this._addMoveButtons(oHoveredItem);

package/src/sap/m/p13n/SortController.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -19,12 +19,11 @@ sap.ui.define([
 	 * @class
 	 * The <code>SortController</code> entity serves as a base class to create personalization implementations that are specific to sorting.
 	 *
-	 * @extends sap.ui.base.Object
+	 * @extends sap.m.p13n.SelectionController
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 * @public
-	 * @experimental Since 1.104. Please note that the API of this control is not yet finalized!
 	 * @alias sap.m.p13n.SortController
 	 */
     var SortController = BaseController.extend("sap.m.p13n.SortController", {

package/src/sap/m/p13n/SortPanel.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([
@@ -21,10 +21,9 @@ sap.ui.define([
 	 * @extends sap.m.p13n.QueryPanel
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @public
-	 * @experimental Since 1.96.
 	 * @since 1.96
 	 * @alias sap.m.p13n.SortPanel
 	 */
@@ -54,7 +53,6 @@ sap.ui.define([
 	/**
 	 * P13n <code>SortItem</code> object type.
 	 *
-	 * @type {sap.m.p13n.SortItem}
 	 * @static
 	 * @constant
 	 * @typedef {object} sap.m.p13n.SortItem

package/src/sap/m/p13n/enum/PersistenceMode.js

@@ -1,6 +1,6 @@
 /*
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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(function () {
@@ -11,6 +11,8 @@ sap.ui.define(function () {
      * @enum {string}
      * @since 1.104
      * @alias sap.m.p13n.enum.PersistenceMode
+     * @private
+     * @ui5-restricted
      */
     var PersistenceMode = {
         /**
@@ -26,6 +28,7 @@ sap.ui.define(function () {
          * control reference could be found. If a <code>sap.ui.fl.variants.VariantManagement</code> has been found,
          * it will be used instead.
          *
+         * @private
          * @ui5-restricted sap.fe
          */
         Auto: "Auto",

package/src/sap/m/p13n/enum/ProcessingStrategy.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -13,8 +13,9 @@ sap.ui.define(function() {
 	 *
 	 * @enum {string}
      * @private
+     * @ui5-restricted
 	 * @since 1.108
-	 * @alias sap.m.p13n.ProcessingStrategy
+	 * @alias sap.m.p13n.enum.ProcessingStrategy
 	 */
 	var ProcessingStrategy = {
 		/**

package/src/sap/m/p13n/handler/xConfigHandler.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -17,7 +17,7 @@ sap.ui.define([
 	 *
 	 * @author SAP SE
 	 * @private
-	 * @alias sap.m.flexibility.xConfigHandler
+	 * @alias sap.m.p13n.handler.xConfigHandler
 	 */
     var xConfigHandler = {};
 

package/src/sap/m/p13n/modification/FlexModificationHandler.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([

package/src/sap/m/p13n/modification/LocalStorageModificationHandler.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([

package/src/sap/m/p13n/modification/ModificationHandler.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([

package/src/sap/m/p13n/modules/AdaptationProvider.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([
@@ -18,13 +18,10 @@ sap.ui.define([
 	 * @private
      *
 	 * @ui5-restricted sap.m
-	 * @alias sap.m.p13n.AdaptationProvider
+	 * @alias sap.m.p13n.modules.AdaptationProvider
+	 * @extends sap.ui.base.Object
 	 */
-	var AdaptationProvider = BaseObject.extend("sap.m.p13n.AdaptationProvider", {
-		metadata: {
-			baseType : "sap.m.p13n.AdaptationProvider"
-		}
-	});
+	var AdaptationProvider = BaseObject.extend("sap.m.p13n.modules.AdaptationProvider");
 
 	/**
 	 * Initialize adaptation for a provided control instance, set of keys and properties

package/src/sap/m/p13n/modules/DefaultProviderRegistry.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -26,7 +26,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @private
 	 * @since 1.104
@@ -81,6 +81,18 @@ sap.ui.define([
 			oDefaultProvider.addFor(vElement);
 		}
 
+		var oProvider = this._mDefaultProviders[sPersistenceMode];
+
+		var fnAttachVariantModel = function(){
+			var oModel = oElement.getModel(ControlVariantApplyAPI.getVariantModelName());
+			if (oModel) {
+				oProvider.setModel(oModel, ControlVariantApplyAPI.getVariantModelName());
+				oElement.detachEvent("modelContextChange", fnAttachVariantModel);
+			}
+		};
+
+		oElement.attachEvent("modelContextChange", fnAttachVariantModel);
+
 		return oDefaultProvider;
 	};
 
@@ -114,16 +126,6 @@ sap.ui.define([
 			var oProvider = new PersistenceProvider("defaultProviderRegistry" + sPersistenceMode, {
 				mode: sPersistenceMode
 			});
-
-			var fnAttachVariantModel = function(){
-				var oModel = oElement.getModel(ControlVariantApplyAPI.getVariantModelName());
-				if (oModel) {
-					oProvider.setModel(oModel, ControlVariantApplyAPI.getVariantModelName());
-					oElement.detachEvent("modelContextChange", fnAttachVariantModel);
-				}
-			};
-
-			oElement.attachEvent("modelContextChange", fnAttachVariantModel);
 			this._mDefaultProviders[sPersistenceMode] = oProvider;
 		}
 
@@ -131,10 +133,10 @@ sap.ui.define([
 	};
 
 	/**
+	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
+	 *
 	 * @private
 	 * @ui5-restricted sap.m
-	 *
-	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
 	 */
 	 DefaultProviderRegistry.getInstance = function(Engine) {
 		if (!oDefaultProviderRegistry) {

package/src/sap/m/p13n/modules/StateHandlerRegistry.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -18,10 +18,10 @@ sap.ui.define([
 	 * Constructor for a new StateHandlerRegistry.
 	 *
 	 * @class
-	 * @extends sap.ui.base.Object
+	 * @extends sap.ui.base.EventProvider
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @private
 	 * @since 1.104
@@ -84,10 +84,11 @@ sap.ui.define([
 	};
 
 	/**
+	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
+	 *
 	 * @private
 	 * @ui5-restricted sap.m
 	 *
-	 * This method is the central point of access to the DefaultProviderRegistry Singleton.
 	 * @returns {this} Returns the <code>StateHandlerRegistry</code> instance.
 	 */
 	StateHandlerRegistry.getInstance = function () {

package/src/sap/m/p13n/modules/UIManager.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2009-2023 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -28,14 +28,14 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.109.0
+	 * @version 1.111.0
 	 *
 	 * @private
 	 *
 	 * @since 1.104
 	 * @alias sap.m.p13n.modules.UIManager
 	 */
-	var UIManager = BaseObject.extend("sap.m.p13n.UIManager", {
+	var UIManager = BaseObject.extend("sap.m.p13n.modules.UIManager", {
 		constructor: function(oAdaptationProvider) {
 
 			if (oUIManager) {
@@ -78,7 +78,7 @@ sap.ui.define([
 
 					//if there is no title provided and only one panel created, use it's title as the Popup title
 					var sTitle;
-					if (!mSettings.title && aPanelKeys.length === 1) {
+					if (!mSettings.title && aPanelKeys.length === 1 && aInitializedPanels.length > 0) {
 						sTitle = aInitializedPanels[0].getTitle();
 					} else {
 						sTitle = mSettings.title || oResourceBundle.getText("p13n.VIEW_SETTINGS");
@@ -231,7 +231,7 @@ sap.ui.define([
 	 * @param {sap.m.AdaptationProvider} oAdaptationProvider Object implementing the <code>sap.m.AdaptationProvider</code> interface to provide personalization capabilites.
 	 */
 	UIManager._checkValidInterface = function(oAdaptationProvider) {
-		if (!oAdaptationProvider || !oAdaptationProvider.isA("sap.m.p13n.AdaptationProvider")){
+		if (!oAdaptationProvider || !oAdaptationProvider.isA("sap.m.p13n.modules.AdaptationProvider")){
 			throw Error("The UIManager singleton must not be accessed without an AdaptationProvider interface!");
 		}
 	};

package/src/sap/m/p13n/modules/xConfigAPI.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * (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([
@@ -190,7 +190,10 @@ sap.ui.define([
 		var sAffectedAggregation = mControlMeta.aggregation;
 		var sAggregationName = sAffectedAggregation ? sAffectedAggregation : oControlMetadata.getDefaultAggregation().name;
 		var oConfig = oExistingConfig || {};
-		oConfig.aggregations = {};
+
+		if (!oConfig.hasOwnProperty("aggregations")) {
+			oConfig.aggregations = {};
+		}
 
 		if (!oConfig.aggregations.hasOwnProperty(sAggregationName)) {
 			if (oControlMetadata.hasAggregation(sAggregationName)) {