@openui5/sap.ui.rta 1.132.1 → 1.134.0

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

@@ -49,7 +49,7 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.78
@@ -90,6 +90,11 @@ sap.ui.define([
 		return DesignTime.isDesignModeEnabled();
 	}
 
+	function checkViewId(oElementOverlay) {
+		const oView = getExtensionPointList(oElementOverlay.getElement())[0]?.view;
+		return oView && FlUtils.checkControlId(oView);
+	}
+
 	AddXMLAtExtensionPoint.prototype.bAppDescriptorCommandAlreadyAvailable = false;
 
 	/**
@@ -104,7 +109,7 @@ sap.ui.define([
 		if (isDesignMode()) {
 			var oElement = oOverlay.getElement();
 			return this.hasChangeHandler(FLEX_CHANGE_TYPE, oElement).then(function(bHasChangeHandler) {
-				return bHasChangeHandler && hasExtensionPoints(oElement);
+				return bHasChangeHandler && hasExtensionPoints(oElement) && checkViewId(oOverlay);
 			});
 		}
 		return Promise.resolve(false);
@@ -117,7 +122,8 @@ sap.ui.define([
 	 * @public
 	 */
 	AddXMLAtExtensionPoint.prototype.isEnabled = function(aElementOverlays) {
-		return aElementOverlays.length === 1;
+		const bEnabled = aElementOverlays.length === 1;
+		return bEnabled && !!checkViewId(aElementOverlays[0]);
 	};
 
 	AddXMLAtExtensionPoint.prototype.isAvailable = function(aOverlays) {

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

@@ -0,0 +1,168 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2025 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/dt/Util",
+	"sap/ui/fl/Utils",
+	"sap/ui/rta/Utils",
+	"sap/ui/rta/plugin/Plugin",
+	"sap/ui/rta/util/isReuseComponent"
+], function(
+	DtUtil,
+	FlUtils,
+	RtaUtils,
+	Plugin,
+	isReuseComponent
+) {
+	"use strict";
+
+	/**
+	 * Callback function responsible for fragment handling.
+	 *
+	 * The fragment handling function needs to be provided from outside of key user adaptation. It is called during the execution of the
+	 * plugin handler with the target overlay.
+	 *
+	 * @typedef {function} sap.ui.rta.plugin.AddXML.fragmentHandler
+	 * @since 1.134
+	 * @param {sap.ui.dt.ElementOverlay} oOverlay - Target overlay for where XML will be added
+	 * @param {string[]} aExcludedAggregation - Aggregations that should be excluded from the fragment handling
+	 * @returns {Promise<{fragmentPath: string, fragment: string, targetAggregation: string, index: number}>} Object wrapped in a Promise containing values that are relevant for the <code>addXML</code> command
+
+	/**
+	 * Constructor for a new AddXML plugin.
+	 * Adds the content of the XML fragment
+	 * The fragment handler <code>{@link sap.ui.rta.plugin.AddXML.fragmentHandler FragmentHandler}</code>
+	 * is a callback function that needs to be passed on instantiation of the plugin or alternatively into the
+	 * propertyBag when the handler function is called.
+	 *
+	 * @class
+	 * @extends sap.ui.rta.plugin.Plugin
+	 * @author SAP SE
+	 * @version 1.134.0
+	 * @constructor
+	 * @private
+	 * @since 1.134
+	 * @alias sap.ui.rta.plugin.AddXMLPlugin
+	 */
+	const AddXML = Plugin.extend("sap.ui.rta.plugin.AddXML", /** @lends sap.ui.rta.plugin.AddXMLPlugin.prototype */ {
+		metadata: {
+			library: "sap.ui.rta",
+			properties: {
+				fragmentHandler: {
+					type: "function"
+				}
+			},
+			associations: {},
+			events: {}
+		}
+	});
+
+	const FLEX_CHANGE_TYPE = "addXML";
+
+	/**
+	 * Check if the given overlay is editable.
+	 *
+	 * @param {sap.ui.dt.ElementOverlay} oOverlay - Overlay to be checked for editable
+	 * @returns {Promise<boolean>} <code>true</code> when editable wrapped in a promise
+	 * @private
+	 */
+	AddXML.prototype._isEditable = async function(oOverlay) {
+		// Action should be available by default
+		const oAddXMLAction = this.getAction(oOverlay);
+		const oComponent = FlUtils.getComponentForControl(oOverlay.getElement());
+		const bIsS4HanaCloud = RtaUtils.isS4HanaCloud();
+		if (
+			oAddXMLAction === null ||
+			!this.hasStableId(oOverlay) ||
+			(bIsS4HanaCloud && isReuseComponent(oComponent))
+		) {
+			return Promise.resolve(false);
+		}
+		const bHasChangeHandler = await this.hasChangeHandler(FLEX_CHANGE_TYPE, oOverlay.getElement());
+		return bHasChangeHandler;
+	};
+
+	/**
+	 * Checks if AddXML is enabled for oOverlay
+	 * @param {sap.ui.dt.ElementOverlay[]} aElementOverlays - Target overlays
+	 * @returns {boolean} <code>true</code> if enabled
+	 * @public
+	 */
+	AddXML.prototype.isEnabled = function(aElementOverlays) {
+		const bEnabled = aElementOverlays.length === 1;
+		return bEnabled;
+	};
+
+	function handleAddXmlCommand(mAddXmlData, oElement) {
+		const mAddXmlSettings = {
+			fragment: mAddXmlData.fragment,
+			fragmentPath: mAddXmlData.fragmentPath,
+			targetAggregation: mAddXmlData.targetAggregation,
+			index: mAddXmlData.index
+
+		};
+
+		return this.getCommandFactory().getCommandFor(
+			oElement,
+			FLEX_CHANGE_TYPE,
+			mAddXmlSettings
+		);
+	}
+
+	/**
+	 * Triggers the plugin execution.
+	 * @param {sap.ui.dt.ElementOverlay[]} aElementOverlays - Target overlays
+	 * @param {Object} mPropertyBag - Property bag
+	 * @param {sap.ui.rta.plugin.AddXML.fragmentHandler} [mPropertyBag.fragmentHandler] - Handler function for fragment handling. The fragment handler is a callback function that needs to be passed here into the <code>propertyBag</code> or alternatively on instantiation of the plugin.
+	 */
+	AddXML.prototype.handler = async function(aElementOverlays, mPropertyBag) {
+		try {
+			const fnFragmentHandler = mPropertyBag.fragmentHandler || this.getFragmentHandler();
+			if (!fnFragmentHandler) {
+				throw Error("Fragment handler function is not available in the handler");
+			}
+			const oOverlay = aElementOverlays[0];
+
+			const aExcludedAggregation = this.getAction(oOverlay)?.excludedAggregations || [];
+
+			const mAddXmlData = await fnFragmentHandler(oOverlay, aExcludedAggregation);
+
+			const oAddXmlCommand = await handleAddXmlCommand.call(this, mAddXmlData, oOverlay.getElement());
+			this.fireElementModified({
+				command: oAddXmlCommand
+			});
+		} catch (vError) {
+			throw DtUtil.propagateError(
+				vError,
+				"AddXML#handler",
+				"Error occurred in AddXML handler function",
+				"sap.ui.rta"
+			);
+		}
+	};
+
+	/**
+	 * Retrieves the context menu item for the action.
+	 * @param {sap.ui.dt.ElementOverlay[]} aElementOverlays - Target overlays
+	 * @returns {object[]} Array of the items with required data
+	 */
+	AddXML.prototype.getMenuItems = function(aElementOverlays) {
+		return this._getMenuItems(aElementOverlays, {
+			pluginId: "CTX_ADDXML",
+			icon: "sap-icon://attachment-html"
+		});
+	};
+
+	/**
+	 * Gets the name of the action related to this plugin.
+	 * @returns {string} Action name
+	 */
+	AddXML.prototype.getActionName = function() {
+		return "addXML";
+	};
+
+	return AddXML;
+});

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @class The BaseCreate allows trigger BaseCreate operations on the overlay.
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.75

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.46

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

