@openui5/sap.ui.mdc 1.112.2 → 1.114.0

package/src/sap/ui/mdc/table/utils/Personalization.js

@@ -0,0 +1,236 @@
+/*!
+ * 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/ui/core/library"
+], function(
+	CoreLibrary
+) {
+	"use strict";
+
+	/**
+	 * P13n utilities.
+	 *
+	 * @author SAP SE
+	 * @version 1.114.0
+	 * @namespace
+	 * @alias sap.ui.mdc.table.utils.Personalization
+	 * @private
+	 */
+	var PersonalizationUtils = {};
+
+	/**
+	 * Checks whether a p13n UI, e.g. column header menu or settings dialog, is currently shown, or changes that the user has created with this UI
+	 * are currently being applied.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table that is personalized with the dialog.
+	 * @returns {boolean} Whether user personalization is currently active.
+	 */
+	PersonalizationUtils.isUserPersonalizationActive = function(oTable) {
+		return oTable._bUserPersonalizationActive === true;
+	};
+
+	/**
+	 * Begins observing user personalization via a column menu, including change appliance, to detect its completion.
+	 * The state can be checked with {@link isUserPersonalizationActive}.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table that is personalized with the column menu.
+	 * @param {sap.m.table.columnmenu.Menu} oMenu The column menu to observe.
+	 */
+	PersonalizationUtils.detectUserPersonalizationCompletion = function(oTable, oMenu) {
+		if (!oMenu.isOpen()) {
+			return;
+		}
+
+		oTable._bUserPersonalizationActive = true;
+		oMenu.attachEventOnce("afterClose", function() {
+			oTable.getEngine().waitForChanges(oTable).then(function() {
+				delete oTable._bUserPersonalizationActive;
+			});
+		});
+	};
+
+	/**
+	 * Opens the p13n dialog that contains all panels according to the p13n options enabled in the table.
+	 * Detects the completion of user personalization. The state can be checked with {@link isUserPersonalizationActive}.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table that is personalized with the dialog.
+	 */
+	PersonalizationUtils.openSettingsDialog = function(oTable) {
+		openP13nDialog(oTable, oTable.getActiveP13nModes());
+	};
+
+	/**
+	 * Opens the p13n dialog that contains only the filter panel.
+	 * Detects the completion of user personalization. The state can be checked with {@link isUserPersonalizationActive}.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table that is personalized with the dialog.
+	 * @param {function} [fnOnClose] This callback is called after the filter dialog is closed.
+	 * @returns {Promise<sap.m.ResponsivePopover | sap.m.Dialog>} A promise that resolves with the p13n dialog.
+	 */
+	PersonalizationUtils.openFilterDialog = function(oTable, fnOnClose) {
+		return openP13nDialog(oTable, ["Filter"], fnOnClose);
+	};
+
+	function openP13nDialog(oTable, aPanelKeys, fnOnClose) {
+		return oTable.finalizePropertyHelper().then(function() {
+			var oEngine = oTable.getEngine();
+
+			if (oTable.getInbuiltFilter()) {
+				oTable.getInbuiltFilter().setVisibleFields(null);
+			}
+
+			return oEngine.uimanager.show(oTable, aPanelKeys, {
+				close: function() {
+					if (fnOnClose) {
+						fnOnClose();
+					}
+					oEngine.waitForChanges(oTable).then(function() {
+						delete oTable._bUserPersonalizationActive;
+					});
+				}
+			}).then(function(oP13nControl) {
+				if (oP13nControl) {
+					// The promise resolves with a control instance only if the dialog is opened.
+					oTable._bUserPersonalizationActive = true;
+				}
+				return oP13nControl;
+			});
+		});
+	}
+
+	/**
+	 * Creates a sort change and applies it to the table. Current sorters are replaced, so the table is sorted according to this change only.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {string} mSettings.property The name of the property to sort, as specified in the <code>PropertyInfo</code>.
+	 * @param {sap.ui.core.SortOrder} mSettings.sortOrder The sort order.
+	 */
+	PersonalizationUtils.createSortChange = function(oTable, mSettings) {
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "Sort",
+			state: [{
+				name: mSettings.property,
+				descending: mSettings.sortOrder === CoreLibrary.SortOrder.Descending,
+				sorted: mSettings.sortOrder !== CoreLibrary.SortOrder.None
+			}],
+			applyAbsolute: true
+		});
+	};
+
+	/**
+	 * Creates a group change and applies it to the table. If the type of the table is <code>ResponsiveTable</code>, current groups are replaced,
+	 * otherwise the change is added to the current state.
+	 * It works like a switch. If the table is not grouped by this property, it will be grouped, otherwise it will be ungrouped.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {string} mSettings.property The name of the property to group, as specified in the <code>PropertyInfo</code>.
+	 */
+	PersonalizationUtils.createGroupChange = function(oTable, mSettings) {
+		var bIsGrouped = (oTable.getCurrentState().groupLevels || []).some(function(oProperty) {
+			return oProperty.name == mSettings.property;
+		});
+
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "Group",
+			state: [{
+				grouped: !bIsGrouped,
+				name: mSettings.property
+			}],
+			applyAbsolute: oTable._isOfType("ResponsiveTable")
+		});
+	};
+
+	/**
+	 * Creates a filter change and applies it to the table.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {Array} mSettings.conditions The filter conditions that should be applied to the table.
+	 * @param {sap.ui.mdc.enum.ProcessingStrategy|boolean} mSettings.strategy The processing strategy on how to apply the change.
+	 */
+	PersonalizationUtils.createFilterChange = function(oTable, mSettings) {
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "Filter",
+			state: mSettings.conditions,
+			applyAbsolute: mSettings.strategy
+		});
+	};
+
+	/**
+	 * Creates an aggregate change and applies it to the table. The change is added to the current state.
+	 * It works like a switch. If an aggregate does not exist for this property, it will be added, otherwise it will be removed.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {string} mSettings.property The name of the property to aggregate, as specified in the <code>PropertyInfo</code>.
+	 */
+	PersonalizationUtils.createAggregateChange = function(oTable, mSettings) {
+		var bHasAggregate = mSettings.property in (oTable.getCurrentState().aggregations || {});
+
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "Aggregate",
+			state: [{
+				name: mSettings.property,
+				aggregated: !bHasAggregate
+			}],
+			applyAbsolute: false
+		});
+	};
+
+	/**
+	 * Creates a column width change and applies it to the table.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {sap.ui.mdc.table.Column} mSettings.column The column for which to create the change.
+	 * @param {string} mSettings.width The new width of the column.
+	 */
+	PersonalizationUtils.createColumnWidthChange = function(oTable, mSettings) {
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "ColumnWidth",
+			state: [{
+				name: mSettings.column.getDataProperty(),
+				width: mSettings.width
+			}],
+			applyAbsolute: false
+		});
+	};
+
+	/**
+	 * Creates a column reorder change and applies it to the table. If the column is already at that position, no change is created.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable The table for which to create the change.
+	 * @param {object} mSettings The change details.
+	 * @param {sap.ui.mdc.table.Column} mSettings.column The column for which to create the change.
+	 * @param {int} mSettings.index The new index of the column.
+	 */
+	PersonalizationUtils.createColumnReorderChange = function(oTable, mSettings) {
+		var iCurrentIndex = oTable.indexOfColumn(mSettings.column);
+
+		if (iCurrentIndex === mSettings.index) {
+			return;
+		}
+
+		oTable.getEngine().createChanges({
+			control: oTable,
+			key: "Column",
+			state: [{
+				name: mSettings.column.getDataProperty(),
+				position: mSettings.index
+			}]
+		});
+	};
+
+	return PersonalizationUtils;
+});

