@openui5/sap.ui.rta 1.105.1 → 1.107.0

package/src/sap/ui/rta/util/adaptationStarter.js

@@ -13,7 +13,8 @@ sap.ui.define([
 	"sap/ui/fl/Layer",
 	"sap/ui/fl/Utils",
 	"sap/ui/rta/util/showMessageBox",
-	"sap/ui/rta/RuntimeAuthoring"
+	"sap/ui/rta/RuntimeAuthoring",
+	"sap/ui/core/Core"
 ], function(
 	UriParameters,
 	Log,
@@ -24,7 +25,8 @@ sap.ui.define([
 	Layer,
 	FlexUtils,
 	showMessageBox,
-	RuntimeAuthoring
+	RuntimeAuthoring,
+	Core
 ) {
 	"use strict";
 
@@ -33,7 +35,8 @@ sap.ui.define([
 			return FeaturesAPI.isKeyUser()
 				.then(function(bIsKeyUser) {
 					if (!bIsKeyUser) {
-						var oError = Error("Key user rights have not been granted to the current user");
+						var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+						var oError = new Error(oRtaResourceBundle.getText("MSG_NO_KEY_USER_RIGHTS_ERROR_MESSAGE"));
 						oError.reason = "isKeyUser";
 						throw oError;
 					}
@@ -122,7 +125,7 @@ sap.ui.define([
 				PersistenceWriteAPI.getChangesWarning(mPropertyBag)
 					.then(function(oWarningMessage) {
 						if (oWarningMessage.showWarning) {
-							var oRtaResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
+							var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
 							var oMessageProps = oWarningMessage.warningType === "mixedChangesWarning"
 								? {
 									text: "MSG_ADAPTATION_STARTER_MIXED_CHANGES_WARNING",
@@ -147,6 +150,12 @@ sap.ui.define([
 		})
 		.catch(function(vError) {
 			if (vError !== "Reload triggered") {
+				var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
+				showMessageBox(
+					oRtaResourceBundle.getText("MSG_GENERIC_ERROR_MESSAGE", vError.message),
+					{title: oRtaResourceBundle.getText("MSG_ADAPTATION_COULD_NOT_START")},
+					"error"
+				);
 				Log.error("UI Adaptation could not be started", vError.message);
 			}
 			throw vError;

package/src/sap/ui/rta/util/changeVisualization/ChangeCategories.js

@@ -0,0 +1,50 @@
+/*!
+ * OpenUI5
+ * (c) Copyright 2009-2022 SAP SE or an SAP affiliate company.
+ * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
+ */
+
+sap.ui.define([
+	"sap/ui/fl/changeHandler/common/ChangeCategories"
+], function(
+	FlChangeCategories
+) {
+	"use strict";
+
+	var ChangeCategories = {};
+
+	ChangeCategories.ALL = "all";
+
+	// Assignment of commands to change categories
+	var COMMANDS = {};
+	COMMANDS[FlChangeCategories.ADD] = [
+		"createContainer",
+		"addDelegateProperty",
+		"reveal",
+		"addIFrame"
+	];
+	COMMANDS[FlChangeCategories.MOVE] = ["move"];
+	COMMANDS[FlChangeCategories.RENAME] = ["rename"];
+	COMMANDS[FlChangeCategories.COMBINESPLIT] = ["combine", "split"];
+	COMMANDS[FlChangeCategories.REMOVE] = ["remove"];
+	COMMANDS[FlChangeCategories.OTHER] = [];
+
+	var CATEGORY_ICONS = {};
+	CATEGORY_ICONS[ChangeCategories.ALL] = "sap-icon://show";
+	CATEGORY_ICONS[FlChangeCategories.ADD] = "sap-icon://add";
+	CATEGORY_ICONS[FlChangeCategories.MOVE] = "sap-icon://move";
+	CATEGORY_ICONS[FlChangeCategories.RENAME] = "sap-icon://edit";
+	CATEGORY_ICONS[FlChangeCategories.COMBINESPLIT] = "sap-icon://combine";
+	CATEGORY_ICONS[FlChangeCategories.REMOVE] = "sap-icon://less";
+	CATEGORY_ICONS[FlChangeCategories.OTHER] = "sap-icon://key-user-settings";
+
+	ChangeCategories.getCategories = function() {
+		return COMMANDS;
+	};
+
+	ChangeCategories.getIconForCategory = function(sCategory) {
+		return CATEGORY_ICONS[sCategory];
+	};
+
+	return ChangeCategories;
+});

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicator.js

@@ -10,33 +10,27 @@ sap.ui.define([
 	"sap/ui/core/Control",
 	"sap/ui/core/format/DateFormat",
 	"sap/ui/events/KeyCodes",
-	"sap/ui/rta/util/changeVisualization/categories/getVisualizationCategory",
+	"sap/ui/rta/util/changeVisualization/commands/getCommandVisualization",
 	"sap/ui/fl/Utils",
 	"sap/ui/fl/util/resolveBinding",
 	"sap/ui/rta/util/changeVisualization/ChangeVisualizationUtils",
-	"sap/ui/core/Core"
+	"sap/ui/core/Core",
+	"sap/ui/rta/util/changeVisualization/ChangeCategories"
 ], function(
 	Fragment,
 	JSONModel,
 	Control,
 	DateFormat,
 	KeyCodes,
-	getVisualizationCategory,
+	getCommandVisualization,
 	FlUtils,
 	resolveBinding,
 	ChangeVisualizationUtils,
-	Core
+	Core,
+	ChangeCategories
 ) {
 	"use strict";
 
-	var CATEGORY_ICONS = {
-		add: "sap-icon://add",
-		move: "sap-icon://move",
-		rename: "sap-icon://edit",
-		combinesplit: "sap-icon://combine",
-		remove: "sap-icon://less"
-	};
-
 	/**
 	 * @class
 	 * Constructor for a new <code>sap.ui.rta.util.changeVisualization.ChangeIndicator</code> class.
@@ -46,7 +40,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicator
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @private
 	 */
 	var ChangeIndicator = Control.extend("sap.ui.rta.util.changeVisualization.ChangeIndicator", {
@@ -168,50 +162,59 @@ sap.ui.define([
 
 	function getTexts(mChangeInformation, oRtaResourceBundle, sOverlayId) {
 		var oAffectedElement = Core.byId(mChangeInformation.affectedElementId);
-		var mPayload = Object.keys(mChangeInformation.payload || {}).reduce(function(mPayload, sKey) {
-			var vOriginalValue = mChangeInformation.payload[sKey];
+		var mDescriptionPayload = Object.keys(mChangeInformation.descriptionPayload || {}).reduce(function(mDescriptionPayload, sKey) {
+			var vOriginalValue = mChangeInformation.descriptionPayload[sKey];
 			var bIsBinding = FlUtils.isBinding(vOriginalValue);
 			var vValue = bIsBinding
 				? resolveBinding(vOriginalValue, oAffectedElement)
 				: vOriginalValue;
-			mPayload[sKey] = vValue;
-			return mPayload;
+			mDescriptionPayload[sKey] = vValue;
+			return mDescriptionPayload;
 		}, {});
 
 		var mPropertyBag = { appComponent: FlUtils.getAppComponentForControl(oAffectedElement) };
 		var oOverlay = Core.byId(sOverlayId);
-		var oVisualizationUtil = getVisualizationCategory(mChangeInformation);
 		var sElementLabel = oOverlay.getDesignTimeMetadata().getLabel(oAffectedElement);
-		var oDescription = oVisualizationUtil && oVisualizationUtil.getDescription(mPayload, sElementLabel, mPropertyBag);
-		sElementLabel = sElementLabel && "'" + sElementLabel + "'";
-		var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);
-		var sChangeTextKey = (
-			"TXT_CHANGEVISUALIZATION_CHANGE_"
-			+ mChangeInformation.commandName.toUpperCase()
-		);
-
+		var oCommandVisualization = getCommandVisualization(mChangeInformation);
+		var oDescription = oCommandVisualization && oCommandVisualization.getDescription(mDescriptionPayload, sElementLabel, mPropertyBag) || {};
+		var sCommandName = mChangeInformation.commandName;
 		var sDescriptionText;
 		var sDescriptionTooltip;
-		// for settings commands if available description and tooltip should be taken as is from the change handler
-		if (mPayload.description && mChangeInformation.commandName === "settings") {
-			sDescriptionText = mPayload.description;
-			sDescriptionTooltip = mPayload.descriptionTooltip || "";
+
+		// 'Settings' with a custom description should overwrite the description from the CommandVisualization
+		if (sCommandName === "settings" && mDescriptionPayload.description) {
+			oDescription.descriptionText = mDescriptionPayload.description;
+			oDescription.descriptionTooltip = mDescriptionPayload.descriptionTooltip;
+		} else if (mChangeInformation.changeCategory === "other") {
+			// To retrieve the generic description for commands without visualization
+			sCommandName = "other";
+		}
+
+		if (oDescription.descriptionText) {
+			sDescriptionText = oDescription.descriptionText;
+			sDescriptionTooltip = oDescription.descriptionTooltip || "";
 		} else {
-			if (oDescription) {
-				sDescriptionText = oDescription.descriptionText;
-				sDescriptionTooltip = oDescription.descriptionTooltip;
-			} else {
-				sDescriptionText = oRtaResourceBundle.getText(sChangeTextKey, sShortenedElementLabel);
-				sDescriptionTooltip = oRtaResourceBundle.getText(sChangeTextKey, sElementLabel);
-			}
-			sDescriptionTooltip = sDescriptionText.length < sDescriptionTooltip.length ? sDescriptionTooltip : null;
+			sElementLabel = sElementLabel && "'" + sElementLabel + "'";
+			var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);
+			var sChangeTextKey = (
+				"TXT_CHANGEVISUALIZATION_CHANGE_"
+				+ sCommandName.toUpperCase()
+			);
+			sDescriptionText = oRtaResourceBundle.getText(sChangeTextKey, sShortenedElementLabel);
+			sDescriptionTooltip = oRtaResourceBundle.getText(sChangeTextKey, sElementLabel);
 		}
+		sDescriptionTooltip = sDescriptionText.length < sDescriptionTooltip.length ? sDescriptionTooltip : null;
 		var sDetailButtonText = oDescription && oDescription.buttonText;
+		var sIconTooltip = oRtaResourceBundle.getText(
+			"TXT_CHANGEVISUALIZATION_OVERVIEW_"
+			+ mChangeInformation.changeCategory.toUpperCase()
+		);
 
 		return {
 			description: sDescriptionText,
 			tooltip: sDescriptionTooltip,
-			buttonText: sDetailButtonText
+			buttonText: sDetailButtonText,
+			iconTooltip: sIconTooltip
 		};
 	}
 
@@ -231,7 +234,6 @@ sap.ui.define([
 		var oTexts = getTexts(mChangeInformation, oRtaResourceBundle, sOverlayId);
 		var oDates = getDates(mChangeInformation, oRtaResourceBundle);
 
-
 		return {
 			id: mChangeInformation.id,
 			change: mChangeInformation,
@@ -240,7 +242,8 @@ sap.ui.define([
 			fullDate: oDates.fullDate,
 			relativeDate: oDates.relativeDate,
 			detailButtonText: oTexts.buttonText,
-			icon: CATEGORY_ICONS[mChangeInformation.commandCategory]
+			icon: ChangeCategories.getIconForCategory(mChangeInformation.changeCategory),
+			iconTooltip: oTexts.iconTooltip
 		};
 	}
 

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicatorCategorySelection.fragment.xml

@@ -18,13 +18,13 @@
 		</MessageStrip>
 		<List
 			class="sapUiRtaChangesList"
-			items="{visualizationModel>/commandCategories/}">
+			items="{visualizationModel>/changeCategories/}">
 			<StandardListItem
 				title="{visualizationModel>title}"
 				counter="{visualizationModel>count}"
 				type="{= ${visualizationModel>count} > 0 ? 'Active' : 'Inactive'}"
 				icon="{visualizationModel>icon}"
-				press=".onCommandCategorySelection"/>
+				press=".onChangeCategorySelection"/>
 		</List>
 	</Popover>
 </core:FragmentDefinition>

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicatorPopover.fragment.xml

@@ -31,7 +31,8 @@
 					<cells>
 						<core:Icon
 							src="{details>icon}"
-							class="sapUiTinyMarginBegin"/>
+							class="sapUiTinyMarginBegin"
+							tooltip="{details>iconTooltip}"/>
 						<HBox alignItems="Center">
 							<Text
 								text="{details>description}"

package/src/sap/ui/rta/util/changeVisualization/ChangeIndicatorRegistry.js

@@ -13,7 +13,8 @@ sap.ui.define([
 	"sap/ui/core/util/reflection/JsControlTreeModifier",
 	"sap/ui/dt/ElementUtil",
 	"sap/ui/fl/write/api/ChangesWriteAPI",
-	"sap/ui/fl/Utils"
+	"sap/ui/fl/Utils",
+	"sap/ui/fl/changeHandler/common/ChangeCategories"
 ], function(
 	includes,
 	values,
@@ -23,7 +24,8 @@ sap.ui.define([
 	JsControlTreeModifier,
 	ElementUtil,
 	ChangesWriteAPI,
-	FlUtils
+	FlUtils,
+	ChangeCategories
 ) {
 	"use strict";
 
@@ -35,7 +37,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry
 	 * @author SAP SE
 	 * @since 1.86.0
-	 * @version 1.105.1
+	 * @version 1.107.0
 	 * @private
 	 */
 	var ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {
@@ -44,7 +46,7 @@ sap.ui.define([
 				/**
 				 * Available command categories
 				 */
-				commandCategories: {
+				changeCategories: {
 					type: "object",
 					defaultValue: []
 				},
@@ -58,7 +60,11 @@ sap.ui.define([
 		},
 		constructor: function () {
 			ManagedObject.prototype.constructor.apply(this, arguments);
-			this._oChangeIndicatorData = {};
+
+			// List of entries with indicator data, grouped by Change ID
+			this._oRegisteredChanges = {};
+
+			// List of actual change indicator objects, grouped by selector
 			this._oChangeIndicators = {};
 		}
 	});
@@ -68,12 +74,12 @@ sap.ui.define([
 	};
 
 	/**
-	 * Returns all registered changes.
+	 * Returns the change indicator data for all registered changes.
 	 *
-	 * @returns {object[]} Registered changes
+	 * @returns {object[]} Change indicator data for all registered changes
 	 */
-	ChangeIndicatorRegistry.prototype.getChanges = function () {
-		return values(this._oChangeIndicatorData || {}).map(function (oChange) {
+	ChangeIndicatorRegistry.prototype.getAllRegisteredChanges = function () {
+		return values(this._oRegisteredChanges || {}).map(function (oChange) {
 			return Object.assign({}, oChange);
 		});
 	};
@@ -81,55 +87,58 @@ sap.ui.define([
 	/**
 	 * Returns the IDs of all registered changes.
 	 *
-	 * @returns {string[]} Promise with both design time and runtime change
+	 * @returns {string[]} Array with both design time and runtime registered changes
 	 */
-	ChangeIndicatorRegistry.prototype.getChangeIds = function () {
-		return Object.keys(this._oChangeIndicatorData || {});
+	ChangeIndicatorRegistry.prototype.getRegisteredChangeIds = function () {
+		return Object.keys(this._oRegisteredChanges || {});
 	};
 
 	/**
-	 * Returns a registered change.
+	 * Returns a data entry of a registered change indicator for a change ID.
 	 *
 	 * @param {string} sChangeId - ID of the registered change
 	 * @returns {object} Registered change
 	 */
-	ChangeIndicatorRegistry.prototype.getChange = function (sChangeId) {
-		return this._oChangeIndicatorData[sChangeId] && Object.assign({}, this._oChangeIndicatorData[sChangeId]);
+	ChangeIndicatorRegistry.prototype.getRegisteredChange = function (sChangeId) {
+		return this._oRegisteredChanges[sChangeId] && Object.assign({}, this._oRegisteredChanges[sChangeId]);
 	};
 
 	/**
 	 * Groups all registered changes by their selectors and returns a list of selectors
-	 * with all dependent and non-dependent changes.
+	 * with all dependent and non-dependent change indicator data.
 	 *
-	 * @returns {object[]} Change indicators
+	 * @returns {object} List of selectors with change indicator data.
 	 */
-	ChangeIndicatorRegistry.prototype.getChangeIndicatorData = function () {
+	ChangeIndicatorRegistry.prototype.getSelectorsWithRegisteredChanges = function () {
 		var oChangeIndicators = {};
 
-		function addSelector (sSelectorId, sAffectedElementId, oChange, bDependent) {
+		function addSelector (sSelectorId, sAffectedElementId, oChangeIndicatorData, bDependent) {
 			if (oChangeIndicators[sSelectorId] === undefined) {
 				oChangeIndicators[sSelectorId] = [];
 			}
 			oChangeIndicators[sSelectorId].push(Object.assign(
 				{
-					id: oChange.change.getId(),
+					id: oChangeIndicatorData.change.getId(),
 					dependent: bDependent,
 					affectedElementId: sAffectedElementId,
-					payload: oChange.visualizationInfo.payload || {}
+					descriptionPayload: oChangeIndicatorData.visualizationInfo.descriptionPayload || {}
 				},
-				_omit(oChange, ["visualizationInfo"])
+				_omit(oChangeIndicatorData, ["visualizationInfo"])
 			));
 		}
 
-		values(this._oChangeIndicatorData).forEach(function (oChange) {
-			oChange.visualizationInfo.displayElementIds.forEach(function (sSelectorId, iIndex) {
-				addSelector(sSelectorId, oChange.visualizationInfo.affectedElementIds[iIndex], oChange, false);
-			});
+		values(this._oRegisteredChanges)
+			.forEach(function (oChangeIndicatorData) {
+				oChangeIndicatorData.visualizationInfo.displayElementIds
+				.forEach(function (sId, iIndex) {
+					addSelector(sId, oChangeIndicatorData.visualizationInfo.affectedElementIds[iIndex], oChangeIndicatorData, false);
+				});
 
-			oChange.visualizationInfo.dependentElementIds.forEach(function (sSelectorId) {
-				addSelector(sSelectorId, sSelectorId, oChange, true);
+				oChangeIndicatorData.visualizationInfo.dependentElementIds
+					.forEach(function (sId) {
+						addSelector(sId, sId, oChangeIndicatorData, true);
+					});
 			});
-		});
 
 		return oChangeIndicators;
 	};
@@ -163,20 +172,24 @@ sap.ui.define([
 	ChangeIndicatorRegistry.prototype.registerChange = function(oChange, sCommandName) {
 		var oAppComponent = FlUtils.getAppComponentForControl(ElementUtil.getElementInstance(this.getRootControlId()));
 		return getVisualizationInfo(oChange, oAppComponent).then(function(mChangeVisualizationInfo) {
-			var aCategories = this.getCommandCategories();
-			var sCommandCategory;
-			if (sCommandName === "settings" && includes(Object.keys(aCategories), mChangeVisualizationInfo.payload.category)) {
-				sCommandCategory = mChangeVisualizationInfo.payload.category;
+			var aCategories = this.getChangeCategories();
+			var sChangeCategory;
+			// For "settings", the control developer can choose one of the existing categories
+			if (sCommandName === "settings" && includes(Object.keys(aCategories), mChangeVisualizationInfo.descriptionPayload.category)) {
+				sChangeCategory = mChangeVisualizationInfo.descriptionPayload.category;
 			} else {
-				sCommandCategory = Object.keys(aCategories).find(function (sCommandCategoryName) {
-					return includes(aCategories[sCommandCategoryName], sCommandName);
+				sChangeCategory = Object.keys(aCategories).find(function (sChangeCategoryName) {
+					return includes(aCategories[sChangeCategoryName], sCommandName);
 				});
+				if (!sChangeCategory) {
+					sChangeCategory = ChangeCategories.OTHER;
+				}
 			}
 
-			this._oChangeIndicatorData[oChange.getId()] = {
+			this._oRegisteredChanges[oChange.getId()] = {
 				change: oChange,
 				commandName: sCommandName,
-				commandCategory: sCommandCategory,
+				changeCategory: sChangeCategory,
 				visualizationInfo: mChangeVisualizationInfo
 			};
 		}.bind(this));
@@ -206,7 +219,8 @@ sap.ui.define([
 					affectedElementIds: aAffectedElementIds,
 					dependentElementIds: getSelectorIds(mVisualizationInfo.dependentControls) || [],
 					displayElementIds: getSelectorIds(mVisualizationInfo.displayControls) || aAffectedElementIds,
-					payload: mVisualizationInfo.payload || {}
+					updateRequired: mVisualizationInfo.updateRequired,
+					descriptionPayload: mVisualizationInfo.descriptionPayload || {}
 				};
 			});
 	}
@@ -249,8 +263,8 @@ sap.ui.define([
 	 * Resets the change and change indicator registries.
 	 */
 	ChangeIndicatorRegistry.prototype.reset = function () {
-		Object.keys(this._oChangeIndicatorData).forEach(function (sKeyToRemove) {
-			this.removeChange(sKeyToRemove);
+		Object.keys(this._oRegisteredChanges).forEach(function (sKeyToRemove) {
+			this.removeRegisteredChange(sKeyToRemove);
 		}.bind(this));
 
 		values(this._oChangeIndicators).forEach(function (oIndicator) {
@@ -260,12 +274,24 @@ sap.ui.define([
 	};
 
 	/**
-	 * Removes a change.
+	 * Removes a data entry of a registered change indicator.
 	 *
 	 * @param {string} sChangeId - ID of the registered change
 	 */
-	ChangeIndicatorRegistry.prototype.removeChange = function (sChangeId) {
-		delete this._oChangeIndicatorData[sChangeId];
+	ChangeIndicatorRegistry.prototype.removeRegisteredChange = function (sChangeId) {
+		delete this._oRegisteredChanges[sChangeId];
+	};
+
+	/**
+	 * Removes changes with the updateRequired flag from the registry so the change can be re-registered and
+	 * the visualizationInfo is updated => if an element has an unstable id this updates the id information in the registry (e.g simple forms)
+	 */
+	ChangeIndicatorRegistry.prototype.removeOutdatedRegisteredChanges = function () {
+		this.getAllRegisteredChanges().forEach(function(oChange) {
+			if (oChange.visualizationInfo && oChange.visualizationInfo.updateRequired) {
+				this.removeRegisteredChange(oChange.change.getId());
+			}
+		}.bind(this));
 	};
 
 	return ChangeIndicatorRegistry;