@sapui5/sap.fe.core 1.93.3 → 1.97.0

package/src/sap/fe/core/converters/controls/Common/Form.ts

@@ -6,19 +6,21 @@ import {
 	FacetTypes,
 	FieldGroup,
 	Identification,
+	PartOfPreview,
 	ReferenceFacetTypes,
 	UIAnnotationTerms,
 	UIAnnotationTypes
 } from "@sap-ux/vocabularies-types";
 import { BindingExpression } from "sap/fe/core/helpers/BindingExpression";
 import { ConfigurableObject, CustomElement, insertCustomElements, Placement } from "../../helpers/ConfigurableObject";
-import { FormID } from "../../helpers/ID";
+import { FormID, FormStandardActionButtonID } from "../../helpers/ID";
 import { KeyHelper } from "../../helpers/Key";
-import { FormManifestConfiguration, FormatOptionsType } from "../../ManifestSettings";
+import { ActionType, FormatOptionsType, FormManifestConfiguration } from "../../ManifestSettings";
 import { getSemanticObjectPath } from "sap/fe/core/converters/annotations/DataField";
 import { getTargetEntitySetPath, getTargetObjectPath } from "sap/fe/core/templating/DataModelPathHelper";
 import { generate } from "../../../helpers/StableIdHelper";
 import ConverterContext from "../../ConverterContext";
