@sapui5/sap.fe.templates 1.106.0 → 1.108.0

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

@@ -4,7 +4,7 @@ import merge from "sap/base/util/merge";
 import ActionRuntime from "sap/fe/core/ActionRuntime";
 import CommonUtils from "sap/fe/core/CommonUtils";
 import BusyLocker from "sap/fe/core/controllerextensions/BusyLocker";
-import { connect } from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
+import { connect, disconnect, isConnected } from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
 import { openManageDialog, showUserDetails } from "sap/fe/core/controllerextensions/collaboration/Manage";
 import EditFlow from "sap/fe/core/controllerextensions/EditFlow";
 import draft from "sap/fe/core/controllerextensions/editFlow/draft";
@@ -19,10 +19,13 @@ import Paginator from "sap/fe/core/controllerextensions/Paginator";
 import Placeholder from "sap/fe/core/controllerextensions/Placeholder";
 import Share from "sap/fe/core/controllerextensions/Share";
 import ViewState from "sap/fe/core/controllerextensions/ViewState";
+import * as MetaModelConverter from "sap/fe/core/converters/MetaModelConverter";
 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 PageController from "sap/fe/core/PageController";
+import type RootContainerBaseController from "sap/fe/core/rootView/RootViewBaseController";
+import RootViewBaseController from "sap/fe/core/rootView/RootViewBaseController";
 import ChartRuntime from "sap/fe/macros/chart/ChartRuntime";
 import CommonHelper from "sap/fe/macros/CommonHelper";
 import DelegateUtil from "sap/fe/macros/DelegateUtil";
@@ -30,7 +33,6 @@ 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";
 import { default as ExtensionAPI } from "sap/fe/templates/ObjectPage/ExtensionAPI";
-import type RootContainerBaseController from "sap/fe/templates/RootContainer/controller/RootContainerBaseController";
 import EditFlowOverrides from "sap/fe/templates/RootContainer/overrides/EditFlow";
 import TableScroller from "sap/fe/templates/TableScroller";
 import InstanceManager from "sap/m/InstanceManager";
@@ -38,7 +40,9 @@ 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 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 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";
@@ -51,6 +55,7 @@ import type ObjectPageDynamicHeaderTitle from "sap/uxap/ObjectPageDynamicHeaderT
 import type ObjectPageLayout from "sap/uxap/ObjectPageLayout";
 import type ObjectPageSection from "sap/uxap/ObjectPageSection";
 import type ObjectPageSubSection from "sap/uxap/ObjectPageSubSection";
+import type { ODataContextBindingEx, V4Context } from "types/extension_types";
 import IntentBasedNavigationOverride from "./overrides/IntentBasedNavigation";
 import InternalRoutingOverride from "./overrides/InternalRouting";
 import MessageHandlerOverride from "./overrides/MessageHandler";
