@sapui5/sap.fe.templates 1.111.1 → 1.112.0

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

@@ -1,4 +1,3 @@
-import type ResourceBundle from "sap/base/i18n/ResourceBundle";
 import Log from "sap/base/Log";
 import merge from "sap/base/util/merge";
 import ActionRuntime from "sap/fe/core/ActionRuntime";
@@ -20,9 +19,11 @@ import ViewState from "sap/fe/core/controllerextensions/ViewState";
 import { defineUI5Class, extensible, finalExtension, publicExtension, usingExtension } from "sap/fe/core/helpers/ClassSupport";
 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 PageController from "sap/fe/core/PageController";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import DelegateUtil from "sap/fe/macros/DelegateUtil";
+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 { default as ObjectPageExtensionAPI } from "sap/fe/templates/ObjectPage/ExtensionAPI";
@@ -42,7 +43,6 @@ import type Context from "sap/ui/model/odata/v4/Context";
 import ODataContextBinding from "sap/ui/model/odata/v4/ODataContextBinding";
 import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
 import type ODataModel from "sap/ui/model/odata/v4/ODataModel";
-import type ResourceModel from "sap/ui/model/resource/ResourceModel";
 import type BreadCrumbs from "sap/uxap/BreadCrumbs";
 import type ObjectPageDynamicHeaderTitle from "sap/uxap/ObjectPageDynamicHeaderTitle";
 import type ObjectPageLayout from "sap/uxap/ObjectPageLayout";
