@openui5/sap.ui.mdc 1.96.5 → 1.99.0

package/src/sap/ui/mdc/odata/v4/TableDelegate.js

@@ -35,26 +35,46 @@ sap.ui.define([
 	var TableMap = new window.WeakMap(); // To store table-related information for easy access in the delegate.
 
 	/**
-	 * Delegate class for sap.ui.mdc.Table and ODataV4.
+	 * Delegate for {@link sap.ui.mdc.Table} and <code>ODataV4</code>.
 	 * Enables additional analytical capabilities.
-	 * <b>Note:</b> The class is experimental and the API/behavior is not finalized.
 	 *
 	 * @author SAP SE
+	 * @namespace
+	 * @alias module:sap/ui/mdc/odata/v4/TableDelegate
+	 * @extends module:sap/ui/mdc/TableDelegate
+	 * @experimental
 	 * @private
 	 * @ui5-restricted sap.fe
 	 * @MDC_PUBLIC_CANDIDATE
 	 * @since 1.85
-	 * @alias sap.ui.mdc.odata.v4.TableDelegate
 	 */
 	var Delegate = Object.assign({}, TableDelegate);
 
 	/**
-	 * Fetches the model-specific property helper class or instance.
+	 * Fetches the model-specific <code>PropertyHelper</code> class or instance.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
-	 * @param {object[]} aProperties The property infos
+	 * <b>Note:</b> The <code>PropertyHelper</code> class adds the extension of a property to the reserved attribute "extension". It is not allowed to
+	 * add an <code>extension</code> attribute in the standard <code>PropertyInfo</code>.
+	 *
+	 * @example <caption>Initializing a <code>PropertyHelper</code> with extensions:</caption>
+	 * new PropertyHelper(
+	 *     [{
+	 *         name: "propA",
+	 *         label: "Property A",
+	 *         extension: {
+	 *             messageType: "Success"
+	 *         }
+	 *     }, {
+	 *         name: "propB",
+	 *         label: "Property B"
+	 *     }]
+	 * )
+	 *
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @param {object[]} aProperties <code>PropertyInfo</code>
 	 * @param {Promise<object<string, object>|null>} mExtensions The property extensions
-	 * @returns {Promise<sap.ui.mdc.table.V4AnalyticsPropertyHelper>} A promise that resolves with the property helper class or instance
+	 * @returns {Promise<sap.ui.mdc.table.V4AnalyticsPropertyHelper>} A <code>Promise</code> that resolves with the <code>PropertyHelper</code> class
+	 * or instance
 	 * @private
 	 * @ui5-restricted sap.ui.mdc
 	 */
@@ -66,10 +86,14 @@ sap.ui.define([
 
 	/**
 	 * Fetches the property extensions.
-	 * TODO: document structure of the extension
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
-	 * @param {object[]} aProperties The property infos
+	 * <b>Note:</b> Property extensions add model-specific information. To ensure a clear separation from the standard property information, the
+	 * extensions need to be passed separately to the constructor, together with their attribute metadata. An extension has to be provided as a
+	 * key-value pair, where the key is the name of the property and the value is the extension of this property. It is not allowed to provide
+	 * extensions without the corresponding attribute metadata.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @param {object[]} aProperties <code>PropertyInfo</code>
 	 * @returns {Promise<object<string, object>|null>} Key-value map, where the key is the name of the property, and the value is the extension
 	 * @protected
 	 */
@@ -78,12 +102,12 @@ sap.ui.define([
 	};
 
 	/**
-	 * Retrieves the relevant metadata that will be used for the table binding, and returns the property info array.
-	 * If not overriden, this method return the same as <code>fetchProperties</code>.
-	 * When overridding, make sure the returned result is consistent with what is returned by <code>fetchProperties</code>.
+	 * Retrieves the relevant metadata that will be used for the table binding, and returns the <code>PropertyInfo</code> array.
+	 * If it is not overridden, this method returns the same as <code>fetchProperties</code>.
+	 * When overriding the method make sure the returned result is consistent with what is returned by <code>fetchProperties</code>.
 	 *
-	 * @param {Object} oControl MDC Control instance
-	 * @returns {Promise} Once resolved, an array of property info objects is returned
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @returns {Promise} Once resolved, an array of <code>PropertyInfo</code> objects is returned
 	 * @protected
 	*/
 	Delegate.fetchPropertiesForBinding = function(oTable) {
@@ -92,11 +116,11 @@ sap.ui.define([
 
 	/**
 	 * Fetches the property extensions that will be used for the table binding.
-	 * If not overriden, this method eturn the same as <code>fetchPropertyExtensions</code>.
-	 * When overridding, make sure the returned result is consistent with what is returned by <code>fetchPropertyExtensions</code>.
+	 * If it is not overridden, this method returns the same as <code>fetchPropertyExtensions</code>.
+	 * When overriding the method make sure the returned result is consistent with what is returned by <code>fetchPropertyExtensions</code>.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
-	 * @param {object[]} aProperties The property infos
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @param {object[]} aProperties <code>PropertyInfo</code>
 	 * @returns {Promise<object<string, object>|null>} Key-value map, where the key is the name of the property, and the value is the extension
 	 * @protected
 	 */
@@ -107,10 +131,11 @@ sap.ui.define([
 	/**
 	 * Formats the title text of a group header row of the table.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
 	 * @param {sap.ui.model.Context} oContext Binding context
 	 * @param {string} sProperty The name of the grouped property
 	 * @returns {string | undefined} The group header title. If <code>undefined</code> is returned, the default group header title is set.
+	 * @private
 	 */
 	Delegate.formatGroupHeader = function(oTable, oContext, sProperty) {};
 
@@ -121,18 +146,17 @@ sap.ui.define([
 
 		return configureInnerTable(oTable).then(function() {
 			setAggregation(oTable);
-			setUpTableObserver(oTable);
 		});
 	};
 
-	Delegate.validateState = function(oControl, oState, sKey) {
+	Delegate.validateState = function(oTable, oState, sKey) {
 		var oBaseStates = TableDelegate.validateState.apply(this, arguments);
 		var oValidation;
 
 		var oResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.mdc");
 
 		if (sKey == "Sort" && oState.sorters) {
-			if (!checkForValidity(oControl, oState.items, oState.sorters)) {
+			if (isAnalyticsEnabled(oTable) && !checkForValidity(oTable, oState.items, oState.sorters)) {
 				oValidation = {
 					validation: coreLibrary.MessageType.Information,
 					message: oResourceBundle.getText("table.PERSONALIZATION_DIALOG_SORT_RESTRICTION")
@@ -142,9 +166,10 @@ sap.ui.define([
 			var aAggregateProperties = Object.keys(oState.aggregations);
 			var aAggregateGroupableProperties = [];
 			var oListFormat = ListFormat.getInstance();
-			aAggregateProperties.forEach(function(oItem) {
-				if (oControl.getPropertyHelper().isGroupable(oItem)) {
-					aAggregateGroupableProperties.push(oItem);
+			aAggregateProperties.forEach(function(sProperty) {
+				var oProperty = oTable.getPropertyHelper().getProperty(sProperty);
+				if (oProperty && oProperty.groupable) {
+					aAggregateGroupableProperties.push(sProperty);
 				}
 			});
 
@@ -158,11 +183,11 @@ sap.ui.define([
 			var sMessage;
 			var aAggregateProperties = oState.aggregations && Object.keys(oState.aggregations);
 
-			if (!checkForValidity(oControl, oState.items, aAggregateProperties)) {
+			if (!checkForValidity(oTable, oState.items, aAggregateProperties)) {
 				sMessage = oResourceBundle.getText("table.PERSONALIZATION_DIALOG_TOTAL_RESTRICTION");
 			}
 
-			if (!checkForValidity(oControl, oState.items, oState.sorters)) {
+			if (isAnalyticsEnabled(oTable) && !checkForValidity(oTable, oState.items, oState.sorters)) {
 				sMessage = sMessage ? sMessage + "\n" + oResourceBundle.getText("table.PERSONALIZATION_DIALOG_SORT_RESTRICTION")
 					: oResourceBundle.getText("table.PERSONALIZATION_DIALOG_SORT_RESTRICTION");
 			}
@@ -184,14 +209,13 @@ sap.ui.define([
 	 * <b>Note:</b> To remove a binding info parameter, the value must be set to <code>undefined</code>. For more information, see
 	 * {@link sap.ui.model.odata.v4.ODataListBinding#changeParameters}.
 	 *
-	 * @param {sap.ui.mdc.Table} oMDCTable The MDC table instance
-	 * @param {object} oDelegatePayload The delegate payload
+	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
 	 * @param {sap.ui.base.ManagedObject.AggregationBindingInfo} oBindingInfo The binding info object to be used to bind the table to the model
 	 * @function
-	 * @name sap.ui.mdc.odata.v4.TableDelegate.updateBindingInfo
+	 * @name module:sap/ui/mdc/odata/v4/TableDelegate.updateBindingInfo
 	 * @abstract
 	 */
-	//Delegate.updateBindingInfo = function(oTable, oDelegatePayload, oBindingInfo) { };
+	//Delegate.updateBindingInfo = function(oTable, oBindingInfo) { };
 
 	/**
 	 * Updates the row binding of the table if possible, rebinds otherwise.
@@ -202,15 +226,15 @@ sap.ui.define([
 	 * <code>model</code>... must be provided in the {@link #updateBindingInfo updateBindingInfo} method always,
 	 * and those keys must not be changed conditionally.
 	 *
-	 * @param {sap.ui.mdc.Table} oMDCTable The MDC table instance
+	 * @param {sap.ui.mdc.Table} oMDCTable Instance of the table
 	 * @param {sap.ui.base.ManagedObject.AggregationBindingInfo} oBindingInfo The binding info object to be used to bind the table to the model.
 	 * @param {sap.ui.model.ListBinding} [oBinding] The binding instance of the table
 	 * @protected
 	 * @override
 	 */
 	Delegate.updateBinding = function(oTable, oBindingInfo, oBinding) {
-		if (!oBinding || oBinding.hasPendingChanges() || oBinding.getPath() != oBindingInfo.path) {
-			this.rebindTable(oTable, oBindingInfo);
+		if (!oBinding || oBinding.getPath() != oBindingInfo.path) {
+			this.rebind(oTable, oBindingInfo);
 			return;
 		}
 
@@ -228,7 +252,7 @@ sap.ui.define([
 			oBinding.filter(oBindingInfo.filters, "Application");
 			oBinding.sort(oBindingInfo.sorter);
 		} catch (e) {
-			this.rebindTable(oTable, oBindingInfo);
+			this.rebind(oTable, oBindingInfo);
 			if (oRootBinding == oBinding) {
 				// If we resume before the rebind, you get an extra request therefore we must
 				// resume after rebind, but only if the list binding was not the root binding.
@@ -245,23 +269,37 @@ sap.ui.define([
 	 * @override
 	 * @inheritDoc
 	 */
-	Delegate.rebindTable = function (oTable, oBindingInfo) {
+	Delegate.rebind = function (oTable, oBindingInfo) {
 		setAggregation(oTable, oBindingInfo);
-		TableDelegate.rebindTable(oTable, oBindingInfo);
+		TableDelegate.rebind(oTable, oBindingInfo);
 	};
 
 	Delegate.addColumnMenuItems = function(oTable, oMDCColumn) {
-		if (!isInnerTableReadyForAnalytics(oTable)) {
+		var oPropertyHelper = oTable.getPropertyHelper();
+		var oProperty = oPropertyHelper.getProperty(oMDCColumn.getDataProperty());
+		var aItems = [];
+
+		if (!oProperty) {
 			return [];
 		}
 
-		var oPropertyHelper = oTable.getPropertyHelper();
-		var aGroupProperties = oPropertyHelper.getGroupableProperties(oMDCColumn.getDataProperty());
-		var aAggregateProperties = oPropertyHelper.getAggregatableProperties(oMDCColumn.getDataProperty());
-		var oPopover = oTable._oPopover;
-		var oAggregatePopoverItem;
-		var oGroupPopoverItem;
+		if (oTable.isGroupingEnabled() && supportsGrouping(oTable)) {
+			var aGroupProperties = oProperty.getGroupableProperties();
+
+			if (aGroupProperties.length > 0) {
+				aItems.push(createGroupPopoverItem(aGroupProperties, oMDCColumn));
+			}
+		}
+
+		if (oTable.isAggregationEnabled() && supportsAggregation(oTable)) {
+			var aAggregateProperties = oProperty.getAggregatableProperties();
 
+			if (aAggregateProperties.length > 0) {
+				aItems.push(createAggregatePopoverItem(aAggregateProperties, oMDCColumn));
+			}
+		}
+
+		var oPopover = oTable._oPopover;
 		if (oPopover) {
 			oPopover.getItems().forEach(function(oItem, iIndex, aItems) {
 				var sLabel = oItem.getLabel();
@@ -277,22 +315,14 @@ sap.ui.define([
 			});
 		}
 
-		if (oTable.isGroupingEnabled() && aGroupProperties && aGroupProperties.length > 0) {
-			oGroupPopoverItem = createGroupPopoverItem(aGroupProperties, oMDCColumn);
-		}
-
-		if (oTable.isAggregationEnabled() && aAggregateProperties && aAggregateProperties.length > 0) {
-			oAggregatePopoverItem = createAggregatePopoverItem(aAggregateProperties, oMDCColumn);
-		}
-
-		return [oGroupPopoverItem, oAggregatePopoverItem];
+		return aItems;
 	};
 
 	function createGroupPopoverItem(aGroupProperties, oMDCColumn) {
 		var aGroupChildren = aGroupProperties.map(function(oGroupProperty) {
 			return new Item({
-				text: oGroupProperty.getLabel(),
-				key: oGroupProperty.getName()
+				text: oGroupProperty.label,
+				key: oGroupProperty.name
 			});
 		});
 
@@ -312,8 +342,8 @@ sap.ui.define([
 	function createAggregatePopoverItem(aAggregateProperties, oMDCColumn) {
 		var aAggregateChildren = aAggregateProperties.map(function(oAggregateProperty) {
 			return new Item({
-				text: oAggregateProperty.getLabel(),
-				key: oAggregateProperty.getName()
+				text: oAggregateProperty.label,
+				key: oAggregateProperty.name
 			});
 		});
 
@@ -401,30 +431,36 @@ sap.ui.define([
 	/**
 	 * Updates the aggregation info if the plugin is enabled.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
 	 * @param {sap.ui.base.ManagedObject.AggregationBindingInfo} [oBindingInfo] The binding info object to be used to bind the table to the model
 	 */
 	function setAggregation(oTable, oBindingInfo) {
-		if (isInnerTableReadyForAnalytics(oTable)) {
-			var aAggregates = Object.keys(oTable._getAggregatedProperties());
-			var sSearch = oBindingInfo && oBindingInfo.parameters["$search"] || undefined;
-			if (sSearch ) {
-				delete oBindingInfo.parameters["$search"];
-			}
-			var aGroupLevels = oTable._getGroupedProperties().map(function (mGroupLevel) {
-				return mGroupLevel.name;
-			});
-			var oAggregationInfo = {
-				visible: getVisibleProperties(oTable),
-				groupLevels: aGroupLevels,
-				grandTotal: aAggregates,
-				subtotals: aAggregates,
-				columnState: getColumnState(oTable, aAggregates),
-				search: sSearch
-			};
+		var oPlugin = TableMap.get(oTable).plugin;
+
+		if (!oPlugin || oPlugin.isDestroyed()) {
+			return;
+		}
+
+		var aGroupLevels = oTable._getGroupedProperties().map(function (mGroupLevel) {
+			return mGroupLevel.name;
+		});
+		var aAggregates = Object.keys(oTable._getAggregatedProperties());
+		var sSearch = oBindingInfo ? oBindingInfo.parameters["$search"] : undefined;
 
-			TableMap.get(oTable).plugin.setAggregationInfo(oAggregationInfo);
+		if (sSearch ) {
+			delete oBindingInfo.parameters["$search"];
 		}
+
+		var oAggregationInfo = {
+			visible: getVisibleProperties(oTable),
+			groupLevels: aGroupLevels,
+			grandTotal: aAggregates,
+			subtotals: aAggregates,
+			columnState: getColumnState(oTable, aAggregates),
+			search: sSearch
+		};
+
+		oPlugin.setAggregationInfo(oAggregationInfo);
 	}
 
 	function getVisibleProperties(oTable) {
@@ -439,7 +475,7 @@ sap.ui.define([
 			}
 
 			if (oProperty.isComplex()) {
-				// Add the names of all related (simple) propertyInfos in the list.
+				// Add the names of all related (simple) PropertyInfo in the list.
 				oProperty.getReferencedProperties().forEach(function(oProperty) {
 					oVisiblePropertiesSet.add(oProperty.name);
 				});
@@ -515,10 +551,8 @@ sap.ui.define([
 		var aUnitProperties = [];
 
 		aProperties.forEach(function(oProperty) {
-			var oUnitProperty = oProperty ? oProperty.getUnitProperty() : null;
-
-			if (oUnitProperty) {
-				aUnitProperties.push(oUnitProperty);
+			if (oProperty.unitProperty) {
+				aUnitProperties.push(oProperty.unitProperty);
 			}
 		});
 
@@ -554,9 +588,9 @@ sap.ui.define([
 	/**
 	 * Compares the message type and returns the message with higher priority.
 	 *
-	 * @param {Object} oBaseState message set by the base table delegate.
-	 * @param {Object} oValidationState message set by the odata v4 delegate.
-	 * @return {Object} A message with higher priority.
+	 * @param {Object} oBaseState Message set by the base <code>TableDelegate</code>
+	 * @param {Object} oValidationState Message set by the <code>ODataV4Delegate</code>
+	 * @returns {Object} The message with higher priority
 	 * @private
 	 */
 	function mergeValidation(oBaseState, oValidationState) {
@@ -570,39 +604,56 @@ sap.ui.define([
 	}
 
 	/**
-	 * Configures the inner table to support the p13n settings of the MDC table.
+	 * Checks whether the inner table supports grouping.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
-	 * @return {Promise} A promise that revolves when the inner table is configured
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @returns {boolean} Whether the inner table supports grouping
 	 */
-	function configureInnerTable(oTable) {
-		return oTable._isOfType(TableType.Table) ? configureGridTable(oTable) : configureResponsiveTable(oTable);
+	function supportsGrouping(oTable) {
+		return oTable._isOfType(TableType.Table);
 	}
 
 	/**
-	 * Checks whether the inner table supports the "analytical" p13n modes <code>Group</code> and <code>Aggregate</code>.
+	 * Checks whether the inner table supports aggregation.
 	 *
-	 * @param {sap.ui.mdc.Table} oTable Instance of the MDC table
-	 * @return {boolean} Whether the inner table supports the "analytical" p13n modes
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @returns {boolean} Whether the inner table supports aggregation
 	 */
-	function isInnerTableReadyForAnalytics(oTable) {
-		if (oTable._isOfType(TableType.Table)) {
-			var oPlugin = TableMap.get(oTable).plugin;
-			return oPlugin != null && !oPlugin.bIsDestroyed;
-		} else {
-			return false;
-		}
+	function supportsAggregation(oTable) {
+		return oTable._isOfType(TableType.Table);
 	}
 
-	function configureGridTable(oTable) {
-		return isAnalyticsEnabled(oTable) ? enableGridTablePlugin(oTable) : disableGridTablePlugin(oTable);
+	/**
+	 * Checks whether aggregation features of the model are used.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @returns {boolean} Whether aggregation features are used
+	 * @see sap.ui.model.odata.v4.ODataListBinding#setAggregation
+	 */
+	function isAnalyticsEnabled(oTable) {
+		return (oTable.isGroupingEnabled() || oTable.isAggregationEnabled()) && oTable._isOfType(TableType.Table);
+	}
+
+	/**
+	 * Configures the inner table to support the personalization settings of the table.
+	 *
+	 * @param {sap.ui.mdc.Table} oTable Instance of the table
+	 * @return {Promise} A <code>Promise</code> that resolves when the inner table is configured
+	 */
+	function configureInnerTable(oTable) {
+		if (oTable._isOfType(TableType.Table)) {
+			return (isAnalyticsEnabled(oTable) ? enableGridTablePlugin(oTable) : disableGridTablePlugin(oTable)).then(function() {
+				return setUpTableObserver(oTable);
+			});
+		}
+		return Promise.resolve();
 	}
 
 	function enableGridTablePlugin(oTable) {
 		var mTableMap = TableMap.get(oTable);
 		var oPlugin = mTableMap.plugin;
 
-		if (oPlugin && !oPlugin.bIsDestroyed) {
+		if (oPlugin && !oPlugin.isDestroyed()) {
 			oPlugin.activate();
 			return Promise.resolve();
 		}
@@ -640,10 +691,6 @@ sap.ui.define([
 		return Promise.resolve();
 	}
 
-	function configureResponsiveTable(oTable) {
-		return Promise.resolve();
-	}
-
 	function fetchPropertyHelperForBinding(oTable) {
 		var mTableMap = TableMap.get(oTable);
 
@@ -678,20 +725,17 @@ sap.ui.define([
 					if (mTableMap.oPropertyHelperForBinding) {
 						mTableMap.oPropertyHelperForBinding.destroy();
 					}
+
 				} else {
 					configureInnerTable(oTable);
 				}
 			});
-		}
-
-		mTableMap.observer.observe(oTable, {
-			properties: ["p13nMode"],
-			destroy: true
-		});
-	}
 
-	function isAnalyticsEnabled(oTable) {
-		return oTable.isGroupingEnabled() || oTable.isAggregationEnabled();
+			mTableMap.observer.observe(oTable, {
+				properties: ["p13nMode"],
+				destroy: true
+			});
+		}
 	}
 
 	return Delegate;

package/src/sap/ui/mdc/odata/v4/TypeUtil.js

@@ -77,4 +77,4 @@ sap.ui.define(['sap/ui/mdc/odata/TypeUtil', 'sap/ui/mdc/enum/BaseType'], functio
 
 	return ODataV4TypeUtil;
 
-}, /* bExport= */ true);
+});

package/src/sap/ui/mdc/odata/v4/ValueHelpDelegate.js

@@ -16,7 +16,7 @@ sap.ui.define([
 	var ODataV4ValueHelpDelegate = Object.assign({}, ValueHelpDelegate);
 
 	ODataV4ValueHelpDelegate.isSearchSupported = function(oPayload, oListBinding) {
-		return true; // only on V4
+		return !!oListBinding.changeParameters;
 	};
 
 	var _waitForBindingData = function (oBinding) {

package/src/sap/ui/mdc/odata/v4/util/DelegateUtil.js

@@ -110,4 +110,4 @@ sap.ui.define(['sap/ui/mdc/util/FilterUtil',
 
 
 	return DelegateUtil;
-}, /* bExport= */true);
+});