@sapui5/sap.fe.templates 1.146.0 → 1.148.0

package/src/sap/fe/templates/ObjectPage/ObjectPageController.controller.ts

@@ -48,17 +48,22 @@ import type { default as ObjectPageExtensionAPI } from "sap/fe/templates/ObjectP
 import { default as ExtensionAPI } from "sap/fe/templates/ObjectPage/ExtensionAPI";
 import CollaborationDiscard from "sap/fe/templates/ObjectPage/components/CollaborationDiscardDialog";
 import type SubSectionBlock from "sap/fe/templates/ObjectPage/controls/SubSectionBlock";
+import { pollForSectionStability } from "sap/fe/templates/ObjectPage/helpers/SectionNavigationHelper";
 import TableScroller from "sap/fe/templates/TableScroller";
 import type Button from "sap/m/Button";
 import type InputBase from "sap/m/InputBase";
 import InstanceManager from "sap/m/InstanceManager";
+import type MenuButton from "sap/m/MenuButton";
 import type NavContainer from "sap/m/NavContainer";
 import type Popover from "sap/m/Popover";
+import type SearchField from "sap/m/SearchField";
 import type ToolbarSpacer from "sap/m/ToolbarSpacer";
 import Device from "sap/ui/Device";
 import type UI5Event from "sap/ui/base/Event";
+import type ManagedObject from "sap/ui/base/ManagedObject";
 import type { CommandExecution$ExecuteEvent } from "sap/ui/core/CommandExecution";
 import type Control from "sap/ui/core/Control";
+import type CustomData from "sap/ui/core/CustomData";
 import UI5Element from "sap/ui/core/Element";
 import type InvisibleText from "sap/ui/core/InvisibleText";
 import Library from "sap/ui/core/Lib";
@@ -101,6 +106,8 @@ export type BindingParams = {
 	bPersistOPScroll?: boolean;
 	listBinding?: ODataListBinding;
 	showPlaceholder?: boolean;
+	requestOnBinding?: string[];
+	targetControlId?: string;
 };
 
 const ProgrammingModel = FELibrary.ProgrammingModel;
