@sapui5/sap.fe.core 1.98.0 → 1.101.0

package/src/sap/fe/core/PageController.ts

@@ -0,0 +1,129 @@
+import AppComponent from "sap/fe/core/AppComponent";
+import BaseController from "sap/fe/core/BaseController";
+import EditFlow from "sap/fe/core/controllerextensions/EditFlow";
+import IntentBasedNavigation from "sap/fe/core/controllerextensions/IntentBasedNavigation";
+import InternalEditFlow from "sap/fe/core/controllerextensions/InternalEditFlow";
+import InternalIntentBasedNavigation from "sap/fe/core/controllerextensions/InternalIntentBasedNavigation";
+import InternalRouting from "sap/fe/core/controllerextensions/InternalRouting";
+import MassEdit from "sap/fe/core/controllerextensions/MassEdit";
+import MessageHandler from "sap/fe/core/controllerextensions/MessageHandler";
+import PageReady from "sap/fe/core/controllerextensions/PageReady";
+import Paginator from "sap/fe/core/controllerextensions/Paginator";
+import Placeholder from "sap/fe/core/controllerextensions/Placeholder";
+import Routing from "sap/fe/core/controllerextensions/Routing";
+import Share from "sap/fe/core/controllerextensions/Share";
+import SideEffects from "sap/fe/core/controllerextensions/SideEffects";
+import ViewState from "sap/fe/core/controllerextensions/ViewState";
+import ExtensionAPI from "sap/fe/core/ExtensionAPI";
+import { defineUI5Class, publicExtension, usingExtension } from "sap/fe/core/helpers/ClassSupport";
+import JSONModel from "sap/ui/model/json/JSONModel";
+
+/**
+ * Base controller class for your custom page used inside an SAP Fiori elements application.
+ *
+ * This controller provides preconfigured extensions that will ensure you have the basic functionalities required to use the building blocks.
+ *
+ * @hideconstructor
+ * @public
+ * @since 1.88.0
+ */
+@defineUI5Class("sap.fe.core.PageController")
+class PageController extends BaseController {
+	@usingExtension(Routing)
+	routing!: Routing;
+	@usingExtension(InternalRouting)
+	_routing!: InternalRouting;
+	@usingExtension(EditFlow)
+	editFlow!: EditFlow;
+	@usingExtension(InternalEditFlow)
+	_editFlow!: InternalEditFlow;
+	@usingExtension(IntentBasedNavigation)
+	intentBasedNavigation!: IntentBasedNavigation;
+	@usingExtension(InternalIntentBasedNavigation)
+	_intentBasedNavigation!: InternalIntentBasedNavigation;
+	@usingExtension(PageReady)
+	pageReady!: PageReady;
+	@usingExtension(MessageHandler)
+	messageHandler!: MessageHandler;
+	@usingExtension(Share)
+	share!: Share;
+	@usingExtension(Paginator)
+	paginator!: Paginator;
+	@usingExtension(ViewState)
+	viewState!: ViewState;
+	@usingExtension(Placeholder)
+	placeholder!: Placeholder;
+	@usingExtension(SideEffects)
+	_sideEffects!: SideEffects;
+	@usingExtension(MassEdit)
+	massEdit!: MassEdit;
+	// @Public
+	// getView(): { getController(): PageController } & View {
+	// 	return super.getView() as any;
+	// }
+	/**
+	 * @private
+	 * @name sap.fe.core.PageController.getMetadata
+	 * @function
+	 */
+	/**
+	 * @private
+	 * @name sap.fe.core.PageController.extend
+	 * @function
+	 */
+
+	@publicExtension()
+	onInit() {
+		const oUIModel = this.getAppComponent().getModel("ui") as JSONModel,
+			oInternalModel = this.getAppComponent().getModel("internal") as JSONModel,
+			sPath = "/pages/" + this.getView().getId();
+
+		oUIModel.setProperty(sPath, {
+			controls: {}
+		});
+		oInternalModel.setProperty(sPath, {
+			controls: {},
+			collaboration: {}
+		});
+		this.getView().bindElement({
+			path: sPath,
+			model: "ui"
+		});
+		this.getView().bindElement({
+			path: sPath,
+			model: "internal"
+		});
+
+		// for the time being provide it also pageInternal as some macros access it - to be removed
+		this.getView().bindElement({
+			path: sPath,
+			model: "pageInternal"
+		});
+		this.getView().setModel(oInternalModel, "pageInternal");
+
+		// as the model propagation happens after init but we actually want to access the binding context in the
+		// init phase already setting the model here
+		this.getView().setModel(oUIModel, "ui");
+		this.getView().setModel(oInternalModel, "internal");
+	}
+	@publicExtension()
+	onBeforeRendering() {
+		if (this.placeholder.attachHideCallback) {
+			this.placeholder.attachHideCallback();
+		}
+	}
+	@publicExtension()
+	getExtensionAPI(this: any): ExtensionAPI {
+		if (!this.extensionAPI) {
+			this.extensionAPI = new ExtensionAPI(this);
+		}
+		return this.extensionAPI;
+	}
+	@publicExtension()
+	// eslint-disable-next-line @typescript-eslint/no-unused-vars
+	onPageReady(mParameters: any) {
+		// Apply app state only after the page is ready with the first section selected
+		(this.getAppComponent() as AppComponent).getAppStateHandler().applyAppState();
+	}
+}
+export default PageController;