@sapui5/sap.fe.templates 1.143.0 → 1.145.0

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

@@ -27,19 +27,20 @@ import { RecommendationDialogDecision } from "sap/fe/core/controls/Recommendatio
 import type { HiddenDraft, MicroChartManifestConfiguration } from "sap/fe/core/converters/ManifestSettings";
 import type { InternalModelContext } from "sap/fe/core/helpers/ModelHelper";
 import ModelHelper from "sap/fe/core/helpers/ModelHelper";
-import { getResourceModel } from "sap/fe/core/helpers/ResourceModelHelper";
 import FELibrary from "sap/fe/core/library";
 import { type WrappedCard } from "sap/fe/core/services/CollaborationManagerServiceFactory";
 import type ChartBlock from "sap/fe/macros/Chart";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import type MacroAPI from "sap/fe/macros/MacroAPI";
 import type MultiValueFieldBlock from "sap/fe/macros/MultiValueField";
+import type TableAPI from "sap/fe/macros/Table";
 import type EasyFillButton from "sap/fe/macros/ai/EasyFillButton";
 import type SummarizationButton from "sap/fe/macros/ai/SummarizationButton";
+import type SubSection from "sap/fe/macros/controls/section/SubSection";
 import type FormAPI from "sap/fe/macros/form/FormAPI";
 import type MessageButton from "sap/fe/macros/messages/MessageButton";
 import type ShareAPI from "sap/fe/macros/share/ShareAPI";
-import type TableAPI from "sap/fe/macros/table/TableAPI";
+import type TableCreationOptions from "sap/fe/macros/table/TableCreationOptions";
 import TableHelper from "sap/fe/macros/table/TableHelper";
 import TableUtils from "sap/fe/macros/table/Utils";
 import SelectionVariant from "sap/fe/navigation/SelectionVariant";
@@ -51,7 +52,6 @@ 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 MessageBox from "sap/m/MessageBox";
 import type NavContainer from "sap/m/NavContainer";
 import type Popover from "sap/m/Popover";
 import type ToolbarSpacer from "sap/m/ToolbarSpacer";
