@openui5/sap.ui.mdc 1.96.5 → 1.99.0

package/src/sap/ui/mdc/p13n/panels/LinkSelectionPanel.js

@@ -0,0 +1,72 @@
+/*
+ * ! OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+    "sap/m/p13n/SelectionPanel",
+    "sap/m/ColumnListItem",
+	"sap/m/HBox",
+	"sap/m/VBox",
+    "sap/m/Link",
+    "sap/m/Text",
+    "sap/ui/core/Icon",
+    "sap/m/library",
+    "sap/m/MessageBox"
+], function (SelectionPanel, ColumnListItem, HBox, VBox, Link, Text, Icon, mLibrary, MessageBox) {
+    "use strict";
+
+    // shortcut for sap.m.ListType
+    var ListType = mLibrary.ListType;
+
+    var LinkSelectionPanel = SelectionPanel.extend("sap.ui.mdc.p13n.panels.LinkSelectionPanel", {
+        metadata: {
+			library: "sap.ui.mdc",
+            /**
+             * This event is fired when a Link on the SelectionPanel is pressed.
+             */
+            events: {
+                linkPressed: {}
+            }
+        },
+		renderer: {
+			apiVersion: 2
+		}
+    });
+
+    LinkSelectionPanel.prototype._getListTemplate = function() {
+		return new ColumnListItem({
+			selected: "{" + this.P13N_MODEL + ">" + this.PRESENCE_ATTRIBUTE + "}",
+			type: ListType.Active,
+			cells: [
+				new VBox({
+					items: [
+						new Link({
+							tooltip: "{" + this.P13N_MODEL + ">tooltip}",
+							text: "{" + this.P13N_MODEL + ">text}",
+                            href: "{" + this.P13N_MODEL + ">href}",
+                            target: "{" + this.P13N_MODEL + ">target}",
+                            press: this._onLinkPressed.bind(this)
+						}),
+                        new Text({
+                            text: "{" + this.P13N_MODEL + ">description}",
+                            visible: "{= ${" + this.P13N_MODEL + ">description} ? true:false}"
+                        })
+					]
+				})
+			]
+		});
+	};
+
+    LinkSelectionPanel.prototype._onLinkPressed = function(oEvent) {
+        this.fireLinkPressed(oEvent);
+    };
+
+    LinkSelectionPanel.prototype.setMultiSelectMode = function(sMultiSelectMode) {
+        this._oListControl.setMultiSelectMode(sMultiSelectMode);
+    };
+
+    return LinkSelectionPanel;
+
+});

package/src/sap/ui/mdc/p13n/panels/ListView.js

