@sapui5/sap.fe.core 1.100.0 → 1.102.0

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

@@ -1,35 +1,42 @@
-import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
-import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
-import TransactionHelper from "sap/fe/core/TransactionHelper";
 import Log from "sap/base/Log";
+import AppComponent from "sap/fe/core/AppComponent";
 import CommonUtils from "sap/fe/core/CommonUtils";
-import BusyLocker from "sap/fe/core/BusyLocker";
-import FELibrary from "sap/fe/core/library";
+import BusyLocker from "sap/fe/core/controllerextensions/BusyLocker";
+import { send } from "sap/fe/core/controllerextensions/collaboration/ActivitySync";
+import { Activity } from "sap/fe/core/controllerextensions/collaboration/CollaborationCommon";
+import sticky from "sap/fe/core/controllerextensions/editFlow/sticky";
+import TransactionHelper from "sap/fe/core/controllerextensions/editFlow/TransactionHelper";
+import {
+	defineUI5Class,
+	extensible,
+	finalExtension,
+	methodOverride,
+	privateExtension,
+	publicExtension
+} from "sap/fe/core/helpers/ClassSupport";
 import EditState from "sap/fe/core/helpers/EditState";
-import { Extensible, Final, Override, Private, Public, UI5Class } from "sap/fe/core/helpers/ClassSupport";
-import ControllerExtensionMetadata from "sap/fe/core/controllerextensions/ControllerExtensionMetadata";
-import AppComponent from "sap/fe/core/AppComponent";
+import FELibrary from "sap/fe/core/library";
 import PageController from "sap/fe/core/PageController";
-import JSONModel from "sap/ui/model/json/JSONModel";
-import Table from "sap/ui/mdc/Table";
-import Dialog from "sap/m/Dialog";
 import Button from "sap/m/Button";
+import Dialog from "sap/m/Dialog";
 import Text from "sap/m/Text";
-import Model from "sap/ui/model/Model";
-import sticky from "sap/fe/core/actions/sticky";
+import ControllerExtension from "sap/ui/core/mvc/ControllerExtension";
+import OverrideExecution from "sap/ui/core/mvc/OverrideExecution";
 import View from "sap/ui/core/mvc/View";
-import { send } from "sap/fe/core/actions/collaboration/ActivitySync";
-import { Activity } from "sap/fe/core/actions/collaboration/CollaborationCommon";
+import Table from "sap/ui/mdc/Table";
+import JSONModel from "sap/ui/model/json/JSONModel";
+import Model from "sap/ui/model/Model";
 import Context from "sap/ui/model/odata/v4/Context";
+import ODataListBinding from "sap/ui/model/odata/v4/ODataListBinding";
 
 const ProgrammingModel = FELibrary.ProgrammingModel,
 	DraftStatus = FELibrary.DraftStatus,
 	EditMode = FELibrary.EditMode,
 	CreationMode = FELibrary.CreationMode;
 
