@sapui5/sap.fe.templates 1.112.0 → 1.114.0

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

@@ -20,12 +20,15 @@ import { defineUI5Class, extensible, finalExtension, publicExtension, usingExten
 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 PageController from "sap/fe/core/PageController";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import DelegateUtil from "sap/fe/macros/DelegateUtil";
+import type TableAPI from "sap/fe/macros/table/TableAPI";
 import TableHelper from "sap/fe/macros/table/TableHelper";
 import TableUtils from "sap/fe/macros/table/Utils";
 import SelectionVariant from "sap/fe/navigation/SelectionVariant";
+import type SubSectionBlock from "sap/fe/templates/ObjectPage/controls/SubSectionBlock";
 import type { default as ObjectPageExtensionAPI } from "sap/fe/templates/ObjectPage/ExtensionAPI";
 import { default as ExtensionAPI } from "sap/fe/templates/ObjectPage/ExtensionAPI";
 import TableScroller from "sap/fe/templates/TableScroller";
@@ -34,9 +37,10 @@ import Link from "sap/m/Link";
 import MessageBox from "sap/m/MessageBox";
 import type Popover from "sap/m/Popover";
 import Core from "sap/ui/core/Core";
-import type Message from "sap/ui/core/message/Message";
+import Message from "sap/ui/core/message/Message";
 import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
 import type View from "sap/ui/core/mvc/View";
+import type Table from "sap/ui/mdc/Table";
 import type Binding from "sap/ui/model/Binding";
 import type JSONModel from "sap/ui/model/json/JSONModel";
 import type Context from "sap/ui/model/odata/v4/Context";
@@ -55,6 +59,7 @@ import PaginatorOverride from "./overrides/Paginator";
 import ShareOverrides from "./overrides/Share";
 import ViewStateOverrides from "./overrides/ViewState";
 
+const ProgrammingModel = FELibrary.ProgrammingModel;
 @defineUI5Class("sap.fe.templates.ObjectPage.ObjectPageController")
 class ObjectPageController extends PageController {
 	oView!: any;
@@ -194,6 +199,8 @@ class ObjectPageController extends PageController {
 	_fnShowOPMessage() {
 		const extensionAPI = this.getExtensionAPI();
 		const view = this.getView();
+		const internalContext = view?.getBindingContext("internal");
+		const stripVisible = internalContext?.getProperty("OPMessageStripVisibility");
 		const messages = this.messageButton.oMessagePopover
 			.getItems()
 			.map((item: any) => item.getBindingContext("message").getObject())
@@ -201,7 +208,7 @@ class ObjectPageController extends PageController {
 				return message.getTargets()[0] === view.getBindingContext()?.getPath();
 			});
 
-		if (extensionAPI) {
+		if (extensionAPI && !(messages.length === 0 && stripVisible)) {
 			extensionAPI.showMessages(messages);
 		}
 	}
@@ -210,6 +217,55 @@ class ObjectPageController extends PageController {
 		return oTable && oTable.getRowBinding();
 	}
 
+	/**
+	 * Find the last visible subsection and add the sapUxAPObjectPageSubSectionFitContainer CSS class if it contains only a GridTable or a TreeTable.
+	 *
+	 * @param subSections The sub sections to look for
+	 * @private
+	 */
+	private checkSectionsForNonResponsiveTable(subSections: ObjectPageSubSection[]) {
+		const changeClassForTables = (event: Event, lastVisibleSubSection: ObjectPageSubSection) => {
+			const blocks = [...lastVisibleSubSection.getBlocks(), ...lastVisibleSubSection.getMoreBlocks()];
+			const tableType = blocks.length === 1 && this.searchTableInBlock(blocks[0] as SubSectionBlock)?.getType();
+			if (tableType && (tableType?.isA("sap.ui.mdc.table.GridTableType") || tableType?.isA("sap.ui.mdc.table.TreeTableType"))) {
+				//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);
+			}
+		};
+		for (let subSectionIndex = subSections.length - 1; subSectionIndex >= 0; subSectionIndex--) {
+			if (subSections[subSectionIndex].getVisible()) {
+				const lastVisibleSubSection = subSections[subSectionIndex];
+				// We need to attach this event in order to manage the Object Page Lazy Loading mechanism
+				lastVisibleSubSection.attachEvent("modelContextChange", lastVisibleSubSection, changeClassForTables, this);
+				break;
+			}
+		}
+	}
+
+	/**
+	 * Find a table in blocks of section.
+	 *
+	 * @param block One sub section block
+	 * @returns Table if exists
+	 */
+	private searchTableInBlock(block: SubSectionBlock) {
+		const control = block.content;
+		let tableAPI: TableAPI | undefined;
+		if (block.isA("sap.fe.templates.ObjectPage.controls.SubSectionBlock")) {
+			// 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");
+			} else if (control.isA("sap.fe.macros.table.TableAPI")) {
+				tableAPI = control as TableAPI;
+			}
+			if (tableAPI) {
+				return tableAPI.content as Table;
+			}
+		}
+		return undefined;
+	}
 	onBeforeRendering() {
 		PageController.prototype.onBeforeRendering.apply(this);
 		// In the retrieveTextFromValueList scenario we need to ensure in case of reload/refresh that the meta model in the methode retrieveTextFromValueList of the FieldRuntime is available
@@ -218,6 +274,20 @@ class ObjectPageController extends PageController {
 		}
 	}
 
+	onAfterRendering() {
+		let subSections: ObjectPageSubSection[];
+		if (this._getObjectPageLayoutControl().getUseIconTabBar()) {
+			const sections = this._getObjectPageLayoutControl().getSections();
+			for (const section of sections) {
+				subSections = section.getSubSections();
+				this.checkSectionsForNonResponsiveTable(subSections);
+			}
+		} else {
+			subSections = this._getAllSubSections();
+			this.checkSectionsForNonResponsiveTable(subSections);
+		}
+	}
+
 	_onBeforeBinding(oContext: any, mParameters: any) {
 		// TODO: we should check how this comes together with the transaction helper, same to the change in the afterBinding
 		const aTables = this._findTables(),
@@ -447,7 +517,7 @@ class ObjectPageController extends PageController {
 	}
 
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
-	_onAfterBinding(oBindingContext: any, mParameters: any) {
+	_onAfterBinding(inputBindingContext: any, mParameters: any) {
 		const oObjectPage = this._getObjectPageLayoutControl();
 		const aTables = this._findTables();
 
@@ -455,7 +525,7 @@ class ObjectPageController extends PageController {
 
 		// TODO: this is only a temp solution as long as the model fix the cache issue and we use this additional
 		// binding with ownRequest
-		oBindingContext = oObjectPage.getBindingContext();
+		const bindingContext = oObjectPage.getBindingContext() as Context;
 
 		let aIBNActions: any[] = [];
 		oObjectPage.getSections().forEach(function (oSection: any) {
@@ -472,33 +542,35 @@ class ObjectPageController extends PageController {
 
 		aTables.forEach(function (oTable: any) {
 			const oInternalModelContext = oTable.getBindingContext("internal");
-			oInternalModelContext.setProperty("creationRowFieldValidity", {});
-			oInternalModelContext.setProperty("creationRowCustomValidity", {});
-
-			aIBNActions = CommonUtils.getIBNActions(oTable, aIBNActions);
-			// temporary workaround for BCP: 2080218004
-			// Need to fix with BLI: FIORITECHP1-15274
-			// only for edit mode, we clear the table cache
-			// Workaround starts here!!
-			const oTableRowBinding = oTable.getRowBinding();
-			if (oTableRowBinding) {
-				if (ModelHelper.isStickySessionSupported(oTableRowBinding.getModel().getMetaModel())) {
-					// apply for both edit and display mode in sticky
-					oTableRowBinding.removeCachesAndMessages("");
+			if (oInternalModelContext) {
+				oInternalModelContext.setProperty("creationRowFieldValidity", {});
+				oInternalModelContext.setProperty("creationRowCustomValidity", {});
+
+				aIBNActions = CommonUtils.getIBNActions(oTable, aIBNActions);
+
+				// temporary workaround for BCP: 2080218004
+				// Need to fix with BLI: FIORITECHP1-15274
+				// only for edit mode, we clear the table cache
+				// Workaround starts here!!
+				const oTableRowBinding = oTable.getRowBinding();
+				if (oTableRowBinding) {
+					if (ModelHelper.isStickySessionSupported(oTableRowBinding.getModel().getMetaModel())) {
+						// apply for both edit and display mode in sticky
+						oTableRowBinding.removeCachesAndMessages("");
+					}
 				}
-			}
-			// Workaround ends here!!
+				// Workaround ends here!!
 
-			// Update 'enabled' property of DataFieldForAction buttons on table toolbar
-			// The same is also performed on Table selectionChange event
-			const oActionOperationAvailableMap = JSON.parse(
+				// Clear the selection in the table and update action enablement accordingly
+				// Will to be fixed with BLI: FIORITECHP1-24318
+				const oActionOperationAvailableMap = JSON.parse(
 					CommonHelper.parseCustomData(DelegateUtil.getCustomData(oTable, "operationAvailableMap"))
-				),
-				aSelectedContexts = oTable.getSelectedContexts();
+				);
+
+				ActionRuntime.setActionEnablement(oInternalModelContext, oActionOperationAvailableMap, [], "table");
 
-			ActionRuntime.setActionEnablement(oInternalModelContext, oActionOperationAvailableMap, aSelectedContexts, "table");
-			// Clear the selection in the table, need to be fixed and review with BLI: FIORITECHP1-24318
-			oTable.clearSelection();
+				oTable.clearSelection();
+			}
 		});
 		CommonUtils.getSemanticTargetsFromPageModel(this, "_pageModel");
 		//Retrieve Object Page header actions from Object Page title control
@@ -544,11 +616,11 @@ class ObjectPageController extends PageController {
 			}
 		};
 
-		if (oBindingContext) {
-			oModel = oBindingContext.getModel();
+		if (bindingContext) {
+			oModel = bindingContext.getModel();
 
 			// Compute Edit Mode
-			oFinalUIState = this.editFlow.computeEditMode(oBindingContext);
+			oFinalUIState = this.editFlow.computeEditMode(bindingContext);
 
 			if (ModelHelper.isCollaborationDraftSupported(oModel.getMetaModel())) {
 				oFinalUIState
@@ -567,11 +639,11 @@ class ObjectPageController extends PageController {
 			this._updateRelatedApps();
 
 			//Attach the patch sent and patch completed event to the object page binding so that we can react
-			const oBinding = (oBindingContext.getBinding && oBindingContext.getBinding()) || oBindingContext;
+			const oBinding = (bindingContext.getBinding && bindingContext.getBinding()) || bindingContext;
 
 			// Attach the event handler only once to the same binding
 			if (this.currentBinding !== oBinding) {
-				oBinding.attachEvent("patchSent", this.editFlow.handlePatchSent, this);
+				oBinding.attachEvent("patchSent", {}, this.editFlow.handlePatchSent, this);
 				this.currentBinding = oBinding;
 			}
 
@@ -590,6 +662,35 @@ 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.displayCollaborationMessage(mParameters?.redirectedToNonDraft);
+	}
+
+	/**
+	 * Show a message strip if a redirection to a non-draft element has been done.
+	 * Remove the message strip in case we navigate to another object page.
+	 *
+	 * @param entityName Name of the Entity to be displayed in the message
+	 * @private
+	 */
+	displayCollaborationMessage(entityName: string | undefined) {
+		const internalBindingContext = this.getView()?.getBindingContext("internal");
+		const resourceBundle = Core.getLibraryResourceBundle("sap.fe.core");
+		if (entityName) {
+			const message = new Message({
+				message: resourceBundle.getText("REROUTED_NAVIGATION_TO_SAVED_VERSION", [entityName]),
+				type: "Information"
+			});
+			this.getExtensionAPI().showMessages([message]);
+		} else {
+			const messageToCompare = resourceBundle.getText("REROUTED_NAVIGATION_TO_SAVED_VERSION", ["{0}"]);
+			const lengthUntilVariable = messageToCompare.search("{");
+			if (
+				internalBindingContext?.getProperty("OPMessageStripText")?.substring(0, lengthUntilVariable) ===
+				messageToCompare.substring(0, lengthUntilVariable)
+			) {
+				this.getExtensionAPI().showMessages([]);
+			}
+		}
 	}
 
 	@publicExtension()
@@ -767,49 +868,6 @@ class ObjectPageController extends PageController {
 		});
 	}
 
-	/**
-	 * Gets the context of the DraftRoot path.
-	 * If a view has been created with the draft Root Path, this method returns its bindingContext.
-	 * Where no view is found a new created context is returned.
-	 * The new created context request the key of the entity in order to get the Etag of this entity.
-	 *
-	 * @function
-	 * @name getDraftRootPath
-	 * @returns Returns a Promise
-	 */
-	async getDraftRootContext(): Promise<Context | undefined> {
-		const view = this.getView();
-		const context = view.getBindingContext() as Context;
-		if (context) {
-			const draftRootContextPath = ModelHelper.getDraftRootPath(context);
-			let simpleDraftRootContext: Context;
-			if (draftRootContextPath) {
-				// Check if a view matches with the draft root path
-				const existingBindingContextOnPage = this.getAppComponent()
-					.getRootViewController()
-					.getInstancedViews()
-					.find((pageView: View) => pageView.getBindingContext()?.getPath() === draftRootContextPath)
-					?.getBindingContext() as Context;
-				if (existingBindingContextOnPage) {
-					return existingBindingContextOnPage;
-				}
-				const internalModel = view.getModel("internal") as JSONModel;
-				simpleDraftRootContext = internalModel.getProperty("/simpleDraftRootContext");
-				if (simpleDraftRootContext?.getPath() === draftRootContextPath) {
-					return simpleDraftRootContext;
-				}
-				const model = context.getModel();
-				simpleDraftRootContext = model.bindContext(draftRootContextPath).getBoundContext();
-				await CommonUtils.waitForContextRequested(simpleDraftRootContext);
-				// Store this new created context to use it on the next iterations
-				internalModel.setProperty("/simpleDraftRootContext", simpleDraftRootContext);
-				return simpleDraftRootContext;
-			}
-			return undefined;
-		}
-		return undefined;
-	}
-
 	async _validateDocument(): Promise<void | any[] | ODataContextBinding> {
 		const appComponent = this.getAppComponent();
 		const control = Core.byId(Core.getCurrentFocusedControlId());
@@ -823,7 +881,7 @@ class ObjectPageController extends PageController {
 				await this.editFlow.syncTask();
 				return Promise.all(globalSideEffects.map((sideEffects) => this._sideEffects.requestSideEffects(sideEffects, context)));
 			}
-			const draftRootContext = await this.getDraftRootContext();
+			const draftRootContext = (await CommonUtils.createRootContext(ProgrammingModel.Draft, this.getView(), appComponent)) as Context;
 			//Execute the draftValidation if there is no globalSideEffects (ignore ETags in collaboration draft)
 			if (draftRootContext) {
 				await this.editFlow.syncTask();
@@ -904,20 +962,20 @@ class ObjectPageController extends PageController {
 		return this.editFlow.cancelDocument(oContext, mParameters);
 	}
 
-	_applyDocument(oContext: any) {
+	_applyDocument(oContext: Context) {
 		return this.editFlow.applyDocument(oContext).catch(() => this._showMessagePopover());
 	}
 
 	_updateRelatedApps() {
 		const oObjectPage = this._getObjectPageLayoutControl();
-		if (CommonUtils.resolveStringtoBoolean(oObjectPage.data("showRelatedApps"))) {
+		const showRelatedApps = oObjectPage.data("showRelatedApps");
+		if (showRelatedApps === "true" || showRelatedApps === true) {
 			const appComponent = CommonUtils.getAppComponent(this.getView());
 			CommonUtils.updateRelatedAppsDetails(oObjectPage, appComponent);
 		}
 	}
 
 	_findControlInSubSection(aParentElement: any, aSubsection: any, aControls: any, bIsChart?: boolean) {
-		const aSubSectionTables = [];
 		for (let element = 0; element < aParentElement.length; element++) {
 			let oElement = aParentElement[element].getContent instanceof Function && aParentElement[element].getContent();
 			if (bIsChart) {
@@ -949,10 +1007,6 @@ class ObjectPageController extends PageController {
 			}
 			if (oElement && oElement.isA && oElement.isA("sap.ui.mdc.Table")) {
 				aControls.push(oElement);
-				aSubSectionTables.push({
-					table: oElement,
-					gridTable: oElement.getType().isA("sap.ui.mdc.table.GridTableType")
-				});
 			}
 			if (oElement && oElement.isA && oElement.isA("sap.fe.macros.chart.ChartAPI")) {
 				oElement = oElement.getContent instanceof Function && oElement.getContent();
@@ -964,16 +1018,6 @@ class ObjectPageController extends PageController {
 				aControls.push(oElement);
 			}
 		}
-
-		if (
-			aSubSectionTables.length === 1 &&
-			aParentElement.length === 1 &&
-			aSubSectionTables[0].gridTable &&
-			!aSubsection.hasStyleClass("sapUxAPObjectPageSubSectionFitContainer")
-		) {
-			//In case there is only a single table in a section we fit that to the whole page so that the scrollbar comes only on table and not on page
-			aSubsection.addStyleClass("sapUxAPObjectPageSubSectionFitContainer");
-		}
 	}
 
 	_getAllSubSections() {
@@ -1112,9 +1156,9 @@ class ObjectPageController extends PageController {
 			entitySet: sMetaPathPage
 		});
 		// Adding Page Context to selection variant
-		aPageAttributes = CommonUtils.removeSensitiveData(aPageAttributes, oMetaModel);
+		aPageAttributes = this._intentBasedNavigation.removeSensitiveData(aPageAttributes, sMetaPathPage);
 		const oPageLevelSV = CommonUtils.addPageContextToSelectionVariant(new SelectionVariant(), aPageAttributes, this.getView());
-		aAttributes = CommonUtils.removeSensitiveData(aAttributes, oMetaModel);
+		aAttributes = this._intentBasedNavigation.removeSensitiveData(aAttributes, sMetaPathPage);
 		return {
 			selectionVariant: oPageLevelSV,
 			attributes: aAttributes
@@ -1352,7 +1396,34 @@ class ObjectPageController extends PageController {
 				return false;
 			});
 
+			// set correct binding context for fast creation row
+			const fastCreationRow = oTable.getCreationRow();
+
+			if (fastCreationRow && !fastCreationRow._oInnerCreationRow?.getBindingContext()) {
+				const tableBinding = this._getTableBinding(oTable);
+
+				if (!tableBinding) {
+					Log.error(`Expected binding missing for table: ${oTable.getId()}`);
+					return;
+				}
+
+				if (tableBinding.getContext()) {
+					const objectPage = this._getObjectPageLayoutControl();
+					const bindingContext = objectPage.getBindingContext() as Context;
+					const model = bindingContext.getModel();
+
+					TableHelper.enableFastCreationRow(
+						fastCreationRow,
+						tableBinding.getPath(),
+						tableBinding.getContext(),
+						model,
+						oTable.getModel("ui").getProperty("/isEditable")
+					);
+				}
+			}
+
 			const oCurrentActionPromise = this.editFlow.getCurrentActionPromise();
+
 			if (oCurrentActionPromise) {
 				let aTableContexts: any;
 				if (oTable.getType().getMetadata().isA("sap.ui.mdc.table.GridTableType")) {