@openui5/sap.ui.rta 1.102.1 → 1.103.1

package/src/sap/ui/rta/toolbar/versioning/Versioning.js

@@ -0,0 +1,271 @@
+/*!
+ * 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/m/GroupHeaderListItem",
+	"sap/ui/base/ManagedObject",
+	"sap/ui/core/format/DateFormat",
+	"sap/ui/core/Fragment",
+	"sap/ui/core/library",
+	"sap/ui/fl/write/api/Version",
+	"sap/ui/model/Sorter",
+	"sap/ui/rta/Utils"
+], function(
+	GroupHeaderListItem,
+	ManagedObject,
+	DateFormat,
+	Fragment,
+	coreLibrary,
+	Version,
+	Sorter,
+	Utils
+) {
+	"use strict";
+
+	var MessageType = coreLibrary.MessageType;
+	var DRAFT_ACCENT_COLOR = "sapUiRtaDraftVersionAccent";
+	var ACTIVE_ACCENT_COLOR = "sapUiRtaActiveVersionAccent";
+
+	/**
+	 * Controller for the <code>sap.ui.rta.toolbar.versioning.Versioning</code> controls.
+	 * Contains implementation of versioning functionality.
+	 *
+	 * @class
+	 *
+	 * @author SAP SE
+	 * @version 1.103.1
+	 *
+	 * @constructor
+	 * @private
+	 * @since 1.103
+	 * @alias sap.ui.rta.toolbar.versioning.Versioning
+	 */
+	var Versioning = ManagedObject.extend("sap.ui.rta.toolbar.versioning.Versioning", {
+		metadata: {
+			properties: {
+				toolbar: {
+					type: "any" // "sap.ui.rta.toolbar.Base"
+				}
+			}
+		},
+		constructor: function() {
+			ManagedObject.prototype.constructor.apply(this, arguments);
+			this.oTextResources = this.getToolbar().getTextResources();
+		}
+	});
+
+	function versionSelected(oEvent) {
+		var oVersionsBindingContext = oEvent.getSource().getBindingContext("versions");
+		var sVersion = Version.Number.Original;
+
+		if (oVersionsBindingContext) {
+			// the original Version does not have a version binding Context
+			sVersion = oVersionsBindingContext.getProperty("version");
+		}
+
+		this.getToolbar().fireEvent("switchVersion", {version: sVersion});
+	}
+
+	function doesActiveVersionExists (aVersions) {
+		return aVersions.some(function (oVersion) {
+			return oVersion.type === Version.Type.Active;
+		});
+	}
+
+	// ------ formatting ------
+	function formatOriginalAppHighlight(aVersions) {
+		return doesActiveVersionExists(aVersions) ? MessageType.None : MessageType.Success;
+	}
+
+	function formatOriginalAppHighlightText(aVersions) {
+		return doesActiveVersionExists(aVersions) ? this.oTextResources.getText("LBL_INACTIVE") : this.oTextResources.getText("LBL_ACTIVE");
+	}
+
+	function formatHighlight(sType) {
+		switch (sType) {
+			case Version.Type.Draft:
+				return MessageType.Warning;
+			case Version.Type.Active:
+				return MessageType.Success;
+			default:
+				return MessageType.None;
+		}
+	}
+
+	function formatHighlightText(sType) {
+		switch (sType) {
+			case Version.Type.Draft:
+				return this.oTextResources.getText("TIT_DRAFT");
+			case Version.Type.Active:
+				return this.oTextResources.getText("LBL_ACTIVE");
+			default:
+				return this.oTextResources.getText("LBL_INACTIVE");
+		}
+	}
+
+	function formatVersionTitle(sTitle, sType) {
+		if (sType === Version.Type.Draft) {
+			return this.oTextResources.getText("TIT_DRAFT");
+		}
+
+		return sTitle || this.oTextResources.getText("TIT_VERSION_1");
+	}
+
+	function formatVersionTimeStamp(sActivatedAtTimeStamp, sImportedAtTimeStamp) {
+		var sTimeStamp = sImportedAtTimeStamp || sActivatedAtTimeStamp;
+
+		if (!sTimeStamp) {
+			// in case of "Original App" and "Draft" no timestamp is set
+			return "";
+		}
+
+		return DateFormat.getInstance({
+			format: "yMMMdjm"
+		}).format(new Date(sTimeStamp));
+	}
+
+	function getGroupHeaderFactory(oGroup) {
+		return new GroupHeaderListItem({
+			title: oGroup.key ? this.oTextResources.getText("TIT_VERSION_HISTORY_PUBLISHED") : this.oTextResources.getText("TIT_VERSION_HISTORY_UNPUBLISHED"),
+			upperCase: false,
+			visible: this.getToolbar().getModel("controls").getProperty("/publishVisible")
+		}).addStyleClass("sapUiRtaVersionHistoryGrouping").addStyleClass("sapUiRtaVersionHistory");
+	}
+
+	function setVersionButtonAccentColor(oVersionButton, sType) {
+		switch (sType) {
+			case Version.Type.Draft:
+				oVersionButton.addStyleClass(DRAFT_ACCENT_COLOR);
+				oVersionButton.removeStyleClass(ACTIVE_ACCENT_COLOR);
+				break;
+			case Version.Type.Active:
+				oVersionButton.addStyleClass(ACTIVE_ACCENT_COLOR);
+				oVersionButton.removeStyleClass(DRAFT_ACCENT_COLOR);
+				break;
+			default:
+				oVersionButton.removeStyleClass(ACTIVE_ACCENT_COLOR);
+				oVersionButton.removeStyleClass(DRAFT_ACCENT_COLOR);
+		}
+	}
+
+	Versioning.prototype.formatVersionButtonText = function(aVersions, sDisplayedVersion) {
+		var sText = "";
+		var sType = "Active";
+		aVersions = aVersions || [];
+
+		if (sDisplayedVersion === undefined || sDisplayedVersion === Version.Number.Original) {
+			sText = this.oTextResources.getText("TIT_ORIGINAL_APP");
+			sType = Version.Type.Inactive;
+			if (aVersions.length === 0 || (aVersions.length === 1 && aVersions[0].type === Version.Type.Draft)) {
+				sType = Version.Type.Active;
+			}
+		} else {
+			var oDisplayedVersion = aVersions.find(function (oVersion) {
+				return oVersion.version === sDisplayedVersion;
+			});
+			if (oDisplayedVersion) {
+				sType = oDisplayedVersion.type;
+				if (sDisplayedVersion === Version.Number.Draft) {
+					sText = this.oTextResources.getText("TIT_DRAFT");
+				} else {
+					sText = oDisplayedVersion.title || this.oTextResources.getText("TIT_VERSION_1");
+				}
+			}
+		}
+		setVersionButtonAccentColor(this.getToolbar().getControl("versionButton"), sType);
+		return sText;
+	};
+
+	Versioning.prototype.formatPublishVersionVisibility = function(bPublishVisible, bVersioningEnabled, sDisplayedVersion, sModeSwitcher) {
+		return bPublishVisible && bVersioningEnabled && sDisplayedVersion !== Version.Number.Draft && sModeSwitcher === "adaptation";
+	};
+
+	Versioning.prototype.formatDiscardDraftVisible = function(sDisplayedVersion, bVersioningEnabled, sModeSwitcher) {
+		return sDisplayedVersion === Version.Number.Draft && bVersioningEnabled && sModeSwitcher === "adaptation";
+	};
+
+	// ------ Dialog handling ------
+	Versioning.prototype.showVersionHistory = function(oEvent) {
+		var oVersionButton = oEvent.getSource();
+
+		if (!this._oVersionHistoryDialogPromise) {
+			this._oVersionHistoryDialogPromise = Fragment.load({
+				name: "sap.ui.rta.toolbar.versioning.VersionHistory",
+				id: this.getToolbar().getId() + "_fragment--sapUiRta_versionHistoryDialog",
+				controller: {
+					formatVersionTitle: formatVersionTitle.bind(this),
+					formatVersionTimeStamp: formatVersionTimeStamp,
+					formatHighlight: formatHighlight,
+					formatHighlightText: formatHighlightText.bind(this),
+					formatOriginalAppHighlight: formatOriginalAppHighlight,
+					formatOriginalAppHighlightText: formatOriginalAppHighlightText.bind(this),
+					versionSelected: versionSelected.bind(this),
+					getGroupHeaderFactory: getGroupHeaderFactory.bind(this)
+				}
+			}).then(function(oDialog) {
+				this.getToolbar().addDependent(oDialog);
+				return oDialog;
+			}.bind(this));
+		}
+
+		return this._oVersionHistoryDialogPromise.then(function(oVersionsDialog) {
+			if (!oVersionsDialog.isOpen()) {
+				oVersionsDialog.openBy(oVersionButton);
+				if (this.getToolbar().getModel("controls").getProperty("/publishVisible")) {
+					var oList = this.getToolbar().getControl("versionHistoryDialog--versionList");
+					var oSorter = new Sorter({
+						path: "isPublished",
+						group: true
+					});
+					oList.getBinding("items").sort(oSorter);
+				}
+			} else {
+				oVersionsDialog.close();
+			}
+		}.bind(this));
+	};
+
+	Versioning.prototype.openActivateVersionDialog = function(sDisplayedVersion) {
+		if (!this._oActivateVersionDialogPromise) {
+			this._oActivateVersionDialogPromise = Fragment.load({
+				name: "sap.ui.rta.toolbar.versioning.VersionTitleDialog",
+				id: this.getToolbar().getId() + "_fragment--sapUiRta_activateVersionDialog",
+				controller: {
+					onConfirmVersioningDialog: function () {
+						var sVersionTitle = this.getToolbar().getControl("activateVersionDialog--versionTitleInput").getValue();
+						this.getToolbar().fireEvent("activate", {versionTitle: sVersionTitle});
+						this._oActivateVersionDialog.close();
+					}.bind(this),
+					onCancelVersioningDialog: function () {
+						this._oActivateVersionDialog.close();
+					}.bind(this),
+					onVersionTitleLiveChange: function (oEvent) {
+						var sValue = oEvent.getParameter("value");
+						this.getToolbar().getControl("activateVersionDialog--confirmVersionTitleButton").setEnabled(!!sValue);
+					}.bind(this)
+				}
+			}).then(function (oDialog) {
+				this._oActivateVersionDialog = oDialog;
+				oDialog.addStyleClass(Utils.getRtaStyleClassName());
+				this.getToolbar().addDependent(this._oActivateVersionDialog);
+			}.bind(this));
+		} else {
+			this.getToolbar().getControl("activateVersionDialog--versionTitleInput").setValue("");
+			this.getToolbar().getControl("activateVersionDialog--confirmVersionTitleButton").setEnabled(false);
+		}
+
+		return this._oActivateVersionDialogPromise.then(function () {
+			var sTitle = this.oTextResources.getText("TIT_VERSION_TITLE_DIALOG");
+			if (sDisplayedVersion !== Version.Number.Draft) {
+				sTitle = this.oTextResources.getText("TIT_REACTIVATE_VERSION_TITLE_DIALOG");
+			}
+			this._oActivateVersionDialog.setTitle(sTitle);
+			return this._oActivateVersionDialog.open();
+		}.bind(this));
+	};
+
+	return Versioning;
+});

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