@@ -10,6 +10,7 @@ sap.ui.define([
     "sap/m/HBox",
     "sap/m/VBox",
     "sap/ui/core/Icon",
+    "sap/ui/core/library",
     "sap/m/Text",
     "sap/m/Column",
     "sap/m/Table",
@@ -18,7 +19,7 @@ sap.ui.define([
     "sap/m/Button",
     "sap/m/OverflowToolbar",
     "sap/ui/model/Filter"
-], function(BasePanel, Label, ColumnListItem, HBox, VBox, Icon, Text, Column, Table, mLibrary, ToolbarSpacer, Button, OverflowToolbar, Filter) {
+], function(BasePanel, Label, ColumnListItem, HBox, VBox, Icon, coreLibrary, Text, Column, Table, mLibrary, ToolbarSpacer, Button, OverflowToolbar, Filter) {
 	"use strict";
 
     // shortcut for sap.m.ListKeyboardMode
@@ -30,6 +31,9 @@ sap.ui.define([
     // shortcut for sap.m.ListType
     var ListType = mLibrary.ListType;
 
+    // shortcut for sap.ui.core.IconColor;
+    var IconColor = coreLibrary.IconColor;
+
     /**
 	 * Constructor for a new ListView
 	 *
@@ -112,7 +116,7 @@ sap.ui.define([
                         new Icon({
                             src: "sap-icon://circle-task-2",
                             size: "0.5rem",
-                            color: sap.ui.core.IconColor.Neutral,
+                            color: IconColor.Neutral,
                             visible: {
                                 path: this.P13N_MODEL + ">isFiltered",
                                 formatter: function(bIsFiltered) {

package/src/sap/ui/mdc/p13n/subcontroller/AdaptFiltersController.js

@@ -9,7 +9,12 @@ sap.ui.define([
 ], function (BaseController, P13nBuilder, merge) {
     "use strict";
 
-    var AdaptFiltersController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.AdaptFiltersController");
+    var AdaptFiltersController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.AdaptFiltersController", {
+        constructor: function() {
+			BaseController.apply(this, arguments);
+			this._bResetEnabled = true;
+		}
+    });
 
     AdaptFiltersController.prototype.getUISettings = function() {
         return {
@@ -56,10 +61,6 @@ sap.ui.define([
         }.bind(this));
     };
 
-    AdaptFiltersController.prototype.getResetEnabled = function () {
-        return true;
-    };
-
     AdaptFiltersController.prototype.update = function(){
         BaseController.prototype.update.apply(this, arguments);
         this.getAdaptationControl().getInbuiltFilter().createFilterFields();

package/src/sap/ui/mdc/p13n/subcontroller/AggregateController.js

@@ -55,7 +55,7 @@ sap.ui.define([
         var oP13nData = P13nBuilder.prepareAdaptationData(oPropertyHelper, function(mItem, oProperty){
             var oExisting = mExistingAggregations[oProperty.name];
             mItem.aggregated = !!oExisting;
-            return oProperty.isAggregatable();
+            return oProperty.aggregatable;
         });
 
         return oP13nData;

package/src/sap/ui/mdc/p13n/subcontroller/BaseController.js

@@ -5,6 +5,7 @@
  */
 
 sap.ui.define([
+    'sap/base/util/array/diff',
     'sap/ui/base/Object',
     'sap/ui/mdc/p13n/FlexUtil',
     'sap/ui/mdc/p13n/P13nBuilder',
@@ -12,18 +13,22 @@ sap.ui.define([
     'sap/base/util/deepEqual',
     'sap/ui/model/json/JSONModel',
     'sap/m/p13n/SelectionPanel'
-], function (BaseObject, FlexUtil, P13nBuilder, merge, deepEqual, JSONModel, SelectionPanel) {
+], function (diff, BaseObject, FlexUtil, P13nBuilder, merge, deepEqual, JSONModel, SelectionPanel) {
 	"use strict";
 
-	/**
-	 * Constructor for a new BaseController. The BaseController serves as
-     * base class to create control specific personalization implementations.
+    /**
+	 * Constructor for a new <code>BaseController</code>.
+	 *
+	 * @param {string} [sId] ID for the new control, generated automatically if no ID is given
+	 * @param {object} [mSettings] Initial settings for the new control
 	 *
 	 * @class
+	 * The <code>BaseController</code> serves as base class to create control specific personalization implementations.
+	 *
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.96.5
+	 * @version 1.99.0
 	 *
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
@@ -66,7 +71,7 @@ sap.ui.define([
     /**
      * Defines whether a Dialog (Change creation on 'OK') or a Popover (liveChanges) should be used.
      *
-     * @returns {boolean}
+     * @returns {boolean} Determines if the livemode should be enabled
      */
     BaseController.prototype.getLiveMode = function(){
         return this._bLiveMode;
@@ -88,12 +93,21 @@ sap.ui.define([
     /**
      * Defines whether the container should include a reset.
      *
-     * @returns {boolean}
+     * @returns {boolean} Determines if the reset should be enabled
      */
     BaseController.prototype.getResetEnabled = function() {
         return this._bResetEnabled;
     };
 
+     /**
+     * Defines which control(s) are considered for the reset.
+     *
+     * @returns {sap.ui.core.Control|sap.ui.core.Control[]}
+     */
+    BaseController.prototype.getSelectorForReset = function() {
+        return this._oAdaptationControl;
+    };
+
     BaseController.prototype.sanityCheck = function(oState) {
         return oState;
     };
@@ -101,6 +115,7 @@ sap.ui.define([
     /**
      * The actual UI used for personalization.
      *
+     * @param {sap.ui.mdc.util.PropertyHelper} oPropertyHelper The property helper instance
      * @returns {sap.ui.core.Control|string|Promise} The control which is going to be used in the p13n container.
      */
     BaseController.prototype.getAdaptationUI = function(oPropertyHelper){
@@ -133,12 +148,137 @@ sap.ui.define([
         if (deepEqual(mPropertyBag.existingState, aNewStatePrepared)){
             return [];
         } else {
-            return FlexUtil.getArrayDeltaChanges(mPropertyBag);
+            return this.getArrayDeltaChanges(mPropertyBag);
+        }
+
+    };
+
+    /**
+    * Generates a set of changes based on the given arrays for a specified control
+    *
+    * @public
+    *
+    * @param {object} mDeltaInfo Map containing the necessary information to calculate the diff as change objects
+    * @param {array} mDeltaInfo.existingState An array describing the control state before a adaptation
+    * @param {array} mDeltaInfo.changedState An array describing the control state after a certain adaptation
+    * @param {object} mDeltaInfo.control Control instance which is being used to generate the changes
+    * @param {object} mDeltaInfo.changeOperations Map containing the changeOperations for the given Control instance
+    * @param {string} mDeltaInfo.changeOperations.add Name of the control specific 'add' changehandler
+    * @param {string} mDeltaInfo.changeOperations.remove Name of the control specific 'remove' changehandler
+    * @param {string} [mDeltaInfo.changeOperations.move] Name of the control specific 'move' changehandler
+    * @param {string} [mDeltaInfo.generator] Name of the change generator (E.g. the namespace of the UI creating the change object)
+    *
+    * @returns {array} Array containing the delta based created changes
+    */
+    BaseController.prototype.getArrayDeltaChanges = function (mDeltaInfo) {
+
+        var aExistingArray = mDeltaInfo.existingState;
+        var aChangedArray = mDeltaInfo.changedState;
+        var oControl = mDeltaInfo.control;
+        var sInsertOperation = mDeltaInfo.changeOperations.add;
+        var sRemoveOperation = mDeltaInfo.changeOperations.remove;
+        var sMoveOperation = mDeltaInfo.changeOperations.move;
+        var sGenerator = mDeltaInfo.generator;
+
+        var aDeltaAttributes = mDeltaInfo.deltaAttributes || [];
+
+        var fnSymbol = function(o) {
+            var sDiff = "";
+            aDeltaAttributes.forEach(function(sAttribute){
+                sDiff = sDiff + o[sAttribute];
+            });
+            return sDiff;
+        };
+
+        var aResults = diff(aExistingArray, aChangedArray, fnSymbol);
+        // Function to match field with exising field in the given array
+        var fMatch = function (oField, aArray) {
+            return aArray.filter(function (oExistingField) {
+                return oExistingField && (oExistingField.name === oField.name);
+            })[0];
+        };
+
+        var aChanges = [];
+        var aProcessedArray = aExistingArray.slice(0);
+
+        aResults.forEach(function (oResult) {
+            // Begin --> hack for handling result returned by diff
+            if (oResult.type === "delete" && aProcessedArray[oResult.index] === undefined) {
+                aProcessedArray.splice(oResult.index, 1);
+                return;
+            }
+
+            var oProp, oExistingProp, iLength;
+            if (oResult.type === "insert") {
+                oExistingProp = fMatch(aChangedArray[oResult.index], aProcessedArray);
+                if (oExistingProp) {
+                    oExistingProp.index = aProcessedArray.indexOf(oExistingProp);
+                    aProcessedArray.splice(oExistingProp.index, 1, undefined);
+                    aChanges = aChanges.concat(this._createAddRemoveChange(oControl, sRemoveOperation, FlexUtil._getChangeContent(oExistingProp, aDeltaAttributes), sGenerator));
+                }
+            }
+            // End hack
+            oProp = oResult.type === "delete" ? aProcessedArray[oResult.index] : aChangedArray[oResult.index];
+            oProp.index = oResult.index;
+            if (oResult.type === "delete") {
+                aProcessedArray.splice(oProp.index, 1);
+            } else {
+                aProcessedArray.splice(oProp.index, 0, oProp);
+            }
+            // Move operation shows up as insert followed by delete OR delete followed by insert
+            if (sMoveOperation) {
+                iLength = aChanges.length;
+                // Get the last added change
+                if (iLength) {
+                    oExistingProp = aChanges[iLength - 1];
+                    oExistingProp = oExistingProp ? oExistingProp.changeSpecificData.content : undefined;
+                }
+                // Matching property exists with a different index --> then this is a move operation
+                if (oExistingProp && oExistingProp.name === oProp.name && oResult.index != oExistingProp.index) {
+                    // remove the last insert/delete operation
+                    aChanges.pop();
+                    aChanges = aChanges.concat(this._createMoveChange(oExistingProp.id, oExistingProp.name, oResult.index, sMoveOperation, oControl, sMoveOperation !== "moveSort", sGenerator));
+                    return;
+                }
+            }
+
+            aChanges = aChanges.concat(this._createAddRemoveChange(oControl, oResult.type === "delete" ? sRemoveOperation : sInsertOperation, FlexUtil._getChangeContent(oProp, aDeltaAttributes), sGenerator));
+
+        }.bind(this));
+        return aChanges;
+    };
+
+    BaseController.prototype._createAddRemoveChange = function(oControl, sOperation, oContent){
+        var oAddRemoveChange = {
+            selectorElement: oControl,
+            changeSpecificData: {
+                changeType: sOperation,
+                content: oContent
+            }
+        };
+        return oAddRemoveChange;
+    };
+
+    BaseController.prototype._createMoveChange = function(sId, sPropertyName, iNewIndex, sMoveOperation, oControl, bPersistId){
+        var oMoveChange =  {
+            selectorElement: oControl,
+            changeSpecificData: {
+                changeType: sMoveOperation,
+                content: {
+                    id: sId,
+                    name: sPropertyName,
+                    index: iNewIndex
+                }
+            }
+        };
+
+        if (!bPersistId) {
+            delete oMoveChange.changeSpecificData.content.id;
         }
 
+        return oMoveChange;
     };
 
-    //TODO: check if this can be avoided
     BaseController.prototype._getPresenceAttribute = function(bexternalAppliance){
         return "visible";
     };
@@ -157,6 +297,7 @@ sap.ui.define([
      * Initialized the inner model for the Personalization.
      *
      * @param {sap.ui.mdc.util.PropertyHelper} oPropertyHelper The propertyhelper that should be utilized for property determination.
+     * @returns {object} The personalization model data
      */
     BaseController.prototype.mixInfoAndState = function(oPropertyHelper) {
 
@@ -191,6 +332,8 @@ sap.ui.define([
 
     /**
      * Can be used to trigger update after UI interactions such as "Ok" and "Reset"
+     *
+     * @param {sap.ui.mdc.util.PropertyHelper} oPropertyHelper The property helper instance
      */
     BaseController.prototype.update = function(oPropertyHelper) {
         if (this._oPanel) {
@@ -204,8 +347,6 @@ sap.ui.define([
         }
     };
 
-
-    //TODO: move to FlexUtil? --> Split FlexUtil<>DeltaUtil
     BaseController.prototype._getFilledArray = function(aPreviousItems, aNewItems, sRemoveProperty) {
 		var aNewItemsPrepared = merge([], aPreviousItems);
 		var aNewItemState = merge([], aNewItems);
@@ -235,6 +376,10 @@ sap.ui.define([
 	};
 
     /**
+     *
+     * Getter for the personalization model
+     *
+     * @param {sap.ui.mdc.util.PropertyHelper} oPropertyHelper The property helper instance
      * @returns {sap.ui.model.json.JSONModel} The personalization model.
      *
      */

package/src/sap/ui/mdc/p13n/subcontroller/ChartItemController.js

@@ -6,10 +6,8 @@
 
 sap.ui.define([
     "./BaseController",
-    "sap/ui/mdc/p13n/P13nBuilder",
-    "sap/base/util/UriParameters",
-    "sap/ui/mdc/p13n/panels/ChartItemPanel"
-], function (BaseController, P13nBuilder, UriParameters, ChartItemPanel) {
+    "sap/ui/mdc/p13n/P13nBuilder"
+], function (BaseController, P13nBuilder) {
     "use strict";
 
     var oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
@@ -18,36 +16,27 @@ sap.ui.define([
 
     ChartItemController.prototype.getAdaptationUI = function(oPropertyHelper) {
 
-        if (UriParameters.fromQuery(window.location.search).get("newChartP13n") === "true"){
+        var fnResolve;
 
-            var fnResolve;
+        this._oAdaptationControl.getAdaptationUI().then(function(oPanel){
+            this._oPanel = oPanel;
+            this._oPropHelper = oPropertyHelper;
+            var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
+            oPanel.setP13nData(oAdaptationData.items);
+            fnResolve(oPanel);
+        }.bind(this));
 
-            this._oAdaptationControl.getAdaptationUI().then(function(oPanel){
-                this._oPanel = oPanel;
-                this._oPropHelper = oPropertyHelper;
-                var oAdaptationData = this.mixInfoAndState(oPropertyHelper);
-                oPanel.setP13nData(oAdaptationData.items);
-                fnResolve(oPanel);
-            }.bind(this));
-
-            return new Promise(function (resolve, reject) {
-                fnResolve = resolve;
-            });
-
-        } else {
-            var oChartItemPanel = new ChartItemPanel();
-            oChartItemPanel.setP13nModel(this._getP13nModel(oPropertyHelper));
-            return Promise.resolve(oChartItemPanel);
-        }
+        return new Promise(function (resolve, reject) {
+            fnResolve = resolve;
+        });
 
     };
 
     ChartItemController.prototype.update = function(){
         BaseController.prototype.update.apply(this, arguments);
 
-        if (UriParameters.fromQuery(window.location.search).get("newChartP13n") === "true"){
-            this._oPanel.setP13nData(this.mixInfoAndState(this._oPropHelper).items);
-        }
+        this._oPanel.setP13nData(this.mixInfoAndState(this._oPropHelper).items);
+
     };
 
     ChartItemController.prototype.getDelta = function(mPropertyBag) {

package/src/sap/ui/mdc/p13n/subcontroller/ColumnController.js

@@ -10,7 +10,12 @@ sap.ui.define([
     "use strict";
 
     var oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
-    var ColumnController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.ColumnController");
+    var ColumnController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.ColumnController", {
+        constructor: function() {
+			BaseController.apply(this, arguments);
+			this._bResetEnabled = true;
+		}
+    });
 
     ColumnController.prototype.getUISettings = function() {
         return {
@@ -19,10 +24,6 @@ sap.ui.define([
         };
     };
 
-    ColumnController.prototype.getResetEnabled = function() {
-        return true;
-    };
-
     ColumnController.prototype.model2State = function() {
         var aItems = [];
         this._oPanel.getP13nData(true).forEach(function(oItem){

package/src/sap/ui/mdc/p13n/subcontroller/FilterController.js

@@ -9,17 +9,18 @@ sap.ui.define([
 ], function (FilterOperatorUtil, BaseController, P13nBuilder, FlexUtil, Log) {
 	"use strict";
 
-    var FilterController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.FilterController");
+    var FilterController = BaseController.extend("sap.ui.mdc.p13n.subcontroller.FilterController", {
+        constructor: function() {
+			BaseController.apply(this, arguments);
+			this._bResetEnabled = true;
+		}
+    });
 
     FilterController.prototype.getCurrentState = function() {
         var oControlState = this.getAdaptationControl().getCurrentState();
         return oControlState.hasOwnProperty("filter") ? oControlState.filter : {};
     };
 
-    FilterController.prototype.getResetEnabled = function() {
-        return true;
-    };
-
     FilterController.prototype.getUISettings = function() {
         return {
             title: sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc").getText("filter.PERSONALIZATION_DIALOG_TITLE"),
@@ -27,9 +28,15 @@ sap.ui.define([
             afterClose: function(oEvt) {
                 var oDialog = oEvt.getSource();
                 if (oDialog) {
-                    oDialog.removeAllContent();
-                    oDialog.destroy();
+                    var oDialogContent = oDialog.getContent()[0];
+                    if (oDialogContent.isA("sap.m.p13n.Container")) {
+                        oDialogContent.removeView("Filter");
+                    } else {
+                        oDialog.removeAllContent();
+                    }
                 }
+
+                oDialog.destroy();
             }
         };
     };