@@ -101,11 +106,12 @@ class ObjectPageController extends PageController {
 	@usingExtension(MassEdit)
 	massEdit!: MassEdit;
 	private mCustomSectionExtensionAPIs?: Record<string, ObjectPageExtensionAPI>;
-	private extensionAPI?: ObjectPageExtensionAPI;
+	protected extensionAPI?: ObjectPageExtensionAPI;
 	private oResourceBundle?: ResourceBundle;
 	private bSectionNavigated?: boolean;
 	private switchDraftAndActivePopOver?: Popover;
 	private currentBinding?: Binding;
+	private messageButton: any;
 
 	@publicExtension()
 	@finalExtension()
@@ -132,17 +138,19 @@ class ObjectPageController extends PageController {
 
 		// Setting defaults of internal model context
 		const oInternalModelContext = this.getView().getBindingContext("internal") as InternalModelContext;
-		oInternalModelContext.setProperty("externalNavigationContext", { "page": true });
-		oInternalModelContext.setProperty("relatedApps", {
+		oInternalModelContext?.setProperty("externalNavigationContext", { "page": true });
+		oInternalModelContext?.setProperty("relatedApps", {
 			visibility: false,
 			items: null
 		});
-		oInternalModelContext.setProperty("batchGroups", this._getBatchGroupsForView());
-		oInternalModelContext.setProperty("errorNavigationSectionFlag", false);
+		oInternalModelContext?.setProperty("batchGroups", this._getBatchGroupsForView());
+		oInternalModelContext?.setProperty("errorNavigationSectionFlag", false);
 		if (!(this.getView().getViewData() as any).useNewLazyLoading && (oObjectPage as any).getEnableLazyLoading()) {
 			//Attaching the event to make the subsection context binding active when it is visible.
 			oObjectPage.attachEvent("subSectionEnteredViewPort", this._handleSubSectionEnteredViewPort.bind(this));
 		}
+		this.messageButton = this.getView().byId("fe::FooterBar::MessageButton");
+		this.messageButton.oItemBinding.attachChange(this._fnShowOPMessage, this);
 	}
 
 	onExit() {
@@ -159,8 +167,7 @@ class ObjectPageController extends PageController {
 		}
 		delete this.extensionAPI;
 
-		const oMessageButton = this.getView().byId("fe::FooterBar::MessageButton"),
-			oMessagePopover = oMessageButton ? (oMessageButton as any).oMessagePopover : null;
+		const oMessagePopover = this.messageButton ? this.messageButton.oMessagePopover : null;
 		if (oMessagePopover && oMessagePopover.isOpen()) {
 			oMessagePopover.close();
 		}
@@ -169,6 +176,29 @@ class ObjectPageController extends PageController {
 		if (oContext && oContext.isKeepAlive()) {
 			oContext.setKeepAlive(false);
 		}
+		if (isConnected(this.getView())) {
+			disconnect(this.getView()); // Cleanup collaboration connection when leaving the app
+		}
+	}
+
+	/**
+	 * Method to show the message strip on the object page.
+	 *
+	 * @private
+	 */
+	_fnShowOPMessage() {
+		const extensionAPI = this.getExtensionAPI();
+		const view = this.getView();
+		const messages = this.messageButton.oMessagePopover
+			.getItems()
+			.map((item: any) => item.getBindingContext("message").getObject())
+			.filter((message: Message) => {
+				return message.getTargets()[0] === view.getBindingContext()?.getPath();
+			});
+
+		if (extensionAPI) {
+			extensionAPI.showMessages(messages);
+		}
 	}
 
 	_getTableBinding(oTable: any) {
@@ -319,12 +349,13 @@ 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
-				return (
-					!oAction.isA("sap.ui.core.InvisibleText") &&
-					!oAction.isA("sap.m.ToolbarSpacer") &&
-					oAction.getVisible() &&
-					oAction.getEnabled()
-				);
+				if (oAction.isA("sap.fe.macros.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();
+				} else if (!oAction.isA("sap.ui.core.InvisibleText") && !oAction.isA("sap.m.ToolbarSpacer")) {
+					return oAction.getVisible() && oAction.getEnabled();
+				}
 			});
 		}
 		return oFirstClickableElement;
@@ -560,6 +591,8 @@ class ObjectPageController extends PageController {
 					.then(() => {
 						if (this.getView().getModel("ui").getProperty("/isEditable")) {
 							connect(this.getView());
+						} else if (isConnected(this.getView())) {
+							disconnect(this.getView()); // Cleanup collaboration connection in case we switch to another element (e.g. in FCL)
 						}
 					})
 					.catch(function (oError: any) {
@@ -619,7 +652,9 @@ class ObjectPageController extends PageController {
 				}
 			} else {
 				const oSelectedSection: any = Core.byId(oObjectPage.getSelectedSection());
-				this._updateFocusInEditMode(oSelectedSection.getSubSections());
+				if (oSelectedSection) {
+					this._updateFocusInEditMode(oSelectedSection.getSubSections());
+				}
 			}
 		};
 		// Apply app state only after the page is ready with the first section selected
@@ -751,7 +786,7 @@ class ObjectPageController extends PageController {
 			? rootViewController.getRightmostView()
 			: (this.getAppComponent().getRootContainer() as any).getCurrentPage();
 		if (!currentPageView.isA("sap.m.MessagePage")) {
-			const oMessageButton = this.getView().byId("fe::FooterBar::MessageButton") as any,
+			const oMessageButton = this.messageButton,
 				oMessagePopover = oMessageButton.oMessagePopover,
 				oItemBinding = oMessagePopover.getBinding("items");
 
@@ -773,6 +808,74 @@ class ObjectPageController extends PageController {
 			BusyLocker.unlock(oModel);
 		});
 	}
+	/**
+	 * 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<V4Context | undefined> {
+		const view = this.getView();
+		const context = view.getBindingContext() as V4Context;
+		if (context) {
+			const draftRootContextPath = ModelHelper.getDraftRootPath(context);
+			let simpleDraftRootContext: V4Context;
+			if (draftRootContextPath) {
+				// Check if a view matches with the draft root path
+				const existingBindingContextOnPage = (this.getAppComponent().getRootViewController() as RootViewBaseController)
+					.getInstancedViews()
+					.find((pageView: View) => pageView.getBindingContext()?.getPath() === draftRootContextPath)
+					?.getBindingContext() as V4Context;
+				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();
+				const metaModel = model.getMetaModel();
+				const sEntityPath = metaModel.getMetaPath(draftRootContextPath);
+				const mDataModel = MetaModelConverter.getInvolvedDataModelObjects(metaModel.getContext(sEntityPath));
+				simpleDraftRootContext = model.bindContext(draftRootContextPath).getBoundContext();
+				await simpleDraftRootContext.requestProperty(mDataModel.targetEntityType.keys[0]?.name);
+				// 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[] | ODataContextBindingEx> {
+		const control = Core.byId(Core.getCurrentFocusedControlId());
+		const context = control?.getBindingContext() as V4Context;
+		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) {
+				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
+				if (draftRootContext) {
+					return draft.executeDraftValidation(draftRootContext, appComponent);
+				}
+			}
+		}
+		return undefined;
+	}
 
 	async _saveDocument(oContext: any) {
 		const oModel = this.getView().getModel("ui"),
@@ -856,10 +959,20 @@ class ObjectPageController extends PageController {
 		}
 	}
 
-	_findTableInSubSection(aParentElement: any, aSubsection: any, aTables: any) {
+	_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) {
+				if (oElement && oElement.mAggregations && oElement.getAggregation("items")) {
+					const aItems = oElement.getAggregation("items");
+					aItems.forEach(function (oItem: any) {
+						if (oItem.isA("sap.fe.macros.chart.ChartAPI")) {
+							oElement = oItem;
+						}
+					});
+				}
+			}
 			if (oElement && oElement.isA && oElement.isA("sap.ui.layout.DynamicSideContent")) {
 				oElement = oElement.getMainContent instanceof Function && oElement.getMainContent();
 				if (oElement && oElement.length > 0) {
@@ -873,12 +986,22 @@ class ObjectPageController extends PageController {
 				}
 			}
 			if (oElement && oElement.isA && oElement.isA("sap.ui.mdc.Table")) {
-				aTables.push(oElement);
+				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();
+				if (oElement && oElement.length > 0) {
+					oElement = oElement[0];
+				}
+			}
+			if (oElement && oElement.isA && oElement.isA("sap.ui.mdc.Chart")) {
+				aControls.push(oElement);
+			}
 		}
 		if (
 			aSubSectionTables.length === 1 &&
@@ -888,13 +1011,6 @@ class ObjectPageController extends PageController {
 		) {
 			//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");
-		} else if (aSubSectionTables && !aSubsection.hasStyleClass("sapUxAPObjectPageSubSectionFitContainer")) {
-			aSubSectionTables.forEach(function (oTable: { table: any; gridTable: any }) {
-				if (oTable.gridTable) {
-					//Resetting the row count to default value in case we have a combination of forms and tables or multiple tables in a subsection
-					oTable.table.getType().setRowCount(null);
-				}
-			});
 		}
 	}
 
@@ -919,12 +1035,22 @@ class ObjectPageController extends PageController {
 		const aSubSections = this._getAllSubSections();
 		const aTables: any[] = [];
 		for (let subSection = 0; subSection < aSubSections.length; subSection++) {
-			this._findTableInSubSection(aSubSections[subSection].getBlocks(), aSubSections[subSection], aTables);
-			this._findTableInSubSection(aSubSections[subSection].getMoreBlocks(), aSubSections[subSection], aTables);
+			this._findControlInSubSection(aSubSections[subSection].getBlocks(), aSubSections[subSection], aTables);
+			this._findControlInSubSection(aSubSections[subSection].getMoreBlocks(), aSubSections[subSection], aTables);
 		}
 		return aTables;
 	}
 
+	_findCharts() {
+		const aSubSections = this._getAllSubSections();
+		const aCharts: any[] = [];
+		for (let subSection = 0; subSection < aSubSections.length; subSection++) {
+			this._findControlInSubSection(aSubSections[subSection].getBlocks(), aSubSections[subSection], aCharts, true);
+			this._findControlInSubSection(aSubSections[subSection].getMoreBlocks(), aSubSections[subSection], aCharts, true);
+		}
+		return aCharts;
+	}
+
 	_closeSideContent() {
 		this._getAllBlocks().forEach(function (oBlock: any) {
 			const oContent = oBlock.getContent instanceof Function && oBlock.getContent();
@@ -1097,7 +1223,8 @@ class ObjectPageController extends PageController {
 				oLink = oSource.getLinks()[idx] ? oSource.getLinks()[idx] : new Link();
 				//sCurrentEntity is a fallback value in case of empty title
 				oLink.setText(titleHierarchyInfo.subtitle || titleHierarchyInfo.title);
-				oLink.setHref(titleHierarchyInfo.intent);
+				//We apply an additional encodeURI in case of special characters (ie "/") used in the url through the semantic keys
+				oLink.setHref(encodeURI(titleHierarchyInfo.intent));
 				if (!oSource.getLinks()[idx]) {
 					oSource.addLink(oLink);
 				}
@@ -1204,6 +1331,54 @@ class ObjectPageController extends PageController {
 	}
 
 	handlers = {
+		/**
+		 * Invokes the page primary action on press of Ctrl+Enter.
+		 *
+		 * @param oController The page controller
+		 * @param oView
+		 * @param oContext Context for which the action is called
+		 * @param sActionName The name of the action to be called
+		 * @param [mParameters] Contains the following attributes:
+		 * @param [mParameters.contexts] Mandatory for a bound action, either one context or an array with contexts for which the action is called
+		 * @param [mParameters.model] Mandatory for an unbound action; an instance of an OData V4 model
+		 * @param [mConditions] Contains the following attributes:
+		 * @param [mConditions.positiveActionVisible] The visibility of sematic positive action
+		 * @param [mConditions.positiveActionEnabled] The enablement of semantic positive action
+		 * @param [mConditions.editActionVisible] The Edit button visibility
+		 * @param [mConditions.editActionEnabled] The enablement of Edit button
+		 * @ui5-restricted
+		 * @final
+		 */
+		onPrimaryAction(
+			oController: ObjectPageController,
+			oView: View,
+			oContext: Context,
+			sActionName: string,
+			mParameters: unknown,
+			mConditions: {
+				positiveActionVisible: boolean;
+				positiveActionEnabled: boolean;
+				editActionVisible: boolean;
+				editActionEnabled: boolean;
+			}
+		) {
+			const iViewLevel = (oController.getView().getViewData() as any).viewLevel,
+				oObjectPage = oController._getObjectPageLayoutControl();
+			if (mConditions.positiveActionVisible) {
+				if (mConditions.positiveActionEnabled) {
+					oController.handlers.onCallAction(oView, sActionName, mParameters);
+				}
+			} else if (mConditions.editActionVisible && iViewLevel === 1) {
+				if (mConditions.editActionEnabled) {
+					oController._editDocument(oContext);
+				}
+			} else if (iViewLevel === 1 && oObjectPage.getModel("ui").getProperty("/isEditable")) {
+				oController._saveDocument(oContext);
+			} else if (oObjectPage.getModel("ui").getProperty("/isEditable")) {
+				oController._applyDocument(oContext);
+			}
+		},
+
 		onTableContextChange(this: ObjectPageController, oEvent: any) {
 			const oSource = oEvent.getSource();
 			let oTable: any;
@@ -1266,8 +1441,7 @@ class ObjectPageController extends PageController {
 					});
 			}
 			// fire ModelContextChange on the message button whenever the table context changes
-			const oMessageButton = this.getView().byId("fe::FooterBar::MessageButton");
-			oMessageButton.fireModelContextChange();
+			this.messageButton.fireModelContextChange();
 		},
 
 		/**
@@ -1276,7 +1450,7 @@ class ObjectPageController extends PageController {
 		 * @param oView
 		 * @param sActionName The name of the action to be called
 		 * @param [mParameters] Contains the following attributes:
-		 * @param [mParameters.contexts] Mandatory for a bound action, either one context or an array with contexts for which the action shall be called
+		 * @param [mParameters.contexts] Mandatory for a bound action, either one context or an array with contexts for which the action is called
 		 * @param [mParameters.model] Mandatory for an unbound action; an instance of an OData V4 model
 		 * @returns The action promise
 		 * @ui5-restricted
@@ -1403,6 +1577,9 @@ class ObjectPageController extends PageController {
 		},
 		onChartSelectionChanged: function (oEvent: any) {
 			ChartRuntime.fnUpdateChart(oEvent);
+		},
+		onStateChange(this: ObjectPageController) {
+			this.getExtensionAPI().updateAppState();
 		}
 	};
 }