@sapui5/sap.fe.templates 1.141.1 → 1.142.0

package/src/sap/fe/templates/ObjectPage/ExtensionAPI.ts

@@ -1,4 +1,5 @@
 import Log from "sap/base/Log";
+import uid from "sap/base/util/uid";
 import { defineUI5Class } from "sap/fe/base/ClassSupport";
 import CommonUtils from "sap/fe/core/CommonUtils";
 import ExtensionAPI from "sap/fe/core/ExtensionAPI";
@@ -10,6 +11,11 @@ import ResourceModelHelper from "sap/fe/core/helpers/ResourceModelHelper";
 import type { SideEffectsTargetType } from "sap/fe/core/services/SideEffectsServiceFactory";
 import type Section from "sap/fe/macros/controls/Section";
 import type TableAPI from "sap/fe/macros/table/TableAPI";
+import Link from "sap/m/Link";
+import MessageItem from "sap/m/MessageItem";
+import MessagePopover from "sap/m/MessagePopover";
+import MessageStrip from "sap/m/MessageStrip";
+import type UI5Event from "sap/ui/base/Event";
 import type ManagedObject from "sap/ui/base/ManagedObject";
 import InvisibleMessage from "sap/ui/core/InvisibleMessage";
 import { InvisibleMessageMode } from "sap/ui/core/library";
@@ -20,6 +26,8 @@ import type Control from "sap/ui/mdc/Control";
 import type Table from "sap/ui/mdc/Table";
 import type Context from "sap/ui/model/Context";
 import type ODataV4Context from "sap/ui/model/odata/v4/Context";
