@sapui5/sap.fe.macros 1.138.0 → 1.140.0

package/src/sap/fe/macros/Field.ts

@@ -20,6 +20,7 @@ import { generate } from "sap/fe/core/helpers/StableIdHelper";
 import { getContextRelativeTargetObjectPath, type DataModelObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
 import type Contact from "sap/fe/macros/contact/Contact";
 import type BuildingBlockObjectProperty from "sap/fe/macros/controls/BuildingBlockObjectProperty";
+import type ConditionalWrapper from "sap/fe/macros/controls/ConditionalWrapper";
 import type FieldWrapper from "sap/fe/macros/controls/FieldWrapper";
 import type TextLink from "sap/fe/macros/controls/TextLink";
 import FieldRuntime from "sap/fe/macros/field/FieldRuntime";
@@ -237,7 +238,6 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 	/**
 	 * This is used to optionally provide an external value that comes from a different model than the OData model.
 	 * It is designed to work with a field with value help, and without support for complex value help (currency / unit).
-	 * @experimental
 	 * @public
 	 */
 	@property({
@@ -251,7 +251,6 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 	/**
 	 * This is used to optionally provide an external description that comes from a different model than the oData model.
 	 * This should be used in conjunction with the value property.
-	 * @experimental
 	 * @public
 	 */
 	@property({
@@ -447,18 +446,27 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 			// a potential UNLOCK that would be sent in handleFocusOut, to make sure it's sent after the CHANGE message
 			controller?.collaborativeDraft.retainAsyncMessages(data);
 
-			const isDataUpdated = binding.hasPendingChanges();
-			if (isDataUpdated) {
+			const sendCollaborationMessagesAfterPatchCompleted = (): void => {
 				// The value has been changed by the user --> wait until it's sent to the server before sending a notification to other users
 				binding.attachEventOnce("patchCompleted", function () {
 					controller?.collaborativeDraft.send({ action: Activity.Change, content: data });
 					controller?.collaborativeDraft.releaseAsyncMessages(data);
 				});
+			};
+
+			const isDataUpdated = binding.hasPendingChanges();
+			if (isDataUpdated) {
+				sendCollaborationMessagesAfterPatchCompleted();
 			}
 
 			const updateCollaboration = (): void => {
 				if (!isDataUpdated) {
-					controller?.collaborativeDraft.releaseAsyncMessages(data);
+					// We need to check again if the binding has some pending changes, since it may have been updated once the Field value is resolved
+					if (binding.hasPendingChanges()) {
+						sendCollaborationMessagesAfterPatchCompleted();
+					} else {
+						controller?.collaborativeDraft.releaseAsyncMessages(data);
+					}
 				}
 			};
 			if (source.isA("sap.ui.mdc.Field") || (source as Control).isA("sap.ui.mdc.MultiValueField")) {
@@ -544,8 +552,27 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 		this._setAriaLabelledBy(this.content as unknown as ControlWithAccessibility);
 	}
 
+	private getInnerControl(source: Control): Control | undefined {
+		if (source?.isA("sap.fe.macros.controls.FieldWrapper") && !source?.isA("sap.fe.macros.controls.FileWrapper")) {
+			const fieldWrapper = source as EnhanceWithUI5<FieldWrapper>;
+			const controls = fieldWrapper.getContentEdit() as Control[];
+			let innerControl;
+			if (controls.length >= 1) {
+				innerControl = controls[0];
+			}
+			if (innerControl?.isA("sap.m.HBox")) {
+				innerControl = (innerControl as HBox).getItems()[0];
+			}
+			return innerControl;
+		}
+	}
+
 	onAfterRendering(): void {
-		if (this.collaborationEnabled && !this.focusHandlersAttached) {
+		const editControl = this.getInnerControl(this.content);
+		const notLockControls = ["sap.m.CheckBox"];
+
+		const canLock = !notLockControls.includes(editControl?.getMetadata().getName() ?? "");
+		if (this.collaborationEnabled && !this.focusHandlersAttached && canLock) {
 			// The event delegate doesn't work on the Field, we need to put it on its content (FieldWrapper)
 			this.content?.addEventDelegate(
 				{
@@ -577,6 +604,15 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 		}
 	}
 
+	/**
+	 * Method to determine if the field has some Mdc field with pending user input.
+	 * @returns True if the field has pending user input, false otherwise
+	 */
+	hasPendingUserInput(): boolean {
+		const targetControl = Field.getControlInFieldWrapper(this.getContent());
+		return !!(targetControl && targetControl.isA<mdcField>("sap.ui.mdc.Field") && targetControl.hasPendingUserInput());
+	}
+
 	/**
 	 * Returns the label controls of the field
 	 * when being referenced by the 'labelFor' attribute on the label or when in a form.
@@ -707,63 +743,69 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 	 */
 	getEnabled(): boolean {
 		let control = Field.getControlInFieldWrapper(this.content);
-		if (control !== null && control !== undefined && !control?.isA("sap.m.Text")) {
-			//check needed for file wrapper which does not have a content
-			if (this.collaborationEnabled && control.isA<HBox>("sap.m.HBox")) {
-				// for chaining reasons, let´s keep it like that
-				control = control.getItems()[0];
-			}
-			if (control.isA<VBox>("sap.m.VBox")) {
-				// for chaining reasons, let´s keep it like that
-				control = control.getItems()[0];
-			}
 
-			// we need to call the getProperty in the following examples
-			// otherwise we end up in a max call stack size
-			if (control.isA<CheckBox>("sap.m.CheckBox")) {
-				return control.getProperty("enabled");
-			} else if (control.isA<InputBase>("sap.m.InputBase")) {
-				return control.getProperty("enabled");
-			} else if (control.isA<Link>("sap.m.Link")) {
-				return control.getProperty("enabled");
-			} else if (control.isA<Button>("sap.m.Button")) {
-				return control.getProperty("enabled");
-			} else if (control.isA<ObjectStatus>("sap.m.ObjectStatus")) {
-				return true;
-			} else if (control.isA<ObjectIdentifier>("sap.m.ObjectIdentifier")) {
-				return true;
-			} else if (control.isA<FormElementWrapper>("sap.fe.core.controls.FormElementWrapper")) {
-				// It is for a Draft Indicator
-				return true;
-			} else if (control.isA<DataPoint>("sap.fe.macros.internal.DataPoint")) {
-				return control.getEnabled();
-			} else if (control.isA<Email>("sap.fe.macros.contact.Email")) {
-				return control.getProperty("linkEnabled");
-			} else if (control.isA<Contact>("sap.fe.macros.contact.Contact")) {
-				return control.getEnabled();
-			} else if (control.isA<ExpandableText>("sap.m.ExpandableText")) {
-				// otherwise show more would be inactive
-				return true;
-			} else if (control.isA<mdcField>("sap.ui.mdc.Field")) {
-				const editMode = control.getEditMode();
-				// The mdc field does not have a direct property "enabled", therefore we map
-				// the internal disabled setting of the edit mode in this graceful pattern
-				return editMode !== FieldEditMode.Disabled;
-			} else if (control.isA<FileWrapper>("sap.fe.macros.controls.FileWrapper")) {
-				// The file wrapper could contain a link or an avatar with a delete button,
-				// we must ensure the enablement in both cases
-				return control.link ? control.link.getProperty("enabled") : true;
-			} else if (
-				control.isA("sap.fe.macros.controls.ConditionalWrapper") ||
-				(control as Control).isA<TextLink>("sap.fe.macros.controls.TextLink")
-			) {
-				return true;
-			} else {
-				return false;
-			}
-		} else {
+		if (control === null || control === undefined || control?.isA("sap.m.Text")) {
 			return true;
 		}
+
+		// Handle collaboration-enabled HBox
+		if (this.collaborationEnabled && control.isA<HBox>("sap.m.HBox")) {
+			control = control.getItems()[0];
+		}
+
+		// Handle VBox wrapper
+		if (control.isA<VBox>("sap.m.VBox")) {
+			control = control.getItems()[0];
+		}
+
+		// Handle property-based controls that use "enabled" property
+		if (
+			control.isA<CheckBox>("sap.m.CheckBox") ||
+			control.isA<InputBase>("sap.m.InputBase") ||
+			control.isA<Link>("sap.m.Link") ||
+			control.isA<Button>("sap.m.Button")
+		) {
+			return control.getProperty("enabled");
+		}
+
+		// Handle controls that are always enabled
+		if (
+			control.isA<ObjectStatus>("sap.m.ObjectStatus") ||
+			control.isA<ObjectIdentifier>("sap.m.ObjectIdentifier") ||
+			control.isA<FormElementWrapper>("sap.fe.core.controls.FormElementWrapper") ||
+			control.isA<ExpandableText>("sap.m.ExpandableText") ||
+			control.isA<typeof ConditionalWrapper>("sap.fe.macros.controls.ConditionalWrapper") ||
+			control.isA<TextLink>("sap.fe.macros.controls.TextLink")
+		) {
+			return true;
+		}
+
+		// Handle special property cases
+		if (control.isA<DataPoint>("sap.fe.macros.internal.DataPoint") || control.isA<Contact>("sap.fe.macros.contact.Contact")) {
+			return control.getEnabled();
+		}
+
+		if (control.isA<Email>("sap.fe.macros.contact.Email")) {
+			return control.getProperty("linkEnabled");
+		}
+
+		// Handle MDC Field special case
+		if (control.isA<mdcField>("sap.ui.mdc.Field")) {
+			const editMode = control.getEditMode();
+			return editMode !== FieldEditMode.Disabled;
+		}
+
+		// Handle FileWrapper special case
+		if (control.isA<FileWrapper>("sap.fe.macros.controls.FileWrapper")) {
+			return control.link ? control.link.getProperty("enabled") : true;
+		}
+
+		// Handle HBox with SituationsIndicator at item[1]
+		if ((control as HBox).isA?.("sap.m.HBox") && (control as HBox).getItems()[1]?.isA("sap.fe.macros.situations.SituationsIndicator")) {
+			return true;
+		}
+
+		return false;
 	}
 
 	/**
@@ -951,6 +993,8 @@ class Field extends MacroAPI<{ readOnly: boolean; semanticObject: string }> {
 		preparedProperties.isDynamicInstantiation = true;
 		if (preparedProperties.mainPropertyRelativePath) this.mainPropertyRelativePath = preparedProperties.mainPropertyRelativePath;
 		if (preparedProperties.collaborationEnabled) this.collaborationEnabled = preparedProperties.collaborationEnabled;
+		if (preparedProperties.displayStyle === "File")
+			preparedProperties.fileUploaderVisible = !this.readOnly && preparedProperties.editableExpression;
 		return preparedProperties;
 	}