@sapui5/sap.fe.templates 1.141.2 → 1.143.0

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

@@ -4,6 +4,7 @@ import merge from "sap/base/util/merge";
 import type { EnhanceWithUI5 } from "sap/fe/base/ClassSupport";
 import { defineUI5Class, extensible, finalExtension, publicExtension, usingExtension } from "sap/fe/base/ClassSupport";
 import ActionRuntime from "sap/fe/core/ActionRuntime";
+import type { StartupParameters } from "sap/fe/core/AppComponent";
 import type { FEView } from "sap/fe/core/BaseController";
 import CommonUtils from "sap/fe/core/CommonUtils";
 import PageController from "sap/fe/core/PageController";
@@ -72,6 +73,7 @@ import type Chart from "sap/ui/mdc/Chart";
 import type Table from "sap/ui/mdc/Table";
 import type TableTypeBase from "sap/ui/mdc/table/TableTypeBase";
 import type Binding from "sap/ui/model/Binding";
+import type CompositeBinding from "sap/ui/model/CompositeBinding";
 import type Context from "sap/ui/model/Context";
 import type ListBinding from "sap/ui/model/ListBinding";
 import type JSONModel from "sap/ui/model/json/JSONModel";
@@ -102,7 +104,11 @@ export type BindingParams = {
 };
 
 const ProgrammingModel = FELibrary.ProgrammingModel;
+const PreferredActionStatus = FELibrary.PreferredActionStatusType;
 
