@sapui5/sap.fe.templates 1.145.1 → 1.147.0

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

@@ -52,13 +52,16 @@ 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 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";
@@ -184,6 +187,39 @@ class ObjectPageController extends PageController {
 
 	private subSections?: { fe: SubSection[]; others: ObjectPageSubSection[] };
 
+	private previousBindingContextPath?: string;
+
+	/**
+	 * 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 {
@@ -296,12 +332,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) {
@@ -315,17 +352,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);
 			}
 		}
 	}
@@ -395,6 +430,7 @@ class ObjectPageController extends PageController {
 
 	_onBeforeBinding(oContext: ODataV4Context, mParameters: BindingParams = {}): void {
 		// 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(),
 			oObjectPage = this._getObjectPageLayoutControl(),
 			oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext,
@@ -504,12 +540,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) {
@@ -551,23 +596,22 @@ class ObjectPageController extends PageController {
 			const aSubSections = oSection.getSubSections();
 			for (let iSubSection = 0; iSubSection < aSubSections.length; iSubSection++, iSkip--) {
 				// In IconTabBar mode keep the second section bound if there is an editable header and we are switching to display mode
-
+				const oSubSection = aSubSections[iSubSection];
 				const disableBindingContextCondition =
 					(this.getDisableObjectPageRequestOptimization() &&
 						(iSkip < 1 || (bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode))))) ||
 					(!this.getDisableObjectPageRequestOptimization() &&
-						((!bUseIconTabBar && firstVisibilityBinding) || //if some subsections have visibility binding and we are not in IconTabBar mode
+						((!bUseIconTabBar && (iSkip < 1 || oSubSection.getBinding("visible"))) || //if we are not in IconTabBar mode, all section with index >=3 or with visibility binding should be disconnected
 							(!bUseIconTabBar && !firstVisibilityBinding && iSkip < 1) || // if no subsection has visibility binding and we are not in IconTabBar mode
 							(bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode)))));
 				if (disableBindingContextCondition) {
-					const oSubSection = aSubSections[iSubSection];
 					// SubSection's binding is enabled.
 					oSubSection.setBindingContext(undefined);
 					const blocks = oSubSection.getBlocks();
 					// SubSection's contents binding is disabled.
 					blocks.forEach((block) => {
 						if (block.isA<SubSectionBlock>("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
-							block.content.setBindingContext(null);
+							block.content.setBindingContext?.(null);
 						} else {
 							block.setBindingContext(null);
 						}
@@ -719,7 +763,7 @@ class ObjectPageController extends PageController {
 		const blocks = oSubSection.getBlocks();
 		blocks.forEach((block) => {
 			if (block.isA<SubSectionBlock>("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
-				block.content.setBindingContext(undefined);
+				block.content.setBindingContext?.(undefined);
 			} else {
 				block.setBindingContext(undefined);
 			}
@@ -773,11 +817,14 @@ 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();
 
@@ -931,7 +978,12 @@ class ObjectPageController extends PageController {
 		const applyAppState = this.getAppComponent().getAppStateHandler().applyAppState(view);
 		this.pageReady.waitFor(applyAppState);
 
-		this.reconnectSubSectionVisibilityObservers(this.subSections, oObjectPage, applyAppState);
+		this.reconnectSubSectionVisibilityObservers(
+			this.subSections,
+			oObjectPage,
+			applyAppState,
+			this.previousBindingContextPath !== this.getView().getBindingContext()?.getPath()
+		);
 	}
 
 	/**
@@ -940,15 +992,17 @@ class ObjectPageController extends PageController {
 	 * @param subSectionInfo Subsections information retrieved during disconnection
 	 * @param objectPageLayout Object Page Layout control
 	 * @param waitForApplyAppstate Promise that resolves when the app state is applied
+	 * @param waitForVisibilityBindings Boolean indicating whether to wait for visibility bindings to be resolved before reconnecting observers
 	 * @returns A promise that resolves to true if the observers were reconnected, false otherwise
 	 */
 	async reconnectSubSectionVisibilityObservers(
 		subSectionInfo: { fe: SubSection[]; others: ObjectPageSubSection[] } | undefined,
 		objectPageLayout: ObjectPageLayout,
-		waitForApplyAppstate: Promise<unknown>
+		waitForApplyAppstate: Promise<unknown>,
+		waitForVisibilityBindings = true
 	): Promise<boolean> {
 		if (!this.getDisableObjectPageRequestOptimization() && subSectionInfo) {
-			await Promise.all(this.waitForVisibilityBindings)
+			await Promise.all(waitForVisibilityBindings ? this.waitForVisibilityBindings : [])
 				.then(async () => {
 					objectPageLayout.setVisible(true);
 					try {
@@ -1180,7 +1234,9 @@ class ObjectPageController extends PageController {
 		if (!oObjectPageContext || pathsToResolve.length === 0) {
 			return Promise.resolve(build());
 		}
-		await Promise.all(pathsToResolve.map(async (p) => (oObjectPageContext as ODataV4Context).requestObject(p).catch(() => undefined)));
+		await Promise.all(
+			pathsToResolve.map(async (p) => (oObjectPageContext as ODataV4Context).requestProperty(p).catch(() => undefined))
+		);
 		return build();
 	}
 
@@ -1404,10 +1460,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
@@ -1431,7 +1488,6 @@ class ObjectPageController extends PageController {
 				if (error !== RecommendationDialogDecision.Continue) {
 					messagePopoverErr = (error as string) ?? "";
 				}
-				throw error;
 			}
 		} finally {
 			if (BusyLocker.isLocked(model)) {
@@ -1951,8 +2007,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) {
@@ -1980,7 +2055,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 {
@@ -1988,10 +2063,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) {