-@UI5Class("sap.fe.core.controllerextensions.InternalEditFlow", ControllerExtensionMetadata)
+@defineUI5Class("sap.fe.core.controllerextensions.InternalEditFlow")
 class InternalEditFlow extends ControllerExtension {
-	private base!: PageController;
+	protected base!: PageController;
 	private _oAppComponent!: AppComponent;
 	private _pTasks: any;
 	private oActionPromise?: Promise<any>;
@@ -37,7 +44,7 @@ class InternalEditFlow extends ControllerExtension {
 	private fnDirtyStateProvider?: Function;
 	private fnHandleSessionTimeout?: Function;
 	private fnStickyDiscardAfterNavigation?: Function;
-	@Override()
+	@methodOverride()
 	onInit() {
 		this._oAppComponent = this.base.getAppComponent();
 	}
@@ -50,22 +57,29 @@ class InternalEditFlow extends ControllerExtension {
 	 * @alias sap.fe.core.controllerextensions.InternalEditFlow#setCreationMode
 	 * @since 1.90.0
 	 */
-	@Private
-	@Extensible(OverrideExecution.After)
+	@privateExtension()
+	@extensible(OverrideExecution.After)
 	// eslint-disable-next-line @typescript-eslint/no-unused-vars
 	setCreationMode(bCreationMode: boolean) {
 		// to be overridden
 	}
-	@Public
-	@Final
-	createMultipleDocuments(oListBinding: any, aData: any, bCreateAtEnd: any, bFromCopyPaste: any, beforeCreateCallBack: any) {
+	@publicExtension()
+	@finalExtension()
+	createMultipleDocuments(
+		oListBinding: any,
+		aData: any,
+		bCreateAtEnd: any,
+		bFromCopyPaste: boolean,
+		beforeCreateCallBack: any,
+		bInactive?: boolean
+	) {
 		const transactionHelper = this.getTransactionHelper(),
 			oLockObject = this.getGlobalUIModel(),
 			oResourceBundle = (this.getView().getController() as any).oResourceBundle;
 
 		BusyLocker.lock(oLockObject);
 		return this.syncTask()
-			.then(function() {
+			.then(function () {
 				const onBeforeCreatePromise = beforeCreateCallBack
 					? beforeCreateCallBack({ contextPath: oListBinding && oListBinding.getPath() })
 					: Promise.resolve();
@@ -93,6 +107,7 @@ class InternalEditFlow extends ControllerExtension {
 					mParameters.creationMode = CreationMode.CreationRow;
 					mParameters.parentControl = this.getView();
 					mParameters.createAtEnd = bCreateAtEnd;
+					mParameters.inactive = bInactive;
 
 					// Remove navigation properties as we don't support deep create
 					for (const sPropertyPath in mPropertyValues) {
@@ -114,11 +129,13 @@ class InternalEditFlow extends ControllerExtension {
 
 				return Promise.all(aCreationPromises);
 			})
-			.then(function(aContexts: any) {
+			.then(function (aContexts: any) {
 				// transient contexts are reliably removed once oNewContext.created() is resolved
 				return Promise.all(
-					aContexts.map(function(oNewContext: any) {
-						return oNewContext.created();
+					aContexts.map(function (oNewContext: any) {
+						if (!oNewContext.bInactive) {
+							return oNewContext.created();
+						}
 					})
 				);
 			})
@@ -134,16 +151,16 @@ class InternalEditFlow extends ControllerExtension {
 						.requestSideEffectsForNavigationProperty(oListBinding.getPath(), oBindingContext as Context);
 				}
 			})
-			.catch(function(err: any) {
+			.catch(function (err: any) {
 				Log.error("Error while creating multiple documents.");
 				return Promise.reject(err);
 			})
-			.finally(function() {
+			.finally(function () {
 				BusyLocker.unlock(oLockObject);
 			});
 	}
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	deleteMultipleDocuments(aContexts: any, mParameters: any) {
 		const oRoutingListener = this.getRoutingListener(),
 			oLockObject = this.getGlobalUIModel();
@@ -166,8 +183,8 @@ class InternalEditFlow extends ControllerExtension {
 				const oBindingContext = this.getView().getBindingContext();
 				if (oListBinding.isRoot()) {
 					// keep promise chain pending until refresh of listbinding is completed
-					oResult = new Promise<void>(resolve => {
-						oListBinding.attachEventOnce("dataReceived", function() {
+					oResult = new Promise<void>((resolve) => {
+						oListBinding.attachEventOnce("dataReceived", function () {
 							resolve();
 						});
 					});
@@ -186,7 +203,11 @@ class InternalEditFlow extends ControllerExtension {
 				// deleting at least one object should also set the UI to dirty
 				EditState.setEditStateDirty();
 
-				send(this.getView(), Activity.Delete, aContexts);
+				send(
+					this.getView(),
+					Activity.Delete,
+					aContexts.map((context: Context) => context.getPath())
+				);
 
 				// Finally, check if the current state can be impacted by the deletion, i.e. if there's
 				// an OP displaying a deleted object. If yes navigate back to dismiss the OP
@@ -199,10 +220,10 @@ class InternalEditFlow extends ControllerExtension {
 
 				return oResult;
 			})
-			.catch(function(oError: any) {
+			.catch(function (oError: any) {
 				Log.error("Error while deleting the document(s)", oError);
 			})
-			.finally(function() {
+			.finally(function () {
 				BusyLocker.unlock(oLockObject);
 			});
 	}
@@ -217,8 +238,8 @@ class InternalEditFlow extends ControllerExtension {
 	 * @returns {Promise} Promise resolves once the edit mode is computed
 	 */
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	computeEditMode(oContext: any) {
 		const sCustomAction = this.getInternalModel().getProperty("/sCustomAction");
 		return Promise.resolve(
@@ -242,7 +263,7 @@ class InternalEditFlow extends ControllerExtension {
 								this.setEditMode(EditMode.Display, false);
 							}
 						})
-						.catch(function(oError: any) {
+						.catch(function (oError: any) {
 							Log.error("Error while determining the editMode for draft", oError);
 							throw oError;
 						});
@@ -266,15 +287,14 @@ class InternalEditFlow extends ControllerExtension {
 	 * @param {string} sEditMode
 	 * @param {boolean} bCreationMode CreateMode flag to identify the creation mode
 	 */
-	@Public
-	@Final
-	setEditMode(sEditMode?: string, bCreationMode: boolean = false) {
+	@publicExtension()
+	@finalExtension()
+	setEditMode(sEditMode?: string, bCreationMode?: boolean) {
 		// at this point of time it's not meant to release the edit flow for freestyle usage therefore we can
 		// rely on the global UI model to exist
 		const oGlobalModel = this.getGlobalUIModel();
 
 		if (sEditMode) {
-			oGlobalModel.setProperty("/editMode", sEditMode, undefined, true);
 			oGlobalModel.setProperty("/isEditable", sEditMode === "Editable", undefined, true);
 		}
 
@@ -285,16 +305,16 @@ class InternalEditFlow extends ControllerExtension {
 		}
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	setDraftStatus(sDraftState: any) {
 		// at this point of time it's not meant to release the edit flow for freestyle usage therefore we can
 		// rely on the global UI model to exist
 		(this.base.getView().getModel("ui") as JSONModel).setProperty("/draftStatus", sDraftState, undefined, true);
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getRoutingListener() {
 		// at this point of time it's not meant to release the edit flow for FPM custom pages and the routing
 		// listener is not yet public therefore keep the logic here for now
@@ -306,8 +326,8 @@ class InternalEditFlow extends ControllerExtension {
 		}
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getGlobalUIModel(): JSONModel {
 		// at this point of time it's not meant to release the edit flow for freestyle usage therefore we can
 		// rely on the global UI model to exist
@@ -328,12 +348,12 @@ class InternalEditFlow extends ControllerExtension {
 	 * @ui5-restricted
 	 * @final
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	syncTask(vTask?: Function | Promise<any>) {
 		let fnNewTask;
 		if (vTask instanceof Promise) {
-			fnNewTask = function() {
+			fnNewTask = function () {
 				return vTask;
 			};
 		} else if (typeof vTask === "function") {
@@ -342,7 +362,7 @@ class InternalEditFlow extends ControllerExtension {
 
 		this._pTasks = this._pTasks || Promise.resolve();
 		if (!!fnNewTask) {
-			this._pTasks = this._pTasks.then(fnNewTask).catch(function() {
+			this._pTasks = this._pTasks.then(fnNewTask).catch(function () {
 				return Promise.resolve();
 			});
 		}
@@ -350,14 +370,14 @@ class InternalEditFlow extends ControllerExtension {
 		return this._pTasks;
 	}
 
-	@Public
-	@Final
-	getProgrammingModel(oContext: any): typeof ProgrammingModel {
+	@publicExtension()
+	@finalExtension()
+	getProgrammingModel(oContext?: any): typeof ProgrammingModel {
 		return this.getTransactionHelper().getProgrammingModel(oContext);
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	deleteDocumentTransaction(oContext: any, mParameters: any) {
 		const oResourceBundle = (this.getView().getController() as any).oResourceBundle,
 			transactionHelper = this.getTransactionHelper();
@@ -367,10 +387,7 @@ class InternalEditFlow extends ControllerExtension {
 		// TODO: this setting and removing of contexts shouldn't be in the transaction helper at all
 		// for the time being I kept it and provide the internal model context to not break something
 		mParameters.internalModelContext = mParameters.controlId
-			? sap.ui
-					.getCore()
-					.byId(mParameters.controlId)
-					?.getBindingContext("internal")
+			? sap.ui.getCore().byId(mParameters.controlId)?.getBindingContext("internal")
 			: null;
 
 		return this.syncTask()
@@ -378,9 +395,11 @@ class InternalEditFlow extends ControllerExtension {
 				transactionHelper.deleteDocument.bind(transactionHelper, oContext, mParameters, oResourceBundle, this.getMessageHandler())
 			)
 			.then(() => {
-				this.getInternalModel().setProperty("/sessionOn", false);
+				const internalModel = this.getInternalModel();
+				internalModel.setProperty("/sessionOn", false);
+				internalModel.setProperty("/stickySessionToken", undefined);
 			})
-			.catch(function(oError: any) {
+			.catch(function (oError: any) {
 				return Promise.reject(oError);
 			});
 	}
@@ -391,8 +410,8 @@ class InternalEditFlow extends ControllerExtension {
 	 * @memberof sap.fe.core.controllerextensions.EditFlow
 	 * @param {object} oBinding OData list binding object
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	handleCreateEvents(oBinding: any) {
 		const transactionHelper = this.getTransactionHelper();
 
@@ -416,8 +435,8 @@ class InternalEditFlow extends ControllerExtension {
 		});
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getTransactionHelper() {
 		if (!this._oTransactionHelper) {
 			// currently also the transaction helper is locking therefore passing lock object
@@ -427,8 +446,8 @@ class InternalEditFlow extends ControllerExtension {
 		return this._oTransactionHelper;
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getInternalModel(): JSONModel {
 		return this.base.getView().getModel("internal") as JSONModel;
 	}
@@ -442,8 +461,8 @@ class InternalEditFlow extends ControllerExtension {
 	 * @returns {Function} The resolver function which can be used to externally resolve the promise
 	 */
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	createActionPromise(sActionName: any, sControlId: any) {
 		let fResolver, fRejector;
 		this.oActionPromise = new Promise((resolve, reject) => {
@@ -464,14 +483,14 @@ class InternalEditFlow extends ControllerExtension {
 	 *
 	 * @returns {Promise} Returns the promise
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getCurrentActionPromise() {
 		return this.oActionPromise;
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	deleteCurrentActionPromise() {
 		this.oActionPromise = undefined;
 	}
@@ -484,8 +503,8 @@ class InternalEditFlow extends ControllerExtension {
 	 * @param {object} oResponse The bound action's response data or response context
 	 * @returns {object} Object with data and names of the key fields of the response
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getActionResponseDataAndKeys(sActionName: string, oResponse: any) {
 		if (Array.isArray(oResponse)) {
 			if (oResponse.length === 1) {
@@ -511,8 +530,8 @@ class InternalEditFlow extends ControllerExtension {
 		};
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	getMessageHandler() {
 		// at this point of time it's not meant to release the edit flow for FPM custom pages therefore keep
 		// the logic here for now
@@ -524,9 +543,9 @@ class InternalEditFlow extends ControllerExtension {
 		}
 	}
 
-	@Public
-	@Final
-	handleStickyOn(oContext: any) {
+	@publicExtension()
+	@finalExtension()
+	handleStickyOn(oContext: Context) {
 		const oAppComponent = CommonUtils.getAppComponent(this.getView());
 
 		try {
@@ -541,8 +560,8 @@ class InternalEditFlow extends ControllerExtension {
 				// Set a guard in the RouterProxy
 				// A timeout is necessary, as with deferred creation the hashChanger is not updated yet with
 				// the new hash, and the guard cannot be found in the managed history of the router proxy
-				setTimeout(function() {
-					oAppComponent.getRouterProxy().setNavigationGuard();
+				setTimeout(function () {
+					oAppComponent.getRouterProxy().setNavigationGuard(oContext.getPath().substring(1));
 				}, 0);
 
 				// Setting back navigation on shell service, to get the dicard message box in case of sticky
@@ -553,21 +572,21 @@ class InternalEditFlow extends ControllerExtension {
 
 				// handle session timeout
 				const i18nModel = this.getView().getModel("sap.fe.i18n");
-				this.fnHandleSessionTimeout = this._attachSessionTimeout(this, i18nModel);
+				this.fnHandleSessionTimeout = this._attachSessionTimeout(oContext, i18nModel);
 				(this.getView().getModel() as any).attachSessionTimeout(this.fnHandleSessionTimeout);
 
 				this.fnStickyDiscardAfterNavigation = this._attachRouteMatched(this, oContext, oAppComponent);
 				oAppComponent.getRoutingService().attachRouteMatched(this.fnStickyDiscardAfterNavigation);
 			}
 		} catch (error) {
-			Log.info(error);
+			Log.info(error as any);
 			return undefined;
 		}
 		return true;
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	handleStickyOff() {
 		const oAppComponent = CommonUtils.getAppComponent(this.getView());
 		try {
@@ -602,7 +621,7 @@ class InternalEditFlow extends ControllerExtension {
 				oAppComponent.getShellServices().setBackNavigation();
 			}
 		} catch (error) {
-			Log.info(error);
+			Log.info(error as any);
 			return undefined;
 		}
 		return true;
@@ -615,8 +634,8 @@ class InternalEditFlow extends ControllerExtension {
 	 * @name onBackNavigationInSession
 	 * @memberof sap.fe.core.controllerextensions.InternalEditFlow
 	 */
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	onBackNavigationInSession() {
 		const oView = this.getView(),
 			oAppComponent = CommonUtils.getAppComponent(oView),
@@ -625,7 +644,7 @@ class InternalEditFlow extends ControllerExtension {
 		if (oRouterProxy.checkIfBackIsOutOfGuard()) {
 			const oBindingContext = oView && oView.getBindingContext();
 
-			CommonUtils.processDataLossConfirmation(
+			sticky.processDataLossConfirmation(
 				() => {
 					this.discardStickySession(oBindingContext);
 					history.back();
@@ -639,8 +658,8 @@ class InternalEditFlow extends ControllerExtension {
 		history.back();
 	}
 
-	@Public
-	@Final
+	@publicExtension()
+	@finalExtension()
 	discardStickySession(oContext: any) {
 		sticky.discardDocument(oContext);
 		this.handleStickyOff();
@@ -660,7 +679,7 @@ class InternalEditFlow extends ControllerExtension {
 				return true;
 			} else if (oStickySession && oStickySession.AdditionalNewActions) {
 				return sCustomAction ===
-					oStickySession.AdditionalNewActions.find(function(sAdditionalAction: string) {
+					oStickySession.AdditionalNewActions.find(function (sAdditionalAction: string) {
 						return sAdditionalAction === sCustomAction;
 					})
 					? true
@@ -669,7 +688,7 @@ class InternalEditFlow extends ControllerExtension {
 				return false;
 			}
 		} catch (error) {
-			Log.info(error);
+			Log.info(error as any);
 			return undefined;
 		}
 	}
@@ -714,7 +733,7 @@ class InternalEditFlow extends ControllerExtension {
 				if (bDirty) {
 					// the FLP doesn't call the dirty state provider anymore once it's dirty, as they can't
 					// change this due to compatibility reasons we set it back to not-dirty
-					setTimeout(function() {
+					setTimeout(function () {
 						oAppComponent.getShellServices().setDirtyFlag(false);
 					}, 0);
 				} else {
@@ -723,14 +742,14 @@ class InternalEditFlow extends ControllerExtension {
 
 				return bDirty;
 			} catch (error) {
-				Log.info(error);
+				Log.info(error as any);
 				return undefined;
 			}
 		};
 	}
 
 	_attachSessionTimeout(oContext: any, i18nModel: Model) {
-		const that = oContext;
+		const that = this;
 
 		return function fnHandleSessionTimeout() {
 			try {
@@ -747,13 +766,13 @@ class InternalEditFlow extends ControllerExtension {
 					beginButton: new Button({
 						text: "{sap.fe.i18n>C_COMMON_DIALOG_OK}",
 						type: "Emphasized",
-						press: function() {
+						press: function () {
 							// remove sticky handling after navigation since session has already been terminated
 							that.handleStickyOff();
 							that.getRoutingListener().navigateBackFromContext(oContext);
 						}
 					}),
-					afterClose: function() {
+					afterClose: function () {
 						oDialog.destroy();
 					}
 				});
@@ -762,7 +781,7 @@ class InternalEditFlow extends ControllerExtension {
 				that.getView().addDependent(oDialog);
 				oDialog.open();
 			} catch (error) {
-				Log.info(error);
+				Log.info(error as any);
 				return undefined;
 			}
 			return true;
@@ -778,6 +797,16 @@ class InternalEditFlow extends ControllerExtension {
 			}
 		};
 	}
+	scrollAndFocusOnInactiveRow(oTable: Table) {
+		const oRowBinding = oTable.getRowBinding() as ODataListBinding;
+		const iActiveRowIndex = oRowBinding.getCount() || 0;
+		if (iActiveRowIndex > 0) {
+			oTable.scrollToIndex(iActiveRowIndex - 1);
+			oTable.focusRow(iActiveRowIndex, true);
+		} else {
+			oTable.focusRow(iActiveRowIndex, true);
+		}
+	}
 }
 
 export default InternalEditFlow;