@openui5/sap.ui.rta 1.134.0 → 1.136.0

package/src/sap/ui/rta/plugin/Stretch.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.rta.plugin.Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 *
 	 * @constructor
 	 * @private

package/src/sap/ui/rta/plugin/additionalElements/ActionExtractor.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -32,7 +32,7 @@ sap.ui.define([
 	 * handled by the AdditionalElements Plugin (Reveal, Add Via Delegate, Add Custom)
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 * @since 1.94
 	 */

package/src/sap/ui/rta/plugin/additionalElements/AddElementsDialog.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @class Context - Dialog for available Fields in Runtime Authoring
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @private
 	 * @since 1.44

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsAnalyzer.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsPlugin.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -119,7 +119,7 @@ sap.ui.define([
 	 * @class The plugin allows to add additional elements that exist either hidden in the UI or in the OData service
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @private
 	 * @since 1.44

package/src/sap/ui/rta/plugin/additionalElements/AdditionalElementsUtils.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Helper object containing methods for the AdditionalElements plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 * @since 1.94
 	 */

package/src/sap/ui/rta/plugin/additionalElements/CommandBuilder.js

@@ -1,6 +1,6 @@
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 
@@ -25,7 +25,7 @@ sap.ui.define([
 	 * Helper object to build the RTA commands resulting from the AdditionalElements Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @private
 	 * @since 1.94
 	 */

package/src/sap/ui/rta/plugin/annotations/AnnotationChangeDialog.fragment.xml

@@ -9,9 +9,10 @@
 		resizable="false"
 		draggable="true"
 		contentWidth="50rem"
-		contentHeight="25rem"
+		contentHeight="{= ${/singleRename} === true ? 'auto' : '25rem'}"
 		title="{/title}"
 		class="sapUiContentPadding"
+		escapeHandler=".onCancel"
 	>
 		<content>
 			<VBox>
@@ -30,7 +31,11 @@
 					id="sapUiRtaChangeAnnotationDialog_description"
 					visible="{= ${/description}.length > 0}"
 					text="{/description}"/>
-				<HBox fitContainer="true">
+				<HBox
+					id="sapUiRtaChangeAnnotationDialog_filterHBox"
+					fitContainer="true"
+					visible="{= ${/singleRename} === false}"
+				>
 					<SearchField
 						id="sapUiRtaChangeAnnotationDialog_propertiesFilter"
 						placeholder="{i18n>ANNOTATION_CHANGE_DIALOG_PROPERTY_SEARCH}"
@@ -54,9 +59,9 @@
 				<f:Form editable="true">
 					<f:layout>
 						<f:ResponsiveGridLayout
-							labelSpanXL="3"
-							labelSpanL="3"
-							labelSpanM="3"
+							labelSpanXL="4"
+							labelSpanL="4"
+							labelSpanM="4"
 							labelSpanS="12"
 							adjustLabelSpan="false"
 							emptySpanXL="0"
@@ -77,10 +82,9 @@
 		<beginButton>
 			<Button
 				id="sapUiRtaChangeAnnotationDialog_saveButton"
-				enabled="{= ${path: '/properties', formatter: '.hasChangesFormatter'}}"
 				type="Emphasized"
-				text="{i18n>ANNOTATION_CHANGE_DIALOG_SAVE}"
-				press="onSavePress"
+				text="{i18n>ANNOTATION_CHANGE_DIALOG_CONFIRM}"
+				press="onSave"
 			/>
 		</beginButton>
 		<endButton>
@@ -88,7 +92,7 @@
 				id="sapUiRtaChangeAnnotationDialog_cancelButton"
 				type="Transparent"
 				text="{i18n>ANNOTATION_CHANGE_DIALOG_CANCEL}"
-				press="onCancelPress"
+				press="onCancel"
 			/>
 		</endButton>
 	</Dialog>

package/src/sap/ui/rta/plugin/annotations/AnnotationChangeDialog.js

@@ -1,12 +1,13 @@
 
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
 	"sap/ui/base/ManagedObject",
 	"sap/ui/core/Fragment",
+	"sap/ui/dt/ElementUtil",
 	"sap/ui/fl/write/api/PersistenceWriteAPI",
 	"sap/ui/model/json/JSONModel",
 	"sap/ui/model/resource/ResourceModel",
@@ -15,6 +16,7 @@ sap.ui.define([
 ], function(
 	ManagedObject,
 	Fragment,
+	ElementUtil,
 	PersistenceWriteAPI,
 	JSONModel,
 	ResourceModel,
@@ -27,7 +29,7 @@ sap.ui.define([
 	 * @class Constructor for a new sap.ui.rta.plugin.annotations.AnnotationChangeDialog.
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @since 1.132
 	 * @private
@@ -35,6 +37,26 @@ sap.ui.define([
 	 */
 	const AnnotationChangeDialog = ManagedObject.extend("sap.ui.rta.plugin.annotations.AnnotationChangeDialog");
 
+	function replaceValue(aProperties, sAnnotationPath, sValue) {
+		const oProperty = aProperties.find((oProperty) => oProperty.annotationPath === sAnnotationPath);
+		if (oProperty) {
+			oProperty.currentValue = sValue;
+			oProperty.originalValue = sValue;
+		}
+	}
+
+	function replaceCurrentValueWithTextFromControl(aProperties, sPreSelectedProperty, oControl) {
+		const aNewLabel = ElementUtil.getLabelForElement(oControl);
+		replaceValue(aProperties, sPreSelectedProperty, aNewLabel);
+	}
+
+	function replaceValuesWithValuesFromPendingChanges(aAnnotationChanges, aProperties, bObjectAsKey) {
+		aAnnotationChanges.forEach((oChange) => {
+			const sAnnotationPath = oChange.getContent().annotationPath;
+			replaceValue(aProperties, sAnnotationPath, bObjectAsKey ? JSON.stringify(oChange.getValue()) : oChange.getValue());
+		});
+	}
+
 	AnnotationChangeDialog.prototype._createDialog = async function() {
 		this._oController = new AnnotationChangeDialogController();
 		const oDialog = await Fragment.load({
@@ -63,6 +85,8 @@ sap.ui.define([
 	 * @property {string} properties.annotationPath - Path of the property
 	 * @property {string} properties.propertyName - Name of the property
 	 * @property {string} properties.currentValue - Current value of the property
+	 * @property {string} [properties.label] - Label of the property. If not given, the property name is used
+	 * @property {string} [properties.tooltip] - Tooltip of the property
 	 * @property {object[]} possibleValues - Array of possible values for value list type properties
 	 * @property {string} possibleValues.key - Key of the option
 	 * @property {string} possibleValues.text - Text of the option
@@ -83,10 +107,15 @@ sap.ui.define([
 	 *
 	 * @typedef {object} sap.ui.rta.plugin.annotations.AnnotationChangeDefinition
 	 * @property {string} annotationChangeType - Change type
+	 * @property {string} serviceUrl - Url of the OData service
 	 * @property {object} content - Change content
 	 * @property {string} content.annotationPath - Path of the property
 	 * @property {string} content.value - New value
-	 * @property {string} serviceUrl - Url of the OData service
+	 * @property {string} content.text - New value as translatable text. If given, the value is ignored
+	 * @property {object} [content.objectTemplateInfo] - Object template to construct a return object.
+	 * If given the applyChange function will return an object as value, which is parsed from the template string.
+	 * @property {string} [content.objectTemplateInfo.templateAsString] - Stringified template to be used for constructing the return object
+	 * @property {string} [content.objectTemplateInfo.placeholder] - Placeholder in the template string. Will be replaced by the new value
 	 * @public
 	 */
 
@@ -110,20 +139,31 @@ sap.ui.define([
 			delegate: oDelegate,
 			control: oControl,
 			annotation: sAnnotation,
-			description: sAnnotationDescription = ""
+			description: sAnnotationDescription,
+			singleRename: bSingleRename
 		} = mPropertyBag;
 		const {
 			serviceUrl: sServiceUrl,
 			properties: aDelegateProperties,
-			possibleValues: aPossibleValues,
+			possibleValues: aDelegatePossibleValues,
 			preSelectedProperty: sPreSelectedPropertyKey
-		} = oDelegate.getAnnotationsChangeInfo(oControl, sAnnotation);
+		} = await oDelegate.getAnnotationsChangeInfo(oControl, sAnnotation);
+
+		const bObjectAsKey = !!aDelegatePossibleValues?.some((oPossibleValue) => typeof oPossibleValue.key === "object");
+		// the key could be an object which does not work as property for the Select control
+		// therefore the key must be stringified and later parsed
 		const aProperties = aDelegateProperties.map((oProperty) => ({
 			...oProperty,
-			originalValue: oProperty.currentValue
+			currentValue: bObjectAsKey ? JSON.stringify(oProperty.currentValue) : oProperty.currentValue,
+			originalValue: bObjectAsKey ? JSON.stringify(oProperty.currentValue) : oProperty.currentValue,
+			label: oProperty.label || oProperty.propertyName
+		}));
+		const aPossibleValues = (aDelegatePossibleValues || []).map((oPossibleValue) => ({
+			...oPossibleValue,
+			key: bObjectAsKey ? JSON.stringify(oPossibleValue.key) : oPossibleValue.key
 		}));
 
-		aProperties.sort((oProperty1, oProperty2) => oProperty1.propertyName.localeCompare(oProperty2.propertyName));
+		aProperties.sort((oProperty1, oProperty2) => oProperty1.label.localeCompare(oProperty2.label));
 
 		const aExistingChanges = PersistenceWriteAPI._getAnnotationChanges({
 			control: oControl
@@ -135,25 +175,47 @@ sap.ui.define([
 
 		this._oDialog ||= await this._createDialog();
 
-		const sFilterText = sPreSelectedPropertyKey
-			? aProperties.find((oProperty) => oProperty.annotationPath === sPreSelectedPropertyKey).propertyName
-			: "";
+		const sFilterText = (
+			sPreSelectedPropertyKey && aProperties.find((oProperty) => oProperty.annotationPath === sPreSelectedPropertyKey)?.label
+		) || "";
+
+		// default size limit is 100, but we need to display all properties.
+		// As the list size is not dynamic, we can set the size limit to the number of properties
+		// the size influences all binding sizes, so we only set it if the number of properties is greater than 100
+		if (aProperties.length > 100) {
+			this.oChangeAnnotationModel.setSizeLimit(aProperties.length);
+		}
+
+		if (bSingleRename) {
+			replaceCurrentValueWithTextFromControl(aProperties, sPreSelectedPropertyKey, oControl);
+		}
+
+		// Once a change gets passed to the model during initialization, the property _appliedOnModel is set to true
+		replaceValuesWithValuesFromPendingChanges(aExistingChanges.filter((oChange) => !oChange._appliedOnModel), aProperties, bObjectAsKey);
+
 		this.oChangeAnnotationModel.setData({
+			objectAsKey: bObjectAsKey,
+			control: oControl,
 			title: sAnnotationTitle,
-			description: sAnnotationDescription,
+			description: sAnnotationDescription || "",
 			properties: aProperties, // all properties
 			changedProperties: aProperties.filter(({ annotationPath }) => aChangedAnnotations.includes(annotationPath)),
 			propertiesToDisplay: aProperties, // switches dynamically between all properties and changed properties
 			showChangedPropertiesOnly: false,
 			filterText: sFilterText,
+			singleRename: bSingleRename || false,
 			possibleValues: aPossibleValues,
 			valueType: sAnnotationValueType,
 			serviceUrl: sServiceUrl
 		});
 		if (sFilterText) {
-			this._oController.filterProperties(sFilterText);
+			this._oController.filterProperties(sFilterText, !!bSingleRename);
 		}
+		// Ensure that the model is fully refreshed before opening the dialog
+		this.oChangeAnnotationModel.refresh(true);
 		const aChangedProperties = await this._openDialog();
+		// reset filter to not have a filtered list when opening the dialog again
+		this._oController.filterProperties("");
 		this._oDialog.close();
 		return aChangedProperties;
 	};

package/src/sap/ui/rta/plugin/annotations/AnnotationChangeDialogController.js

@@ -1,11 +1,12 @@
 
 /*!
  * OpenUI5
- * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * (c) Copyright 2025 SAP SE or an SAP affiliate company.
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
 	"sap/m/Input",
+	"sap/m/Label",
 	"sap/m/Select",
 	"sap/m/Switch",
 	"sap/ui/core/mvc/Controller",
@@ -17,6 +18,7 @@ sap.ui.define([
 	"sap/ui/rta/plugin/annotations/AnnotationTypes"
 ], function(
 	Input,
+	Label,
 	Select,
 	Switch,
 	Controller,
@@ -33,7 +35,7 @@ sap.ui.define([
 	 * @class Controller for the AnnotationChangeDialog.
 	 * @extends sap.ui.core.mvc.Controller
 	 * @author SAP SE
-	 * @version 1.134.0
+	 * @version 1.136.0
 	 * @constructor
 	 * @since 1.132
 	 * @private
@@ -47,10 +49,10 @@ sap.ui.define([
 		});
 	};
 
-	AnnotationChangeDialogController.prototype.filterProperties = function(sQuery) {
+	AnnotationChangeDialogController.prototype.filterProperties = function(sQuery, bEquals) {
 		const aFilters = [];
 		if (sQuery && sQuery.length > 0) {
-			const filter = new Filter("propertyName", FilterOperator.Contains, sQuery);
+			const filter = new Filter("label", bEquals ? FilterOperator.EQ : FilterOperator.Contains, sQuery);
 			aFilters.push(filter);
 		}
 
@@ -67,16 +69,24 @@ sap.ui.define([
 	AnnotationChangeDialogController.prototype.switchDisplayMode = function(oEvent) {
 		const bShowChangedPropertiesOnly = oEvent.getParameter("state");
 		const oList = Element.getElementById("sapUiRtaChangeAnnotationDialog_propertyList");
-		oList.getModel().setProperty("/showChangedPropertiesOnly", bShowChangedPropertiesOnly);
-		oList.getModel().setProperty(
-			"/propertiesToDisplay",
-			bShowChangedPropertiesOnly
-				? oList.getModel().getProperty("/changedProperties")
-				: oList.getModel().getProperty("/properties")
-		);
+		const oModel = oList.getModel();
+		oModel.setProperty("/showChangedPropertiesOnly", bShowChangedPropertiesOnly);
+
+		if (bShowChangedPropertiesOnly) {
+			const aOriginallyChangedProperties = oModel.getProperty("/changedProperties");
+			const aAllChangedProperties = oModel.getProperty("/properties").filter((oProperty) => (
+				aOriginallyChangedProperties.some((oOriginallyChangedProperty) => (
+					oOriginallyChangedProperty.annotationPath === oProperty.annotationPath
+				))
+				|| oProperty.originalValue !== oProperty.currentValue
+			));
+			oModel.setProperty("/propertiesToDisplay", aAllChangedProperties);
+		} else {
+			oModel.setProperty("/propertiesToDisplay", oModel.getProperty("/properties"));
+		}
 	};
 
-	AnnotationChangeDialogController.prototype.onSavePress = function(oEvent) {
+	AnnotationChangeDialogController.prototype.onSave = function(oEvent) {
 		const oModelData = oEvent.getSource().getModel().getData();
 		const aChanges = oModelData.properties
 		.map((oProperty) => {
@@ -89,30 +99,23 @@ sap.ui.define([
 					annotationPath: oProperty.annotationPath
 				}
 			};
-			oChangeSpecificData.content[oModelData.valueType === AnnotationTypes.StringType ? "text" : "value"] = oProperty.currentValue;
+			oChangeSpecificData.content[oModelData.valueType === AnnotationTypes.StringType ? "text" : "value"] =
+			oModelData.objectAsKey ? JSON.parse(oProperty.currentValue) : oProperty.currentValue;
 			return oChangeSpecificData;
 		})
 		.filter(Boolean);
+
 		this._fnResolveAfterClose(aChanges);
 	};
 
-	AnnotationChangeDialogController.prototype.onCancelPress = function() {
+	AnnotationChangeDialogController.prototype.onCancel = function() {
 		this._fnResolveAfterClose([]);
 	};
 
 	function createEditorField(sValueType) {
-		const onChange = () => {
-			// Property updates are handled via two-way binding
-			// However, the binding of the save button doesn't detect changes
-			// within nested object properties, so it has to be refreshed explicitly
-			const oSaveButton = Element.getElementById("sapUiRtaChangeAnnotationDialog_saveButton");
-			oSaveButton.getBinding("enabled").refresh(true);
-		};
-
 		if (sValueType === AnnotationTypes.ValueListType) {
 			const oSelect = new Select({
-				selectedKey: "{currentValue}",
-				change: onChange
+				selectedKey: "{currentValue}"
 			});
 
 			const oItemTemplate = new Item({
@@ -132,14 +135,17 @@ sap.ui.define([
 		if (sValueType === AnnotationTypes.StringType) {
 			return new Input({
 				value: "{currentValue}",
-				change: onChange
+				liveChange: (oEvent) => {
+					const sValue = oEvent.getParameter("newValue");
+					const oContext = oEvent.getSource().getBindingContext();
+					oEvent.getSource().getModel().setProperty("currentValue", sValue, oContext);
+				}
 			});
 		}
 
 		if (sValueType === AnnotationTypes.BooleanType) {
 			return new Switch({
-				state: "{currentValue}",
-				change: onChange
+				state: "{currentValue}"
 			});
 		}
 
@@ -148,19 +154,19 @@ sap.ui.define([
 
 	AnnotationChangeDialogController.prototype.editorFactory = function(sId, oContext) {
 		const sValueType = oContext.getProperty("/valueType");
+		const bSingleRename = oContext.getProperty("/singleRename");
 
 		return new FormElement({
 			id: sId,
-			label: "{propertyName}",
+			label: new Label({
+				text: bSingleRename ? "{i18n>ANNOTATION_CHANGE_DIALOG_SINGLE_RENAME_LABEL}" : "{= ${label} || ${propertyName}}",
+				tooltip: "{tooltip}"
+			}),
 			fields: [
 				createEditorField.call(this, sValueType)
 			]
 		});
 	};
 
-	AnnotationChangeDialogController.prototype.hasChangesFormatter = function(aProperties) {
-		return aProperties?.some((oProperty) => oProperty.originalValue !== oProperty.currentValue);
-	};
-
 	return AnnotationChangeDialogController;
 });