swing-ui 1.0.3 → 1.0.5

package/SwingUI.js

@@ -668,7 +668,7 @@ export class SwingUI
 						callback.call(e.target, e);
 					}catch(ex)
 					{
-						let comp_name = e.target.constructor.name;
+						let comp_name = e.target?.constructor?.name;
 						e.target = `${comp_name}{...}`; // make it shorter by hiding internals of component
 						if(e.source != null) e.source = `${e.source.constructor.name}{...}`; // make it shorter by hiding internals of component
 						error(`${this._msg[6]}${comp_name}: ${e.event} \n\n${ex.stack}\n\nEvent ${stringify(e)}`, false);
@@ -1245,6 +1245,28 @@ export class SwingUI
 		}
 	}
 
+	/**
+	 * Sets/get whether double-buffering should be used in rendering GUI in Java. Disabling may help to fix some graphical issues in Linux if flickering happens on component repaint.
+	 *
+	 * @param {boolean} enabled - `true` to enable double-buffering (default), `false` to disable.
+	 * @return {SwingUI|boolean} When setting a value, an instance of this `ui` object is returned, otherwise a current value is returned.
+	 */
+	doubleBuffer(...args)
+	{
+		if(args.length > 0)
+		{
+			this.sendToGUI({java: "doubleBuffer", value: args[0] === true});
+			return this;
+		}
+		else
+		{
+			return /** @type {boolean} */ this.sendToGUI({java: "doubleBuffer"}, r =>
+			{
+				return r.value;
+			});
+		}
+	}
+
 	/**
 	 * Shows a message dialog window like alert() in web browser.
 	 *

package/classes/Arc.js

@@ -96,7 +96,7 @@ export class Arc extends Shape
 		}
 		else
 		{
-			return {width: this._size.width, height: this._size.height};
+			return {width: this._hole_size.width, height: this._hole_size.height};
 		}
 	}
 	
@@ -182,4 +182,4 @@ export class Arc extends Shape
 		
 		return obj;
 	}
-}
+}

package/classes/ComponentContainer.js

@@ -111,8 +111,13 @@ export class ComponentContainer extends UIComponent
 
 		if(this.#descriptorObject == null)
 		{
-			this.applyComponentProperties = null;
-			this.applyUIDefinition = null;
+			this._applyUIDefinition = undefined;
+			this._applyComponentPropertiesV1_0 = undefined;
+			this._buildComponentResources = undefined;
+
+			delete this._applyUIDefinition;
+			delete this._applyComponentPropertiesV1_0;
+			delete this._buildComponentResources;
 		}
 	}
 
@@ -446,7 +451,7 @@ export class ComponentContainer extends UIComponent
 	 * @private
 	 * @ignore
 	 */