package/src/sap/ui/mdc/themes/base/ValueHelpDialog.less

@@ -26,9 +26,9 @@
     background-color: @sapUiBaseBG;
 }
 
-.sapMdcTablePanel > .sapMPanelHdr,
-.sapMdcTokenizerPanel > .sapMPanelHdr,
-.sapMdcDefineconditionPanel > .sapMPanelHdr{
+.sapMdcTablePanel > .sapMPanelHeadingDiv > .sapMPanelHdr,
+.sapMdcTokenizerPanel > .sapMPanelHeadingDiv > .sapMPanelHdr,
+.sapMdcDefineconditionPanel > .sapMPanelHeadingDiv > .sapMPanelHdr{
 	border: none;
 }
 

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

@@ -135,9 +135,9 @@ sap.ui.define([
 
 					var oDate = this.typeToDate(vDate, oType, sBaseType);
 
-					// if (oType.getFormatOptions().UTC) { // in UTC date we need to bring the local date to UTC
-					// 	oDate = UI5Date.getInstance(Date.UTC(oDate.getFullYear(), oDate.getMonth(), oDate.getDate(), oDate.getHours(), oDate.getMinutes(), oDate.getSeconds(), oDate.getMilliseconds()));
-					// }
+					if (oType.getFormatOptions().UTC) { // in UTC date we need to bring the local date to UTC
+						oDate = UI5Date.getInstance(Date.UTC(oDate.getFullYear(), oDate.getMonth(), oDate.getDate(), oDate.getHours(), oDate.getMinutes(), oDate.getSeconds(), oDate.getMilliseconds()));
+					}
 
 					return oDate.toISOString();
 
@@ -182,6 +182,8 @@ sap.ui.define([
 
 					if (oType.getModelValue) {
 						vDate = oType.getModelValue(oDate);
+					} else if (oType.isA("sap.ui.model.type.DateTime") && oType.getFormatOptions().UTC) { // old DateTime don't support UTC on ModelFormat
+						vDate = UI5Date.getInstance(Date.UTC(oDate.getFullYear(), oDate.getMonth(), oDate.getDate(), oDate.getHours(), oDate.getMinutes(), oDate.getSeconds(), oDate.getMilliseconds()));
 					} else { // older types don't support the new getModelValue
 						var oModelFormat = oType.getModelFormat();
 						var oFormatOptions = oType.getFormatOptions();
@@ -206,9 +208,11 @@ sap.ui.define([
 				typeToDate: function(vDate, oType, sBaseType) {
 					var oDate;
 
-					if (oType.isA("sap.ui.model.odata.type.DateTime") && oType.getConstraints().displayFormat === "Date") { // TODO: need some type-function to convert
-						oDate = UI5Date.getInstance(vDate.getUTCFullYear(), vDate.getUTCMonth(), vDate.getUTCDate());
-					} else {
+					if (oType.getDateValue) {
+						oDate = oType.getDateValue(vDate);
+					} else if (oType.isA("sap.ui.model.type.DateTime") && oType.getFormatOptions().UTC) { // old DateTime don't support UTC on ModelFormat
+						oDate = UI5Date.getInstance(vDate.getUTCFullYear(), vDate.getUTCMonth(), vDate.getUTCDate(), vDate.getUTCHours(), vDate.getUTCMinutes(), vDate.getUTCSeconds(), vDate.getUTCMilliseconds());
+					} else { // older types don't support the new getDateValue
 						var oModelFormat = oType.getModelFormat();
 						var oFormatOptions = oType.getFormatOptions();
 						var bUTC = sBaseType === BaseType.DateTime ? !!oFormatOptions.UTC : false;

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

@@ -17,6 +17,7 @@ sap.ui.define(['sap/ui/mdc/util/IdentifierUtil', 'sap/ui/mdc/enum/ConditionValid
 	 * @namespace
 	 * @private
 	 * @ui5-restricted sap.ui.mdc, sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
 	 * @since 1.80.0
 	 * @alias sap.ui.mdc.util.FilterUtil
 	 */
@@ -30,6 +31,7 @@ sap.ui.define(['sap/ui/mdc/util/IdentifierUtil', 'sap/ui/mdc/enum/ConditionValid
 				 * @returns {object}  PropertyInfo object for a given name, or <code>null</code>
 				 * @private
 				 * @ui5-restricted sap.ui.mdc, sap.fe
+				 * @MDC_PUBLIC_CANDIDATE
 				 */
 				getPropertyByKey : function(aPropertiesMetadata, sKey) {
 					var oPropertyInfo = null;
@@ -115,6 +117,7 @@ sap.ui.define(['sap/ui/mdc/util/IdentifierUtil', 'sap/ui/mdc/enum/ConditionValid
 				 * @returns {object} Object with filters
 				 * @private
 				 * @ui5-restricted sap.ui.mdc
+				 * @MDC_PUBLIC_CANDIDATE
 				 */
 				getFilterInfo: function(vTypeProvider, mConditions, aPropertiesMetadata, aIgnoreProperties) {
 

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

@@ -23,12 +23,11 @@ sap.ui.define([
      * @class The <code>InfoBar</code> control provides an easy way of displaying filter information inside an <code>sap.ui.mdc.Chart</code> and an <code>sap.ui.mdc.Table</code>.
      * @extends sap.ui.core.Control
      * @author SAP SE
-     * @version 1.112.2
+     * @version 1.114.0
      * @constructor
      * @experimental As of version 1.111
      * @private
      * @ui5-restricted sap.ui.mdc
-     * @MDC_PUBLIC_CANDIDATE
      * @since 1.111.0
      * @alias sap.ui.mdc.util.InfoBar
      */
@@ -71,7 +70,6 @@ sap.ui.define([
         renderer: InfoBarRenderer
     });
 
-
     InfoBar.prototype.applySettings = function () {
         Control.prototype.applySettings.apply(this, arguments);
 
@@ -85,6 +83,7 @@ sap.ui.define([
         this.oInvisibleText = new InvisibleText().toStatic();
 
         this.oRemoveAllFiltersBtn = new Button(this.getId() + "-RemoveAllFilters", {
+            type: mLibrary.ButtonType.Transparent,
             press: function (oEvent) {
                 this.fireRemoveAllFilters();
                 // TODO this.oInvisibleMessage.announce(oMessageBundle.getText("valuehelp.REMOVEALLTOKEN_ANNOUNCE"), InvisibleMessageMode.Polite);

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

@@ -45,7 +45,7 @@ sap.ui.define(
 		 * Destroying the cache will cancel all registered promises and delete references. Convenience methods for promise creation, wrapping and replacement are offered.
 		 *
 		 * @author SAP SE
-		 * @version 1.112.2
+		 * @version 1.114.0
 		 * @alias sap.ui.mdc.util.PromiseCache
 		 * @since 1.85.0
 		 * @private

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

@@ -531,7 +531,7 @@ sap.ui.define([
 	 * @extends sap.ui.base.Object
 	 *
 	 * @author SAP SE
-	 * @version 1.112.2
+	 * @version 1.114.0
 	 *
 	 * @private
 	 * @experimental

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

@@ -0,0 +1,177 @@
+/*!
+ * 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([
+], function(
+) {
+	"use strict";
+
+	var _cache = new WeakMap(); // We do not want to share Maps with derived TypeMaps
+
+	/**
+	 * Configuration class for type-handling in MDC delegates.
+	 * Allows mapping of model-types to <code>sap.ui.mdc.enum.BaseType</code> and enables model-specific type configuration.
+	 *
+	 * <b>Note:</b>
+	 * This utility is experimental and the API/behavior is not finalized and hence this should not be used for productive usage.
+	 *
+	 * @namespace
+	 * @author SAP SE
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @experimental As of version 1.114.0
+	 * @MDC_PUBLIC_CANDIDATE
+	 * @since 1.114.0
+	 * @alias sap.ui.mdc.util.TypeMap
+	 */
+	var TypeMap = {};
+
+	/*
+	* Gets values of the internal map, treating string values as references to other keys (aliases)
+	*/
+	TypeMap._get = function (sType) {
+		var vEntry = this._getMap().get(sType);
+		if (typeof vEntry === "string") {
+			return this._get(vEntry);
+		} else if (vEntry) {
+			return [sType, vEntry];
+		}
+	};
+
+	/*
+	* Updates the internal map's values, if not suppressed by TypeMap.freeze()
+	*/
+	TypeMap._set = function (sKey, vValue) {
+		var oMap = this._getMap();
+		if (oMap._bFrozen) {
+			throw "TypeMap: You must not modify a frozen TypeMap";
+		}
+		oMap.set(sKey, vValue);
+	};
+
+	/*
+	* As derived typemaps want to act as singletons with separate data-sets, we provide a context based cache for each map's internal data.
+	* Please also see <code>sap.ui.mdc.util.TypeMap.import</code>
+	*/
+	TypeMap._getMap = function () {
+		var oMap = _cache.get(this);
+		if (!oMap) {
+			oMap = new Map();
+			_cache.set(this, oMap);
+		}
+		return oMap;
+	};
+
+	/**
+	 * Sets a BaseType and an optional model- or scenario-specific configuration method for a given sap.ui.model.SimpleType ObjectPath string
+	 *
+	 * As default <code>string</code> is returned.
+	 *
+	 * @param {string} sType Objectpath string for sap.ui.model.SimpleType
+	 * @param {sap.ui.mdc.enum.BaseType|function} vBaseType BaseType fitting the given sType or method returning a BaseType based on type configuration
+	 * @param {function} [fnOptions] Optional customizing method for formatoptions and constraints. See <code>sap.ui.mdc.DefaultTypeMap</code> for examples.
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.set = function (sType, vBaseType, fnOptions) {
+		this._set(sType, [vBaseType, fnOptions]);
+	};
+
+	/**
+	 * Allows alternative identifiers for Types, such as "Boolean" for "sap.ui.model.type.Boolean"
+	 *
+	 * @param {string} sType Objectpath string for sap.ui.model.SimpleType
+	 * @param {string} sAlias Alternative identifier for sType
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.setAlias = function (sType, sAlias) {
+		this._set(sType, sAlias);
+	};
+
+	/**
+	 * Returns the <code>sap.ui.mdc.enum.BaseType</code> or a method to resolve the BaseType dynamically for the given type
+	 *
+	 * @param {string} sType Objectpath string for sap.ui.model.SimpleType
+	 * @returns {sap.ui.mdc.enum.BaseType|function} BaseType configured for the sap.ui.model.SimpleType or function to resolve BaseType based on configuration
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.getBaseType = function (sType) {
+		var aResult = this._get(sType);
+		return aResult && aResult[1][0];
+	};
+
+	/**
+	 * Returns the option customizing method configured for a sap.ui.model.SimpleType
+	 *
+	 * @param {string} sType Objectpath string for sap.ui.model.SimpleType
+	 * @returns {function} Method for model-specific type configuration. See <code>sap.ui.mdc.DefaultTypeMap</code> for examples.
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.getOptions = function (sType) {
+		var aResult = this._get(sType);
+		return aResult && aResult[1][1];
+	};
+
+	/**
+	 * Returns the ObjectPath string for a given type alias.
+	 *
+	 * @param {string} sAlias Identifier for a configured Type Alias
+	 * @returns {string} Objectpath string for sap.ui.model.SimpleType
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.getClass = function (sAlias) {
+		var aResult = this._get(sAlias);
+		return aResult && aResult[0];
+	};
+
+	 /**
+	 * Exports the TypeMap's current data
+	 *
+	 * @returns {Array} Array created from this TypeMap's internal map
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.export = function () {
+		return Array.from(this._getMap());
+	};
+
+	/**
+	 * Imports a TypeMap's data into another TypeMap
+	 *
+	 * @param {sap.ui.mdc.util.TypeMap} oTypeMap TypeMap to import
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.import = function (oTypeMap) {
+		oTypeMap.export().forEach(function (aEntry) {
+			this._getMap().set(aEntry[0], aEntry[1]);
+		}.bind(this));
+	};
+
+	/**
+	 * Prevents further manipulation of a TypeMap's data
+	 *
+	 * @private
+	 * @ui5-restricted sap.fe
+	 * @MDC_PUBLIC_CANDIDATE
+	 */
+	TypeMap.freeze = function () {
+		this._getMap()._bFrozen = true;
+	};
+
+	return TypeMap;
+});