@@ -58,18 +58,25 @@ import ViewStateOverrides from "./overrides/ViewState";
 @defineUI5Class("sap.fe.templates.ObjectPage.ObjectPageController")
 class ObjectPageController extends PageController {
 	oView!: any;
+
 	@usingExtension(Placeholder)
 	placeholder!: Placeholder;
+
 	@usingExtension(Share.override(ShareOverrides))
 	share!: Share;
+
 	@usingExtension(InternalRouting.override(InternalRoutingOverride))
 	_routing!: InternalRouting;
+
 	@usingExtension(Paginator.override(PaginatorOverride))
 	paginator!: Paginator;
+
 	@usingExtension(MessageHandler.override(MessageHandlerOverride))
 	messageHandler!: MessageHandler;
+
 	@usingExtension(IntentBasedNavigation.override(IntentBasedNavigationOverride))
 	intentBasedNavigation!: IntentBasedNavigation;
+
 	@usingExtension(
 		InternalIntentBasedNavigation.override({
 			getNavigationMode: function (this: InternalIntentBasedNavigation) {
@@ -81,8 +88,10 @@ class ObjectPageController extends PageController {
 		})
 	)
 	_intentBasedNavigation!: InternalIntentBasedNavigation;
+
 	@usingExtension(ViewState.override(ViewStateOverrides))
 	viewState!: ViewState;
+
 	@usingExtension(
 		PageReady.override({
 			isContextExpected: function () {
@@ -91,14 +100,20 @@ class ObjectPageController extends PageController {
 		})
 	)
 	pageReady!: PageReady;
+
 	@usingExtension(MassEdit)
 	massEdit!: MassEdit;
+
 	private mCustomSectionExtensionAPIs?: Record<string, ObjectPageExtensionAPI>;
+
 	protected extensionAPI?: ObjectPageExtensionAPI;
-	private oResourceBundle?: ResourceBundle;
+
 	private bSectionNavigated?: boolean;
+
 	private switchDraftAndActivePopOver?: Popover;
+
 	private currentBinding?: Binding;
+
 	private messageButton: any;
 
 	@publicExtension()
@@ -133,7 +148,7 @@ class ObjectPageController extends PageController {
 		});
 		oInternalModelContext?.setProperty("batchGroups", this._getBatchGroupsForView());
 		oInternalModelContext?.setProperty("errorNavigationSectionFlag", false);
-		if (!(this.getView().getViewData() as any).useNewLazyLoading && (oObjectPage as any).getEnableLazyLoading()) {
+		if (oObjectPage.getEnableLazyLoading()) {
 			//Attaching the event to make the subsection context binding active when it is visible.
 			oObjectPage.attachEvent("subSectionEnteredViewPort", this._handleSubSectionEnteredViewPort.bind(this));
 		}
@@ -203,16 +218,6 @@ class ObjectPageController extends PageController {
 		}
 	}
 
-	onAfterRendering() {
-		((this.getView().getModel("sap.fe.i18n") as ResourceModel).getResourceBundle() as Promise<ResourceBundle>)
-			.then((response: any) => {
-				this.oResourceBundle = response;
-			})
-			.catch(function (oError: any) {
-				Log.error("Error while retrieving the resource bundle", oError);
-			});
-	}
-
 	_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(),
@@ -233,8 +238,8 @@ class ObjectPageController extends PageController {
 			!aBatchGroups.some(opContext.getModel().hasPendingChanges.bind(opContext.getModel()))
 		) {
 			/* 	In case there are pending changes for the creation row and no others we need to reset the changes
-    						TODO: this is just a quick solution, this needs to be reworked
-    				 	*/
+								TODO: this is just a quick solution, this needs to be reworked
+								*/
 
 			opContext.getBinding().resetChanges();
 		}
@@ -281,9 +286,9 @@ class ObjectPageController extends PageController {
 					// if the binding type is not ODataListBinding because of a deeplink navigation or a refresh of the page
 					// we need to create it
 					const sBindingPath = oBinding.getPath();
-					if (/\([^\)]*\)$/.test(sBindingPath)) {
+					if (/\([^)]*\)$/.test(sBindingPath)) {
 						// The current binding path ends with (xxx), so we create the listBinding by removing (xxx)
-						const sListBindingPath = sBindingPath.replace(/\([^\)]*\)$/, "");
+						const sListBindingPath = sBindingPath.replace(/\([^)]*\)$/, "");
 						oBinding = new (ODataListBinding as any)(oBinding.oModel, sListBindingPath);
 						const _setListBindingAsync = () => {
 							if (oBinding.getContexts().length > 0) {
@@ -301,7 +306,8 @@ class ObjectPageController extends PageController {
 				}
 			}
 		}
-		if (!(this.getView().getViewData() as any).useNewLazyLoading && oObjectPage.getEnableLazyLoading()) {
+
+		if (oObjectPage.getEnableLazyLoading()) {
 			const aSections = oObjectPage.getSections();
 			const bUseIconTabBar = oObjectPage.getUseIconTabBar();
 			let iSkip = 2;
@@ -339,7 +345,7 @@ class ObjectPageController extends PageController {
 				// Due to the left alignment of the Draft switch and the collaborative draft avatar controls
 				// there is a ToolbarSpacer in the actions aggregation which we need to exclude here!
 				// Due to the ACC report, we also need not to check for the InvisibleText elements
-				if (oAction.isA("sap.fe.macros.ShareAPI")) {
+				if (oAction.isA("sap.fe.macros.share.ShareAPI")) {
 					// since ShareAPI does not have a disable property
 					// hence there is no need to check if it is disbaled or not
 					return oAction.getVisible();
@@ -504,44 +510,6 @@ class ObjectPageController extends PageController {
 
 		let oModel: any, oFinalUIState: any;
 
-		// TODO: this should be moved into an init event of the MDC tables (not yet existing) and should be part
-		// of any controller extension
-		/**
-		 * @param oTable
-		 * @param oListBinding
-		 */
-		async function enableFastCreationRow(oTable: any, oListBinding: any) {
-			const oFastCreationRow = oTable.getCreationRow();
-			let oFastCreationListBinding, oFastCreationContext;
-
-			if (oFastCreationRow) {
-				try {
-					await oFinalUIState;
-					if (oFastCreationRow.getModel("ui").getProperty("/isEditable")) {
-						oFastCreationListBinding = oModel.bindList(oListBinding.getPath(), oListBinding.getContext(), [], [], {
-							$$updateGroupId: "doNotSubmit",
-							$$groupId: "doNotSubmit"
-						});
-						// Workaround suggested by OData model v4 colleagues
-						oFastCreationListBinding.refreshInternal = function () {
-							/* do nothing */
-						};
-						oFastCreationContext = oFastCreationListBinding.create();
-						oFastCreationRow.setBindingContext(oFastCreationContext);
-
-						// this is needed to avoid console error
-						try {
-							await oFastCreationContext.created();
-						} catch (e) {
-							Log.trace("transient fast creation context deleted");
-						}
-					}
-				} catch (oError: any) {
-					Log.error("Error while computing the final UI state", oError);
-				}
-			}
-		}
-
 		// this should not be needed at the all
 		/**
 		 * @param oTable
@@ -549,7 +517,13 @@ class ObjectPageController extends PageController {
 		const handleTableModifications = (oTable: any) => {
 			const oBinding = this._getTableBinding(oTable),
 				fnHandleTablePatchEvents = function () {
-					enableFastCreationRow(oTable, oBinding);
+					TableHelper.enableFastCreationRow(
+						oTable.getCreationRow(),
+						oBinding.getPath(),
+						oBinding.getContext(),
+						oModel,
+						oFinalUIState
+					);
 				};
 
 			if (!oBinding) {
@@ -574,7 +548,7 @@ class ObjectPageController extends PageController {
 			oModel = oBindingContext.getModel();
 
 			// Compute Edit Mode
-			oFinalUIState = this._editFlow.computeEditMode(oBindingContext);
+			oFinalUIState = this.editFlow.computeEditMode(oBindingContext);
 
 			if (ModelHelper.isCollaborationDraftSupported(oModel.getMetaModel())) {
 				oFinalUIState
@@ -589,17 +563,8 @@ class ObjectPageController extends PageController {
 						Log.error("Error while waiting for the final UI State", oError);
 					});
 			}
-			// update related apps once Data is received in case of binding cache is not available
-			// TODO: this is only a temp solution since we need to call _updateRelatedApps method only after data for Object Page is received (if there is no binding)
-			if (oBindingContext.getBinding().oCache) {
-				this._updateRelatedApps();
-			} else {
-				const fnUpdateRelatedApps = () => {
-					this._updateRelatedApps();
-					oBindingContext.getBinding().detachDataReceived(fnUpdateRelatedApps);
-				};
-				oBindingContext.getBinding().attachDataReceived(fnUpdateRelatedApps);
-			}
+			// update related apps
+			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;
@@ -619,10 +584,8 @@ class ObjectPageController extends PageController {
 					});
 			});
 
-			if (!(this.getView().getViewData() as any).useNewLazyLoading) {
-				// should be called only after binding is ready hence calling it in onAfterBinding
-				(oObjectPage as any)._triggerVisibleSubSectionsEvents();
-			}
+			// should be called only after binding is ready hence calling it in onAfterBinding
+			(oObjectPage as any)._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());
@@ -848,24 +811,23 @@ class ObjectPageController extends PageController {
 	}
 
 	async _validateDocument(): Promise<void | any[] | ODataContextBinding> {
+		const appComponent = this.getAppComponent();
 		const control = Core.byId(Core.getCurrentFocusedControlId());
-		const context = control?.getBindingContext() as Context;
+		const context = control?.getBindingContext() as Context | undefined;
 		if (context && !context.isTransient()) {
-			// Wait for the pending changes before starting this validation
-			await this._editFlow.syncTask();
-			const appComponent = this.getAppComponent();
 			const sideEffectsService = appComponent.getSideEffectsService();
 			const entityType = sideEffectsService.getEntityTypeFromContext(context);
 			const globalSideEffects = entityType ? sideEffectsService.getGlobalODataEntitySideEffects(entityType) : [];
 			// 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((sideEffects) => this._sideEffects.requestSideEffects(sideEffects, context)));
-			} else {
-				const draftRootContext = await this.getDraftRootContext();
-				//Execute the draftValidation if there is no globalSideEffects (ignore ETags in collaboration draft)
-				if (draftRootContext) {
-					return draft.executeDraftValidation(draftRootContext, appComponent, isConnected(this.getView()));
-				}
+			}
+			const draftRootContext = await this.getDraftRootContext();
+			//Execute the draftValidation if there is no globalSideEffects (ignore ETags in collaboration draft)
+			if (draftRootContext) {
+				await this.editFlow.syncTask();
+				return draft.executeDraftValidation(draftRootContext, appComponent, isConnected(this.getView()));
 			}
 		}
 		return undefined;
@@ -949,7 +911,8 @@ class ObjectPageController extends PageController {
 	_updateRelatedApps() {
 		const oObjectPage = this._getObjectPageLayoutControl();
 		if (CommonUtils.resolveStringtoBoolean(oObjectPage.data("showRelatedApps"))) {
-			CommonUtils.updateRelatedAppsDetails(oObjectPage);
+			const appComponent = CommonUtils.getAppComponent(this.getView());
+			CommonUtils.updateRelatedAppsDetails(oObjectPage, appComponent);
 		}
 	}
 
@@ -973,6 +936,11 @@ class ObjectPageController extends PageController {
 					oElement = oElement[0];
 				}
 			}
+			// 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 (oElement && oElement.isA && oElement.isA("sap.m.Panel") && oElement.data("FullScreenTablePlaceHolder")) {
+				oElement = oElement.data("tableAPIreference");
+			}
 			if (oElement && oElement.isA && oElement.isA("sap.fe.macros.table.TableAPI")) {
 				oElement = oElement.getContent instanceof Function && oElement.getContent();
 				if (oElement && oElement.length > 0) {
@@ -986,7 +954,6 @@ class ObjectPageController extends PageController {
 					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();
 				if (oElement && oElement.length > 0) {
@@ -997,6 +964,7 @@ class ObjectPageController extends PageController {
 				aControls.push(oElement);
 			}
 		}
+
 		if (
 			aSubSectionTables.length === 1 &&
 			aParentElement.length === 1 &&
@@ -1384,7 +1352,7 @@ class ObjectPageController extends PageController {
 				return false;
 			});
 
-			const oCurrentActionPromise = this._editFlow.getCurrentActionPromise();
+			const oCurrentActionPromise = this.editFlow.getCurrentActionPromise();
 			if (oCurrentActionPromise) {
 				let aTableContexts: any;
 				if (oTable.getType().getMetadata().isA("sap.ui.mdc.table.GridTableType")) {
@@ -1427,7 +1395,7 @@ class ObjectPageController extends PageController {
 							} else {
 								oTable.focusRow(iNewItemp, true);
 							}
-							this._editFlow.deleteCurrentActionPromise();
+							this.editFlow.deleteCurrentActionPromise();
 						}
 					})
 					.catch(function (err: any) {
@@ -1527,7 +1495,7 @@ class ObjectPageController extends PageController {
 			//TODO: Should remove this setTimeOut once Variant Management provides an api to fetch the current variant key on save
 			setTimeout(() => {
 				this.getExtensionAPI().updateAppState();
-			}, 500);
+			}, 2000);
 		},
 		navigateToSubSection: function (oController: ObjectPageController, vDetailConfig: any) {
 			const oDetailConfig = typeof vDetailConfig === "string" ? JSON.parse(vDetailConfig) : vDetailConfig;
@@ -1546,20 +1514,13 @@ class ObjectPageController extends PageController {
 				oSection = oSubSection && (oSubSection.getParent() as ObjectPageSection);
 			}
 			if (!oSection || !oSubSection || !oSection.getVisible() || !oSubSection.getVisible()) {
-				((oController.getView().getModel("sap.fe.i18n") as ResourceModel).getResourceBundle() as Promise<ResourceBundle>)
-					.then(function (oResourceBundle) {
-						const sTitle = CommonUtils.getTranslatedText(
-							"C_ROUTING_NAVIGATION_DISABLED_TITLE",
-							oResourceBundle,
-							undefined,
-							(oController.getView().getViewData() as any).entitySet
-						);
-						Log.error(sTitle);
-						MessageBox.error(sTitle);
-					})
-					.catch(function (error) {
-						Log.error(error);
-					});
+				const sTitle = getResourceModel(oController).getText(
+					"C_ROUTING_NAVIGATION_DISABLED_TITLE",
+					undefined,
+					(oController.getView().getViewData() as any).entitySet
+				);
+				Log.error(sTitle);
+				MessageBox.error(sTitle);
 			} else {
 				oObjectPage.scrollToSection(oSubSection.getId());
 				// trigger iapp state change