@@ -186,6 +193,44 @@ class ObjectPageController extends PageController {
 
 	private previousBindingContextPath?: string;
 
+	private pendingTargetControlId?: string;
+
+	private targetSubSection?: ObjectPageSubSection;
+
+	// Tracks if initial ObjectPage load has completed
+	private hasInitialLoadCompleted = false;
+
+	/**
+	 * Returns controls (Button / MenuButton) that are marked as "primary action".
+	 * The marker is set by the converters when an action is emphasized (annotation-based) or
+	 * configured as primaryAction (custom action defined in the manifest).
+	 * @param root Root control to start the search from
+	 * @param onlyActionable If true, only actionable (enabled) candidates are returned
+	 * @returns An array of controls that are candidates for primary action shortcuts
+	 */
+	private _getPrimaryActionShortcutCandidates(root: ManagedObject, onlyActionable = false): Array<Button | MenuButton> {
+		return root.findAggregatedObjects(true, (object: ManagedObject) => {
+			const isButton = object.isA("sap.m.Button");
+			const isMenuButton = object.isA("sap.m.MenuButton");
+			if (!isButton && !isMenuButton) {
+				return false;
+			}
+			const ctrl = object as Button | MenuButton;
+			const flag = ctrl
+				.getCustomData()
+				.find((customData: CustomData) => customData.getKey() === "fePrimaryActionShortcut")
+				?.getValue();
+			if (flag !== true && flag !== "true") {
+				return false;
+			}
+			if (!ctrl.getVisible()) {
+				return false;
+			}
+			// For focus placement we must ignore disabled candidates.
+			return onlyActionable ? ctrl.getEnabled() : true;
+		}) as Array<Button | MenuButton>;
+	}
+
 	@publicExtension()
 	@finalExtension()
 	getExtensionAPI(sId?: string): ExtensionAPI {
@@ -298,12 +343,13 @@ class ObjectPageController extends PageController {
 	}
 
 	/**
-	 * Find the last visible subsection and add the sapUxAPObjectPageSubSectionFitContainer CSS class if it contains only a GridTable or a TreeTable.
+	 * Add the sapUxAPObjectPageSubSectionFitContainer CSS class to every visible subsection that contains only a single GridTable or TreeTable.
+	 * This makes the table fill the full height of its container so that the scrollbar appears on the table itself rather than on the page.
 	 * @param subSections The sub sections to look for
 	 */
 	private checkSectionsForNonResponsiveTable(subSections: ObjectPageSubSection[]): void {
-		const changeClassForTables = (event: Event, lastVisibleSubSection: ObjectPageSubSection): void => {
-			const blocks = [...lastVisibleSubSection.getBlocks(), ...lastVisibleSubSection.getMoreBlocks()];
+		const changeClassForTables = (event: Event, visibleSubSection: ObjectPageSubSection): void => {
+			const blocks = [...visibleSubSection.getBlocks(), ...visibleSubSection.getMoreBlocks()];
 			if (blocks.length === 1) {
 				const table = this.searchTableInBlock(blocks[0] as SubSectionBlock);
 				if (!table) {
@@ -317,17 +363,15 @@ class ObjectPageController extends PageController {
 					tableAPI?.getTableDefinition().control.rowCountMode === "Auto"
 				) {
 					//In case there is only a single table in a subSection we fit that to the whole page so that the scrollbar comes only on table and not on page
-					lastVisibleSubSection.addStyleClass("sapUxAPObjectPageSubSectionFitContainer");
-					lastVisibleSubSection.detachEvent("modelContextChange", changeClassForTables, this);
+					visibleSubSection.addStyleClass("sapUxAPObjectPageSubSectionFitContainer");
+					visibleSubSection.detachEvent("modelContextChange", changeClassForTables, this);
 				}
 			}
 		};
-		for (let subSectionIndex = subSections.length - 1; subSectionIndex >= 0; subSectionIndex--) {
-			if (subSections[subSectionIndex].getVisible()) {
-				const lastVisibleSubSection = subSections[subSectionIndex];
+		for (const subSection of subSections) {
+			if (subSection.getVisible()) {
 				// We need to attach this event in order to manage the Object Page Lazy Loading mechanism
-				lastVisibleSubSection.attachEvent("modelContextChange", lastVisibleSubSection, changeClassForTables, this);
-				break;
+				subSection.attachEvent("modelContextChange", subSection, changeClassForTables, this);
 			}
 		}
 	}
@@ -396,6 +440,9 @@ class ObjectPageController extends PageController {
 	}
 
 	_onBeforeBinding(oContext: ODataV4Context, mParameters: BindingParams = {}): void {
+		// Store targetControlId for scrolling after binding completes
+		this.pendingTargetControlId = mParameters.targetControlId;
+
 		// TODO: we should check how this comes together with the transaction helper, same to the change in the afterBinding
 		this.previousBindingContextPath = this.getView().getBindingContext()?.getPath();
 		const aTables = this._findTables(),
@@ -507,12 +554,21 @@ class ObjectPageController extends PageController {
 	}
 
 	/**
-	 * Get the first clickable element in the header of the object page.
+	 * Get the first clickable element in the object page.
 	 * @private
 	 * @param objectPage Object Page Layout control
-	 * @returns The first clickable element found in the header
+	 * @returns The first clickable element found
 	 */
 	private getFirstClickableElement(objectPage: ObjectPageLayout): UI5Element | undefined {
+		// In display mode, if a visible primary action with the emphasis exists in the footer, it must be the first clickable element on the page.
+		const footer = objectPage.getFooter();
+		const footerPrimaryAction = footer
+			? this._getPrimaryActionShortcutCandidates(footer as unknown as ManagedObject, true)[0]
+			: undefined;
+		if (footerPrimaryAction) {
+			return footerPrimaryAction;
+		}
+		// Fallback: first visible & enabled header action (Edit, etc.)
 		let firstClickableElement;
 		const actions = objectPage.getHeaderTitle() && (objectPage.getHeaderTitle() as ObjectPageDynamicHeaderTitle).getActions();
 		if (actions?.length) {
@@ -648,6 +704,7 @@ class ObjectPageController extends PageController {
 	/**
 	 * Set the initial focus in edit mode.
 	 * @param aSubSections Object page sub sections
+	 * @param fromTabNavigation Indicates if the focus is set after a tab navigation
 	 */
 	_updateFocusInEditMode(aSubSections: ObjectPageSubSection[], fromTabNavigation = false): void {
 		setTimeout(
@@ -655,7 +712,7 @@ class ObjectPageController extends PageController {
 				// We set the focus in a timeeout, otherwise the focus sometimes goes to the TabBar
 				const oObjectPage = this._getObjectPageLayoutControl();
 				const oMandatoryField = this._getFirstEmptyMandatoryFieldFromSubSection(aSubSections);
-				let oFieldToFocus;
+				let oFieldToFocus: UI5Element | undefined;
 				if (oMandatoryField) {
 					if (oMandatoryField.isA("sap.fe.macros.MultiValueField")) {
 						oFieldToFocus = (oMandatoryField as unknown as MultiValueFieldBlock).getMultiValueField();
@@ -671,9 +728,22 @@ class ObjectPageController extends PageController {
 					const focusInfo = oFieldToFocus.getFocusInfo() as { targetInfo: object };
 					focusInfo.targetInfo = { silent: true };
 					if (oFieldToFocus.isA("sap.ui.mdc.field.FieldInput")) {
-						oFieldToFocus = oFieldToFocus.getParent();
+						oFieldToFocus = oFieldToFocus.getParent() as UI5Element | undefined;
+					}
+
+					if (
+						oFieldToFocus?.isA<SearchField>("sap.m.SearchField") &&
+						oFieldToFocus.getEnableSuggestions() &&
+						!oFieldToFocus.isBound("enableSuggestions")
+					) {
+						// In case the focus is set on a search field with suggestions, we temporarily disable the suggestions to avoid triggering them on focus
+						// unless this property is bound (to avoid modifying something in a model)
+						oFieldToFocus.setEnableSuggestions(false);
+						oFieldToFocus.focus(focusInfo);
+						oFieldToFocus.setEnableSuggestions(true);
+					} else {
+						oFieldToFocus?.focus(focusInfo);
 					}
-					oFieldToFocus.focus(focusInfo);
 				}
 			}.bind(this),
 			fromTabNavigation ? 300 : 0
@@ -735,15 +805,24 @@ class ObjectPageController extends PageController {
 
 		// Function to navigate back, or display the launchpad if we're on the first page of the history
 		const navBack = (): void => {
-			const currentURL = document.URL;
-			history.back();
-			// In case there is no previous page in the history, history.back does nothing.
-			// In this case, we need to use navigateBackFromContext, that will display the home page
-			setTimeout(() => {
-				if (document.URL === currentURL) {
-					this._routing.navigateBackFromContext(oContext);
-				}
-			}, 500);
+			// Use the new Navigation API if it's available in the browser, to check if we can go back in history.
+			const canGoBack = (window as { navigation?: { canGoBack?: boolean } }).navigation?.canGoBack;
+			if (canGoBack === true) {
+				history.back();
+			} else if (canGoBack === false) {
+				this._routing.navigateBackFromContext(oContext);
+			} else {
+				// Fallback in case the browser doesn't support the Navigation API
+				const currentURL = document.URL;
+				history.back();
+				// In case there is no previous page in the history, history.back does nothing.
+				// In this case, we need to use navigateBackFromContext, that will display the home page
+				setTimeout(() => {
+					if (document.URL === currentURL) {
+						this._routing.navigateBackFromContext(oContext);
+					}
+				}, 500);
+			}
 		};
 
 		if (this.getAppComponent().getRouterProxy().checkIfBackHasSameContext()) {
@@ -775,13 +854,16 @@ class ObjectPageController extends PageController {
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	_onAfterBinding(inputBindingContext: Context | undefined, mParameters: BindingParams | undefined): void {
+	_onAfterBinding(inputBindingContext: ODataV4Context | undefined, mParameters: BindingParams | undefined): void {
 		const view = this.getView();
 		const viewLevel = view?.getViewData()?.viewLevel;
 		const oObjectPage = this._getObjectPageLayoutControl();
 		const aTables = this._findTables();
+		if ([NavigationReason.EditFlowAction, NavigationReason.RowPress].includes(mParameters?.reason as NavigationReason)) {
+			this.editFlow.storeSiblingContextData(inputBindingContext);
+		}
 
-		this._sideEffects.clearFieldGroupsValidity();
+		this.sideEffects.clearFieldGroupsValidity();
 
 		// TODO: this is only a temp solution as long as the model fix the cache issue and we use this additional
 		// binding with ownRequest
@@ -939,6 +1021,143 @@ class ObjectPageController extends PageController {
 			applyAppState,
 			this.previousBindingContextPath !== this.getView().getBindingContext()?.getPath()
 		);
+
+		// Capture synchronously to avoid race with subsequent navigations
+		const pendingTargetControlId = this.pendingTargetControlId;
+		this.pendingTargetControlId = undefined;
+
+		this.handlePendingTargetControlIdNavigation(applyAppState, oObjectPage, pendingTargetControlId);
+	}
+
+	/**
+	 * Handles navigation to a target section or subsection after app state is applied.
+	 * This coordinates targetControlId navigation from two sources:
+	 * - In-app navigation: pendingTargetControlId captured before applyAppState.
+	 * - Cross-app navigation: xAppState targetControlId stored by AppStateHandler during LR to OP transition.
+	 * @param applyAppState Promise that resolves when app state has been applied.
+	 * @param oObjectPage The ObjectPageLayout control.
+	 * @param pendingTargetControlId The targetControlId captured before applyAppState, if any.
+	 */
+	private handlePendingTargetControlIdNavigation(
+		applyAppState: Promise<void | object>,
+		oObjectPage: ObjectPageLayout,
+		pendingTargetControlId: string | undefined
+	): void {
+		applyAppState
+			.then(async () => {
+				const xAppStateTargetControlId = this.getAppComponent().getAppStateHandler()?.consumePendingTargetControlId();
+				const targetControlId = pendingTargetControlId ?? xAppStateTargetControlId;
+				if (!targetControlId) {
+					return;
+				}
+
+				// Wait for visibility bindings  (needed for lazy loading scenarios)
+				try {
+					await Promise.all(this.waitForVisibilityBindings);
+				} catch {
+					// Some visibility bindings failed to resolve, proceeding anyway
+				}
+
+				// Wait for pageReady to ensure ObjectPage is fully initialized
+				await this.pageReady.waitPageReady();
+
+				// Navigate to target section
+				this.navigateToTargetSection(oObjectPage, targetControlId);
+				return; // Required by linter rule promise/always-return
+			})
+			.catch(() => {
+				// applyAppState failed - skip targetControlId navigation
+			});
+	}
+
+	/**
+	 * Navigates to a target section with automatic re-navigation if UX rules reset the selection.
+	 * Polls the section state since setSelectedSection() doesn't fire the navigate event.
+	 * @param oObjectPage The ObjectPageLayout control.
+	 * @param targetControlId The local ID of the target section or subsection.
+	 */
+	private navigateToTargetSection(oObjectPage: ObjectPageLayout, targetControlId: string): void {
+		// Determine target section ID for comparison
+		const targetControl = this.getView().byId(targetControlId);
+		const isSection = targetControl?.isA("sap.uxap.ObjectPageSection");
+		const targetSectionId = isSection ? targetControl?.getId() : (targetControl?.getParent() as ObjectPageSection)?.getId();
+
+		// Navigate function with guard to prevent duplicate calls when already on target
+		const navigateToTarget = (): void => {
+			if (oObjectPage.getSelectedSection() === targetSectionId) {
+				return; // Already on target section
+			}
+			this.navigateWithConfirmation(targetControlId);
+		};
+
+		// Navigate immediately
+		navigateToTarget();
+
+		// Skip polling if already on target section (navigation was no-op or succeeded immediately)
+		if (oObjectPage.getSelectedSection() === targetSectionId) {
+			this.hasInitialLoadCompleted = true;
+			return;
+		}
+
+		// Skip polling on subsequent navigations
+		if (this.hasInitialLoadCompleted) {
+			return;
+		}
+
+		// Poll to detect UX rules reset during initial load
+		// Uses shared utility from helpers/SectionNavigationHelper.ts
+		pollForSectionStability({
+			getSelectedSection: () => oObjectPage.getSelectedSection(),
+			targetSectionId,
+			onResetDetected: navigateToTarget
+		})
+			.then(() => {
+				this.hasInitialLoadCompleted = true;
+				return; // Required by linter rule promise/always-return
+			})
+			.catch(() => {
+				// Required by linter rule promise/catch-or-return - polling failures are non-critical
+			});
+	}
+
+	/**
+	 * Sets targetSubSection based on the target control ID for app state persistence.
+	 * @param targetControlId The local ID of the target section or subsection.
+	 */
+	private setTargetSubSection(targetControlId: string): void {
+		const targetControl = this.getView().byId(targetControlId);
+		if (targetControl?.isA<ObjectPageSubSection>("sap.uxap.ObjectPageSubSection")) {
+			this.targetSubSection = targetControl;
+		} else if (targetControl?.isA<ObjectPageSection>("sap.uxap.ObjectPageSection")) {
+			const subSections = targetControl.getSubSections();
+			this.targetSubSection = subSections[0];
+		}
+	}
+
+	/**
+	 * Performs navigation to the target section and then updates the app state.
+	 * @param targetControlId The local ID of the target section or subsection.
+	 */
+	private navigateWithConfirmation(targetControlId: string): void {
+		// Set targetSubSection BEFORE navigation for app state saving.
+		// scrollToSection() doesn't fire the navigate event, so onNavigateChange won't be called.
+		this.setTargetSubSection(targetControlId);
+
+		this.getExtensionAPI().navigateToSubSection(targetControlId);
+
+		// Wait for ExtensionAPI polling to complete (~100ms) plus scroll to finish
+		// before updating app state and setting focus.
+		setTimeout(() => {
+			this.viewState.updateAppStateDebounced();
+
+			// Set focus if in edit mode (for in-app navigation to sub-object page in edit mode)
+			// This is needed because scrollToSection() doesn't fire onNavigateChange,
+			// so we need to manually trigger focus setting here
+			const isInEditMode = CommonUtils.getIsEditable(this.getView());
+			if (isInEditMode && this.targetSubSection) {
+				this._updateFocusInEditMode([this.targetSubSection], false);
+			}
+		}, 150);
 	}
 
 	/**
@@ -1339,9 +1558,7 @@ class ObjectPageController extends PageController {
 			// If there is at least one global SideEffects for the related entity, execute it/them
 			if (globalSideEffects.length) {
 				await this.editFlow.syncTask();
-				return Promise.all(
-					globalSideEffects.map(async (sideEffects) => this._sideEffects.requestSideEffects(sideEffects, context))
-				);
+				return Promise.all(globalSideEffects.map(async (sideEffects) => this.sideEffects.requestSideEffects(sideEffects, context)));
 			}
 		}
 
@@ -1415,10 +1632,11 @@ class ObjectPageController extends PageController {
 					);
 				}
 			});
-			const isSkipBindingToView = skipBindingToView as unknown as CommandExecution$ExecuteEvent;
-			const isStandardSave =
-				isSkipBindingToView && typeof isSkipBindingToView == "object" && isSkipBindingToView.getSource().getCommand() === "Save";
-
+			let isStandardSave: boolean | undefined;
+			if (skipBindingToView && typeof skipBindingToView === "object") {
+				const command = (skipBindingToView as CommandExecution$ExecuteEvent)?.getSource?.()?.getCommand?.();
+				isStandardSave = command === "Save";
+			}
 			const bindings = await Promise.all(awaitCreateDocuments);
 			// We need to either reject or resolve a promise here and return it since this save
 			// function is not only called when pressing the save button in the footer, but also
@@ -1961,8 +2179,27 @@ class ObjectPageController extends PageController {
 			}
 		): void {
 			/**
-			 * Invokes the page primary action on press of Ctrl+Enter.
+			 * Invokes the page primary action when the user presses Ctrl+Enter (Cmd+Enter on macOS).
 			 */
+
+			const primaryCandidate = oController._getPrimaryActionShortcutCandidates(oView)[0];
+
+			/* By design, there must be at most one candidate due to the "single emphasis per page" rule.
+			   If a primary-enter target is found, it must fully take over Ctrl/Cmd+Enter.*/
+
+			if (primaryCandidate) {
+				if (!primaryCandidate.getEnabled()) {
+					// Take over Ctrl/Cmd+Enter, but do not trigger anything when the primary action is disabled.
+					return;
+				}
+				if (primaryCandidate.isA("sap.m.Button")) {
+					(primaryCandidate as Button).firePress();
+				}
+				if ((primaryCandidate as MenuButton).isA("sap.m.MenuButton")) {
+					(primaryCandidate as MenuButton).fireDefaultAction();
+				}
+				return;
+			}
 			const iViewLevel = oController.getView().getViewData().viewLevel;
 			if (mConditions.positiveActionVisible) {
 				if (mConditions.positiveActionEnabled) {
@@ -1990,7 +2227,7 @@ class ObjectPageController extends PageController {
 			const tableAPI = event.getSource();
 			const table = tableAPI.content;
 			const currentActionPromise = this.editFlow.getCurrentActionPromise();
-			const tableContexts = this._getTableBinding(table)?.getCurrentContexts();
+			const tableContexts = this._getTableBinding(table)?.getAllCurrentContexts();
 
 			if (currentActionPromise && tableContexts?.length) {
 				try {
@@ -1998,10 +2235,13 @@ class ObjectPageController extends PageController {
 					if (actionResponse?.controlId === table.getId()) {
 						const actionData = actionResponse.oData;
 						const keys = actionResponse.keys;
-						const newItem = tableContexts.findIndex((tableContext: Context) => {
-							const tableData = tableContext.getObject();
-							return keys.every((key: string) => tableData[key] === actionData[key]);
-						});
+						const newItem =
+							tableContexts
+								.find((tableContext: Context) => {
+									const tableData = tableContext.getObject();
+									return keys.every((key: string) => tableData[key] === actionData[key]);
+								})
+								?.getIndex() ?? -1;
 						if (newItem !== -1) {
 							const dialog = InstanceManager.getOpenDialogs().find((dialog) => dialog.data("FullScreenDialog") !== true);
 							if (dialog) {
@@ -2136,17 +2376,21 @@ class ObjectPageController extends PageController {
 
 		onNavigateChange(this: ObjectPageController, oEvent: UI5Event<{ subSection: ObjectPageSubSection }>): void {
 			//will be called always when we click on a section tab
-			this.getExtensionAPI().updateAppState();
 			this.bSectionNavigated = true;
 
+			const subSection = oEvent.getParameter("subSection");
+			this.targetSubSection = subSection;
+
+			this.getExtensionAPI().updateAppState();
+
 			const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+
 			if (
 				CommonUtils.getIsEditable(this.getView()) &&
 				this.getView().getViewData().sectionLayout === "Tabs" &&
 				oInternalModelContext.getProperty("errorNavigationSectionFlag") === false
 			) {
-				const oSubSection = oEvent.getParameter("subSection");
-				this._updateFocusInEditMode([oSubSection], true);
+				this._updateFocusInEditMode([subSection], true);
 			}
 		},
 		onVariantSelected: function (this: ObjectPageController): void {