+import { BaseAction, ConverterAction } from "sap/fe/core/converters/controls/Common/Action";
 
 export type FormDefinition = {
 	id: string;
@@ -32,6 +34,7 @@ export enum FormElementType {
 }
 
 export type BaseFormElement = ConfigurableObject & {
+	id?: string;
 	type: FormElementType;
 	label?: string;
 	visible?: BindingExpression<boolean>;
@@ -43,6 +46,7 @@ export type AnnotationFormElement = BaseFormElement & {
 	annotationPath?: string;
 	isValueMultilineText?: boolean;
 	semanticObjectPath?: string;
+	isPartOfPreview?: boolean;
 };
 
 export type CustomFormElement = CustomElement<
@@ -59,6 +63,7 @@ type FormContainer = {
 	formElements: FormElement[];
 	annotationPath: string;
 	entitySet?: string;
+	actions?: ConverterAction[] | BaseAction[];
 };
 
 /**
@@ -68,11 +73,17 @@ type FormContainer = {
  */
 function getDefaultFormatOptionsForForm(): FormatOptionsType {
 	return {
-		textLinesDisplay: 0,
 		textLinesEdit: 4
 	};
 }
 
+function isFieldPartOfPreview(field: DataFieldAbstractTypes, formPartOfPreview: PartOfPreview | undefined): boolean {
+	// Both each form and field can have the PartOfPreview annotation. Only if the form is not hidden (not partOfPreview) we allow toggling on field level
+	return (
+		formPartOfPreview === false || field.annotations?.UI?.PartOfPreview === undefined || field.annotations?.UI?.PartOfPreview === true
+	);
+}
+
 function getFormElementsFromAnnotations(facetDefinition: ReferenceFacetTypes, converterContext: ConverterContext): AnnotationFormElement[] {
 	const formElements: AnnotationFormElement[] = [];
 	const resolvedTarget = converterContext.getEntityTypeAnnotation(facetDefinition.Target.value);
@@ -81,7 +92,7 @@ function getFormElementsFromAnnotations(facetDefinition: ReferenceFacetTypes, co
 		| AnnotationTerm<FieldGroup>;
 	converterContext = resolvedTarget.converterContext;
 
-	function getDataFieldsFromAnnotations(field: DataFieldAbstractTypes) {
+	function getDataFieldsFromAnnotations(field: DataFieldAbstractTypes, formPartOfPreview: PartOfPreview | undefined) {
 		const semanticObjectAnnotationPath = getSemanticObjectPath(converterContext, field);
 		if (
 			field.$Type !== UIAnnotationTypes.DataFieldForAction &&
@@ -93,17 +104,22 @@ function getFormElementsFromAnnotations(facetDefinition: ReferenceFacetTypes, co
 				type: FormElementType.Annotation,
 				annotationPath: converterContext.getEntitySetBasedAnnotationPath(field.fullyQualifiedName) + "/",
 				semanticObjectPath: semanticObjectAnnotationPath,
-				formatOptions: getDefaultFormatOptionsForForm()
+				formatOptions: getDefaultFormatOptionsForForm(),
+				isPartOfPreview: isFieldPartOfPreview(field, formPartOfPreview)
 			});
 		}
 	}
 
 	switch (formAnnotation?.term) {
 		case UIAnnotationTerms.FieldGroup:
-			(formAnnotation as AnnotationTerm<FieldGroup>).Data.forEach(getDataFieldsFromAnnotations);
+			(formAnnotation as AnnotationTerm<FieldGroup>).Data.forEach(field =>
+				getDataFieldsFromAnnotations(field, facetDefinition.annotations?.UI?.PartOfPreview)
+			);
 			break;
 		case UIAnnotationTerms.Identification:
-			(formAnnotation as AnnotationTerm<Identification>).forEach(getDataFieldsFromAnnotations);
+			(formAnnotation as AnnotationTerm<Identification>).forEach(field =>
+				getDataFieldsFromAnnotations(field, facetDefinition.annotations?.UI?.PartOfPreview)
+			);
 			break;
 		case UIAnnotationTerms.DataPoint:
 			formElements.push({
@@ -138,6 +154,7 @@ export function getFormElementsFromManifest(
 		Object.keys(manifestFormContainer?.fields).forEach(fieldId => {
 			formElements[fieldId] = {
 				key: fieldId,
+				id: "CustomFormElement::" + fieldId,
 				type: FormElementType.Default,
 				template: manifestFormContainer.fields[fieldId].template,
 				label: manifestFormContainer.fields[fieldId].label,
@@ -154,8 +171,14 @@ export function getFormElementsFromManifest(
 	return formElements;
 }
 
-export function getFormContainer(facetDefinition: ReferenceFacetTypes, converterContext: ConverterContext): FormContainer {
+export function getFormContainer(
+	facetDefinition: ReferenceFacetTypes,
+	converterContext: ConverterContext,
+	actions: BaseAction[] | ConverterAction[] | undefined
+): FormContainer {
 	//TODO form container id
+	const sFormContainerId = generate([{ Facet: facetDefinition }]);
+	const sAnnotationPath = "/" + facetDefinition.fullyQualifiedName;
 	const resolvedTarget = converterContext.getEntityTypeAnnotation(facetDefinition.Target.value);
 	let sEntitySetPath!: string;
 	// resolvedTarget doesn't have a entitySet in case Containments and Paramterized services.
@@ -167,19 +190,50 @@ export function getFormContainer(facetDefinition: ReferenceFacetTypes, converter
 	} else if (resolvedTarget.converterContext.getDataModelObjectPath().targetObject?.containsTarget === true) {
 		sEntitySetPath = getTargetObjectPath(resolvedTarget.converterContext.getDataModelObjectPath(), false);
 	}
+	const aFormElements = insertCustomElements(
+		getFormElementsFromAnnotations(facetDefinition, converterContext),
+		getFormElementsFromManifest(facetDefinition, converterContext),
+		{ formatOptions: "overwrite" }
+	);
+
+	actions = actions !== undefined ? actions.filter(action => action.facetName == facetDefinition.fullyQualifiedName) : [];
+	if (actions.length === 0) {
+		actions = undefined;
+	}
+
+	const oActionShowDetails: BaseAction = {
+		id: FormStandardActionButtonID(sFormContainerId, "ShowHideDetails"),
+		key: "StandardAction::ShowHideDetails",
+		text: "{sap.fe.i18n>T_COMMON_OBJECT_PAGE_SHOW_FORM_CONTAINER_DETAILS}",
+		type: ActionType.ShowFormDetails,
+		press: "FormContainerRuntime.toggleDetails"
+	};
+
+	if (
+		facetDefinition.annotations?.UI?.PartOfPreview !== false &&
+		aFormElements.some(oFormElement => oFormElement.isPartOfPreview === false)
+	) {
+		if (actions !== undefined) {
+			actions.push(oActionShowDetails);
+		} else {
+			actions = [oActionShowDetails];
+		}
+	}
+
 	return {
-		id: generate([{ Facet: facetDefinition }]),
-		formElements: insertCustomElements(
-			getFormElementsFromAnnotations(facetDefinition, converterContext),
-			getFormElementsFromManifest(facetDefinition, converterContext),
-			{ formatOptions: "overwrite" }
-		),
-		annotationPath: "/" + facetDefinition.fullyQualifiedName,
-		entitySet: sEntitySetPath
+		id: sFormContainerId,
+		formElements: aFormElements,
+		annotationPath: sAnnotationPath,
+		entitySet: sEntitySetPath,
+		actions: actions
 	};
 }
 
-function getFormContainersForCollection(facetDefinition: CollectionFacetTypes, converterContext: ConverterContext): FormContainer[] {
+function getFormContainersForCollection(
+	facetDefinition: CollectionFacetTypes,
+	converterContext: ConverterContext,
+	actions: BaseAction[] | ConverterAction[]
+): FormContainer[] {
 	const formContainers: FormContainer[] = [];
 	//TODO coll facet inside coll facet?
 	facetDefinition.Facets?.forEach(facet => {
@@ -187,7 +241,7 @@ function getFormContainersForCollection(facetDefinition: CollectionFacetTypes, c
 		if (facet.$Type === UIAnnotationTypes.CollectionFacet) {
 			return;
 		}
-		formContainers.push(getFormContainer(facet as ReferenceFacetTypes, converterContext));
+		formContainers.push(getFormContainer(facet as ReferenceFacetTypes, converterContext, actions));
 	});
 	return formContainers;
 }
@@ -196,7 +250,11 @@ export function isReferenceFacet(facetDefinition: FacetTypes): facetDefinition i
 	return facetDefinition.$Type === UIAnnotationTypes.ReferenceFacet;
 }
 
-export function createFormDefinition(facetDefinition: FacetTypes, converterContext: ConverterContext): FormDefinition {
+export function createFormDefinition(
+	facetDefinition: FacetTypes,
+	converterContext: ConverterContext,
+	actions: BaseAction[] | ConverterAction[]
+): FormDefinition {
 	switch (facetDefinition.$Type) {
 		case UIAnnotationTypes.CollectionFacet:
 			// Keep only valid children
@@ -206,7 +264,7 @@ export function createFormDefinition(facetDefinition: FacetTypes, converterConte
 				hasFacetsNotPartOfPreview: facetDefinition.Facets.some(
 					childFacet => childFacet.annotations?.UI?.PartOfPreview?.valueOf() === false
 				),
-				formContainers: getFormContainersForCollection(facetDefinition, converterContext)
+				formContainers: getFormContainersForCollection(facetDefinition, converterContext, actions)
 			};
 			return formCollectionDefinition;
 		case UIAnnotationTypes.ReferenceFacet:
@@ -214,7 +272,7 @@ export function createFormDefinition(facetDefinition: FacetTypes, converterConte
 				id: FormID({ Facet: facetDefinition }),
 				useFormContainerLabels: false,
 				hasFacetsNotPartOfPreview: facetDefinition.annotations?.UI?.PartOfPreview?.valueOf() === false,
-				formContainers: [getFormContainer(facetDefinition, converterContext)]
+				formContainers: [getFormContainer(facetDefinition, converterContext, actions)]
 			};
 			return formDefinition;
 		default: