@guiexpert/table 1.1.5 → 1.1.8

package/lib/table/action/action-id.type.d.ts

@@ -3,7 +3,7 @@
  *
  * @type {ReadonlyArray<string>}
  */
-export declare const actionIds: readonly ["START_EDITING", "TOGGLE_SELECTION", "SELECT_ALL", "DESELECT_ALL", "NAVIGATE_LEFT", "NAVIGATE_RIGHT", "NAVIGATE_UP", "NAVIGATE_DOWN"];
+export declare const actionIds: readonly ["COPY_2_CLIPBOARD", "START_EDITING", "TOGGLE_SELECTION", "SELECT_ALL", "DESELECT_ALL", "NAVIGATE_LEFT", "NAVIGATE_RIGHT", "NAVIGATE_UP", "NAVIGATE_DOWN"];
 /**
  * Represents an action ID.
  *

package/lib/table/action/osx-shortcut-actionId-mapping.d.ts

@@ -2,6 +2,8 @@ import { ActionId } from "./action-id.type";
 /**
  * Class representing the mapping of OS X shortcut actions to action IDs.
  *
+ * Use 'meta' for the MacOS 'cmd' key.
+ *
  * @class OsxShortcutActionIdMapping
  */
 export declare class OsxShortcutActionIdMapping {

package/lib/table/action/shortcut.service.d.ts

@@ -1,4 +1,5 @@
 import { TableScope } from "../table-scope";
+import { ShortcutActionIdMapping } from "./shortcut-actionid-mapping.type";
 import { OnActionTriggeredIf } from "./on-action-triggered.if";
 /**
  * Represents a service for managing shortcuts and triggering actions based on keyboard events.
@@ -8,14 +9,31 @@ export declare class ShortcutService {
     private shortcutActionIdMapping;
     private listener;
     constructor(tableScope: TableScope);
+    /**
+     * Adds a listener to the list of listeners.
+     *
+     * @param {OnActionTriggeredIf} listener - The listener to be added.
+     * @returns {void}
+     */
     addListener(listener: OnActionTriggeredIf): void;
+    /**
+     * Initializes the ShortcutService by assigning shortcut action id mappings based on the current operating system.
+     * Also adds key down event listener to the table host element.
+     */
     init(): void;
+    private assignPredefinedSystemShortcutMappings;
     private isMacintosh;
     private isDebug;
     private isLocalhost;
     private onKeyDown;
     private emit;
-    private findEnty;
+    private findEntity;
     private areTokensEquals;
     private getTokenByEvent;
+    /**
+     * Retrieves the shortcut action mapping object.
+     *
+     * @returns {ShortcutActionIdMapping} - The shortcut action mapping object.
+     */
+    getShortcutActionMapping(): ShortcutActionIdMapping;
 }

package/lib/table/action/windows-shortcut-actionId-mapping.d.ts

@@ -1,6 +1,8 @@
 import { ActionId } from "./action-id.type";
 /**
  * Class representing a mapping of Windows shortcut keys to action IDs.
+ *
+ * Use 'meta' for the MacOS 'cmd' key.
  */
 export declare class WindowsShortcutActionIdMapping {
     get(): {

package/lib/table/data/tablemodel/areamodel/abstract-area-model.d.ts

@@ -17,6 +17,7 @@ export declare abstract class AbstractAreaModel<T> implements AreaModelIf, HasDe
     constructor(areaIdent: AreaIdent, columnDefs?: ColumnDefIf[], defaultRowHeight?: number);
     abstract getRowCount(): number;
     abstract getValueAt(rowIndex: number, columnIndex: number): any;
+    getTextValueAt(rowIndex: number, columnIndex: number): string;
     getTooltipAt(_rowIndex: number, _columnIndex: number): any;
     abstract getRowHeight(rowIndex: number): number;
     getCellRenderer(_rowIndex: number, columnIndex: number): CellRendererIf | undefined;

package/lib/table/data/tablemodel/areamodel/area-model-cell-groups.d.ts

@@ -38,6 +38,7 @@ export declare class AreaModelCellGroups implements AreaModelIf {
     getRowspanAt(rowIndex: number, columnIndex: number): number;
     getTooltipAt(_rowIndex: number, _columnIndex: number): any;
     getValueAt(rowIndex: number, columnIndex: number): any;
+    getTextValueAt(rowIndex: number, columnIndex: number): string;
     getYPosByRowIndex(_rowIndex: number): number;
     init(): void;
     getRowHeight(_rowIndex: number): number;

package/lib/table/data/tablemodel/areamodel/area-model-hidden.d.ts

@@ -14,6 +14,7 @@ export declare class AreaModelHidden implements AreaModelIf {
     constructor(areaIdent?: AreaIdent);
     getRowCount(): number;
     getValueAt(_rowIndex: number, _columnIndex: number): any;
+    getTextValueAt(_rowIndex: number, _columnIndex: number): string;
     getCellRenderer(_rowIndex: number, _columnIndex: number): CellRendererIf | undefined;
     getRowHeight(_rowIndex: number): number;
     getColspanAt(_rowIndex: number, _columnIndex: number): number;

package/lib/table/data/tablemodel/areamodel/area-model.d.ts

@@ -28,6 +28,7 @@ export declare class AreaModel implements AreaModelIf {
     getRowspanAt(_rowIndex: number, _columnIndex: number): number;
     getTooltipAt(_rowIndex: number, _columnIndex: number): any;
     getValueAt(_rowIndex: number, _columnIndex: number): any;
+    getTextValueAt(_rowIndex: number, _columnIndex: number): string;
     getYPosByRowIndex(_rowIndex: number): number;
     init(): void;
     isEditable(_rowIndex: number, _columnIndex: number): boolean;

package/lib/table/data/tablemodel/areamodel/area-model.if.d.ts

@@ -39,6 +39,11 @@ export interface AreaModelIf {
      * Returns the value of the cell at position rowIndex/columnIndex.
      */
     getValueAt(rowIndex: number, columnIndex: number): any;
+    /**
+     * Returns a string value of the cell at position rowIndex/columnIndex.
+     * This function will be called by 'export' or 'copy to clipboard'.
+     */
+    getTextValueAt(rowIndex: number, columnIndex: number): string;
     /**
      * Returns the value of a colspan of the cell at position rowIndex/columnIndex.
      * A value below 2 is ignored.

package/lib/table/mouse-handler.d.ts

@@ -6,6 +6,12 @@ import { GeMouseEvent } from "./data/common/event/ge-mouse-event";
  */
 export declare class MouseHandler {
     protected tableScope: TableScope;
+    /**
+     * Represents the delay in milliseconds between two consecutive double clicks.
+     *
+     * @type {number}
+     */
+    doubleClickDelay: number;
     mouseEvent?: MouseEvent;
     startMouseEvent?: GeMouseEvent;
     geMouseEvent?: GeMouseEvent;
@@ -22,6 +28,7 @@ export declare class MouseHandler {
      * @return {void}
      */
     private onContextmenu;
+    private lastClicked;
     /**
      * Handles the click event on the host element.
      *

package/lib/table/render-scope.d.ts

@@ -45,7 +45,14 @@ export declare class RenderScope extends EleScope {
     protected editing: boolean;
     isEditing(): boolean;
     resetEditorRenderer(): void;
-    clearSelection(): void;
+    /**
+     * Clears the selection in the component.
+     *
+     * @param {boolean} rerender - Indicates whether to rerender the component after clearing the selection. Default value is false.
+     *
+     * @return {void}
+     */
+    clearSelection(rerender?: boolean): void;
     initRenderEditor(rowIdx: number, colIdx: number): void;
     repaint(): void;
     adjustAfterScrolling(): void;

package/lib/table/renderer/positive-and-negative-number-renderer.d.ts

@@ -0,0 +1,4 @@
+import { AreaIdent, AreaModelIf, CellRendererIf, DomServiceIf, RendererCleanupFnType } from '../../../index.ts';
+export declare class PositiveAndNegativeNumberRenderer implements CellRendererIf {
+    render(cellDiv: HTMLDivElement, rowIndex: number, columnIndex: number, areaIdent: AreaIdent, _areaModel: AreaModelIf, cellValue: any, domService: DomServiceIf): RendererCleanupFnType | undefined;
+}

package/lib/table/selection/selection-model.d.ts

@@ -1,13 +1,14 @@
 import { CellRange } from "../data/common/cell-range";
-import { SelectionMode, SelectionType } from "./selection.type";
+import { ExtendedSelectionType, SelectionMode } from './selection.type';
 import { SelectionModelIf } from "./selection-model.if";
 export declare class SelectionModel implements SelectionModelIf {
-    selectionType: SelectionType;
+    selectionType: ExtendedSelectionType;
     selectionMode: SelectionMode;
     protected ranges: CellRange[];
     protected negativeRanges: CellRange[];
     protected allSelected: boolean;
-    constructor(selectionType?: SelectionType, selectionMode?: SelectionMode);
+    constructor(selectionType?: ExtendedSelectionType, selectionMode?: SelectionMode);
+    firstClick(rowIndex: number, columnIndex: number): void;
     getSelectionCount(rowIndex: number, columnIndex: number): number;
     isInNegativeRange(rowIndex: number, columnIndex: number): boolean;
     getRanges(): CellRange[];
@@ -17,5 +18,6 @@ export declare class SelectionModel implements SelectionModelIf {
     addSelection(range: CellRange): void;
     removeSelection(range: CellRange): void;
     togglePoint(row: number, col: number): void;
+    isSelected(row: number, col: number): boolean;
     private addRange;
 }

package/lib/table/selection/selection-model.if.d.ts

@@ -1,6 +1,7 @@
 import { CellRange } from "../data/common/cell-range";
 export interface SelectionModelIf {
     togglePoint(row: number, col: number): void;
+    isSelected(row: number, col: number): boolean;
     getRanges(): CellRange[];
     clear(): void;
     hasSelection(): boolean;
@@ -8,4 +9,5 @@ export interface SelectionModelIf {
     removeSelection(range: CellRange): void;
     getSelectionCount(rowIndex: number, columnIndex: number): number;
     selectAll(): void;
+    firstClick(rowIndex: number, columnIndex: number): void;
 }

package/lib/table/selection/selection-service.d.ts

@@ -7,8 +7,8 @@ import { OnActionTriggeredIf } from "../action/on-action-triggered.if";
 import { ActionId } from "../action/action-id.type";
 export declare class SelectionService implements OnActionTriggeredIf {
     protected readonly tableScope: TableScope;
-    protected getSelectionModel?: GetT<SelectionModelIf>;
-    protected getFocusModel?: GetT<FocusModelIf>;
+    getSelectionModel?: GetT<SelectionModelIf>;
+    getFocusModel?: GetT<FocusModelIf>;
     protected previousEvt?: GeMouseEvent;
     constructor(tableScope: TableScope);
     onMouseClicked(evt: GeMouseEvent, _previousEvt: GeMouseEvent | undefined): boolean;

package/lib/table/selection/selection.type.d.ts

@@ -1,2 +1,3 @@
-export type SelectionType = "none" | "cell" | "row" | "column" | "range";
+export type ExtendedSelectionType = SelectionType | "range";
+export type SelectionType = "none" | "cell" | "row" | "column";
 export type SelectionMode = "single" | "multi";

package/lib/table/service/copy-service.d.ts

@@ -0,0 +1,11 @@
+import { TableModelIf } from '../data/tablemodel/table-model.if';
+import { SelectionModelIf } from '../selection/selection-model.if';
+import { FocusModelIf } from '../focus/focus-model.if';
+import { CopyServiceIf } from './copy-service.if';
+export declare class CopyService implements CopyServiceIf {
+    static columnSeparatorChar: string;
+    static rowSeparatorChar: string;
+    createContent(tableModel: TableModelIf, selectionModel: SelectionModelIf, focusModel: FocusModelIf): Promise<string>;
+    copyContent(content: string): Promise<void>;
+    private mergeRanges;
+}

package/lib/table/service/copy-service.if.d.ts

@@ -0,0 +1,7 @@
+import { TableModelIf } from '../data/tablemodel/table-model.if';
+import { SelectionModelIf } from '../selection/selection-model.if';
+import { FocusModelIf } from '../focus/focus-model.if';
+export interface CopyServiceIf {
+    createContent(tableModel: TableModelIf, selectionModel: SelectionModelIf | undefined, focusModel: FocusModelIf | undefined): Promise<string>;
+    copyContent(content: string): Promise<void>;
+}

package/lib/table/table-api.d.ts

@@ -1,6 +1,9 @@
 import { TableScope } from "./table-scope";
 import { ColumnDefIf } from "./data/tablemodel/column/column-def.if";
 import { TableCellUpdateEventIf } from "./data/common/event/input/table-cell-update-event.if";
+import { SelectionModel } from './selection/selection-model';
+import { ActionId } from './action/action-id.type';
+import { ShortcutActionIdMapping } from './action/shortcut-actionid-mapping.type';
 export declare class TableApi {
     private readonly tableScope;
     constructor(tableScope: TableScope);
@@ -87,4 +90,34 @@ export declare class TableApi {
      * to update and redraw the table based on the latest data.
      */
     repaint(): void;
+    /**
+     * Clears the current selection of the table.
+     * The table will be rendered automatically.
+     *
+     * @returns {void}
+     */
+    clearSelection(): void;
+    /**
+     * Sets the selection model for the table scope.
+     *
+     * @param {SelectionModel} sm - The selection model to be set.
+     * @param {boolean} [repaint=true] - Indicates whether the table should be repainted after setting the selection model. Default value is true.
+     *
+     * @return {void}
+     */
+    setSelectionModel(sm: SelectionModel, repaint?: boolean): void;
+    /**
+     * Triggers the action with the given action ID.
+     * This function can be invoked programmatically.
+     *
+     * @param {ActionId} actionId - The ID of the action to trigger.
+     * @return {void}
+     */
+    triggerAction(actionId: ActionId): void;
+    /**
+     * Retrieves the mapping of shortcuts to corresponding action in the current table scope.
+     *
+     * @return {ShortcutActionIdMapping} The mapping of shortcuts to corresponding action.
+     */
+    getShortcutActionMapping(): ShortcutActionIdMapping;
 }

package/lib/table/table-scope.d.ts

@@ -16,6 +16,8 @@ import { OnActionTriggeredIf } from "./action/on-action-triggered.if";
 import { ActionId } from "./action/action-id.type";
 import { ShortcutService } from "./action/shortcut.service";
 import { LicenseManager } from './license-manager';
+import { SelectionModel } from './selection/selection-model';
+import { CopyServiceIf } from './service/copy-service.if';
 /**
  * Creates a TableScope instance.
  * @param {HTMLDivElement} hostElement - The host element.
@@ -26,6 +28,7 @@ import { LicenseManager } from './license-manager';
  */
 export declare class TableScope extends RenderScope implements OnActionTriggeredIf {
     protected readonly eventListener: EventListenerIf;
+    protected readonly copyService: CopyServiceIf;
     licenseManager: LicenseManager;
     mouseHandler: MouseHandler;
     inputHandler: InputHandler;
@@ -51,8 +54,16 @@ export declare class TableScope extends RenderScope implements OnActionTriggered
      *
      * @return {TableScope} - The newly created TableScope instance.
      */
-    static create(hostElement: HTMLDivElement, tableModel: TableModelIf, tableOptions?: TableOptionsIf, eventListener?: EventListenerIf, domService?: DomServiceIf): TableScope;
-    constructor(hostElement: HTMLDivElement, tableModel: TableModelIf, domService: DomServiceIf, tableOptions: TableOptionsIf, eventListener: EventListenerIf);
+    static create(hostElement: HTMLDivElement, tableModel: TableModelIf, tableOptions?: TableOptionsIf, eventListener?: EventListenerIf, domService?: DomServiceIf, copyService?: CopyServiceIf): TableScope;
+    constructor(hostElement: HTMLDivElement, tableModel: TableModelIf, domService: DomServiceIf, tableOptions: TableOptionsIf, eventListener: EventListenerIf, copyService?: CopyServiceIf);
+    /**
+     * Triggers an action based on the provided actionId.
+     *
+     * This function can be invoked manually via the table API or by keyboard shortcuts.
+     *
+     * @param {ActionId} actionId - The identifier of the action to be triggered.
+     * @return {boolean} - Returns true if the action was triggered successfully, false otherwise.
+     */
     onActionTriggered(actionId: ActionId): boolean;
     updateModelValueAfterEdit(areaIdent: AreaIdent, rowIndex: number, columnIndex: number, value: string): void;
     /**
@@ -137,7 +148,9 @@ export declare class TableScope extends RenderScope implements OnActionTriggered
      * @param {GeMouseEvent | undefined} previousEvt - The previous mouse click event, if any.
      * @returns {void}
      */
-    onMouseClicked(evt: GeMouseEvent, previousEvt: GeMouseEvent | undefined): void;
+    onMouseClicked(evt: GeMouseEvent, previousEvt: GeMouseEvent | undefined): boolean;
+    debounceRepaint(): void;
+    publishGeMouseEvent(evt: GeMouseEvent): void;
     /**
      * Updates the table (repaint) when an external filter is changed.
      *
@@ -179,8 +192,6 @@ export declare class TableScope extends RenderScope implements OnActionTriggered
     /**
      * Restores the scroll position of the table if auto restore options are enabled.
      *
-     * @private
-     * @memberof ClassName
      *
      * @returns {void}
      */
@@ -224,4 +235,13 @@ export declare class TableScope extends RenderScope implements OnActionTriggered
      * @return {void}
      */
     scrollToIndex(_indexX: number, indexY: number): void;
+    /**
+     * Sets the selection model for the table.
+     *
+     * @param {SelectionModel} sm - The selection model to be set.
+     * @param {boolean} rerender - Optional parameter indicating whether to rerender the table after setting the selection model. Default value is false.
+     *
+     * @return {void} - This method does not return any value.
+     */
+    setSelectionModel(sm: SelectionModel, rerender?: boolean): void;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@guiexpert/table",
-  "version": "1.1.5",
+  "version": "1.1.8",
   "dependencies": {
     "tslib": "^2.3.0"
   },
@@ -25,3 +25,4 @@
   }
 }
 
+