-	applyUIDefinition(class_name)
+	_applyUIDefinition(class_name)
 	{
 		// Apply UI to this component
 		if(this.#descriptorObject != null)
@@ -473,12 +478,12 @@ export class ComponentContainer extends UIComponent
 				try
 				{
 					common.validateComponent(this.#descriptorObject.component);
+					this._buildComponentResources(this, this.#descriptorObject, common); // contextMenus, menuBar, trayIcons
+					this._applyComponentPropertiesV1_0(this, this.#descriptorObject.component, common);
 				}catch(ex)
 				{
 					error(`${ex.name}: ${ex.message}`, false);
 				}
-
-				this.applyComponentPropertiesV1_0(this, this.#descriptorObject.component, common);
 			}
 			else
 			{
@@ -502,15 +507,108 @@ export class ComponentContainer extends UIComponent
 		}
 
 		// delete these functions to make sure they can't be called again
-		this.applyComponentProperties = null;
-		this.applyComponentPropertiesV1_0 = null;
-		this.applyUIDefinition = null;
+		this._buildComponentResources = undefined;
+		this._applyComponentPropertiesV1_0 = undefined;
+		this._applyUIDefinition = undefined;
+
+		delete this._buildComponentResources;
+		delete this._applyComponentPropertiesV1_0;
+		delete this._applyUIDefinition;
+	}
+
+	/**
+	 * @private
+	 */
+	_buildComponentResources(component, desc, common)
+	{
+		//region For backward compatibility
+		if("contextMenus" in desc.component)
+		{
+			desc.contextMenus = desc.component.contextMenus;
+			delete desc.component.contextMenus;
+		}
+
+		if("trayIcons" in desc.component)
+		{
+			desc.trayIcons = desc.component.trayIcons;
+			delete desc.component.trayIcons;
+		}
+		//endregion
+
+		// load context menus
+		if("contextMenus" in desc)
+		{
+			if(Array.isArray(desc.contextMenus))
+			{
+				desc.contextMenus.forEach(json_child =>
+				{
+					try
+					{
+						common.validateComponent(json_child);
+
+						this[json_child.ref] = new globalThis[json_child.type]();
+						this._applyComponentPropertiesV1_0(this[json_child.ref], json_child, common);
+					}catch(ex)
+					{
+						error(`Failed to load a context menu. ${ex.name}: ${ex.message}`, false);
+					}
+				});
+			}
+
+			delete desc.contextMenus;
+		}
+
+		if(desc.component.type === "Window")
+		{
+			// load main menu bar
+			if("menuBar" in desc.component)
+			{
+				try
+				{
+					common.validateComponent(desc.component.menuBar);
+
+					const bar = new globalThis[desc.component.menuBar.type]();
+					this._applyComponentPropertiesV1_0(bar, desc.component.menuBar, common);
+					component.menuBar(bar);
+					delete desc.component.menuBar;
+				}catch(ex)
+				{
+					error(`Failed to load a menu bar. ${ex.name}: ${ex.message}`, false);
+				}
+			}
+
+			// load tray icons
+			if("trayIcons" in desc)
+			{
+				if(Array.isArray(desc.trayIcons))
+				{
+					desc.trayIcons.forEach(json_child =>
+					{
+						try
+						{
+							common.validateComponent(json_child);
+						}catch(ex)
+						{
+							error(`Failed to load a tray icon. ${ex.name}: ${ex.message}`, false);
+							return;
+						}
+
+						const trayIcon = new globalThis[json_child.type]();
+						this.onDispose(e => {if(!trayIcon.destroyed) trayIcon.destroy();}); // destroy the tray icon when window gets disposed
+						this[json_child.ref] = trayIcon;
+						this._applyComponentPropertiesV1_0(trayIcon, json_child, common);
+					});
+				}
+
+				delete desc.trayIcons;
+			}
+		}
 	}
 
 	/**
 	 * @private
 	 */
-	applyComponentPropertiesV1_0(component, properties, common)
+	_applyComponentPropertiesV1_0(component, properties, common)
 	{
 		const ref = properties.ref;
 		delete properties.ref;
@@ -605,76 +703,6 @@ export class ComponentContainer extends UIComponent
 			}
 		}
 
-		// load context menus
-		if("contextMenus" in properties)
-		{
-			if(Array.isArray(properties.contextMenus))
-			{
-				properties.contextMenus.forEach(json_child =>
-				{
-					try
-					{
-						common.validateComponent(json_child);
-					}catch(ex)
-					{
-						error(`Failed to load a context menu. ${ex.name}: ${ex.message}`, false);
-						return;
-					}
-
-					this[json_child.ref] = new globalThis[json_child.type]();
-					this.applyComponentPropertiesV1_0(this[json_child.ref], json_child, common);
-				});
-			}
-
-			delete properties.contextMenus;
-		}
-
-		if(component instanceof Window)
-		{
-			// load main menu bar
-			if("menuBar" in properties)
-			{
-				try
-				{
-					common.validateComponent(properties.menuBar);
-				}catch(ex)
-				{
-					error(`Failed to load a menu bar. ${ex.name}: ${ex.message}`, false);
-				}
-
-				const bar = new globalThis[properties.menuBar.type]();
-				this.applyComponentPropertiesV1_0(bar, properties.menuBar, common);
-				component.menuBar(bar);
-				delete properties.menuBar;
-			}
-
-			// load tray icons
-			if("trayIcons" in properties)
-			{
-				if(Array.isArray(properties.trayIcons))
-				{
-					properties.trayIcons.forEach(json_child =>
-					{
-						try
-						{
-							common.validateComponent(json_child);
-						}catch(ex)
-						{
-							error(`Failed to load a tray icon. ${ex.name}: ${ex.message}`, false);
-							return;
-						}
-
-						const trayIcon = new globalThis[json_child.type]();
-						component.onDispose(e => {if(!trayIcon.destroyed) trayIcon.destroy();}); // destroy the tray icon when window gets disposed
-						this[json_child.ref] = trayIcon;
-						this.applyComponentPropertiesV1_0(trayIcon, json_child, common);
-					});
-				}
-
-				delete properties.trayIcons;
-			}
-		}
-
 		// apply properties
 		for(const prop of Object.keys(properties))
 		{
@@ -748,7 +776,7 @@ export class ComponentContainer extends UIComponent
 
 				const child_ref = json_child.ref;
 				this[child_ref] = new globalThis[json_child.type]();
-				this.applyComponentPropertiesV1_0(this[child_ref], json_child, common);
+				this._applyComponentPropertiesV1_0(this[child_ref], json_child, common);
 				component.addChild(this[child_ref]);
 			});
 		}

package/classes/Panel.js

@@ -32,7 +32,7 @@ class Panel extends ShapeContainer
 		//this.finalize(Panel, ShapeContainer);
 
 		// load UI definition file
-		if(new.target !== Panel && this.applyUIDefinition != null) this.applyUIDefinition(new.target.name); // must be called AFTER super()
+		if(new.target !== Panel && this._applyUIDefinition != null) this._applyUIDefinition(new.target.name); // must be called AFTER super()
 	}
 
 	/**

package/classes/UIComponent.js

@@ -267,7 +267,7 @@ class UIComponent
 	 * Gets a previous sibling component. If this component wasn't added to any container component, then `null` is returned.
 	 * @readonly
 	 * @type {UIComponent|null}
-	 * @since 1.0.2
+	 * @since 1.0.3
 	 */
 	get previousSibling()
 	{
@@ -281,7 +281,7 @@ class UIComponent
 	 * Gets a next sibling component. If this component wasn't added to any container component, then `null` is returned.
 	 * @readonly
 	 * @type {UIComponent|null}
-	 * @since 1.0.2
+	 * @since 1.0.3
 	 */
 	get nextSibling()
 	{
@@ -294,7 +294,7 @@ class UIComponent
 	 * Gets an array of sibling components.
 	 * @readonly
 	 * @type {UIComponent[]}
-	 * @since 1.0.2
+	 * @since 1.0.3
 	 */
 	get siblings()
 	{
@@ -445,7 +445,7 @@ class UIComponent
 
 	/**
 	 * Checks if this component is inside specified ancestor component (at any level, not just direct child).
-	 * @param {Object} ancestor - Ancestor component to test against
+	 * @param {UIComponent} ancestor - Ancestor component to test against
 	 * @return {boolean}
 	 * @see ComponentContainer#contains
 	 */

package/classes/Window.js

@@ -129,7 +129,7 @@ class Window extends ShapeContainer
 		//this.finalize(ShapeContainer, Window);
 
 		// load UI definition file
-		if(new.target !== Window && this.applyUIDefinition != null) this.applyUIDefinition(new.target.name); // must be called AFTER super()
+		if(new.target !== Window && this._applyUIDefinition != null) this._applyUIDefinition(new.target.name); // must be called AFTER super()
 	}
 
 	/**

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "swing-ui",
-	"version": "1.0.3",
+	"version": "1.0.5",
 	"description": "Cross-platform Graphic User Interface for Node.js, Bun and Deno 2+",
 	"main": "index.js",
 	"scripts": {

package/types/classes/ComponentContainer.d.ts

@@ -14,7 +14,6 @@ export class ComponentContainer extends UIComponent {
      * @ignore
      */
     constructor(...args: any[]);
-    applyComponentProperties: any;
     /**
      * Loads UI Components and properties from UI designer file FILE_NAME.ui.json where FILE_NAME is the name of JavaScript file of the component.
      *
@@ -22,7 +21,15 @@ export class ComponentContainer extends UIComponent {
      * @private
      * @ignore
      */
-    private applyUIDefinition;
+    private _applyUIDefinition;
+    /**
+     * @private
+     */
+    private _applyComponentPropertiesV1_0;
+    /**
+     * @private
+     */
+    private _buildComponentResources;
     /**
      * Gets an array of child components.
      *
@@ -122,10 +129,6 @@ export class ComponentContainer extends UIComponent {
      * };
      */
     onContainerEvents(...args: any[]): this | Function[];
-    /**
-     * @private
-     */
-    private applyComponentPropertiesV1_0;
     #private;
 }
 import { UIComponent } from "./UIComponent.js";

package/types/classes/UIComponent.d.ts

@@ -98,21 +98,21 @@ export class UIComponent {
      * Gets a previous sibling component. If this component wasn't added to any container component, then `null` is returned.
      * @readonly
      * @type {UIComponent|null}
-     * @since 1.0.2
+     * @since 1.0.3
      */
     readonly get previousSibling(): UIComponent | null;
     /**
      * Gets a next sibling component. If this component wasn't added to any container component, then `null` is returned.
      * @readonly
      * @type {UIComponent|null}
-     * @since 1.0.2
+     * @since 1.0.3
      */
     readonly get nextSibling(): UIComponent | null;
     /**
      * Gets an array of sibling components.
      * @readonly
      * @type {UIComponent[]}
-     * @since 1.0.2
+     * @since 1.0.3
      */
     readonly get siblings(): UIComponent[];
     /**
@@ -176,11 +176,11 @@ export class UIComponent {
     verifyComponent(): this;
     /**
      * Checks if this component is inside specified ancestor component (at any level, not just direct child).
-     * @param {Object} ancestor - Ancestor component to test against
+     * @param {UIComponent} ancestor - Ancestor component to test against
      * @return {boolean}
      * @see ComponentContainer#contains
      */
-    insideOf(ancestor: Object): boolean;
+    insideOf(ancestor: UIComponent): boolean;
     /**
      * Sets or gets component's visibility.
      * NOTE: Window and InternalWindow components visibility is set to `false` by default. Use .visible(true) or .show() to make it visible.

package/ui-process-manager.js

@@ -58,7 +58,7 @@ async function startJar()
 	let JAVA_OPTS = (env.JAVA_OPTS ?? "").split(" ").filter(Boolean);
 	if(JAVA_OPTS.indexOf("-Dfile.encoding=UTF-8") === -1) JAVA_OPTS.push("-Dfile.encoding=UTF-8"); // important
 	if(workerData.debugJava) JAVA_OPTS.push("-agentlib:jdwp=transport=dt_socket,server=y,suspend=y,address=*:5005"); // for debugging JAR
-	if(workerData.os === "linux")  JAVA_OPTS.push("--add-opens=java.desktop/sun.awt.X11=ALL-UNNAMED"); // to be able to set WM_CLASS to project name in Java GUI
+	if(workerData.os === "linux") JAVA_OPTS.push("--add-opens=java.desktop/sun.awt.X11=ALL-UNNAMED"); // to be able to set WM_CLASS to project name in Java GUI
 	
 	const _opts = [...JAVA_OPTS, "-jar", JAR_PATH, "--root-dir", workerData.rootDir, "--module-dir", workerData.moduleDir];