@openui5/sap.ui.core 1.124.2 → 1.126.0

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

@@ -42,7 +42,7 @@ sap.ui.define([
 		 * @hideconstructor
 		 * @public
 		 * @since 1.39.0
-		 * @version 1.124.2
+		 * @version 1.126.0
 		 */
 		Context = BaseContext.extend("sap.ui.model.odata.v4.Context", {
 				constructor : constructor
@@ -244,12 +244,11 @@ sap.ui.define([
 	 * model itself ensures that all bindings depending on this context become unresolved, but no
 	 * attempt is made to restore these bindings in case of reset or failure.
 	 *
-	 * Deleting a node in a recursive hierarchy
-	 * (see {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}) is supported
-	 * (@experimental as of version 1.118.0). As a precondition, the context must not be
-	 * {@link #setKeepAlive kept-alive} and hidden (for example due to a filter), and the group ID
-	 * must not have {@link sap.ui.model.odata.v4.SubmitMode.API}. Such a deletion is not a pending
-	 * change.
+	 * Since 1.125.0, deleting a node in a recursive hierarchy (see
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#setAggregation}) is supported. As a
+	 * precondition, the context must not be both {@link #setKeepAlive kept-alive} and hidden (for
+	 * example due to a filter), and the group ID must not have
+	 * {@link sap.ui.model.odata.v4.SubmitMode.API}. Such a deletion is not a pending change.
 	 *
 	 * @param {string} [sGroupId]
 	 *   The group ID to be used for the DELETE request; if not specified, the update group ID for
@@ -361,8 +360,9 @@ sap.ui.define([
 
 	/**
 	 * Destroys this context, that is, it removes this context from all dependent bindings and drops
-	 * references to binding and model, so that the context cannot be used anymore; it keeps path
-	 * and index for debugging purposes.
+	 * references to {@link #getBinding binding} and {@link #getModel model}, so that the context
+	 * cannot be used anymore; it keeps path and index for debugging purposes. A destroyed context
+	 * can be recognized by calling {@link #getBinding}, which returns <code>undefined</code>.
 	 *
 	 * <b>BEWARE:</b> Do not call this function! The lifetime of an OData V4 context is completely
 	 * controlled by its binding.
@@ -436,8 +436,8 @@ sap.ui.define([
 
 			// Messages have been updated via _Cache#_delete; "that" is already destroyed; remove
 			// all dependent caches in all bindings
-			oModel.getAllBindings().forEach(function (oBinding) {
-				oBinding.removeCachesAndMessages(sResourcePathPrefix, true);
+			oModel.getAllBindings().forEach(function (oBinding0) {
+				oBinding0.removeCachesAndMessages(sResourcePathPrefix, true);
 			});
 		}).catch(function (oError) {
 			oModel.reportError("Failed to delete " + that.getPath(), sClassName, oError);
@@ -607,15 +607,32 @@ sap.ui.define([
 	 *
 	 * @param {boolean} bSelected
 	 *   Whether this context is to be selected
+	 * @param {boolean} [bDoNotUpdateAnnotation]
+	 *   Whether the client-side annotation "@$ui5.context.isSelected" should not be updated
+	 * @returns {boolean}
+	 *   Whether the selection state of the context has changed
 	 *
 	 * @private
 	 * @see #setSelected
 	 */
-	Context.prototype.doSetSelected = function (bSelected) {
-		this.bSelected = bSelected;
-		if (this.oBinding) {
-			this.oBinding.onKeepAliveChanged(this); // selected contexts are effectively kept alive
+	Context.prototype.doSetSelected = function (bSelected, bDoNotUpdateAnnotation) {
+		if (bSelected === this.bSelected) {
+			return false;
+		}
+
+		if (!bDoNotUpdateAnnotation) {
+			this.withCache((oCache, sPath) => {
+				if (this.oBinding) {
+					oCache.setProperty("@$ui5.context.isSelected", bSelected, sPath);
+				} // else: context already destroyed
+			}, "");
 		}
+
+		this.bSelected = bSelected;
+
+		this.oBinding?.onKeepAliveChanged(this); // selected contexts are effectively kept alive
+
+		return true;
 	};
 
 	/**
@@ -1016,6 +1033,32 @@ sap.ui.define([
 		return this.oBinding.getQueryOptionsForPath(sPath);
 	};
 
+	/**
+	 * Returns this node's sibling; either the next one (via offset +1) or the previous one (via
+	 * offset -1). Returns <code>null</code> if no such sibling exists (because this node is the
+	 * last or first sibling, respectively). If it's not known whether the requested sibling
+	 * exists, <code>undefined</code> is returned and {@link #requestSibling} can be used instead.
+	 *
+	 * @param {number} [iOffset=+1] - An offset, either -1 or +1
+	 * @returns {sap.ui.model.odata.v4.Context|null|undefined}
+	 *   The sibling's context, or <code>null</code> if no such sibling exists for sure, or
+	 *   <code>undefined</code> if we cannot tell
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> the given offset is unsupported,
+	 *     <li> this context's root binding is suspended,
+	 *     <li> this context is {@link #isDeleted deleted}, {@link #isTransient transient}, or not
+	 *       part of a recursive hierarchy.
+	 *   </ul>
+	 *
+	 * @private
+	 * @since 1.126.0
+	 * @ui5-restricted sap.fe
+	 */
+	Context.prototype.getSibling = function (iOffset) {
+		return this.oBinding.fetchOrGetSibling(this, iOffset);
+	};
+
 	/**
 	 * Returns the group ID of the context's binding that is used for update requests. See
 	 * {@link sap.ui.model.odata.v4.ODataListBinding#getUpdateGroupId} and
@@ -1261,7 +1304,13 @@ sap.ui.define([
 	 *
 	 * The move potentially changes the {@link #getIndex index} of this context, of all of its
 	 * descendants, and of all other nodes affected by the move. Any index change can, however, only
-	 * be observed reliably for this context itself.
+	 * be observed reliably for this context itself or (since 1.126.0) the next sibling's context
+	 * if that is {@link #isKeepAlive kept alive} or {@link #isSelected selected} (and the
+	 * preconditions of {@link #setKeepAlive} hold). For a kept-alive or selected next sibling, the
+	 * index must be retrieved as soon as the returned promise resolves. If such a next sibling is
+	 * not one of the binding's {@link sap.ui.model.odata.v4.ODataListBinding#getCurrentContexts
+	 * current contexts} after the move, it is not in the collection anymore and thus loses its
+	 * index pretty soon.
 	 *
 	 * The move changes the
 	 * {@link topic:c9723f8265f644af91c0ed941e114d46/section_CST context states} of the nodes as
@@ -1288,18 +1337,17 @@ sap.ui.define([
 	 *
 	 * @param {object} oParameters - A parameter object
 	 * @param {sap.ui.model.odata.v4.Context|null} [oParameters.nextSibling]
-	 *   The next sibling's context, or <code>null</code> to turn this node into the last sibling
-	 *   (since 1.124.0). Omitting the sibling moves this node to a position determined by the
-	 *   server.
+	 *   The next sibling's context, or <code>null</code> to turn this node into the last sibling.
+	 *   Omitting the sibling moves this node to a position determined by the server.
 	 * @param {sap.ui.model.odata.v4.Context|null} oParameters.parent
-	 *   The new parent's context, or (since 1.121.0) <code>null</code> to turn this node into a
-	 *   root node
+	 *   The new parent's context, or <code>null</code> to turn this node into a root node
 	 * @returns {Promise<void>}
 	 *   A promise which is resolved without a defined result when the move is finished, or
 	 *   rejected in case of an error
 	 * @throws {Error} If
 	 *   <ul>
 	 *     <li> there is no recursive hierarchy,
+	 *     <li> this context's root binding is suspended,
 	 *     <li> the new parent is (a descendant of) this node,
 	 *     <li> this node or the new parent is
 	 *       <ul>
@@ -1309,8 +1357,8 @@ sap.ui.define([
 	 *     </ul>
 	 *   </ul>
 	 *
-	 * @experimental As of version 1.119.0
 	 * @public
+	 * @since 1.125.0
 	 */
 	Context.prototype.move = function ({nextSibling : oNextSibling, parent : oParent} = {}) {
 		if (oNextSibling === undefined && oParent === undefined) {
@@ -1631,6 +1679,34 @@ sap.ui.define([
 		});
 	};
 
+	/**
+	 * Requests this node's sibling; either the next one (via offset +1) or the previous one (via
+	 * offset -1). Resolves with <code>null</code> if no such sibling exists (because this node is
+	 * the last or first sibling, respectively). If it's not known whether the requested sibling
+	 * exists, a request is sent to the server.
+	 *
+	 * @param {number} [iOffset=+1] - An offset, either -1 or +1
+	 * @returns {Promise<sap.ui.model.odata.v4.Context|null>}
+	 *   A promise which is either resolved with the sibling's context (or <code>null</code> if no
+	 *   such sibling exists) in case of success, or rejected with an instance of <code>Error</code>
+	 *   in case of failure
+	 * @throws {Error} If
+	 *   <ul>
+	 *     <li> the given offset is unsupported,
+	 *     <li> this context's root binding is suspended,
+	 *     <li> this context is {@link #isDeleted deleted}, {@link #isTransient transient}, or not
+	 *       part of a recursive hierarchy.
+	 *   </ul>
+	 *
+	 * @private
+	 * @see #getSibling
+	 * @since 1.125.0
+	 * @ui5-restricted sap.fe
+	 */
+	Context.prototype.requestSibling = function (iOffset) {
+		return Promise.resolve(this.oBinding.fetchOrGetSibling(this, iOffset, true));
+	};
+
 	/**
 	 * Loads side effects for this context using the given
 	 * "14.5.11 Expression edm:NavigationPropertyPath" or "14.5.13 Expression edm:PropertyPath"
@@ -2206,17 +2282,24 @@ sap.ui.define([
 	};
 
 	/**
-	 * Sets whether this context is currently selected. While a context is currently
-	 * {@link #delete deleted} on the client, it does not appear as {@link #isSelected selected}. If
-	 * the preconditions of {@link #setKeepAlive} hold, a best effort is made to implicitly keep a
-	 * selected context alive in order to preserve the selection state. Once the selection is no
-	 * longer needed, for example because you perform an operation on this context which logically
-	 * removes it from its list, you need to reset the selection.
+	 * Sets whether this context is currently selected. If the selection state changes, a
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged'}
+	 * event is fired on the list binding which this context belongs to. While a context is
+	 * currently {@link #delete deleted} on the client, it does not appear as
+	 * {@link #isSelected selected}. If the preconditions of {@link #setKeepAlive} hold, a best
+	 * effort is made to implicitly keep a selected context alive in order to preserve the selection
+	 * state. Once the selection is no longer needed, for example because you perform an operation
+	 * on this context which logically removes it from its list, you need to reset the selection.
 	 *
 	 * If this context is a header context of a list binding, the new selection state is propagated
-	 * to all row contexts. This method can be called repeatedly with the same value to again select
-	 * all row contexts. For example, if a row context was deselected explicitly, it is selected
-	 * again by selecting the header context (even if the header context is already selected).
+	 * to all row contexts. If the selection state of this header context changes, a
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged'}
+	 * event is fired for this header context. This method can be called repeatedly with
+	 * the same value to again select all row contexts. For example, if a row context was deselected
+	 * explicitly, it is selected again by selecting the header context (even if the header context
+	 * is already selected). If the selection state of any row context changes in this way, then a
+	 * {@link sap.ui.model.odata.v4.ODataListBinding#event:selectionChanged 'selectionChanged'}
+	 * event is nevertheless fired for this header context, but not for the row context.
 	 *
 	 * <b>Note:</b> It is unsafe to keep a reference to a context instance which is not
 	 * {@link #isKeepAlive kept alive}.
@@ -2237,23 +2320,21 @@ sap.ui.define([
 		if (bSelected && this.isDeleted()) {
 			throw new Error("Must not select a deleted entity: " + this);
 		}
-		if (this.oBinding.getHeaderContext() === this) {
-			this.oBinding._getAllExistingContexts().forEach(function (oContext) {
-				oContext.setSelected(bSelected);
-			});
-		}
-		if (bSelected !== this.bSelected) {
-			if (this.mChangeListeners) { // header context: "select all"
-				_Helper.fireChange(this.mChangeListeners, "", bSelected);
-			}
-			this.withCache((oCache, sPath) => {
-				if (this.oBinding) {
-					oCache.setProperty("@$ui5.context.isSelected", bSelected, sPath);
-				} // else: context already destroyed
-			}, "");
+
+		const bRowsChanged = this.oBinding.getHeaderContext() === this
+			&& this.oBinding._getAllExistingContexts().reduce((bChanged, oContext) => {
+				return oContext.doSetSelected(bSelected) || bChanged;
+			}, false);
+
+		const bSelectionChanged = this.doSetSelected(bSelected);
+
+		if (bSelectionChanged && this.mChangeListeners) { // header context: "select all"
+			_Helper.fireChange(this.mChangeListeners, "", bSelected);
 		}
 
-		this.doSetSelected(bSelected);
+		if (bSelectionChanged || bRowsChanged) {
+			this.oBinding.fireSelectionChanged(this);
+		}
 	};
 
 	/**

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

@@ -438,15 +438,6 @@ sap.ui.define([
 	 * @private
 	 */
 
-	/**
-	 * @override
-	 * @see sap.ui.base.EventProvider#getEventingParent
-	 */
-	ODataBinding.prototype.getEventingParent = function () {
-		// this allows that dataRequested/dataReceived events are bubbled up to the model
-		return this.oModel;
-	};
-
 	/**
 	 * Hook method for {@link #fetchOrGetQueryOptionsForOwnCache} to determine the query options for
 	 * this binding.
@@ -462,6 +453,15 @@ sap.ui.define([
 	 * @private
 	 */
 
+	/**
+	 * @override
+	 * @see sap.ui.base.EventProvider#getEventingParent
+	 */
+	ODataBinding.prototype.getEventingParent = function () {
+		// this allows that dataRequested/dataReceived events are bubbled up to the model
+		return this.oModel;
+	};
+
 	/**
 	 * Creates a cache for this binding if a cache is needed and updates <code>oCachePromise</code>.
 	 *
@@ -1060,17 +1060,6 @@ sap.ui.define([
 	 * @private
 	 */
 
-	/**
-	 * Whether the binding is transient (relative to a transient context).
-	 *
-	 * @returns {boolean} Whether the binding is transient
-	 *
-	 * @private
-	 */
-	ODataBinding.prototype.isTransient = function () {
-		return this.sReducedPath && this.sReducedPath.includes("($uid=");
-	};
-
 	/**
 	 * Method not supported
 	 *
@@ -1120,6 +1109,17 @@ sap.ui.define([
 		return oRootBinding && oRootBinding.isSuspended();
 	};
 
+	/**
+	 * Whether the binding is transient (relative to a transient context).
+	 *
+	 * @returns {boolean} Whether the binding is transient
+	 *
+	 * @private
+	 */
+	ODataBinding.prototype.isTransient = function () {
+		return this.sReducedPath && this.sReducedPath.includes("($uid=");
+	};
+
 	/**
 	 * Creates a lock for a group with this binding as owner.
 	 *

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

@@ -74,7 +74,7 @@ sap.ui.define([
 		 * @mixes sap.ui.model.odata.v4.ODataParentBinding
 		 * @public
 		 * @since 1.37.0
-		 * @version 1.124.2
+		 * @version 1.126.0
 		 *
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getGroupId as #getGroupId
 		 * @borrows sap.ui.model.odata.v4.ODataBinding#getRootBinding as #getRootBinding
@@ -522,6 +522,14 @@ sap.ui.define([
 		return ContextBinding.prototype.attachEvent.apply(this, arguments);
 	};
 
+	/**
+	 * @override
+	 * @see sap.ui.model.odata.v4.ODataParentBinding#checkKeepAlive
+	 */
+	ODataContextBinding.prototype.checkKeepAlive = function () {
+		throw new Error("Unsupported " + this);
+	};
+
 	/**
 	 * Returns this operation binding's cache query options.
 	 *
@@ -533,14 +541,6 @@ sap.ui.define([
 		return Object.assign({}, this.oModel.mUriParameters, this.getQueryOptionsFromParameters());
 	};
 
-	/**
-	 * @override
-	 * @see sap.ui.model.odata.v4.ODataParentBinding#checkKeepAlive
-	 */
-	ODataContextBinding.prototype.checkKeepAlive = function () {
-		throw new Error("Unsupported " + this);
-	};
-
 	/**
 	 * Creates a single cache for an operation and sends a GET/POST request.
 	 *
@@ -799,6 +799,35 @@ sap.ui.define([
 			this.oModel.bAutoExpandSelect, this.oModel.bSharedRequests, sDeepResourcePath);
 	};
 
+	/**
+	 * Fetches all properties described in $expand and $select of the binding parameters, unless
+	 * the binding already has fetched it. This is only done if the model uses autoExpandSelect. The
+	 * goal is that these properties are also requested as late properties.
+	 *
+	 * Expects that the binding is resolved and has no own cache (and thus a parent context). This
+	 * together with autoExpandSelect also implies that $expand contains no collection-valued
+	 * navigation properties.
+	 *
+	 * @private
+	 */
+	ODataContextBinding.prototype.doFetchExpandSelectProperties = function () {
+		var sResolvedPath,
+			that = this;
+
+		if (this.bHasFetchedExpandSelectProperties || !this.oModel.bAutoExpandSelect
+				|| !this.mParameters.$expand && !this.mParameters.$select) {
+			return;
+		}
+
+		sResolvedPath = this.getResolvedPath();
+		_Helper.convertExpandSelectToPaths(this.oModel.buildQueryOptions(this.mParameters, true))
+			.forEach(function (sPath) {
+				that.oContext.fetchValue(_Helper.buildPath(sResolvedPath, sPath))
+					.catch(that.oModel.getReporter());
+			});
+		this.bHasFetchedExpandSelectProperties = true;
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataBinding#doFetchOrGetQueryOptions
@@ -835,35 +864,6 @@ sap.ui.define([
 		}
 	};
 
-	/**
-	 * Fetches all properties described in $expand and $select of the binding parameters, unless
-	 * the binding already has fetched it. This is only done if the model uses autoExpandSelect. The
-	 * goal is that these properties are also requested as late properties.
-	 *
-	 * Expects that the binding is resolved and has no own cache (and thus a parent context). This
-	 * together with autoExpandSelect also implies that $expand contains no collection-valued
-	 * navigation properties.
-	 *
-	 * @private
-	 */
-	ODataContextBinding.prototype.doFetchExpandSelectProperties = function () {
-		var sResolvedPath,
-			that = this;
-
-		if (this.bHasFetchedExpandSelectProperties || !this.oModel.bAutoExpandSelect
-				|| !this.mParameters.$expand && !this.mParameters.$select) {
-			return;
-		}
-
-		sResolvedPath = this.getResolvedPath();
-		_Helper.convertExpandSelectToPaths(this.oModel.buildQueryOptions(this.mParameters, true))
-			.forEach(function (sPath) {
-				that.oContext.fetchValue(_Helper.buildPath(sResolvedPath, sPath))
-					.catch(that.oModel.getReporter());
-			});
-		this.bHasFetchedExpandSelectProperties = true;
-	};
-
 	/**
 	 * Requests the value for the given path; the value is requested from this binding's
 	 * cache or from its context in case it has no cache. For a suspended binding, requesting the
@@ -887,12 +887,11 @@ sap.ui.define([
 		var oCachePromise = bCached && this.oCache !== undefined
 				? SyncPromise.resolve(this.oCache)
 				: this.oCachePromise,
-			oError,
 			that = this;
 
 		// dependent binding will update its value when the suspended binding is resumed
 		if (this.isRootBindingSuspended()) {
-			oError = new Error("Suspended binding provides no value");
+			const oError = new Error("Suspended binding provides no value");
 			oError.canceled = "noDebugLog";
 			throw oError;
 		}
@@ -904,8 +903,7 @@ sap.ui.define([
 				sRelativePath = oCache || that.oOperation
 					? that.getRelativePath(sPath)
 					: undefined,
-				aSegments,
-				vValue;
+				aSegments;
 
 			if (that.oOperation) {
 				if (sRelativePath === undefined) {
@@ -920,7 +918,8 @@ sap.ui.define([
 					_Helper.registerChangeListener(that.oOperation,
 						sRelativePath.slice(/*"$Parameter/".length*/11), oListener);
 
-					vValue = _Helper.drillDown(that.oOperation.mParameters, aSegments.slice(1));
+					const vValue = _Helper.drillDown(that.oOperation.mParameters,
+						aSegments.slice(1));
 
 					return vValue === undefined ? null : vValue;
 				}
@@ -1655,6 +1654,36 @@ sap.ui.define([
 		return oPromise;
 	};
 
+	/**
+	 * Returns a promise on the value for the given path relative to this binding. The function
+	 * allows access to the complete data the binding points to (if <code>sPath</code> is "") or
+	 * any part thereof. The data is a JSON structure as described in <a href=
+	 * "https://docs.oasis-open.org/odata/odata-json-format/v4.0/odata-json-format-v4.0.html"
+	 * >"OData JSON Format Version 4.0"</a>.
+	 * Note that the function clones the result. Modify values via
+	 * {@link sap.ui.model.odata.v4.Context#setProperty}.
+	 *
+	 * If you want {@link #requestObject} to read fresh data, call
+	 * <code>oBinding.refresh()</code> first.
+	 *
+	 * @param {string} [sPath=""]
+	 *   A path relative to this context binding
+	 * @returns {Promise<any|undefined>}
+	 *   A promise on the requested value; in case there is no bound context this promise resolves
+	 *   with <code>undefined</code>
+	 * @throws {Error}
+	 *   If the context's root binding is suspended
+	 *
+	 * @public
+	 * @see sap.ui.model.odata.v4.Context#requestObject
+	 * @since 1.69.0
+	 */
+	ODataContextBinding.prototype.requestObject = function (sPath) {
+		return this.oElementContext
+			? this.oElementContext.requestObject(sPath)
+			: Promise.resolve();
+	};
+
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataParentBinding#requestSideEffects
@@ -1704,36 +1733,6 @@ sap.ui.define([
 			|| this.refreshInternal("", sGroupId, true, true);
 	};
 
-	/**
-	 * Returns a promise on the value for the given path relative to this binding. The function
-	 * allows access to the complete data the binding points to (if <code>sPath</code> is "") or
-	 * any part thereof. The data is a JSON structure as described in <a href=
-	 * "https://docs.oasis-open.org/odata/odata-json-format/v4.0/odata-json-format-v4.0.html"
-	 * >"OData JSON Format Version 4.0"</a>.
-	 * Note that the function clones the result. Modify values via
-	 * {@link sap.ui.model.odata.v4.Context#setProperty}.
-	 *
-	 * If you want {@link #requestObject} to read fresh data, call
-	 * <code>oBinding.refresh()</code> first.
-	 *
-	 * @param {string} [sPath=""]
-	 *   A path relative to this context binding
-	 * @returns {Promise<any|undefined>}
-	 *   A promise on the requested value; in case there is no bound context this promise resolves
-	 *   with <code>undefined</code>
-	 * @throws {Error}
-	 *   If the context's root binding is suspended
-	 *
-	 * @public
-	 * @see sap.ui.model.odata.v4.Context#requestObject
-	 * @since 1.69.0
-	 */
-	ODataContextBinding.prototype.requestObject = function (sPath) {
-		return this.oElementContext
-			? this.oElementContext.requestObject(sPath)
-			: Promise.resolve();
-	};
-
 	/**
 	 * @override
 	 * @see sap.ui.model.odata.v4.ODataParentBinding#resumeInternal