@@ -53,7 +53,7 @@ sap.ui.define([
 	 * @class The ControlVariant allows propagation of variantManagement key
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.50

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @class The CreateContainer allows trigger CreateContainer operations on the overlay
 	 * @extends sap.ui.rta.plugin.BaseCreate
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.34

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

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * @extends sap.ui.dt.plugin.CutPaste
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -33,7 +33,7 @@ function(
 	 * @extends sap.ui.dt.plugin.ControlDragDrop
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -41,7 +41,7 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.90

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

@@ -39,12 +39,11 @@ sap.ui.define([
 		CTX_GROUP_FIELDS: 90,
 		CTX_UNGROUP_FIELDS: 100,
 		CTX_ADDXML_AT_EXTENSIONPOINT: 105,
+		CTX_ADDXML: 106,
 		// Settings ranks go up 1 by 1 for each setting
 		CTX_SETTINGS: 110,
 		// IFrame ranks go up 1 by 1 for each possible child target
 		CTX_CREATE_SIBLING_IFRAME: 130,
-		// Annotation ranks go up 1 by 1 for each action
-		CTX_ANNOTATION: 140,
 		// Variant types are mutually exclusive
 		CTX_VARIANT_SET_TITLE: 200,
 		CTX_COMP_VARIANT_RENAME: 200,
@@ -56,7 +55,9 @@ sap.ui.define([
 		CTX_COMP_VARIANT_MANAGE: 230,
 		CTX_VARIANT_SWITCH_SUBMENU: 240,
 		CTX_COMP_VARIANT_SWITCH: 240,
-		CTX_COMP_VARIANT_CONTENT: 250
+		CTX_COMP_VARIANT_CONTENT: 250,
+		// Annotation ranks go up 1 by 1 for each action
+		CTX_ANNOTATION: 300
 	};
 
 	function _handleEditableByPlugin(mPropertyBag, aPromises, oSourceElementOverlay) {
@@ -105,7 +106,7 @@ sap.ui.define([
 	 * @extends sap.ui.dt.Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -35,7 +35,7 @@ function(
 	 * The RTAElementMover is responsible for the RTA specific adaptation of element movements.
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @class The Remove allows trigger remove operations on the overlay
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.34

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

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @extends sap.ui.rta.plugin.Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -43,7 +43,7 @@ sap.ui.define([
 	 * Provides Rename handling functionality
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private
@@ -474,4 +474,4 @@ sap.ui.define([
 		}
 	};
 	return RenameHandler;
-}, true);
+});

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

@@ -27,7 +27,7 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.101

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

@@ -31,7 +31,7 @@ sap.ui.define([
 	 * @class The Selection plugin allows you to select or focus overlays with mouse or keyboard and navigate to others.
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.34

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

@@ -28,7 +28,7 @@ sap.ui.define([
 	 * @class The Settings allows trigger change of settings operations on the overlay
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.44

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

@@ -23,7 +23,7 @@ sap.ui.define([
 	 * @class
 	 * @extends sap.ui.rta.plugin.Plugin
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.46

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

@@ -29,7 +29,7 @@ sap.ui.define([
 	 * @extends sap.ui.rta.plugin.Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 *
 	 * @constructor
 	 * @private

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

@@ -32,7 +32,7 @@ sap.ui.define([
 	 * handled by the AdditionalElements Plugin (Reveal, Add Via Delegate, Add Custom)
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @private
 	 * @since 1.94
 	 */

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

@@ -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.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.44

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

@@ -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.132.1
+	 * @version 1.134.0
 	 * @constructor
 	 * @private
 	 * @since 1.44

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

@@ -17,7 +17,7 @@ sap.ui.define([
 	 * Helper object containing methods for the AdditionalElements plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @private
 	 * @since 1.94
 	 */

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * Helper object to build the RTA commands resulting from the AdditionalElements Plugin
 	 *
 	 * @author SAP SE
-	 * @version 1.132.1
+	 * @version 1.134.0
 	 * @private
 	 * @since 1.94
 	 */

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

@@ -10,24 +10,9 @@
 		draggable="true"
 		contentWidth="50rem"
 		contentHeight="25rem"
+		title="{/title}"
+		class="sapUiContentPadding"
 	>
-		<customHeader>
-			<Bar>
-				<contentLeft>
-					<Label
-						id="sapUiRtaChangeAnnotationDialog_title"
-						class="sapUiSmallMargin"
-						text="{/title}"/>
-				</contentLeft>
-				<contentRight>
-					<Button
-						id="sapUiRtaChangeAnnotationDialog_toggleShowAllPropertiesButton"
-						class="sapUiSmallMargin"
-						text="{= ${/showChangedPropertiesOnly} ? ${i18n>ANNOTATION_CHANGE_DIALOG_BUTTON_ALL_PROPERTIES} : ${i18n>ANNOTATION_CHANGE_DIALOG_BUTTON_CHANGED_PROPERTIES}}"
-						press="switchDisplayMode"/>
-				</contentRight>
-			</Bar>
-		</customHeader>
 		<content>
 			<VBox>
 				<MessageStrip
@@ -45,13 +30,28 @@
 					id="sapUiRtaChangeAnnotationDialog_description"
 					visible="{= ${/description}.length > 0}"
 					text="{/description}"/>
-				<SearchField
-					id="sapUiRtaChangeAnnotationDialog_propertiesFilter"
-					placeholder="{i18n>ANNOTATION_CHANGE_DIALOG_PROPERTY_SEARCH}"
-					width="100%"
-					value="{/filterText}"
-					liveChange="onFilterProperties"/>
-				<f:Form editable="false">
+				<HBox fitContainer="true">
+					<SearchField
+						id="sapUiRtaChangeAnnotationDialog_propertiesFilter"
+						placeholder="{i18n>ANNOTATION_CHANGE_DIALOG_PROPERTY_SEARCH}"
+						value="{/filterText}"
+						liveChange="onFilterProperties">
+						<layoutData>
+							<FlexItemData growFactor="1" styleClass="sapUiSmallMarginEnd"/>
+						</layoutData>
+					</SearchField>
+					<HBox alignItems="Center">
+						<Label
+							text="{i18n>ANNOTATION_CHANGE_DIALOG_BUTTON_CHANGED_PROPERTIES}"/>
+						<Switch
+							id="sapUiRtaChangeAnnotationDialog_toggleShowAllPropertiesSwitch"
+							state="{/showChangedPropertiesOnly}"
+							change="switchDisplayMode"
+							customTextOn=" "
+							customTextOff=" "/>
+					</HBox>
+				</HBox>
+				<f:Form editable="true">
 					<f:layout>
 						<f:ResponsiveGridLayout
 							labelSpanXL="3"
@@ -59,42 +59,25 @@
 							labelSpanM="3"
 							labelSpanS="12"
 							adjustLabelSpan="false"
-							emptySpanXL="4"
-							emptySpanL="4"
-							emptySpanM="4"
+							emptySpanXL="0"
+							emptySpanL="0"
+							emptySpanM="0"
 							emptySpanS="0"
 							columnsXL="1"
 							columnsL="1"
 							columnsM="1"
-							singleContainerFullSize="false"/>
+							singleContainerFullSize="true"/>
 					</f:layout>
 					<f:FormContainer
 						id="sapUiRtaChangeAnnotationDialog_propertyList"
-						formElements="{path: '/propertiesToDisplay', templateShareable: false}">
-						<f:FormElement label="{propertyName}">
-							<Select
-								visible="{path: '/valueType', formatter: '.formatters.isValueList'}"
-								selectedKey="{currentValue}"
-								change="onValueListChange"
-								items="{path: '/possibleValues', templateShareable: false}">
-								<core:Item key="{key}" text="{text}" />
-							</Select>
-							<Input
-								visible="{path: '/valueType', formatter: '.formatters.isString'}"
-								value="{currentValue}"
-								change="onStringChange"/>
-							<CheckBox
-								visible="{path: '/valueType', formatter: '.formatters.isBoolean'}"
-								selected="{=!!${currentValue}}"
-								select="onBooleanChange"/>
-						</f:FormElement>
-					</f:FormContainer>
+						formElements="{path: '/propertiesToDisplay', factory: '.editorFactory'}" />
 				</f:Form>
 			</VBox>
 		</content>
 		<beginButton>
 			<Button
 				id="sapUiRtaChangeAnnotationDialog_saveButton"
+				enabled="{= ${path: '/properties', formatter: '.hasChangesFormatter'}}"
 				type="Emphasized"
 				text="{i18n>ANNOTATION_CHANGE_DIALOG_SAVE}"
 				press="onSavePress"