+import type ObjectPageDynamicHeaderTitle from "sap/uxap/ObjectPageDynamicHeaderTitle";
+import type ObjectPageLayout from "sap/uxap/ObjectPageLayout";
 
 /**
  * Extension API for object pages on SAP Fiori elements for OData V4.
@@ -32,11 +40,16 @@ import type ODataV4Context from "sap/ui/model/odata/v4/Context";
  */
 @defineUI5Class("sap.fe.templates.ObjectPage.ExtensionAPI")
 class ObjectPageExtensionAPI extends ExtensionAPI {
+	/**
+	 * ID of the active custom MessageStrip for programmatic removal.
+	 */
+	private customMessageStripId?: string;
+
 	/**
 	 * Refreshes either the whole object page or only parts of it.
 	 * @param [vPath] Path or array of paths referring to entities or properties to be refreshed.
 	 * If omitted, the whole object page is refreshed. The path "" refreshes the entity assigned to the object page
-	 * without navigations
+	 * without navigation.
 	 * @returns Resolved once the data is refreshed or rejected if the request failed
 	 * @public
 	 */
@@ -141,23 +154,164 @@ class ObjectPageExtensionAPI extends ExtensionAPI {
 	}
 
 	/**
-	 * Displays the message strip between the title and the header of the ObjectPage.
-	 * @param  messages The message to be displayed
+	 * Displays the message strip between the title and the header of the ObjectPage. If only one message is provided, it is displayed directly in the message strip. If multiple messages are provided, they are prioritized by the order: Error, Warning, and Information and a corresponding generic text is displayed:
+	 * - Error: "The object contains errors."
+	 * - Warning: "The object contains warnings."
+	 * - Information: "The object contains messages."
+	 * If a back-end message is received with a target pointing to the Object Page, it is displayed in the message strip, overriding any existing message or message strip. If multiple back-end messages are received, the message with the highest priority is displayed with a generic text as described above.
+	 * @param  messagesOrStrip The message to be displayed or a MessageStrip control
 	 * @public
 	 */
+	showMessages(messagesOrStrip: Message[] | MessageStrip): void {
+		if (Array.isArray(messagesOrStrip)) {
+			this._showMessages(messagesOrStrip);
+		} else if (messagesOrStrip.isA("sap.m.MessageStrip")) {
+			this.showCustomMessageStrip(messagesOrStrip);
+		}
+	}
+
+	/**
+	 * Shows a custom MessageStrip control provided by the application.
+	 * Ensures mutual exclusivity with the MessageStrip rendered by the object page view.
+	 * @param messageStrip MessageStrip control
+	 * @private
+	 */
+	private showCustomMessageStrip(messageStrip: MessageStrip): void {
+		const messageStripInternalModelContext = this._view
+			.getModel("internal")
+			.bindContext(this._getMessageStripBindingContextPath())
+			.getBoundContext();
+		if (!messageStripInternalModelContext) {
+			return;
+		}
+
+		this.removeCustomMessageStrip(); // Remove any existing custom message strip before adding new one
+
+		// Hide framework generated message strip to ensure mutual exclusivity
+		messageStripInternalModelContext.setProperty("OPBackendMessageVisible", false);
+		messageStripInternalModelContext.setProperty("OPCustomMessageVisible", false);
+
+		this.customMessageStripId = messageStrip.getId() || uid(); // Store reference for programmatic removal
+
+		messageStrip.addStyleClass("sapUiSmallMarginTop");
+		this.addCustomMessageStripToPage(messageStrip, messageStripInternalModelContext);
+	}
+
+	/**
+	 * Adds a custom MessageStrip to the page layout in the header container such as in expanded and snapped content.
+	 * @param messageStrip The MessageStrip control to add
+	 * @param messagestripInternalModelContext
+	 */
+	private addCustomMessageStripToPage(messageStrip: MessageStrip, messagestripInternalModelContext: Context): void {
+		const headerContainer = this._view.byId("fe::ObjectPageDynamicHeaderTitle");
+		if (headerContainer) {
+			const insertIntoAggregation = (aggregationName: string, controlToInsert: MessageStrip): void => {
+				const aggregationContent = headerContainer.getAggregation(aggregationName);
+				if (aggregationContent) {
+					const contentArray = Array.isArray(aggregationContent) ? aggregationContent : [aggregationContent];
+					headerContainer.insertAggregation(aggregationName, controlToInsert, contentArray.length);
+				}
+			};
+			insertIntoAggregation("expandedContent", messageStrip);
+			insertIntoAggregation("snappedContent", messageStrip.clone());
+
+			messagestripInternalModelContext.setProperty("OPCustomMessageStripVisible", true);
+		}
+	}
+
+	/**
+	 * Removes the active custom MessageStrip programmatically.
+	 */
+	private removeCustomMessageStrip(): void {
+		if (!this.customMessageStripId) {
+			return;
+		}
+
+		// Find and remove the custom message strip from header container
+		const headerContainer = this._view.byId("fe::ObjectPageDynamicHeaderTitle");
+		if (headerContainer) {
+			const removeFromAggregation = (aggregationName: string, idMatcher: (controlId: string) => boolean): void => {
+				const aggregationContent = headerContainer.getAggregation(aggregationName) as Control[];
+				if (aggregationContent) {
+					const controlToRemove = aggregationContent.find((control) => idMatcher(control.getId()));
+					if (controlToRemove) {
+						headerContainer.removeAggregation(aggregationName, controlToRemove);
+						controlToRemove.destroy();
+					}
+				}
+			};
+			removeFromAggregation("expandedContent", (controlId) => controlId === this.customMessageStripId);
+			removeFromAggregation("snappedContent", (controlId) => controlId.includes(this.customMessageStripId + "-__clone"));
+		}
+
+		this.customMessageStripId = undefined;
+
+		const messagestripInternalModelContext = this._view
+			.getModel("internal")
+			.bindContext(this._getMessageStripBindingContextPath())
+			.getBoundContext();
+		if (messagestripInternalModelContext) {
+			messagestripInternalModelContext.setProperty("OPCustomMessageStripVisible", false);
+		}
+	}
+
+	/**
+	 * Creates a MessageItem from a Message instance.
+	 * @param message The message object containing text, type, description, etc.
+	 * @returns The created MessageItem instance for the MessagePopover.
+	 */
+	private createMessageItem(message: Message): MessageItem {
+		const sDescriptionUrl: string | undefined = message.getDescriptionUrl?.();
 
-	showMessages(messages: Message[]): void {
-		this._showMessages(messages);
+		return new MessageItem({
+			title: message.getMessage(),
+			description: message.getDescription(),
+			type: message.getType(),
+			longtextUrl: sDescriptionUrl,
+			subtitle: message.getAdditionalText?.(),
+			groupName: "T_MESSAGE_BUTTON_SAPFE_MESSAGE_GROUP_GENERAL",
+			activeTitle: !!message.getControlIds?.().length
+		});
+	}
+
+	/**
+	 * Creates a MessagePopover for a set of MessageItems and attaches
+	 * an async description handler to load long text when needed.
+	 * @param messageItems Array of MessageItems to be displayed in the popover.
+	 * @returns The created MessagePopover instance.
+	 */
+	createMessagePopover(messageItems: MessageItem): MessagePopover {
+		const popover = new MessagePopover({
+			items: messageItems
+		}) as MessagePopover;
+		return popover;
+	}
+
+	/**
+	 * Opens a MessagePopover for the provided messages, anchored to the
+	 * source control of the UI5 event.
+	 * @param event The UI5 event from the control that triggers the popover.
+	 * @param message Array of Message objects to be shown in the popover.
+	 * @returns The MessagePopover that was opened.
+	 */
+	showMessagePopover(event: UI5Event, message: Message[]): MessagePopover {
+		const messageItem = this.createMessageItem(message[0]);
+		const popover = this.createMessagePopover(messageItem);
+		const sourceControl = event.getSource?.() as Control;
+		sourceControl?.addDependent(popover);
+		popover.openBy(sourceControl);
+		return popover;
 	}
 
 	/**
 	 * Displays the message strip between the title and the header of the ObjectPage.
 	 * @param messages The message to be displayed
-	 * @param origin The origin of the message . It may come from a backend message or a custom message
+	 * @param origin The origin of the message. It may come from a back-end message or a custom message
 	 */
-
 	_showMessages(messages: Message[], origin: "Backend" | "Custom" = "Custom"): void {
 		try {
+			this.removeCustomMessageStrip();
+
 			const view = this._view;
 			const internalModel = view.getModel("internal");
 			const messagestripInternalModelContext = internalModel.bindContext(this._getMessageStripBindingContextPath()).getBoundContext();
@@ -165,14 +319,53 @@ class ObjectPageExtensionAPI extends ExtensionAPI {
 				return;
 			}
 			const resourceModel = ResourceModelHelper.getResourceModel(view);
-			let message: Message | null = null;
+			let message: Message | null = messages[0] || null;
 			messagestripInternalModelContext.setProperty(`OP${origin}MessageVisible`, !!message);
 			switch (messages.length) {
 				case 0:
 					break;
 				case 1:
 					message = messages[0];
-					messagestripInternalModelContext.setProperty(`OP${origin}MessageVisible`, !!message);
+					const hasDescriptionUrl = !!message?.getDescriptionUrl();
+					const isEditMode = CommonUtils.getIsEditable(view);
+					try {
+						const objectPage = view.getContent()?.[0] as ObjectPageLayout;
+						const headerTitle = objectPage.getHeaderTitle() as ObjectPageDynamicHeaderTitle;
+
+						// Collect all MessageStrips (excluding Collaboration Strips)
+						const allStrips = [
+							...(headerTitle.getSnappedContent?.() || []),
+							...(headerTitle.getExpandedContent?.() || [])
+						].filter(
+							(item): item is MessageStrip => item instanceof MessageStrip && !item.getId()?.includes("CollaborationStrip")
+						);
+
+						// Only add links when message is from Backend, in Display mode, and has a description URL
+						if (origin === "Backend" && !isEditMode && hasDescriptionUrl) {
+							allStrips.forEach((strip) => {
+								// Always destroy the existing link before creating a new one
+								if (strip.getLink()) {
+									strip.destroyLink();
+								}
+								const link = new Link({
+									text: resourceModel.getText("C_MESSAGE_HANDLING_SAPFE_ERROR_MESSAGE_STRIP_LINK_TEXT"),
+									press: (event: UI5Event): void => {
+										this.showMessagePopover(event, [message!]);
+									}
+								});
+								strip.setLink(link);
+							});
+						} else {
+							// Remove links when not applicable
+							allStrips.forEach((strip) => {
+								if (strip.getLink()) {
+									strip.destroyLink();
+								}
+							});
+						}
+					} catch (err) {
+						Log.warning("Unable to attach link to ObjectPage MessageStrip", err as Error);
+					}
 					break;
 				default:
 					const messageStats: { [key: string]: { id: number; count: number } } = {
@@ -218,13 +411,16 @@ class ObjectPageExtensionAPI extends ExtensionAPI {
 	 * @public
 	 */
 	hideMessage(): void {
-		const internalModel = this._view.getModel("internal");
-		const messagestripInternalModelContext = internalModel.bindContext(this._getMessageStripBindingContextPath()).getBoundContext()!;
+		const messagestripInternalModelContext = this._view
+			.getModel("internal")
+			.bindContext(this._getMessageStripBindingContextPath())
+			.getBoundContext()!;
 		messagestripInternalModelContext.setProperty(`OPCustomMessageVisible`, false);
+		this.removeCustomMessageStrip();
 	}
 
 	/**
-	 * This function will take the recommendation data details, transform it and update internal model with that.
+	 * This function will take the recommendation data details, transform it, and update the internal model.
 	 * @param data Recommendation data for the app
 	 */
 	setRecommendations(data: InCompletenessInfoType): void {
@@ -262,7 +458,7 @@ class ObjectPageExtensionAPI extends ExtensionAPI {
 		}
 		if (section) {
 			if (reuseComponent && section.getVisibleSubSections().length > 1) {
-				section.adjustForSingleContent(originalControl, { multipleSubSectionsWithReuseComponent : true });
+				section.adjustForSingleContent(originalControl, { multipleSubSectionsWithReuseComponent: true });
 			} else {
 				section.adjustForSingleContent(originalControl);
 			}

package/src/sap/fe/templates/ObjectPage/ObjectPage.view.xml

@@ -119,6 +119,10 @@
 							>
 								<core:Fragment fragmentName="sap.fe.templates.ObjectPage.view.fragments.Heading" type="XML" />
 								<uxap:content>
+									<core:InvisibleText
+										id="fe::AiAction::AriaText"
+										text="{sap.fe.i18n>C_ACCESSIBILITY_AI_ACTION_ARIA_TEXT}"
+									/>
 									<template:if test="{entitySet>@com.sap.vocabularies.Common.v1.DraftRoot}">
 										<macro:draftIndicator.DraftIndicator
 											draftIndicatorType="IconOnly"