swing-ui 1.0.5 → 1.0.6

package/README.md

@@ -67,7 +67,7 @@ If you've shipped a desktop app in JS before, you've probably lived one of these
 npm install swing-ui
 ```
 
-> Install it locally in each project — not with `-g`.
+> Install it locally in each project — not with `-g` option.
 
 ```js
 import "swing-ui";
@@ -117,7 +117,7 @@ That's just a taste. Tables, trees, tabs, menus, system tray icons, custom drawi
 - Financial software with graphical graphs and charts
 - and much more...
 
-Anywhere you want a real desktop app without the weight of a browser runtime, and without leaving JavaScript to get it. With thousands or JavaScript modules now almost anything is possible in JavaScript.
+Anywhere you want a real desktop app without the weight of a browser runtime, and without leaving JavaScript to get it. With thousands of JavaScript modules now almost anything is possible in JavaScript.
 
 ---
 

package/SwingUI.js

@@ -1162,13 +1162,13 @@ export class SwingUI
 	 * data[DataType.HTML] = "<b>HTML Content</b>";
 	 * ui.clipboard(data);
 	 */
-	clipboard()
+	clipboard(...args)
 	{
-		if(arguments.length > 0)
+		if(args.length > 0)
 		{
 			this.sendToGUI({
 				system: "clipboard",
-				value: (typeof arguments[0] === "string") ? {Text: arguments[0]} : arguments[0]
+				value: (typeof args[0] === "string") ? {Text: args[0]} : args[0]
 			});
 			return this;
 		}
@@ -1250,6 +1250,7 @@ export class SwingUI
 	 *
 	 * @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.
+	 * @since 1.0.5
 	 */
 	doubleBuffer(...args)
 	{

package/classes/Arc.js

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

package/classes/Table.js

@@ -707,15 +707,16 @@ export class Table extends ScrollableComponent
 	/**
 	 * Sets or gets a row and a column of selected cell.
 	 *
-	 * @param {number} [row] - Row of a cell. (Original order is used, sorting is disregarded.)
+	 * @param {number|TableCell} [row_or_cell] - Row or a TableCell object. (Original order is used, sorting is disregarded.)
 	 * @param {number} [column] - Column of a cell (required if row is specified). (Original order is used, column reordering is disregarded.)
-	 * @return {number[]|Table} When both `row` and `cell` are passed, an instance of `this` Table is returned, otherwise a currently selected row and column is returned as an array of integers [row, column], or NULL if there is no selection.
+	 * @return {TableCell|Table} When both `row` and `cell` are passed, an instance of `this` Table is returned, otherwise a currently selected `TableCell` object is returned, or NULL if there is no selection.
 	 */
 	selectedCell(...args)
 	{
-		if(args.length > 1)
+		if(args.length > 0)
 		{
-			return this.property("selectedCell", [{row: parseInt(args[0]), col: parseInt(args[1])}]);
+			const cell = (typeof args[0] === "object") ? args[0] : {row: parseInt(args[0]), col: parseInt(args[1])};
+			return this.property("selectedCell", [cell]);
 		}
 		else
 		{
@@ -729,10 +730,10 @@ export class Table extends ScrollableComponent
 	 * Pass `null` as a first argument to stop editing currently edited cell. Do it before reading data from the Table to make sure the cell editor commits it's new value to the Table's data.
 	 * When called with no arguments, returns the cell currently being edited, or `null` if no cell is being edited.
 	 *
-	 * @param {number} [row] - Row index of the cell to edit, or `null` to stop editing currently edited cell (if any).
+	 * @param {number|TableCell} [row_or_cell] - Row index of the cell or a TableCell object to edit, or `null` to stop editing currently edited cell (if any).
 	 * @param {number} [column] - Column index of the cell to edit.
 	 * @param {boolean} [new_order=false] - Specified if row and column should be interpreted as new index as displayed (after row sorting and column reordering) or not.
-	 * @return {Cell|null|Table} When row and cell is specified, an instance of `this` Table is returned, otherwise a currently edited cell is retuned of `null` if no cell is being edited.
+	 * @return {TableCell|null|Table} When row and cell is specified, an instance of `this` Table is returned, otherwise a currently edited cell is retuned of `null` if no cell is being edited.
 	 * @example <h2>Stop editing before reading Table data</h2>
 	 * if(table.editingCell() != null) table.editingCell(null); // stop editing a cell to commit its changes
 	 * const _rows = table.rows(); // read new data
@@ -743,7 +744,8 @@ export class Table extends ScrollableComponent
 
 		if(args.length > 0)
 		{
-			ui.sendToGUI({control:this.id, set: "editingCell", value: args[0] == null ? null : [parseInt(args[0]), parseInt(args[1])], data: {new_order: (args[2] === true)}});
+			const cell = args[0] == null ? null : (typeof args[0] === "object") ? args[0] : {row: parseInt(args[0]), col: parseInt(args[1])};
+			ui.sendToGUI({control:this.id, set: "editingCell", value: cell, data: {new_order: (args[2] === true)}});
 			return this;
 		}
 		else
@@ -873,11 +875,11 @@ export class Table extends ScrollableComponent
 	}
 	
 	/**
-	 * Gets a cell [row,column] located at specified X and Y coordinates relative to the Table's top-left corner.
+	 * Gets a TableCell {row,column} located at specified X and Y coordinates relative to the Table's top-left corner.
 	 *
 	 * @param {number} x - X
 	 * @param {number} y - Y
-	 * @return {Cell|null} Returns the cell, or `null` if the coordinates are outside any cell.
+	 * @return {TableCell|null} Returns the cell at specified location, or `null` if the coordinates are outside any cell.
 	 */
 	cellAt(x, y)
 	{

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.3
+	 * @since 1.0.2
 	 */
 	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.3
+	 * @since 1.0.2
 	 */
 	get nextSibling()
 	{
@@ -294,7 +294,7 @@ class UIComponent
 	 * Gets an array of sibling components.
 	 * @readonly
 	 * @type {UIComponent[]}
-	 * @since 1.0.3
+	 * @since 1.0.2
 	 */
 	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 {UIComponent} ancestor - Ancestor component to test against
+	 * @param {Object} ancestor - Ancestor component to test against
 	 * @return {boolean}
 	 * @see ComponentContainer#contains
 	 */
@@ -662,7 +662,6 @@ class UIComponent
 	/**
 	 * @internal
 	 * @ignore
-	 * @private
 	 * @param {string} property
 	 * @param {any} value
 	 * @return {any}
@@ -697,7 +696,6 @@ class UIComponent
 	 * @return {Function[]|this} If only the `name` argument is provided, returns an array of registered callback functions. Otherwise, returns `this` component.
 	 * @internal
 	 * @ignore
-	 * @private
 	 * @example
 	 * const _callbacks_array = button.event("onAction"); // gets an array of previously registered handler functions
 	 * button.event("onAction", _callbacks_array[0], true); // unregisters callback function, same as button.onAction(_callbacks_array[0], true);
@@ -1175,7 +1173,6 @@ class UIComponent
 			if(this === menu || typeof menu !== "object" || !(menu instanceof globalThis.ContextMenu)) // can't use !(menu instanceof ContextMenu) because ContextMenu imports this class, thus would create circular import.
 			{
 				throw new Error(ui._msg[10]);
-				return this;
 			}
 
 			if(this.#context_menu != null) this.contextMenu(null); // remove existing menu before setting a new one

package/package.json

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

package/typedefs.js

@@ -695,13 +695,13 @@
 /**
  * Table cell coordinates containing column and row property.
  *
- * @typedef {Object} Cell
+ * @typedef {Object} TableCell
  * @property {number} column - a column index of the cell
  * @property {number} row - a row index of the cell
  *
  * @see Table#cellAt
- * @see Table#findCell
- * @see Table#findCells
+ * @see Table#selectedCell
+ * @see Table#editingCell
  *
  */
 

package/types/SwingUI.d.ts

@@ -295,6 +295,14 @@ export class SwingUI {
      * );
      */
     ui(...args: any[]): string | 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.
+     * @since 1.0.5
+     */
+    doubleBuffer(...args: any[]): SwingUI | boolean;
     /**
      * Shows a message dialog window like alert() in web browser.
      *

package/types/classes/Table.d.ts

@@ -466,26 +466,26 @@ export class Table extends ScrollableComponent {
     /**
      * Sets or gets a row and a column of selected cell.
      *
-     * @param {number} [row] - Row of a cell. (Original order is used, sorting is disregarded.)
+     * @param {number|TableCell} [row_or_cell] - Row or a TableCell object. (Original order is used, sorting is disregarded.)
      * @param {number} [column] - Column of a cell (required if row is specified). (Original order is used, column reordering is disregarded.)
-     * @return {number[]|Table} When both `row` and `cell` are passed, an instance of `this` Table is returned, otherwise a currently selected row and column is returned as an array of integers [row, column], or NULL if there is no selection.
+     * @return {TableCell|Table} When both `row` and `cell` are passed, an instance of `this` Table is returned, otherwise a currently selected `TableCell` object is returned, or NULL if there is no selection.
      */
-    selectedCell(...args: any[]): number[] | Table;
+    selectedCell(...args: any[]): TableCell | Table;
     /**
      * Gets or sets the cell currently being edited.
      * When `row` and `column` are provided and are valid, the specified cell enters edit mode.
      * Pass `null` as a first argument to stop editing currently edited cell. Do it before reading data from the Table to make sure the cell editor commits it's new value to the Table's data.
      * When called with no arguments, returns the cell currently being edited, or `null` if no cell is being edited.
      *
-     * @param {number} [row] - Row index of the cell to edit, or `null` to stop editing currently edited cell (if any).
+     * @param {number|TableCell} [row_or_cell] - Row index of the cell or a TableCell object to edit, or `null` to stop editing currently edited cell (if any).
      * @param {number} [column] - Column index of the cell to edit.
      * @param {boolean} [new_order=false] - Specified if row and column should be interpreted as new index as displayed (after row sorting and column reordering) or not.
-     * @return {Cell|null|Table} When row and cell is specified, an instance of `this` Table is returned, otherwise a currently edited cell is retuned of `null` if no cell is being edited.
+     * @return {TableCell|null|Table} When row and cell is specified, an instance of `this` Table is returned, otherwise a currently edited cell is retuned of `null` if no cell is being edited.
      * @example <h2>Stop editing before reading Table data</h2>
      * if(table.editingCell() != null) table.editingCell(null); // stop editing a cell to commit its changes
      * const _rows = table.rows(); // read new data
      */
-    editingCell(...args: any[]): Cell | null | Table;
+    editingCell(...args: any[]): TableCell | null | Table;
     /**
      * Sets or gets whether sorting can be toggled to unsorted state.
      *
@@ -573,13 +573,13 @@ export class Table extends ScrollableComponent {
         height: number;
     };
     /**
-     * Gets a cell [row,column] located at specified X and Y coordinates relative to the Table's top-left corner.
+     * Gets a TableCell {row,column} located at specified X and Y coordinates relative to the Table's top-left corner.
      *
      * @param {number} x - X
      * @param {number} y - Y
-     * @return {Cell|null} Returns the cell, or `null` if the coordinates are outside any cell.
+     * @return {TableCell|null} Returns the cell at specified location, or `null` if the coordinates are outside any cell.
      */
-    cellAt(x: number, y: number): Cell | null;
+    cellAt(x: number, y: number): TableCell | null;
     /**
      * Sets or gets how many quick mouse clicks on editable cells are required to change the cell to editing mode.
      *

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.3
+     * @since 1.0.2
      */
     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.3
+     * @since 1.0.2
      */
     readonly get nextSibling(): UIComponent | null;
     /**
      * Gets an array of sibling components.
      * @readonly
      * @type {UIComponent[]}
-     * @since 1.0.3
+     * @since 1.0.2
      */
     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 {UIComponent} ancestor - Ancestor component to test against
+     * @param {Object} ancestor - Ancestor component to test against
      * @return {boolean}
      * @see ComponentContainer#contains
      */
-    insideOf(ancestor: UIComponent): boolean;
+    insideOf(ancestor: Object): 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.
@@ -257,12 +257,11 @@ export class UIComponent {
     /**
      * @internal
      * @ignore
-     * @private
      * @param {string} property
      * @param {any} value
      * @return {any}
      */
-    private property;
+    property(property: string, ...args: any[]): any;
     /**
      * Registers, unregisters, and gets an event handler callback function for a specified events.
      *
@@ -276,13 +275,12 @@ export class UIComponent {
      * @return {Function[]|this} If only the `name` argument is provided, returns an array of registered callback functions. Otherwise, returns `this` component.
      * @internal
      * @ignore
-     * @private
      * @example
      * const _callbacks_array = button.event("onAction"); // gets an array of previously registered handler functions
      * button.event("onAction", _callbacks_array[0], true); // unregisters callback function, same as button.onAction(_callbacks_array[0], true);
      * button.event("onAction", e => {console.debug(e);}); // registers new event handler function, same as button.onAction(e => {console.debug(e);});
      */
-    private event;
+    event(name: string, callback?: (arg0: Object) => any | null, remove?: boolean): Function[] | this;
     /**
      * Sets or gets the background color of the component. <br />
      * <br />