@sapui5/sap.fe.core 1.96.4 → 1.99.0

package/src/sap/fe/core/controllerextensions/KPIManagement.ts

@@ -1,17 +1,23 @@
-import { ControllerExtension } from "sap/ui/core/mvc";
+import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
 import { ControllerExtensionMetadata } from "sap/fe/core/controllerextensions";
 import { UI5Class, Override, Public } from "../helpers/ClassSupport";
-import { JSONModel } from "sap/ui/model/json";
-import { ODataModel, Context } from "sap/ui/model/odata/v4";
-import { Log } from "sap/base";
-import { KPIChartDefinition, KPIDefinition } from "sap/fe/core/converters/controls/Common/KPI";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import ODataModel from "sap/ui/model/odata/v4/ODataModel";
+import Context from "sap/ui/model/odata/v4/Context";
+import Log from "sap/base/Log";
+import { KPIChartDefinition, KPIDefinition, NavigationInfo } from "sap/fe/core/converters/controls/Common/KPI";
 import { BaseController } from "sap/fe/core";
 import { MessageType } from "sap/fe/core/formatters/TableFormatterTypes";
 import { FilterDefinition, RangeDefinition } from "sap/fe/core/converters/helpers/SelectionVariantHelper";
-import { NumberFormat, DateFormat } from "sap/ui/core/format";
-import { Locale } from "sap/ui/core";
-import { Filter, FilterOperator, Sorter } from "sap/ui/model";
-import { GenericTag, Popover } from "sap/m";
+import NumberFormat from "sap/ui/core/format/NumberFormat";
+import DateFormat from "sap/ui/core/format/DateFormat";
+import Locale from "sap/ui/core/Locale";
+import Filter from "sap/ui/model/Filter";
+import FilterOperator from "sap/ui/model/FilterOperator";
+import Sorter from "sap/ui/model/Sorter";
+import GenericTag from "sap/m/GenericTag";
+import Popover from "sap/m/Popover";
+import ResourceBundle from "sap/base/i18n/ResourceBundle";
 
 const MessageTypeFromCriticality: Record<string, MessageType> = {
 	"1": MessageType.Error,
@@ -211,7 +217,7 @@ function getFilterStringFromDefinition(filterDefinition: FilterDefinition): stri
 			.getConfiguration()
 			.getLanguage()
 	);