@@ -180,7 +180,9 @@ class ObjectPageController extends PageController {
 
 	private messageBinding?: Binding;
 
-	private isFirstBinding = true;
+	private waitForVisibilityBindings!: Promise<unknown>[];
+
+	private subSections?: { fe: SubSection[]; others: ObjectPageSubSection[] };
 
 	@publicExtension()
 	@finalExtension()
@@ -219,10 +221,15 @@ class ObjectPageController extends PageController {
 		);
 		oInternalModelContext?.setProperty("batchGroups", this._getBatchGroupsForView());
 		oInternalModelContext?.setProperty("errorNavigationSectionFlag", false);
-		if (oObjectPage.getEnableLazyLoading()) {
-			//Attaching the event to make the subsection context binding active when it is visible.
+
+		if (this.getDisableObjectPageRequestOptimization()) {
 			oObjectPage.attachEvent("subSectionEnteredViewPort", this._handleSubSectionEnteredViewPort.bind(this));
+		} else {
+			this._getAllSubSections().forEach((subSection) => {
+				subSection.attachEvent("subSectionEnteredViewPort", this._handleSubSectionEnteredViewPort.bind(this));
+			});
 		}
+
 		this.messageButton = this.getView().byId("fe::FooterBar::MessageButton") as MessageButton;
 		this.messageBinding = Messaging.getMessageModel().bindList("/");
 		this.messageBinding?.attachChange(this._fnShowOPMessage, this);
@@ -301,9 +308,7 @@ class ObjectPageController extends PageController {
 					return;
 				}
 				const tableType = table.isA<Table>("sap.ui.mdc.Table") && (table.getType() as TableTypeBase);
-				const tableAPI = table.getParent()?.isA<TableAPI>("sap.fe.macros.table.TableAPI")
-					? (table.getParent() as TableAPI)
-					: undefined;
+				const tableAPI = table.getParent()?.isA<TableAPI>("sap.fe.macros.Table") ? (table.getParent() as TableAPI) : undefined;
 				if (
 					tableType &&
 					(tableType?.isA("sap.ui.mdc.table.GridTableType") || tableType?.isA("sap.ui.mdc.table.TreeTableType")) &&
@@ -337,7 +342,7 @@ class ObjectPageController extends PageController {
 			// control from the custom data of the place holder panel
 			if (control.isA("sap.m.Panel") && control.data("FullScreenTablePlaceHolder")) {
 				return control.data("tableAPIreference");
-			} else if (control.isA("sap.fe.macros.table.TableAPI")) {
+			} else if (control.isA("sap.fe.macros.Table")) {
 				return control as TableAPI;
 			}
 		};
@@ -443,31 +448,10 @@ class ObjectPageController extends PageController {
 		//Set the Binding for Paginators using ListBinding ID
 		this._initializePagination(oContext, oInternalModel, mParameters?.listBinding);
 
-		const firstSubSectionVisibilityBinding = this._getfirstSubSectionVisibilityBinding();
-
-		if (
-			this.useLazyLoaderOptimizations() &&
-			oObjectPage.getEnableLazyLoading() &&
-			firstSubSectionVisibilityBinding &&
-			this.isFirstBinding
-		) {
-			// if lazy loading is enabled and at least one subsection has a visibility binding
-			oObjectPage.setVisible(false); // The objectPage Visibility is set to false to prevent the lazy loader to compute the sections
-			firstSubSectionVisibilityBinding.attachEventOnce("change", async () => {
-				const MDCTablePromises = this._getAllBlocks().map(async (block) =>
-					block.getVisible() && block.getContent?.()?.isA<TableAPI>("sap.fe.macros.table.TableAPI")
-						? (block.getContent() as TableAPI).getContent().initialized()
-						: null
-				);
-				await Promise.all(MDCTablePromises);
-				oObjectPage.setVisible(true); // Visibility is restored once the visibility bindings of the sections are resolved, allowing lazy loading to properly process them
-				this.isFirstBinding = false;
-			});
-		}
+		this._disableBlocksBindings(oObjectPage);
 
-		if (oObjectPage.getEnableLazyLoading()) {
-			this._disableBlocksBindings(oObjectPage);
-		}
+		this.subSections = this.disconnectSubSectionVisibilityObservers(oObjectPage);
+		this.waitForVisibilityBindings = this.waitForAllSubSectionVisibilityBindingsResolved();
 
 		if (this.placeholder.isPlaceholderEnabled() && mParameters.showPlaceholder) {
 			const oView = this.getView();
@@ -479,11 +463,39 @@ class ObjectPageController extends PageController {
 		}
 	}
 
-	private useLazyLoaderOptimizations(): boolean {
-		if (new URLSearchParams(window.location.search).get("sap-ui-xx-lazyloader-optimizations") === "true") {
-			return true;
+	/**
+	 * Disconnect the visibility observers of all FE subsections.
+	 * @param objectPageLayout
+	 * @returns The subsections information or undefined if optimization is disabled
+	 */
+	disconnectSubSectionVisibilityObservers(
+		objectPageLayout: ObjectPageLayout
+	): { fe: SubSection[]; others: ObjectPageSubSection[] } | undefined {
+		if (!this.getDisableObjectPageRequestOptimization()) {
+			objectPageLayout.setVisible(false);
+			const subSectionsInfo: {
+				fe: SubSection[];
+				others: ObjectPageSubSection[];
+			} = { fe: [], others: [] };
+			this._getAllSubSections().forEach((subSection) => {
+				if (subSection.isA<SubSection>("sap.fe.macros.controls.section.SubSection")) {
+					subSectionsInfo.fe.push(subSection);
+				} else {
+					subSectionsInfo.others.push(subSection);
+				}
+			});
+			subSectionsInfo.fe.forEach((subSection) => subSection.disconnectVisibilityObserver());
+			return subSectionsInfo;
 		}
-		return false;
+		return undefined;
+	}
+
+	/**
+	 * Get the loading strategy for the object page.
+	 * @returns The loading strategy for the object page.
+	 */
+	getDisableObjectPageRequestOptimization(): boolean {
+		return this._getObjectPageLayoutControl().data("disableObjectPageRequestOptimization") === "true";
 	}
 
 	private getFirstEditableInput(): UI5Element | undefined {
@@ -541,9 +553,9 @@ class ObjectPageController extends PageController {
 				// In IconTabBar mode keep the second section bound if there is an editable header and we are switching to display mode
 
 				const disableBindingContextCondition =
-					(!this.useLazyLoaderOptimizations() &&
+					(this.getDisableObjectPageRequestOptimization() &&
 						(iSkip < 1 || (bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode))))) ||
-					(this.useLazyLoaderOptimizations() &&
+					(!this.getDisableObjectPageRequestOptimization() &&
 						((!bUseIconTabBar && firstVisibilityBinding) || //if some subsections have visibility binding and we are not in IconTabBar mode
 							(!bUseIconTabBar && !firstVisibilityBinding && iSkip < 1) || // if no subsection has visibility binding and we are not in IconTabBar mode
 							(bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode)))));
@@ -629,7 +641,7 @@ class ObjectPageController extends PageController {
 	 * Set the initial focus in edit mode.
 	 * @param aSubSections Object page sub sections
 	 */
-	_updateFocusInEditMode(aSubSections: ObjectPageSubSection[]): void {
+	_updateFocusInEditMode(aSubSections: ObjectPageSubSection[], fromTabNavigation = false): void {
 		setTimeout(
 			function (this: ObjectPageController): void {
 				// We set the focus in a timeeout, otherwise the focus sometimes goes to the TabBar
@@ -656,13 +668,13 @@ class ObjectPageController extends PageController {
 					oFieldToFocus.focus(focusInfo);
 				}
 			}.bind(this),
-			0 //300
+			fromTabNavigation ? 300 : 0
 		);
 	}
 
 	/**
 	 * Get the first sub-section with a visibility bound to the model of the view.
-	 * Sections with Bindings on internal models only are ignored.
+	 * Sections with bindings on internal models only are ignored.
 	 * @returns The visibility binding of the first sub-section or undefined if not found.
 	 */
 	_getfirstSubSectionVisibilityBinding(): Binding | undefined {
@@ -678,8 +690,26 @@ class ObjectPageController extends PageController {
 			?.getBinding("visible");
 	}
 
+	/**
+	 * Wait for all subsection visibility bindings to be resolved.
+	 * This method listens for the 'visibilityChanged' event  . The change event is fired even if the values are not changed but just resolved.
+	 * @returns An array of promises that resolve when each visibility binding is resolved.
+	 */
+	waitForAllSubSectionVisibilityBindingsResolved(): Promise<unknown>[] {
+		return this._getAllSubSections()
+			.filter(
+				(subSection) => subSection.isA<SubSection>("sap.fe.macros.controls.section.SubSection") && subSection.getBinding("visible")
+			) //filtering on FE subsections with visibility binding)
+			.map(async (subSection) => {
+				return new Promise((resolve) => subSection.attachEventOnce("visibilityChanged", resolve));
+			});
+	}
+
 	_handleSubSectionEnteredViewPort(oEvent: UI5Event<{ subSection: ObjectPageSubSection }>): void {
 		const oSubSection = oEvent.getParameter("subSection");
+		if (oSubSection.isA<SubSection>("sap.fe.macros.controls.section.SubSection")) {
+			oSubSection.handleSubSectionCreated(this.getView());
+		}
 		const blocks = oSubSection.getBlocks() as SubSectionBlock[];
 		blocks.forEach((block) => block.setBindingContext(undefined));
 		oSubSection.getMoreBlocks().forEach((subBlock) => subBlock.setBindingContext(undefined));
@@ -834,6 +864,12 @@ class ObjectPageController extends PageController {
 		if (bindingContext) {
 			oModel = bindingContext.getModel();
 
+			// Store navigation parameters in internal model for access by controller extensions
+			const internalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
+			if (mParameters) {
+				internalModelContext?.setProperty("navigationParameters", mParameters);
+			}
+
 			// Compute Edit Mode
 			oFinalUIState = this.editFlow.computeModelsForEditMode(bindingContext);
 
@@ -859,7 +895,9 @@ class ObjectPageController extends PageController {
 			});
 
 			// should be called only after binding is ready hence calling it in onAfterBinding
-			(oObjectPage as unknown as { _triggerVisibleSubSectionsEvents: Function })._triggerVisibleSubSectionsEvents();
+			if (this.getDisableObjectPageRequestOptimization()) {
+				(oObjectPage as unknown as { _triggerVisibleSubSectionsEvents: Function })._triggerVisibleSubSectionsEvents();
+			}
 
 			//To Compute the Edit Binding of the subObject page using root object page, create a context for draft root and update the edit button in sub OP using the context
 			ActionRuntime.updateEditButtonVisibilityAndEnablement(this.getView());
@@ -880,6 +918,45 @@ class ObjectPageController extends PageController {
 
 		const applyAppState = this.getAppComponent().getAppStateHandler().applyAppState(view);
 		this.pageReady.waitFor(applyAppState);
+
+		this.reconnectSubSectionVisibilityObservers(this.subSections, oObjectPage, applyAppState);
+	}
+
+	/**
+	 * Reconnect the visibility observers of all FE subsections after the subsection visibility bindings are resolved and the app state is applied.
+	 * This function wait for the appSate to be applied before reconnecting the observers and the scrolling to the selected section if it changed during the appState application.
+	 * @param subSectionInfo Subsections information retrieved during disconnection
+	 * @param objectPageLayout Object Page Layout control
+	 * @param waitForApplyAppstate Promise that resolves when the app state is applied
+	 * @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>
+	): Promise<boolean> {
+		if (!this.getDisableObjectPageRequestOptimization() && subSectionInfo) {
+			await Promise.all(this.waitForVisibilityBindings)
+				.then(async () => {
+					objectPageLayout.setVisible(true);
+					try {
+						//waiting for the app state to be applied bto ensure focusing on the correct section if required
+						await waitForApplyAppstate;
+					} catch {
+						Log.warning("Error while applying app state");
+					}
+					subSectionInfo.fe.forEach((subSection) => subSection.observeCurrentSection());
+					subSectionInfo.others
+						.filter((subsection) => subsection.getVisible())
+						.forEach((subSection) => subSection.fireEvent("subSectionEnteredViewPort", { subSection: subSection }));
+					return;
+				})
+				.catch((e: unknown) => {
+					Log.error("Error while applying app state", e as string);
+				});
+			return true;
+		}
+		return false;
 	}
 
 	/**
@@ -887,14 +964,16 @@ class ObjectPageController extends PageController {
 	 * @param cards Array of cards to be updated
 	 */
 	async _updateAvailableCards(cards: WrappedCard[]): Promise<void> {
-		await this.collaborationManager.collectAvailableCards(cards);
-		if (cards.length > 0) {
-			const cardObject = this.collaborationManager.updateCards(cards);
-			const parentAppId = this.getAppComponent().getId();
-			this.getAppComponent()
-				.getCollaborationManagerService()
-				.addCardsToCollaborationManager(cardObject, parentAppId, this.getView().getId());
-			this.getAppComponent().getCollaborationManagerService().shareAvailableCards();
+		const collaborationManagerService = this.getAppComponent().getCollaborationManagerService();
+		// Only collect cards when consumers are connected to the cards channel
+		if (collaborationManagerService.hasCollaborationManagerConnected()) {
+			await this.collaborationManager.collectAvailableCards(cards);
+			if (cards.length > 0) {
+				const cardObject = this.collaborationManager.updateCards(cards);
+				const parentAppId = this.getAppComponent().getId();
+				collaborationManagerService.addCardsToCollaborationManager(cardObject, parentAppId, this.getView().getId());
+				collaborationManagerService.shareAvailableCards();
+			}
 		}
 	}
 
@@ -1136,10 +1215,7 @@ class ObjectPageController extends PageController {
 			});
 	}
 
-	_showMessagePopover(err?: string, oRet?: unknown): unknown {
-		if (err) {
-			Log.error(err);
-		}
+	_showMessagePopover(): void {
 		const isEditMode = CommonUtils.getIsEditable(this.getView());
 		const rootViewController = this.getAppComponent().getRootViewController();
 		const currentPageView = rootViewController.isFclEnabled()
@@ -1158,7 +1234,6 @@ class ObjectPageController extends PageController {
 				}, 0);
 			}
 		}
-		return oRet;
 	}
 
 	async _editDocument(): Promise<void | Context> {
@@ -1264,14 +1339,16 @@ class ObjectPageController extends PageController {
 	 * If data has been provided on the creation rows, the related documents are created
 	 * before saving the draft version.
 	 * @param skipBindingToView Indicates if the binding to the view should be skipped
+	 * @param useSaveAndLeave Indicates if the save is triggered from a save and leave action
 	 * @returns Promise
 	 */
-	async _saveDocument(skipBindingToView?: boolean): Promise<void> {
+	async _saveDocument(skipBindingToView?: boolean, useSaveAndLeave?: boolean): Promise<void> {
 		const context = this.getView().getBindingContext();
 		const model = this.getView().getModel("ui"),
 			awaitCreateDocuments: Promise<void | ODataListBinding>[] = [];
 		// indicates if we are creating a new row in the OP
 		let executeSideEffectsOnError = false;
+		let messagePopoverErr: string | undefined;
 		BusyLocker.lock(model);
 		try {
 			if (this.collaborativeDraft.isCollaborationEnabled()) {
@@ -1296,6 +1373,7 @@ class ObjectPageController extends PageController {
 			this._findTables().forEach((table: Table) => {
 				const creationRow = table.getCreationRow();
 				const tableBinding = this._getTableBinding(table);
+
 				const contextKeys = Object.keys((creationRow?.getBindingContext() as ODataV4Context | undefined)?.getObject() || {});
 				if (contextKeys.filter((key) => !key.startsWith("@$ui5.")).length) {
 					executeSideEffectsOnError = true;
@@ -1304,7 +1382,10 @@ class ObjectPageController extends PageController {
 							.createDocument(tableBinding, {
 								creationMode: table.data("creationMode"),
 								creationRow: creationRow,
-								createAtEnd: table.data("createAtEnd") === "true",
+								createAtEnd:
+									(
+										(table.getParent() as TableAPI).getAggregation("creationMode") as TableCreationOptions | undefined
+									)?.getProperty("createAtEnd") === true,
 								skipSideEffects: true // the skipSideEffects is a parameter created when we click the save key. If we press this key, we don't execute the handleSideEffects funciton to avoid batch redundancy
 							})
 							.then(() => tableBinding)
@@ -1327,7 +1408,8 @@ class ObjectPageController extends PageController {
 					bindings: bindings as unknown as ODataListBinding[],
 					mergePatchDraft: this.mergePatchDraft,
 					skipBindingToView,
-					isStandardSave
+					isStandardSave,
+					useSaveAndLeave
 				});
 			} catch (error: unknown) {
 				// If the saveDocument in editFlow returns errors we need
@@ -1335,7 +1417,7 @@ class ObjectPageController extends PageController {
 				// dataloss logic does not perform the follow up function
 				// like e.g. a back navigation hence we return a promise and reject it
 				if (error !== RecommendationDialogDecision.Continue) {
-					this._showMessagePopover(error as string);
+					messagePopoverErr = (error as string) ?? "";
 				}
 				throw error;
 			}
@@ -1343,6 +1425,12 @@ class ObjectPageController extends PageController {
 			if (BusyLocker.isLocked(model)) {
 				BusyLocker.unlock(model);
 			}
+			if (messagePopoverErr !== undefined) {
+				if (messagePopoverErr.length) {
+					Log.error(messagePopoverErr);
+				}
+				this._showMessagePopover();
+			}
 		}
 	}
 
@@ -1444,7 +1532,7 @@ class ObjectPageController extends PageController {
 				if (oElement && oElement.isA && oElement.isA("sap.m.Panel") && oElement.data("FullScreenTablePlaceHolder")) {
 					oElement = oElement.data("tableAPIreference");
 				}
-				if (oElement && oElement.isA && oElement.isA<TableAPI>("sap.fe.macros.table.TableAPI")) {
+				if (oElement && oElement.isA && oElement.isA<TableAPI>("sap.fe.macros.Table")) {
 					const oSubElement = oElement.getContent instanceof Function ? oElement.getContent() : undefined;
 					if (oSubElement && oSubElement.isA && oSubElement.isA<Table>("sap.ui.mdc.Table")) {
 						aControls.push(oSubElement);
@@ -1914,6 +2002,10 @@ class ObjectPageController extends PageController {
 			this.messageButton.fireModelContextChange();
 		},
 
+		onTableBindingUpdated(this: ObjectPageController): void {
+			this.messageButton.fireModelContextChange();
+		},
+
 		async onCallAction(
 			oView: FEView,
 			sActionName: string,
@@ -1944,8 +2036,13 @@ class ObjectPageController extends PageController {
 
 			return oController.editFlow
 				.invokeAction(sActionName, mParameters)
-				.then(oController._showMessagePopover.bind(oController, undefined))
-				.catch(oController._showMessagePopover.bind(oController));
+				.then((res) => {
+					oController._showMessagePopover();
+					return res;
+				})
+				.catch(() => {
+					oController._showMessagePopover();
+				});
 		},
 		onDataPointTitlePressed(
 			oController: ObjectPageController,
@@ -2027,7 +2124,7 @@ class ObjectPageController extends PageController {
 				oInternalModelContext.getProperty("errorNavigationSectionFlag") === false
 			) {
 				const oSubSection = oEvent.getParameter("subSection");
-				this._updateFocusInEditMode([oSubSection]);
+				this._updateFocusInEditMode([oSubSection], true);
 			}
 		},
 		onVariantSelected: function (this: ObjectPageController): void {
@@ -2041,35 +2138,18 @@ class ObjectPageController extends PageController {
 		},
 		navigateToSubSection: function (oController: ObjectPageController, vDetailConfig: string | object): void {
 			const oDetailConfig = typeof vDetailConfig === "string" ? JSON.parse(vDetailConfig) : vDetailConfig;
-			const oObjectPage = oController.getView().byId("fe::ObjectPage") as ObjectPageLayout;
-			let oSection;
-			let oSubSection;
-			if (oDetailConfig.sectionId) {
-				oSection = oController.getView().byId(oDetailConfig.sectionId) as ObjectPageSection;
-				oSubSection = (
-					oDetailConfig.subSectionId
-						? oController.getView().byId(oDetailConfig.subSectionId)
-						: oSection && oSection.getSubSections() && oSection.getSubSections()[0]
-				) as ObjectPageSubSection;
-			} else if (oDetailConfig.subSectionId) {
-				oSubSection = oController.getView().byId(oDetailConfig.subSectionId) as ObjectPageSubSection;
-				oSection = oSubSection && (oSubSection.getParent() as ObjectPageSection);
-			}
-			if (!oSection || !oSubSection || !oSection.getVisible() || !oSubSection.getVisible()) {
-				const sTitle = getResourceModel(oController).getText(
-					"C_ROUTING_NAVIGATION_DISABLED_TITLE",
-					undefined,
-					oController.getView().getViewData().entitySet
-				);
-				Log.error(sTitle);
-				MessageBox.error(sTitle);
+
+			// Determine the target ID based on input type
+			let targetId: string | undefined;
+			if (typeof oDetailConfig === "string") {
+				targetId = oDetailConfig;
 			} else {
-				oObjectPage.setSelectedSection(oSubSection.getId());
-				// trigger iapp state change
-				oObjectPage.fireNavigate({
-					section: oSection,
-					subSection: oSubSection
-				});
+				// Priority: subSectionId > sectionId
+				targetId = oDetailConfig.subSectionId ?? oDetailConfig.sectionId;
+			}
+
+			if (targetId) {
+				oController.getExtensionAPI().navigateToSubSection(targetId);
 			}
 		},