@@ -68,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.102.1
+	 * @version 1.103.1
 	 * @constructor
 	 * @private
 	 * @since 1.86

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

@@ -42,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.102.1
+	 * @version 1.103.1
 	 * @constructor
 	 * @private
 	 * @since 1.48

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

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

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.102.1
+	 * @version 1.103.1
 	 * @private
 	 */
 	var ChangeIndicator = Control.extend("sap.ui.rta.util.changeVisualization.ChangeIndicator", {

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

@@ -13,7 +13,7 @@
 			<link>
 				<Link text="{i18n>BUT_CHANGEVISUALIZATION_LEARNMORE}"
 					target="_blank"
-					href="https://ui5.sap.com/1.101.0/#/topic/35274280504f42cd87cc4fd3d403ca91.html#loio35274280504f42cd87cc4fd3d403ca91/visualization" />
+					href="https://ui5.sap.com/#/topic/35274280504f42cd87cc4fd3d403ca91.html#loio35274280504f42cd87cc4fd3d403ca91/visualization"/>
 			</link>
 		</MessageStrip>
 		<List

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.102.1
+	 * @version 1.103.1
 	 * @private
 	 */
 	var ChangeIndicatorRegistry = ManagedObject.extend("sap.ui.rta.util.changeVisualization.ChangeIndicatorRegistry", {

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

@@ -93,7 +93,7 @@ sap.ui.define([
 	 * @alias sap.ui.rta.util.changeVisualization.ChangeVisualization
 	 * @author SAP SE
 	 * @since 1.84.0
-	 * @version 1.102.1
+	 * @version 1.103.1
 	 * @private
 	 */
 	var ChangeVisualization = Control.extend("sap.ui.rta.util.changeVisualization.ChangeVisualization", {
@@ -608,7 +608,7 @@ sap.ui.define([
 	 * Triggers the mode switch (on/off).
 	 *
 	 * @param {sap.ui.base.ManagedObject} oRootControl - Root control of the overlays
-	 * @param {sap.ui.triggerModeChange.Toolbar} oToolbar - Toolbar of RTA
+	 * @param {sap.ui.rta.toolbar.Adaptation} oToolbar - Toolbar of RTA
 	 */
 	ChangeVisualization.prototype.triggerModeChange = function(oRootControl, oToolbar) {
 		this.oMenuButton = oToolbar.getControl("toggleChangeVisualizationMenuButton");