-	const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core");
+	const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
 	const dateFormat = DateFormat.getDateInstance({ style: "medium" }, currentLocale);
 
 	function formatRange(range: RangeDefinition): string {
@@ -263,7 +269,7 @@ function getFilterStringFromDefinition(filterDefinition: FilterDefinition): stri
 }
 
 function formatChartTitle(kpiDef: KPIDefinition): string {
-	const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core");
+	const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
 
 	function formatList(items: { name: string; label: string }[]) {
 		if (items.length === 0) {
@@ -522,6 +528,37 @@ function getChartFeeds(chartDefinition: KPIChartDefinition): { uid: string; type
 	return res;
 }
 
+function getNavigationParameters(
+	navInfo: NavigationInfo,
+	oShellService: any
+): Promise<{ semanticObject?: string; action?: string; outbound?: string } | undefined> {
+	if (navInfo.semanticObject) {
+		if (navInfo.action) {
+			// Action is already specified: check if it's available in the shell
+			return oShellService.getLinks({ semanticObject: navInfo.semanticObject, action: navInfo.action }).then((aLinks: any[]) => {
+				return aLinks.length ? { semanticObject: navInfo.semanticObject, action: navInfo.action } : undefined;
+			});
+		} else {
+			// We get the primary intent from the shell
+			return oShellService.getPrimaryIntent(navInfo.semanticObject).then((oLink: any) => {
+				if (!oLink) {
+					// No primary intent...
+					return undefined;
+				}
+
+				// Check that the primary intent is not part of the unavailable actions
+				const oInfo = oShellService.parseShellHash(oLink.intent);
+				return navInfo.unavailableActions && navInfo.unavailableActions.indexOf(oInfo.action) >= 0
+					? undefined
+					: { semanticObject: oInfo.semanticObject, action: oInfo.action };
+			});
+		}
+	} else {
+		// Outbound navigation specified in the manifest
+		return navInfo.outboundNavigation ? Promise.resolve({ outbound: navInfo.outboundNavigation }) : Promise.resolve(undefined);
+	}
+}
+
 /**
  * @class A controller extension for managing the KPIs in an analytical list page
  *
@@ -543,7 +580,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 	 * @param kpiDefinition The KPI definition
 	 * @param oKPIModel The JSON model in which the manifest will be stored
 	 */
-	protected initCardManifest(kpiDefinition: KPIDefinition, oKPIModel: JSONModel<any>): void {
+	protected initCardManifest(kpiDefinition: KPIDefinition, oKPIModel: JSONModel): void {
 		const oCardManifest: any = {
 			"sap.app": {
 				id: "sap.fe",
@@ -587,7 +624,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 
 		// Add side indicators in the card header if a target is defined for the KPI
 		if (kpiDefinition.datapoint.targetPath || kpiDefinition.datapoint.targetValue !== undefined) {
-			const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core");
+			const resBundle = sap.ui.getCore().getLibraryResourceBundle("sap.fe.core") as ResourceBundle;
 			oCardManifest["sap.card"].header.sideIndicators = [
 				{
 					title: resBundle.getText("C_KPICARD_INDICATOR_TARGET"),
@@ -634,6 +671,24 @@ class KPIManagementControllerExtension extends ControllerExtension {
 		});
 	}
 
+	protected initNavigationInfo(kpiDefinition: KPIDefinition, oKPIModel: JSONModel, oShellService: any): Promise<void> {
+		// Add navigation
+		if (kpiDefinition.navigation) {
+			return getNavigationParameters(kpiDefinition.navigation, oShellService).then(oNavInfo => {
+				if (oNavInfo) {
+					oKPIModel.setProperty("/" + kpiDefinition.id + "/manifest/sap.card/header/actions", [
+						{
+							type: "Navigation",
+							parameters: oNavInfo
+						}
+					]);
+				}
+			});
+		} else {
+			return Promise.resolve();
+		}
+	}
+
 	@Override()
 	public onInit(): void {
 		this.aKPIDefinitions = this.getKPIData();
@@ -650,6 +705,11 @@ class KPIManagementControllerExtension extends ControllerExtension {
 				// Create the manifest for the KPI card and store it in the KPI model
 				this.initCardManifest(kpiDefinition, oKPIModel);
 
+				// Set the navigation information in the manifest
+				this.initNavigationInfo(kpiDefinition, oKPIModel, oAppComponent.getShellServices()).catch(function(err: any) {
+					Log.error(err);
+				});
+
 				// Load tag data for the KPI
 				this.loadKPITagData(kpiDefinition, oAppComponent.getModel() as ODataModel, oKPIModel).catch(function(err: any) {
 					Log.error(err);
@@ -660,7 +720,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 
 	@Override()
 	public onExit(): void {
-		const oKPIModel = this.getView().getModel("kpiModel") as JSONModel<any>;
+		const oKPIModel = this.getView().getModel("kpiModel") as JSONModel;
 
 		if (oKPIModel) {
 			oKPIModel.destroy();
@@ -683,7 +743,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 		}
 	}
 
-	private updateDatapointValueAndCurrency(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel<any>) {
+	private updateDatapointValueAndCurrency(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel) {
 		const currentLocale = new Locale(
 			sap.ui
 				.getCore()
@@ -760,7 +820,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 		}
 	}
 
-	private updateDatapointCriticality(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel<any>) {
+	private updateDatapointCriticality(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel) {
 		const rawValue = Number.parseFloat(kpiContext.getProperty(kpiDefinition.datapoint.propertyPath));
 
 		let criticalityValue = MessageType.None;
@@ -802,7 +862,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 		);
 	}
 
-	private updateDatapointTrend(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel<any>) {
+	private updateDatapointTrend(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel) {
 		const rawValue = Number.parseFloat(kpiContext.getProperty(kpiDefinition.datapoint.propertyPath));
 
 		let trendValue = "None";
@@ -837,7 +897,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 		oKPIModel.setProperty("/" + kpiDefinition.id + "/manifest/sap.card/data/json/trend", trendValue);
 	}
 
-	private updateTargetValue(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel<any>) {
+	private updateTargetValue(kpiDefinition: KPIDefinition, kpiContext: Context, oKPIModel: JSONModel) {
 		if (kpiDefinition.datapoint.targetValue === undefined && kpiDefinition.datapoint.targetPath === undefined) {
 			return; // No target set for the KPI
 		}
@@ -904,7 +964,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 	 * @param loadFull If not true, loads only data for the KPI tag
 	 * @returns {Promise} Returns the promise that is resolved when data is loaded.
 	 */
-	protected loadKPITagData(kpiDefinition: KPIDefinition, oMainModel: ODataModel, oKPIModel: JSONModel<any>, loadFull?: boolean): any {
+	protected loadKPITagData(kpiDefinition: KPIDefinition, oMainModel: ODataModel, oKPIModel: JSONModel, loadFull?: boolean): any {
 		// If loadFull=false, then we're just loading data for the tag and we use the "$auto.LongRunners" groupID
 		// If loadFull=true, we're loading data for the whole KPI (tag + card) and we use the default ("$auto") groupID
 		const oListBinding = loadFull
@@ -987,7 +1047,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 	 * @param {JSONModel} oKPIModel The JSON model where the data will be stored
 	 * @returns {Promise} Returns the promise that is resolved when data is loaded.
 	 */
-	protected loadKPICardData(kpiDefinition: KPIDefinition, oMainModel: ODataModel, oKPIModel: JSONModel<any>): any {
+	protected loadKPICardData(kpiDefinition: KPIDefinition, oMainModel: ODataModel, oKPIModel: JSONModel): any {
 		const oListBinding = oMainModel.bindList("/" + kpiDefinition.entitySet);
 		const oGroup: Record<string, Object> = {};
 		const oAggregate: Record<string, Object> = {};
@@ -1040,26 +1100,42 @@ class KPIManagementControllerExtension extends ControllerExtension {
 	/**
 	 * Gets the popover to display the KPI card
 	 * The popover and the contained card for the KPIs are created if necessary.
-	 * The popover is shared between all KPIs, so we create it only once.
+	 * The popover is shared between all KPIs, so it's created only once.
 	 *
-	 * @param oKPITag The Tag that triggered the popover opening.
-	 * @returns The shared popover.
+	 * @param oKPITag The tag that triggered the popover opening.
+	 * @returns The shared popover as a promise.
 	 */
 	protected getPopover(oKPITag: GenericTag): Promise<Popover> {
 		if (!this.oPopover) {
 			return new Promise((resolve, reject) => {
-				sap.ui
-					.getCore()
-					.loadLibrary("sap/ui/integration", { async: true })
+				(sap.ui.getCore().loadLibrary("sap/ui/integration", { async: true }) as Promise<object>)
 					.then(() => {
-						sap.ui.require(["sap/ui/integration/widgets/Card"], (Card: any) => {
+						sap.ui.require(["sap/ui/integration/widgets/Card", "sap/ui/integration/Host"], (Card: any, Host: any) => {
+							const oHost = new Host();
+
+							oHost.attachAction((oEvent: any) => {
+								const sType = oEvent.getParameter("type");
+								const oParams = oEvent.getParameter("parameters");
+
+								if (sType === "Navigation") {
+									if (oParams.semanticObject) {
+										(this.getView().getController() as any)._intentBasedNavigation.navigate(
+											oParams.semanticObject,
+											oParams.action
+										);
+									} else {
+										(this.getView().getController() as any)._intentBasedNavigation.navigateOutbound(oParams.outbound);
+									}
+								}
+							});
+
 							this.oCard = new Card({
 								width: "25rem",
 								height: "auto"
 							});
+							this.oCard.setHost(oHost as any);
 
-							this.oPopover = new Popover({
-								id: "kpi-Popover",
+							this.oPopover = new Popover("kpi-Popover", {
 								showHeader: false,
 								placement: "Auto",
 								content: [this.oCard]
@@ -1070,7 +1146,9 @@ class KPIManagementControllerExtension extends ControllerExtension {
 							resolve(this.oPopover);
 						});
 					})
-					.catch(reject);
+					.catch(function() {
+						reject();
+					});
 			});
 		} else {
 			return Promise.resolve(this.oPopover);
@@ -1079,7 +1157,7 @@ class KPIManagementControllerExtension extends ControllerExtension {
 
 	@Public
 	public onKPIPressed(oKPITag: any, kpiID: string): void {
-		const oKPIModel = oKPITag.getModel("kpiModel") as JSONModel<any>;
+		const oKPIModel = oKPITag.getModel("kpiModel") as JSONModel;
 
 		if (this.aKPIDefinitions && this.aKPIDefinitions.length) {
 			const kpiDefinition = this.aKPIDefinitions.find(function(oDef) {

package/src/sap/fe/core/controllerextensions/MassEdit.js

@@ -0,0 +1,172 @@
+/*!
+ * SAP UI development toolkit for HTML5 (SAPUI5)
+        (c) Copyright 2009-2021 SAP SE. All rights reserved
+    
+ */
+sap.ui.define(
+	[
+		"sap/ui/core/mvc/ControllerExtension",
+		"sap/ui/core/mvc/OverrideExecution",
+		"sap/fe/core/helpers/MassEditHelper",
+		"sap/fe/core/helpers/ModelHelper",
+		"sap/base/Log",
+		"sap/m/MessageBox"
+	],
+	function(ControllerExtension, OverrideExecution, MassEditHelper, ModelHelper, Log, MessageBox) {
+		"use strict";
+		/**
+		 * @class Controller extension providing hooks for the mass edit in a table
+		 *
+		 * @name sap.fe.core.controllerextensions.MassEdit
+		 * @hideconstructor
+		 * @private
+		 */
+		return ControllerExtension.extend("sap.fe.core.controllerextensions.MassEdit", {
+			metadata: {
+				methods: {
+					openMassEditDialog: {
+						"final": true,
+						"public": true
+					},
+					fetchContextsForEdit: {
+						"final": false,
+						"public": false,
+						overrideExecution: OverrideExecution.After
+					}
+				}
+			},
+
+			_getMessageDetailForNonEditable: function(oResourceBundle) {
+				var sHeader = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_MESSAGE_DETAIL_HEADER"),
+					sReasonGroup = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_MESSAGE_DETAIL_REASON"),
+					sReasonDraft = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_MESSAGE_DETAIL_REASON_DRAFT"),
+					sReasonNonEditable = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_MESSAGE_DETAIL_REASON_NON_EDITABLE");
+
+				return (
+					"<p><strong>" +
+					sHeader +
+					"</strong></p>\n" +
+					"<p>" +
+					sReasonGroup +
+					"</p>\n" +
+					"<ul>" +
+					"<li>" +
+					sReasonDraft +
+					"</li>" +
+					"<li>" +
+					sReasonNonEditable +
+					"</li>" +
+					"</ul>"
+				);
+			},
+
+			_openConfirmDialog: function(oTable, aContexts, iSelectedContexts) {
+				var that = this,
+					iUpdatableContexts = (aContexts || []).length;
+
+				return new Promise(function(resolve, reject) {
+					that.getView()
+						.getModel("sap.fe.i18n")
+						.getResourceBundle()
+						.then(function(oResourceBundle) {
+							var sEditButton = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_BUTTON_TEXT"),
+								sCancelButton = oResourceBundle.getText("C_MASS_EDIT_CANCEL_BUTTON_TEXT"),
+								iNonEditable = iSelectedContexts - iUpdatableContexts,
+								sMessage = oResourceBundle.getText("C_MASS_EDIT_CONFIRM_MESSAGE", [
+									iNonEditable,
+									iSelectedContexts,
+									iUpdatableContexts
+								]),
+								sPath = oTable.data("targetCollectionPath"),
+								oMetaModel = oTable.getModel().getMetaModel(),
+								bIsDraft = ModelHelper.isDraftSupported(oMetaModel, sPath),
+								bDisplayMode = oTable.data("displayModePropertyBinding") === "true",
+								sMessageDetail = bIsDraft && bDisplayMode && that._getMessageDetailForNonEditable(oResourceBundle);
+
+							MessageBox.warning(sMessage, {
+								details: sMessageDetail,
+								actions: [sEditButton, sCancelButton],
+								emphasizedAction: sEditButton,
+								contentWidth: "100px",
+								onClose: function(sSelection) {
+									var aContextsForEdit = [];
+									if (sSelection === sEditButton) {
+										Log.info("Mass Edit: Confirmed to edit ", iUpdatableContexts, " selections.");
+										aContextsForEdit = aContexts;
+									} else if (sSelection === sCancelButton) {
+										Log.info("Mass Edit: Cancelled.");
+									}
+									resolve(aContextsForEdit);
+								}
+							});
+						})
+						.catch(function(error) {
+							Log.error(error);
+						});
+				});
+			},
+
+			_confirmContexts: function(oTable, aContexts) {
+				var that = this,
+					oInternalModelContext = oTable.getBindingContext("internal"),
+					iSelectedContexts = +oInternalModelContext.getProperty("numberOfSelectedContexts") || 0;
+
+				aContexts = aContexts || [];
+
+				if (aContexts.length && aContexts.length !== iSelectedContexts) {
+					return that._openConfirmDialog(oTable, aContexts, iSelectedContexts);
+				}
+				return Promise.resolve(aContexts);
+			},
+
+			/**
+			 * The following operations are performed by method openMassEditDialog:
+			 * => Opens the mass edit dialog.
+			 * => Implements the save and cancel functionality.
+			 * => Sets the runtime model to the dialog.
+			 * => Sets the static model's context to the dialog.
+			 *
+			 * @param {object} oTable Instance of the table
+			 * @returns {Promise} A promise that resolves on open of the mass edit dialog.
+			 * @private
+			 */
+			openMassEditDialog: function(oTable) {
+				var that = this,
+					oController = that.getView().getController(),
+					pContextsForEdit = that.fetchContextsForEdit(oTable);
+
+				return pContextsForEdit
+					.then(that._confirmContexts.bind(that, oTable))
+					.then(function(aContexts) {
+						return aContexts && aContexts.length > 0
+							? MassEditHelper.createDialog(oTable, aContexts, oController)
+							: Promise.resolve();
+					})
+					.then(function(oDialog) {
+						if (oDialog) {
+							oDialog.open();
+						}
+					})
+					.catch(function(oError) {
+						Log.error("Mass Edit: Something went wrong in mass edit dialog creation.", oError);
+					});
+			},
+
+			/**
+			 * Returns a promise that resolves to the contexts for mass edit.
+			 * @function
+			 * @param {string} oTable Table for mass edit.
+			 * @alias sap.fe.core.contrllerextensions.MassEdit#fetchContextsForEdit
+			 * @returns {Promise} A promise to be resolved with an array of context(s) which should be considered for mass edit.
+			 * @private
+			 **/
+			fetchContextsForEdit: function(oTable) {
+				//To be overridden by the application
+				var oInternalModelContext = oTable.getBindingContext("internal"),
+					aSelectedContexts = oInternalModelContext.getProperty("updatableContexts") || [];
+
+				return Promise.resolve(aSelectedContexts);
+			}
+		});
+	}
+);