+/**
+ * @public
+ */
 @defineUI5Class("sap.fe.templates.ObjectPage.ObjectPageController")
 class ObjectPageController extends PageController {
 	oView!: FEView;
@@ -158,7 +164,7 @@ class ObjectPageController extends PageController {
 
 	private bSectionNavigated?: boolean;
 
-	private clearTitleHierarchyCacheSetUp = false;
+	private invalidateTitleHierarchyCacheSetUp = false;
 
 	private switchDraftAndActivePopOver?: Popover;
 
@@ -174,6 +180,8 @@ class ObjectPageController extends PageController {
 
 	private messageBinding?: Binding;
 
+	private isFirstBinding = true;
+
 	@publicExtension()
 	@finalExtension()
 	getExtensionAPI(sId?: string): ExtensionAPI {
@@ -198,12 +206,17 @@ class ObjectPageController extends PageController {
 		const oObjectPage = this._getObjectPageLayoutControl();
 
 		// Setting defaults of internal model context
-		const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
-		oInternalModelContext?.setProperty("externalNavigationContext", { page: true });
-		oInternalModelContext?.setProperty("relatedApps", {
-			visibility: false,
-			items: null
-		});
+		const oInternalModelContext = this.getOwnerComponent().getBindingContext("internal") as InternalModelContext;
+		oInternalModelContext?.setProperty("externalNavigationContext", { page: true }, undefined, true);
+		oInternalModelContext?.setProperty(
+			"relatedApps",
+			{
+				visibility: false,
+				items: null
+			},
+			undefined,
+			true
+		);
 		oInternalModelContext?.setProperty("batchGroups", this._getBatchGroupsForView());
 		oInternalModelContext?.setProperty("errorNavigationSectionFlag", false);
 		if (oObjectPage.getEnableLazyLoading()) {
@@ -213,8 +226,10 @@ class ObjectPageController extends PageController {
 		this.messageButton = this.getView().byId("fe::FooterBar::MessageButton") as MessageButton;
 		this.messageBinding = Messaging.getMessageModel().bindList("/");
 		this.messageBinding?.attachChange(this._fnShowOPMessage, this);
-		oInternalModelContext?.setProperty("rootEditEnabled", true);
-		oInternalModelContext?.setProperty("rootEditVisible", true);
+		oInternalModelContext?.setProperty("rootEditEnabled", true, undefined, true);
+		oInternalModelContext?.setProperty("rootEditVisible", true, undefined, true);
+
+		this._handleSmartSummaryStartupAction();
 	}
 
 	onExit(): void {
@@ -316,16 +331,34 @@ class ObjectPageController extends PageController {
 	 * @returns Table if exists
 	 */
 	private searchTableInBlock(block: SubSectionBlock): Table | undefined {
-		const control = block.content;
 		let tableAPI: TableAPI | undefined;
-		if (block.isA("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
+		const getTableAPI = (control: Control): TableAPI | undefined => {
 			// The table may currently be shown in a full screen dialog, we can then get the reference to the TableAPI
 			// control from the custom data of the place holder panel
 			if (control.isA("sap.m.Panel") && control.data("FullScreenTablePlaceHolder")) {
-				tableAPI = control.data("tableAPIreference");
+				return control.data("tableAPIreference");
 			} else if (control.isA("sap.fe.macros.table.TableAPI")) {
-				tableAPI = control as TableAPI;
+				return control as TableAPI;
 			}
+		};
+		if (block.isA("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
+			const control = block.content;
+			if (control.isA("sap.ui.layout.DynamicSideContent")) {
+				const mainContent = (control as DynamicSideContent).getMainContent()[0];
+				const mainContentTableAPI = getTableAPI(mainContent);
+				if (mainContentTableAPI) {
+					tableAPI = mainContentTableAPI;
+				} else {
+					const sideContent = (control as DynamicSideContent).getSideContent()[0];
+					const sideContentTableAPI = getTableAPI(sideContent);
+					if (sideContentTableAPI) {
+						tableAPI = sideContentTableAPI;
+					}
+				}
+			} else {
+				tableAPI = getTableAPI(control);
+			}
+
 			if (tableAPI) {
 				return tableAPI.content;
 			}
@@ -410,6 +443,28 @@ 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;
+			});
+		}
+
 		if (oObjectPage.getEnableLazyLoading()) {
 			this._disableBlocksBindings(oObjectPage);
 		}
@@ -424,6 +479,13 @@ class ObjectPageController extends PageController {
 		}
 	}
 
+	private useLazyLoaderOptimizations(): boolean {
+		if (new URLSearchParams(window.location.search).get("sap-ui-xx-lazyloader-optimizations") === "true") {
+			return true;
+		}
+		return false;
+	}
+
 	private getFirstEditableInput(): UI5Element | undefined {
 		const domEditableElement = this._getObjectPageLayoutControl()._getFirstEditableInput();
 		return domEditableElement ? UI5Element.closestTo(domEditableElement) : undefined;
@@ -471,22 +533,29 @@ class ObjectPageController extends PageController {
 		let iSkip = 3; // 3 sections/subsections are loaded initially, the others are loaded lazily
 		const bIsInEditMode = CommonUtils.getIsEditable(this.getView());
 		const bEditableHeader = this.getView().getViewData().editableHeaderContent;
+		const firstVisibilityBinding = this._getfirstSubSectionVisibilityBinding();
 		for (let iSection = 0; iSection < aSections.length; iSection++) {
 			const oSection = aSections[iSection];
 			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
-				if (iSkip < 1 || (bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode)))) {
+
+				const disableBindingContextCondition =
+					(!this.useLazyLoaderOptimizations() &&
+						(iSkip < 1 || (bUseIconTabBar && (iSection > 1 || (iSection === 1 && !bEditableHeader && !bIsInEditMode))))) ||
+					(this.useLazyLoaderOptimizations() &&
+						((!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)))));
+				if (disableBindingContextCondition) {
 					const oSubSection = aSubSections[iSubSection];
-					if (oSubSection.data().isVisibilityDynamic !== "true") {
-						// SubSection's binding is enabled.
-						oSubSection.setBindingContext(undefined);
-						const blocks = oSubSection.getBlocks() as SubSectionBlock[];
-						// SubSection's contents binding is disabled.
-						blocks.forEach((block) => block.setBindingContext(null));
-						oSubSection.getMoreBlocks().forEach((subBlock) => subBlock.setBindingContext(null));
-						oSubSection.getActions().forEach((actions) => actions.setBindingContext(null));
-					}
+					// SubSection's binding is enabled.
+					oSubSection.setBindingContext(undefined);
+					const blocks = oSubSection.getBlocks() as SubSectionBlock[];
+					// SubSection's contents binding is disabled.
+					blocks.forEach((block) => block.setBindingContext(null));
+					oSubSection.getMoreBlocks().forEach((subBlock) => subBlock.setBindingContext(null));
+					oSubSection.getActions().forEach((actions) => actions.setBindingContext(null));
 				}
 			}
 		}
@@ -587,10 +656,28 @@ class ObjectPageController extends PageController {
 					oFieldToFocus.focus(focusInfo);
 				}
 			}.bind(this),
-			0
+			0 //300
 		);
 	}
 
+	/**
+	 * Get the first sub-section with a visibility bound to the model of the view.
+	 * 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 {
+		const allsubSections = this._getAllSubSections();
+		const currentModel = this.getView().getModel();
+		return allsubSections
+			.find(
+				(subSection) =>
+					(subSection.getBinding("visible") as CompositeBinding | undefined)
+						?.getBindings?.()
+						.some((binding) => binding.getModel() === currentModel)
+			)
+			?.getBinding("visible");
+	}
+
 	_handleSubSectionEnteredViewPort(oEvent: UI5Event<{ subSection: ObjectPageSubSection }>): void {
 		const oSubSection = oEvent.getParameter("subSection");
 		const blocks = oSubSection.getBlocks() as SubSectionBlock[];
@@ -776,6 +863,8 @@ class ObjectPageController extends PageController {
 
 			//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());
+
+			this._updateAvailableCards([]);
 		}
 		// we are clearing any previous data from recommendations every time we come to new OP
 		// so that cached recommendations are not shown to user
@@ -786,11 +875,10 @@ class ObjectPageController extends PageController {
 				return;
 			});
 		}
-		this._updateAvailableCards([]);
 		this.displayCollaborationMessage(mParameters?.redirectedToNonDraft);
 		this._setOPMessageStripInternalContext();
 
-		const applyAppState = this.getAppComponent().getAppStateHandler().applyAppState(view.getId(), view);
+		const applyAppState = this.getAppComponent().getAppStateHandler().applyAppState(view);
 		this.pageReady.waitFor(applyAppState);
 	}
 
@@ -982,11 +1070,12 @@ class ObjectPageController extends PageController {
 		const appComponent = this.getAppComponent();
 		const rootViewController = appComponent.getRootViewController();
 		const fnClearCacheTitle = (): void => {
-			rootViewController.clearTitleHierarchyCache(oObjectPage.getBindingContext()?.getPath() as string);
+			rootViewController.invalidateTitleHierarchyCache(oObjectPage.getBindingContext()?.getPath() as string);
 		};
-		if (oObjectPageSubtitle && !this.clearTitleHierarchyCacheSetUp) {
-			oObjectPageSubtitle.getBinding("value")?.attachChange(fnClearCacheTitle, this);
-			this.clearTitleHierarchyCacheSetUp = true;
+		if ((oObjectPageDescription || oObjectPageSubtitle) && !this.invalidateTitleHierarchyCacheSetUp) {
+			oObjectPageSubtitle?.getBinding("value")?.attachChange(fnClearCacheTitle, this);
+			oObjectPageDescription?.getBinding("value")?.attachChange(fnClearCacheTitle, this);
+			this.invalidateTitleHierarchyCacheSetUp = true;
 		}
 		const oObjectPageContext = oObjectPage.getBindingContext();
 		const build = (): { title: string; subtitle: string; intent: string; icon: string; description: string } => ({
@@ -1650,6 +1739,86 @@ class ObjectPageController extends PageController {
 		}
 	}
 
+	_findSummarizeButton(): Button | undefined {
+		const objectPage = this._getObjectPageLayoutControl();
+		const objectPageTitle = objectPage.getHeaderTitle() as ObjectPageDynamicHeaderTitle;
+		const actions = objectPageTitle?.getActions();
+		let summarizeButton: Button | undefined;
+
+		for (const action of actions) {
+			if (action.isA<SummarizationButton>("sap.fe.macros.ai.SummarizationButton")) {
+				const button = action.getContent() as Button | undefined;
+				if (button && button.getId().endsWith("::Summarize::button")) {
+					summarizeButton = button;
+					break;
+				}
+			}
+		}
+
+		return summarizeButton;
+	}
+
+	/**
+	 * Evaluates startup parameters and triggers the smart summary action on the Object Page if required.
+	 *
+	 * This method checks whether the startup parameters indicate that a smart summary should be performed for the current Object Page level.
+	 * The level parameter determines which Object Page should be summarized, which is relevant in Flexible Column Layout (FCL) scenarios where
+	 * multiple Object Pages may be displayed simultaneously.
+	 * If no level is provided in the startup parameters, the method defaults the level to 1.
+	 * If the summary action is allowed and the SmartSummarize capability is available, it locates the summarize button and triggers its press event.
+	 * The method ensures the summary is only executed once per navigation and logs errors if prerequisites are not met or the button is unavailable.
+	 * All errors encountered during the process are caught and logged.
+	 * @private
+	 */
+	_handleSmartSummaryStartupAction(): void {
+		const appComponent = this.getAppComponent();
+		appComponent
+			?.getStartupParameters()
+			?.then((startupParams: StartupParameters) => {
+				if (!startupParams.preferredAction || !startupParams.preferredAction[0].startsWith("summary")) {
+					return;
+				}
+
+				// check if we are on the correct OP by checking the level provided in the startup parameters
+				const viewLevel = this.getView().getViewData().viewLevel;
+				const preferredActionLevel =
+					startupParams.preferredAction[0] === "summary" ? 1 : parseInt(startupParams.preferredAction[0].split("-")[1], 10);
+				if (isNaN(preferredActionLevel) || viewLevel !== preferredActionLevel) {
+					return;
+				}
+
+				// Check if summary action shall be executed now (it might have already been executed by a higher level OP)
+				if (appComponent.getPreferredActionStatus() === PreferredActionStatus.CanPerform) {
+					appComponent.setPreferredActionStatus(PreferredActionStatus.AlreadyPerformed); // to prevent other OPs on higher levels to execute the summary again
+				} else {
+					return;
+				}
+
+				// Check if SmartSummarize capability is available
+				const environmentService = appComponent.getEnvironmentCapabilities();
+				if (!environmentService?.environmentCapabilities.SmartSummarize) {
+					Log.error("Smart Summarization was not triggered because SmartSummarize capability is not available");
+					return;
+				}
+
+				// Find the Summary button
+				const summarizeButton = this._findSummarizeButton();
+
+				if (summarizeButton && summarizeButton.getVisible() && summarizeButton.getEnabled()) {
+					summarizeButton.firePress();
+					return;
+				} else {
+					Log.error(
+						"Smart Summarization was not triggered because the Summarize button is either not visible or not enabled or not found."
+					);
+					return;
+				}
+			})
+			.catch((error: unknown) => {
+				Log.error("Error while retrieving startup parameters or triggering smart summary:", error as string);
+			});
+	}
+
 	handlers = {
 		onPrimaryAction(
 			oController: ObjectPageController,
@@ -1765,6 +1934,7 @@ class ObjectPageController extends PageController {
 				notApplicableContexts?: ODataV4Context[];
 				enableAutoScroll?: boolean;
 				defaultValuesExtensionFunction?: string;
+				disableStrictHandling?: boolean;
 			}
 		): Promise<unknown> {
 			const oController = oView.getController() as ObjectPageController;