@openui5/sap.ui.core 1.108.0 → 1.109.0

package/src/sap/ui/model/odata/v4/ODataListBinding.js

@@ -57,7 +57,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.108.0
+		 * @version 1.109.0
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getUpdateGroupId as #getUpdateGroupId
@@ -353,8 +353,7 @@ sap.ui.define([
 			}
 			oContext.resetKeepAlive();
 			oContext.iIndex = Context.VIRTUAL; // prevent further cache access via this context
-			that.oModel.addPrerenderingTask(
-				that.destroyPreviousContexts.bind(that, [oContext.getPath()]));
+			that.destroyPreviousContextsLater([oContext.getPath()]);
 		}, function (oError) {
 			that.iDeletedContexts -= 1;
 			if (bReset) {
@@ -505,10 +504,15 @@ sap.ui.define([
 
 	/**
 	 * The 'createActivate' event is fired when a property is changed on a context in an 'inactive'
-	 * state (see {@link #create}). The context then changes its state to 'transient'.
+	 * state (see {@link #create}). The context then changes its state to 'transient'. Since
+	 * 1.109.0, this default behavior can be prevented by calling
+	 * {@link sap.ui.base.Event#preventDefault}. The context will then remain in the 'inactive'
+	 * state.
+	 *
 	 *
 	 * @param {sap.ui.base.Event} oEvent The event object
 	 * @param {sap.ui.model.odata.v4.ODataListBinding} oEvent.getSource() This binding
+	 * @param {sap.ui.model.odata.v4.Context} oEvent.getParameters().context The affected context
 	 *
 	 * @event sap.ui.model.odata.v4.ODataListBinding#createActivate
 	 * @public
@@ -659,7 +663,8 @@ sap.ui.define([
 	 *   {@link #changeParameters} leads to {@link sap.ui.model.ChangeReason.Filter Filter} if one
 	 *   of the parameters '$filter' and '$search' is changed, otherwise it leads to
 	 *   {@link sap.ui.model.ChangeReason.Sort Sort} if the parameter '$orderby' is
-	 *   changed; in other cases, it leads to {@link sap.ui.model.ChangeReason.Change Change}.<br>
+	 *   changed; in other cases, it leads to {@link sap.ui.model.ChangeReason.Change Change}.
+	 *   <br>
 	 *   If APIs that would normally fire change events have been called while the binding is
 	 *   suspended, {@link #resume} leads to the &quot;strongest&quot; change reason in the order
 	 *   {@link sap.ui.model.ChangeReason.Filter Filter},
@@ -820,7 +825,7 @@ sap.ui.define([
 	 *   Create an inactive context. Such a context will only be sent to the server after the first
 	 *   property update. From then on it behaves like any other created context.
 	 *   Supported since 1.97.0
-	 *   <p>
+	 *   <br>
 	 *   Since 1.98.0, when the first property updates happens, the context is no longer
 	 *   {@link sap.ui.model.odata.v4.Context#isInactive inactive} and the
 	 *   {@link sap.ui.model.odata.v4.ODataListBinding#event:createActivate createActivate} event
@@ -886,7 +891,8 @@ sap.ui.define([
 		// only for createInCache
 		oGroupLock = this.lockGroup(sGroupId, true, true, function () {
 			if (!that.aContexts.includes(oContext)) { // #setContext changed the parent context
-				oContext.destroy();
+				that.mPreviousContextsByPath[oContext.getPath()] = oContext;
+				that.destroyPreviousContextsLater([oContext.getPath()]);
 				return;
 			}
 
@@ -984,7 +990,6 @@ sap.ui.define([
 			oModel = this.oModel,
 			sPath = this.getResolvedPath(),
 			sPredicate,
-			aPreviousPaths,
 			bStartBeyondRange = iStart > this.aContexts.length,
 			i,
 			that = this;
@@ -1032,10 +1037,7 @@ sap.ui.define([
 			}
 		}
 		// destroy previous contexts which are not reused or kept-alive
-		aPreviousPaths = Object.keys(this.mPreviousContextsByPath);
-		if (aPreviousPaths.length) {
-			oModel.addPrerenderingTask(this.destroyPreviousContexts.bind(this, aPreviousPaths));
-		}
+		this.destroyPreviousContextsLater(Object.keys(this.mPreviousContextsByPath));
 		if (iCount !== undefined) { // server count is available or "non-empty short read"
 			this.bLengthFinal = true;
 			this.iMaxLength = iCount - this.iActiveContexts;
@@ -1121,7 +1123,7 @@ sap.ui.define([
 	 * Removes and destroys contexts from mPreviousContextsByPath.
 	 *
 	 * @param {string[]} [aPathsToDelete]
-	 *   If given, only contexts with paths in this list except kept-alive and deleted ones are
+	 *   If given, only contexts with paths in this list except kept-alive and pending deletes are
 	 *   removed and destroyed (transient contexts are removed only); otherwise all contexts in the
 	 *   list are removed and destroyed
 	 *
@@ -1135,7 +1137,8 @@ sap.ui.define([
 				var oContext = mPreviousContextsByPath[sPath];
 
 				if (oContext) {
-					if (aPathsToDelete && (oContext.isKeepAlive() || oContext.isDeleted())) {
+					if (aPathsToDelete && (oContext.isKeepAlive()
+							|| oContext.oDeletePromise && oContext.oDeletePromise.isPending())) {
 						oContext.iIndex = undefined;
 					} else {
 						if (!oContext.isTransient()) {
@@ -1148,6 +1151,23 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Removes and destroys the contexts with the given paths from mPreviousContextsByPaths in a
+	 * prerendering task.
+	 *
+	 * @param {string[]} aPathsToDelete
+	 *   Only contexts with paths in this list except kept-alive and pending deletes are removed and
+	 *   destroyed (transient contexts are removed only)
+	 *
+	 * @private
+	 */
+	ODataListBinding.prototype.destroyPreviousContextsLater = function (aPathsToDelete) {
+		if (aPathsToDelete.length) {
+			this.oModel.addPrerenderingTask(
+				this.destroyPreviousContexts.bind(this, aPathsToDelete));
+		}
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#doCreateCache
@@ -1813,14 +1833,37 @@ sap.ui.define([
 	/**
 	 * Fires the 'createActivate' event.
 	 *
-	 * @param {sap.ui.model.odata.v4.Context} _oContext
+	 * @param {sap.ui.model.odata.v4.Context} oContext
 	 *   The context being activated
+	 * @returns {boolean}
+	 *   Whether the context should become active
 	 *
 	 * @private
 	 */
-	ODataListBinding.prototype.fireCreateActivate = function (_oContext) {
-		this.iActiveContexts += 1;
-		this.fireEvent("createActivate");
+	ODataListBinding.prototype.fireCreateActivate = function (oContext) {
+		if (this.fireEvent("createActivate", {context : oContext}, true)) {
+			this.iActiveContexts += 1;
+
+			return true;
+		}
+
+		return false;
+	};
+
+	/**
+	 * Returns the current object holding the information needed for data aggregation, see
+	 * {@link #setAggregation}.
+	 *
+	 * @returns {object}
+	 *   The current data aggregation object, incl. some default values
+	 *
+	 * @public
+	 * @since 1.109.0
+	 */
+	ODataListBinding.prototype.getAggregation = function () {
+		return _Helper.clone(this.mParameters.$$aggregation, function (sKey, vValue) {
+			return sKey[0] === "$" ? undefined : vValue;
+		});
 	};
 
 	/**
@@ -3230,7 +3273,7 @@ sap.ui.define([
 			});
 		}
 
-		if (this.mParameters.$$aggregation) {
+		if (this.mParameters.$$aggregation && !this.mParameters.$$aggregation.hierarchyQualifier) {
 			if (bSingle) {
 				throw new Error(
 					"Must not request side effects for a context of a binding with $$aggregation");
@@ -3474,12 +3517,14 @@ sap.ui.define([
 	 *   <a href="https://docs.oasis-open.org/odata/odata-data-aggregation-ext/v4.0/">OData
 	 *   Extension for Data Aggregation Version 4.0</a>. Since 1.76.0, <code>undefined</code> can be
 	 *   used to remove the data aggregation object, which allows to set <code>$apply</code>
-	 *   explicitly afterwards. <code>null</code> is not supported.<br>
+	 *   explicitly afterwards. <code>null</code> is not supported.
+	 *   <br>
 	 *   Since 1.89.0, the deprecated property <code>"grandTotal like 1.84" : true</code> can be
 	 *   used to turn on the handling of grand totals like in 1.84.0, using aggregates of aggregates
 	 *   and thus allowing to filter by aggregated properties while grand totals are needed. Beware
 	 *   that methods like "average" or "countdistinct" are not compatible with this approach, and
-	 *   it cannot be combined with group levels.<br>
+	 *   it cannot be combined with group levels.
+	 *   <br>
 	 *   Since 1.105.0, either a recursive hierarchy or pure data aggregation is supported, but no
 	 *   mix; <code>hierarchyQualifier</code> is the leading property that decides between those two
 	 *   use cases - this is an <b>experimental API</b> and is only supported if the model uses the
@@ -3512,8 +3557,10 @@ sap.ui.define([
 	 *       suggestion: <code>CASE WHEN MIN(Unit) = MAX(Unit) THEN MIN(Unit) END</code>)
 	 *   </ul>
 	 * @param {number} [oAggregation.expandTo=1]
-	 *   The number of initially expanded levels as a positive integer (@experimental as of version
-	 *   1.105.0), supported only if a <code>hierarchyQualifier</code> is given.
+	 *   The number (as a positive integer) of different levels initially available without calling
+	 *   {@link sap.ui.model.odata.v4.Context#expand} (@experimental as of version 1.105.0),
+	 *   supported only if a <code>hierarchyQualifier</code> is given. Root nodes are on the first
+	 *   level. By default, only root nodes are available; they are not yet expanded.
 	 * @param {boolean} [oAggregation.grandTotalAtBottomOnly]
 	 *   Tells whether the grand totals for aggregatable properties are displayed at the bottom only
 	 *   (since 1.86.0); <code>true</code> for bottom only, <code>false</code> for top and bottom,
@@ -3573,6 +3620,7 @@ sap.ui.define([
 	 *     <li> a recursive hierarchy is requested, but the model does not use the
 	 *       <code>autoExpandSelect</code> parameter.
 	 *   </ul>
+	 *
 	 * @example <caption>First group level is product category including subtotals for the net
 	 *     amount in display currency. On leaf level, transaction currency is used as an additional
 	 *     dimension and the net amount is averaged.</caption>
@@ -3593,6 +3641,7 @@ sap.ui.define([
 	 *     groupLevels : ['ProductCategory']
 	 *   });
 	 * @public
+	 * @see #getAggregation
 	 * @since 1.55.0
 	 */
 	ODataListBinding.prototype.setAggregation = function (oAggregation) {
@@ -3690,6 +3739,11 @@ sap.ui.define([
 	 * request. Since 1.97.0, if sorters are unchanged, no request is sent, regardless of pending
 	 * changes.
 	 *
+	 * <b>Note:</b> To allow proper detection whether sorters are unchanged, care must be taken if a
+	 * sorter uses a function (for example via the <code>vGroup</code> parameter): it must be the
+	 * exact same function instance which was given before, and not a newly created one, for example
+	 * because <code>Function.prototype.bind</code> is called repeatedly.
+	 *
 	 * If there are pending changes that cannot be ignored, an error is thrown. Use
 	 * {@link #hasPendingChanges} to check if there are such pending changes. If there are, call
 	 * {@link sap.ui.model.odata.v4.ODataModel#submitBatch} to submit the changes or

package/src/sap/ui/model/odata/v4/ODataMetaModel.js

@@ -157,7 +157,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.108.0
+		 * @version 1.109.0
 		 */
 		ODataMetaModel = MetaModel.extend("sap.ui.model.odata.v4.ODataMetaModel", {
 				constructor : constructor

package/src/sap/ui/model/odata/v4/ODataModel.js

@@ -218,7 +218,7 @@ sap.ui.define([
 		 * @extends sap.ui.model.Model
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.108.0
+		 * @version 1.109.0
 		 */
 		ODataModel = Model.extend("sap.ui.model.odata.v4.ODataModel",
 			/** @lends sap.ui.model.odata.v4.ODataModel.prototype */{
@@ -2489,7 +2489,7 @@ sap.ui.define([
 	 *   given group ID are running.
 	 *
 	 * @public
-	 * @see sap.ui.model.odata.v4.ODataModel#constructor.
+	 * @see sap.ui.model.odata.v4.ODataModel#constructor
 	 * @since 1.39.0
 	 */
 	ODataModel.prototype.resetChanges = function (sGroupId) {

package/src/sap/ui/model/odata/v4/ODataPropertyBinding.js

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.108.0
+		 * @version 1.109.0
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getUpdateGroupId as #getUpdateGroupId