jsdialog: add base class for components

Signed-off-by: Szymon Kłos <[email protected]>
Change-Id: Iee33c426cdf49b0f6b942ebc159c7e4b27db35fd

Author: eszkadev

browser/Makefile.am

@@ -428,6 +428,7 @@ COOL_JS_LST =\
 	src/control/Control.ESignatureDialog.ts \
 	src/control/ColorPicker.ts \
 	src/control/jsdialog/Util.Shortcuts.ts \
+	src/control/jsdialog/Component.Base.ts \
 	src/control/jsdialog/Component.Toolbar.ts \
 	src/control/jsdialog/Definitions.Menu.ts \
 	src/control/jsdialog/Util.Dropdown.js \

browser/src/control/jsdialog/Component.Base.ts

@@ -0,0 +1,88 @@
+/* -*- js-indent-level: 8 -*- */
+/*
+ * Copyright the Collabora Online contributors.
+ *
+ * SPDX-License-Identifier: MPL-2.0
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+/*
+ * Component.Base - base class for JSDialog components, wrappers which encapsulate
+ *                  target DOM container and it's dedicated JSBuilder, it also receives
+ *                  messages from JSDialogMessageRouter
+ */
+
+declare var JSDialog: any;
+
+abstract class JSDialogComponent {
+	protected map: any;
+	protected name: string;
+	protected builder?: JSBuilder;
+	protected container?: HTMLElement;
+	protected allowedJsonType: string;
+
+	constructor(map: any, name: string, allowedJsonType: string) {
+		this.map = map;
+		this.name = name;
+		this.allowedJsonType = allowedJsonType;
+	}
+
+	/// connects component to the JSDialogMessageRouter
+	protected registerMessageHandlers() {
+		this.map.on('jsdialogupdate', this.onJSUpdate, this);
+		this.map.on('jsdialogaction', this.onJSAction, this);
+	}
+
+	/// disconnects component from JSDialogMessageRouter
+	protected unregisterMessageHandlers() {
+		this.map.off('jsdialogupdate', this.onJSUpdate, this);
+		this.map.off('jsdialogaction', this.onJSAction, this);
+	}
+
+	/// create JSBuilder instance for this component
+	protected abstract createBuilder(): void;
+
+	/// assign or create container for the component
+	protected abstract setupContainer(parentContainer?: HTMLElement): void;
+
+	/// hanlde update message
+	protected onJSUpdate(e: any) {
+		var data = e.data;
+
+		if (data.jsontype !== this.allowedJsonType) return;
+
+		if (!this.container) return;
+
+		if (!this.builder) return;
+
+		app.console.debug(
+			'Component ' +
+				this.name +
+				' handles update message: ' +
+				JSON.stringify(data.control),
+		);
+		this.builder.updateWidget(this.container, data.control);
+	}
+
+	/// handle action message
+	protected onJSAction(e: any) {
+		var data = e.data;
+
+		if (data.jsontype !== this.allowedJsonType) return;
+
+		if (!this.builder) return;
+
+		if (!this.container) return;
+
+		app.console.debug(
+			'Component ' +
+				this.name +
+				' handles action message: ' +
+				JSON.stringify(data.data),
+		);
+		this.builder.executeAction(this.container, data.data);
+	}
+}