@openui5/sap.ui.rta 1.99.1 → 1.102.0

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

@@ -30,7 +30,8 @@ sap.ui.define([
 	"sap/ui/rta/plugin/Settings",
 	"sap/ui/rta/plugin/Split",
 	"sap/ui/rta/plugin/Stretch",
-	"sap/ui/rta/plugin/LocalReset"
+	"sap/ui/rta/plugin/LocalReset",
+	"sap/ui/rta/plugin/Resize"
 ], function(
 	isEmptyObject,
 	values,
@@ -58,7 +59,8 @@ sap.ui.define([
 	SettingsPlugin,
 	SplitPlugin,
 	StretchPlugin,
-	LocalResetPlugin
+	LocalResetPlugin,
+	ResizePlugin
 ) {
 	"use strict";
 
@@ -66,7 +68,7 @@ sap.ui.define([
 	 * Constructor for a new sap.ui.rta.util.PluginManager
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 * @constructor
 	 * @private
 	 * @since 1.86
@@ -181,6 +183,10 @@ sap.ui.define([
 				commandFactory: this._oCommandFactory
 			});
 
+			this._mDefaultPlugins["resize"] = new ResizePlugin({
+				commandFactory: this._oCommandFactory
+			});
+
 			this._mDefaultPlugins["contextMenu"] = new ContextMenuPlugin();
 
 			this._mDefaultPlugins["tabHandling"] = new TabHandlingPlugin();
@@ -207,7 +213,7 @@ sap.ui.define([
 			if (
 				oFlexSettings.layer === Layer.CUSTOMER
 				&& oSettings
-				&& !oSettings.isVersioningEnabled(oFlexSettings.layer)
+				&& oSettings.isPublicLayerAvailable()
 			) {
 				this._mDefaultPlugins["localReset"] = new LocalResetPlugin({
 					commandFactory: this._oCommandFactory

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

@@ -8,6 +8,7 @@ sap.ui.define([
 	"sap/ui/base/ManagedObject",
 	"sap/m/InstanceManager",
 	"sap/ui/dt/Overlay",
+	"sap/ui/dt/OverlayRegistry",
 	"sap/ui/fl/Utils",
 	"sap/ui/core/Component",
 	"sap/ui/core/ComponentContainer",
@@ -20,6 +21,7 @@ sap.ui.define([
 	ManagedObject,
 	InstanceManager,
 	Overlay,
+	OverlayRegistry,
 	flUtils,
 	Component,
 	ComponentContainer,
@@ -40,7 +42,7 @@ sap.ui.define([
 	 * Constructor for a new sap.ui.rta.util.PopupManager
 	 * @extends sap.ui.base.ManagedObject
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 * @constructor
 	 * @private
 	 * @since 1.48
@@ -58,17 +60,17 @@ sap.ui.define([
 				 * To set the associated controls as an autoCloseArea for all Popover/Dialog open in RTA mode.
 				 * Needs to be filled before the popup is open.
 				 */
-				autoCloseAreas: {type: "sap.ui.core.Control", multiple: true, singularName: "autoCloseArea"}
+				autoCloseAreas: { type: "sap.ui.core.Control", multiple: true, singularName: "autoCloseArea" }
 			},
 			events: {
 				open: {
 					parameters: {
-						oControl: {type: "sap.ui.core.Control"}
+						oControl: { type: "sap.ui.core.Control" }
 					}
 				},
 				close: {
 					parameters: {
-						oControl: {type: "sap.ui.core.Control"}
+						oControl: { type: "sap.ui.core.Control" }
 					}
 				}
 			},
@@ -85,7 +87,7 @@ sap.ui.define([
 		// create map for modal states
 		this._oModalState = new Map();
 		this._aPopupFilters = [this._isSupportedPopup.bind(this), this._isPopupAdaptable.bind(this)];
-		this._aPopupFilters.forEach(function (fnFilter) {
+		this._aPopupFilters.forEach(function(fnFilter) {
 			ZIndexManager.addPopupFilter(fnFilter);
 		});
 	};
@@ -214,14 +216,27 @@ sap.ui.define([
 		}
 	};
 
+	/**
+	 * Setting visibility hidden on the other root element overlays
+	 * keeps the focus on the current popover overlay
+	 * @param {boolean} bVisible - Overlay visibility
+	 * @param {sap.m.Popover} oPopover - Current popover
+	 */
+	PopupManager.prototype._adjustRootOverlayVisibility = function(bVisible, oPopover) {
+		this.getRta()._oDesignTime.getRootElements().forEach(function(oRootElement) {
+			if (oRootElement.getId() !== oPopover.getId()) {
+				OverlayRegistry.getOverlay(oRootElement).setVisible(bVisible);
+			}
+		});
+	};
+
 	/**
 	 * Attached to RTA mode change
 	 * @param  {sap.ui.base.Event} oEvent The Event triggered by the mode change
 	 */
 	PopupManager.prototype._onModeChange = function(oEvent) {
 		var sNewMode = oEvent.getParameters().mode;
-
-		var fnApplyFocusAndSetModal = function (sMode, oPopover) {
+		var fnApplyFocusAndSetModal = function(sMode, oPopover) {
 			if (sMode === 'navigation') {
 				// add focus handlers
 				oPopover.oPopup[this._getFocusEventName("add")]();
@@ -325,13 +340,19 @@ sap.ui.define([
 	 *
 	 * @private
 	 */
-	PopupManager.prototype._setModal = function (bSetModal, oPopupElement) {
+	PopupManager.prototype._setModal = function(bSetModal, oPopupElement) {
 		var bOriginalModalState = this._oModalState.get(oPopupElement.oPopup);
-		if (typeof bOriginalModalState !== "boolean" && bSetModal && this.getRta().getMode() === 'adaptation') {
+		if (typeof bOriginalModalState !== "boolean" && bSetModal && this.getRta().getMode() !== 'navigation') {
 			this._oModalState.set(oPopupElement.oPopup, oPopupElement.oPopup.getModal());
+			if (this._isPopupAdaptable(oPopupElement)) {
+				this._adjustRootOverlayVisibility(false, oPopupElement);
+			}
 			oPopupElement.oPopup.setModal(true);
 		} else if (typeof bOriginalModalState === "boolean" && bSetModal === false) {
 			oPopupElement.oPopup.setModal(bOriginalModalState);
+			if (this._isPopupAdaptable(oPopupElement)) {
+				this._adjustRootOverlayVisibility(true, oPopupElement);
+			}
 			this._oModalState.delete(oPopupElement.oPopup);
 		}
 	};
@@ -395,7 +416,7 @@ sap.ui.define([
 		if (!this.fnOriginalPopupOnAfterRendering) {
 			this.fnOriginalPopupOnAfterRendering = oPopup.onAfterRendering;
 		}
-		oPopup.onAfterRendering = function () {
+		oPopup.onAfterRendering = function() {
 			var vOriginalReturn = this.fnOriginalPopupOnAfterRendering.apply(oPopup, arguments);
 			oPopup[this._getFocusEventName("remove")]();
 			return vOriginalReturn;
@@ -433,7 +454,7 @@ sap.ui.define([
 		return function(oPopupElement) {
 			var vOriginalReturn = fnOriginalFunction.apply(InstanceManager, arguments);
 			if (this._isSupportedPopup(oPopupElement)) {
-				if (this._isPopupAdaptable(oPopupElement, false)
+				if (this._isPopupAdaptable(oPopupElement)
 					&& this.getRta()._oDesignTime) {
 					this.getRta()._oDesignTime.removeRootElement(oPopupElement);
 				}
@@ -597,7 +618,7 @@ sap.ui.define([
 	PopupManager.prototype.exit = function() {
 		this._restoreInstanceFunctions();
 		delete this._oModalState;
-		this._aPopupFilters.forEach(function (fnFilter) {
+		this._aPopupFilters.forEach(function(fnFilter) {
 			ZIndexManager.removePopupFilter(fnFilter);
 		});
 	};

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

@@ -19,7 +19,7 @@ function(
 	 *
 	 * @extends sap.ui.core.EventBus
 	 * @author SAP SE
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 * @private
 	 * @since 1.56.0
 	 * @alias sap.ui.rta.util.ServiceEventBus

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

@@ -4,43 +4,59 @@
  * Licensed under the Apache License, Version 2.0 - see LICENSE.txt.
  */
 sap.ui.define([
-	"sap/ui/rta/RuntimeAuthoring",
+	"sap/base/Log",
 	"sap/ui/core/Control",
-	"sap/ui/fl/Utils",
-	"sap/ui/fl/Layer",
-	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/core/UIComponent",
-	"sap/base/Log",
+	"sap/ui/fl/write/api/FeaturesAPI",
 	"sap/ui/fl/write/api/PersistenceWriteAPI",
-	"sap/ui/rta/util/showMessageBox"
+	"sap/ui/fl/Layer",
+	"sap/ui/fl/Utils",
+	"sap/ui/rta/util/showMessageBox",
+	"sap/ui/rta/RuntimeAuthoring"
 ], function(
-	RuntimeAuthoring,
+	Log,
 	Control,
-	FlexUtils,
-	Layer,
-	FeaturesAPI,
 	UIComponent,
-	Log,
+	FeaturesAPI,
 	PersistenceWriteAPI,
-	showMessageBox
+	Layer,
+	FlexUtils,
+	showMessageBox,
+	RuntimeAuthoring
 ) {
 	"use strict";
 
 	function checkKeyUser(sLayer) {
 		if (Layer.CUSTOMER === sLayer) {
 			return FeaturesAPI.isKeyUser()
-				.then(function (bIsKeyUser) {
+				.then(function(bIsKeyUser) {
 					if (!bIsKeyUser) {
-						throw new Error("Key user rights have not been granted to the current user");
+						var oError = Error("Key user rights have not been granted to the current user");
+						oError.reason = "isKeyUser";
+						throw oError;
 					}
 				});
 		}
 		return Promise.resolve();
 	}
 
+	function checkFlexEnabled(oAppComponent) {
+		var oManifest = oAppComponent.getManifest() || {};
+		var vFlexEnabled = oManifest["sap.ui5"] && oManifest["sap.ui5"].flexEnabled;
+
+		if (vFlexEnabled === false) {
+			var oError = Error("This app is not enabled for key user adaptation");
+			oError.reason = "flexEnabled";
+			throw oError;
+		}
+	}
+
 	/**
 	 * Starter util for UI adaptation.
 	 * With this API you are also able to modify the UI adaptation plugins list and or add some event handler functions to be called on start, failed and stop events.
+	 * The function also checks for the Key User authorization and the <code>flexEnabled</code> flag in the manifest.
+	 * If either check is not passed successfully the function returns a rejected Promise.
+	 *
 	 * @param {object} mOptions - Object with properties
 	 * @param {sap.ui.core.Control|sap.ui.core.UIComponent} mOptions.rootControl - Control instance to get the AppComponent. This then is used to start UI adaptation.
 	 * @param {function} [loadPlugins] - Callback function that enables the modification of the default plugin list of UI adaptation. UI adaptation is passed to this function and it should return a promise
@@ -51,78 +67,84 @@ sap.ui.define([
 	 * @private
 	 */
 	function adaptationStarter(mOptions, loadPlugins, onStart, onFailed, onStop) {
-		if (!(mOptions.rootControl instanceof Control) && !(mOptions.rootControl instanceof UIComponent)) {
-			return Promise.reject(new Error("An invalid root control was passed"));
-		}
-
 		var oRta;
-		return checkKeyUser(mOptions.flexSettings.layer)
-			.then(function () {
-				mOptions.rootControl = FlexUtils.getAppComponentForControl(mOptions.rootControl);
 
-				oRta = new RuntimeAuthoring(mOptions);
+		return Promise.resolve().then(function() {
+			if (!(mOptions.rootControl instanceof Control) && !(mOptions.rootControl instanceof UIComponent)) {
+				var oError = Error("An invalid root control was passed");
+				oError.reason = "rootControl";
+				throw oError;
+			}
+			mOptions.rootControl = FlexUtils.getAppComponentForControl(mOptions.rootControl);
+		})
+		.then(checkKeyUser.bind(undefined, mOptions.flexSettings.layer))
+		.then(function() {
+			return checkFlexEnabled(mOptions.rootControl);
+		})
+		.then(function() {
+			oRta = new RuntimeAuthoring(mOptions);
 
-				if (onStart) {
-					oRta.attachEvent("start", onStart);
-				}
-				if (onFailed) {
-					oRta.attachEvent("failed", onFailed);
-				}
-				var fnOnStop = onStop || function () {
-					oRta.destroy();
-				};
-				oRta.attachEvent("stop", fnOnStop);
+			if (onStart) {
+				oRta.attachEvent("start", onStart);
+			}
+			if (onFailed) {
+				oRta.attachEvent("failed", onFailed);
+			}
+			var fnOnStop = onStop || function() {
+				oRta.destroy();
+			};
+			oRta.attachEvent("stop", fnOnStop);
 
-				if (loadPlugins) {
-					return loadPlugins(oRta);
-				}
-			})
-			.then(function() {
-				return oRta.start();
-			})
-			.then(function() {
-				if (mOptions.flexSettings.layer === "CUSTOMER") {
-					var mPropertyBag = {
-						oComponent: mOptions.rootControl,
-						selector: mOptions.rootControl,
-						invalidateCache: false,
-						includeVariants: true,
-						includeCtrlVariants: true,
-						currentLayer: Layer.CUSTOMER
-					};
+			if (loadPlugins) {
+				return loadPlugins(oRta);
+			}
+		})
+		.then(function() {
+			return oRta.start();
+		})
+		.then(function() {
+			if (mOptions.flexSettings.layer === "CUSTOMER") {
+				var mPropertyBag = {
+					oComponent: mOptions.rootControl,
+					selector: mOptions.rootControl,
+					invalidateCache: false,
+					includeVariants: true,
+					includeCtrlVariants: true,
+					currentLayer: Layer.CUSTOMER
+				};
 
-					PersistenceWriteAPI.getChangesWarning(mPropertyBag)
-						.then(function(oWarningMessage) {
-							if (oWarningMessage.showWarning) {
-								var oRtaResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
-								var oMessageProps = oWarningMessage.warningType === "mixedChangesWarning"
-									? {
-										text: "MSG_ADAPTATION_STARTER_MIXED_CHANGES_WARNING",
-										title: "TIT_ADAPTATION_STARTER_MIXED_CHANGES_TITLE"
-									}
-									: {
-										text: "MSG_ADAPTATION_STARTER_NO_CHANGES_IN_P_WARNING",
-										title: "TIT_ADAPTATION_STARTER_NO_CHANGES_IN_P_TITLE"
-									};
+				PersistenceWriteAPI.getChangesWarning(mPropertyBag)
+					.then(function(oWarningMessage) {
+						if (oWarningMessage.showWarning) {
+							var oRtaResourceBundle = sap.ui.getCore().getLibraryResourceBundle("sap.ui.rta");
+							var oMessageProps = oWarningMessage.warningType === "mixedChangesWarning"
+								? {
+									text: "MSG_ADAPTATION_STARTER_MIXED_CHANGES_WARNING",
+									title: "TIT_ADAPTATION_STARTER_MIXED_CHANGES_TITLE"
+								}
+								: {
+									text: "MSG_ADAPTATION_STARTER_NO_CHANGES_IN_P_WARNING",
+									title: "TIT_ADAPTATION_STARTER_NO_CHANGES_IN_P_TITLE"
+								};
 
-								showMessageBox(
-									oRtaResourceBundle.getText(oMessageProps.text),
-									{
-										title: oRtaResourceBundle.getText(oMessageProps.title)
-									},
-									"warning"
-								);
-							}
-						});
-				}
-				return oRta;
-			})
-			.catch(function(vError) {
-				if (vError !== "Reload triggered") {
-					Log.error("UI Adaptation could not be started", vError.message);
-				}
-				throw vError;
-			});
+							showMessageBox(
+								oRtaResourceBundle.getText(oMessageProps.text),
+								{
+									title: oRtaResourceBundle.getText(oMessageProps.title)
+								},
+								"warning"
+							);
+						}
+					});
+			}
+			return oRta;
+		})
+		.catch(function(vError) {
+			if (vError !== "Reload triggered") {
+				Log.error("UI Adaptation could not be started", vError.message);
+			}
+			throw vError;
+		});
 	}
 	return adaptationStarter;
 });

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

@@ -48,7 +48,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicator
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 * @private
 	 */
 	var ChangeIndicator = Control.extend("sap.ui.rta.util.changeVisualization.ChangeIndicator", {
@@ -142,6 +142,9 @@ sap.ui.define([
 
 			this._fnHoverTrue = this._toggleHoverStyleClasses.bind(this, true);
 			this._fnHoverFalse = this._toggleHoverStyleClasses.bind(this, false);
+			// is needed to prevent that multiple events listeners are attached
+			// to the same overlay because setVisible is called multiple times
+			this._bEventAttachedToElement = false;
 		}
 	});
 
@@ -175,10 +178,13 @@ sap.ui.define([
 		var oOverlay = Core.byId(this.getOverlayId());
 		// needed because the change indicator cleanup is only triggered on save and exit
 		if (oOverlay) {
-			if (bVisible) {
+			if (bVisible && !this._bEventAttachedToElement) {
 				handleBrowserEventsOnElement.call(this, oOverlay, "attachBrowserEvent");
-			} else {
+				this._bEventAttachedToElement = true;
+			}
+			if (!bVisible) {
 				handleBrowserEventsOnElement.call(this, oOverlay, "detachBrowserEvent");
+				this._bEventAttachedToElement = false;
 				if (this.getAggregation("_popover")) {
 					this.getAggregation("_popover").destroy();
 				}
@@ -276,10 +282,11 @@ sap.ui.define([
 			return mPayload;
 		}, {});
 
+		var mPropertyBag = { appComponent: FlUtils.getAppComponentForControl(oAffectedElement) };
 		var oOverlay = Core.byId(this.getOverlayId());
 		var sElementLabel = oOverlay.getDesignTimeMetadata().getLabel(oAffectedElement);
 		var oVisualizationUtil = getVisualizationCategory(mChangeInformation.commandName);
-		var oDescription = oVisualizationUtil && oVisualizationUtil.getDescription(mPayload, sElementLabel);
+		var oDescription = oVisualizationUtil && oVisualizationUtil.getDescription(mPayload, sElementLabel, mPropertyBag);
 		var oRtaResourceBundle = Core.getLibraryResourceBundle("sap.ui.rta");
 		sElementLabel = sElementLabel && "'" + sElementLabel + "'";
 		var sShortenedElementLabel = ChangeVisualizationUtils.shortenString(sElementLabel);

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

@@ -0,0 +1,30 @@
+<core:FragmentDefinition
+	xmlns:core="sap.ui.core"
+	xmlns="sap.m"
+	xmlns:l="sap.ui.layout">
+	<Popover
+		showHeader="false"
+		placement="Bottom">
+		<MessageStrip
+			text="{visualizationModel>/popupInfoMessage}"
+			type="Information"
+			showIcon="true"
+			visible="{= ${visualizationModel>/hiddenChanges}.length > 0 }">
+			<link>
+				<Link text="{i18n>BUT_CHANGEVISUALIZATION_LEARNMORE}"
+					target="_blank"
+					href="https://ui5.sap.com/1.101.0/#/topic/35274280504f42cd87cc4fd3d403ca91.html#loio35274280504f42cd87cc4fd3d403ca91/visualization" />
+			</link>
+		</MessageStrip>
+		<List
+			class="sapUiRtaChangesList"
+			items="{visualizationModel>/commandCategories/}">
+			<StandardListItem
+				title="{visualizationModel>title}"
+				counter="{visualizationModel>count}"
+				type="{= ${visualizationModel>count} > 0 ? 'Active' : 'Inactive'}"
+				icon="{visualizationModel>icon}"
+				press=".onCommandCategorySelection"/>
+		</List>
+	</Popover>
+</core:FragmentDefinition>

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

@@ -5,7 +5,7 @@
 	<Popover
 		showHeader="false"
 		placement="PreferredTopOrFlip"
-		class="sapUiRtaPopover">
+		class="sapUiRtaPopover sapUiRtaChangeVisualizationPopover">
 		<Table
 			ariaLabelledBy="Changes"
 			items="{details>/}"

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

@@ -25,7 +25,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry
 	 * @author SAP SE
 	 * @since 1.86.0
-	 * @version 1.99.1
+	 * @version 1.102.0
 	 * @private
 	 */
 	var ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {
@@ -168,11 +168,6 @@ sap.ui.define([
 			}
 		};
 
-		// Only register changes that are valid for visualization
-		if (oNewChangeInformation.commandCategory === undefined) {
-			return;
-		}
-
 		this._oChanges[oChange.getId()] = oNewChangeInformation;
 	};