@guiexpert/table 1.1.1 → 1.1.2

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

@@ -51,35 +51,221 @@ export declare class TableModel implements TableModelIf {
     constructor(headerAreaModel: AreaModelIf, bodyAreaModel: AreaModelIf, footerAreaModel: AreaModelIf, fixedLeftColumnCount?: number, fixedRightColumnCount?: number, rowCheckboxVisible?: boolean, defaultRowHeights?: DefaultRowHeightsIf, columnDefs?: ColumnDefIf[], columnSizes?: number[], overridingColumnWidth?: number, columnCount?: number, parentSize?: number, // can be important when we have percentage widthes,
     getSelectionModel?: GetT<SelectionModelIf>);
     init(): void;
+    /**
+     * Retrieves the count of columns in the current instance.
+     *
+     * @return {number} The count of columns.
+     */
     getColumnCount(): number;
+    /**
+     * Sets the width in pixel of a column (by columnIndex) in a table.
+     *
+     * @param {number} columnIndex - The index of the column.
+     * @param {number} width - The desired width of the column.
+     * @return {void}
+     */
     setColumnWidth(columnIndex: number, width: number): void;
+    /**
+     * Retrieves the width of a column specified by its index.
+     *
+     * @param {number} columnIndex - The index of the desired column.
+     * @return {number} - The width of the specified column.
+     */
     getColumnWidth(columnIndex: number): number;
+    /**
+     * Retrieves the x position for a given column index.
+     *
+     * @param {number} columnIndex - The index of the column.
+     * @return {number} - The x position of the column.
+     */
     getXPosByColumnIndex(columnIndex: number): number;
+    /**
+     * Recalculates the size (width, height, padding)  of the elements based on the client width.
+     *
+     * @param {number} clientWidth - The width of the client area.
+     *
+     * @return {void} - This method does not return a value.
+     */
     recalcSize(clientWidth: number): void;
+    /**
+     * Recalculates the height and padding for the body area.
+     *
+     * This method retrieves the area model for the "body" area,
+     * and updates the rowCount property with the row count of the model.
+     *
+     * The contentHeightInPx property is then updated with the height of the "body" area.
+     *
+     * The method calls the recalcContentWidthInPx() method to recalculate the content width.
+     *
+     * Finally, the method calls the recalcPadding() method to recalculate the padding.
+     *
+     * @return {void}
+     */
     recalcHeightAndPadding(): void;
+    /**
+     * Recalculates the padding of an element based on the width and height of its surrounding areas.
+     *
+     * @method recalcPadding
+     *
+     * @returns {void}
+     */
     recalcPadding(): void;
+    /**
+     * Retrieves the padding value.
+     *
+     * @returns {Padding} The padding value.
+     */
     getPadding(): Padding;
+    /**
+     * Returns the height of the content in pixels.
+     *
+     * @returns {number} The height of the content in pixels.
+     */
     getContentHeightInPixel(): number;
+    /**
+     * Returns the width of the content in pixels.
+     *
+     * @returns {number} The width of the content in pixels.
+     */
     getContentWidthInPixel(): number;
+    /**
+     * Returns the height of the specified row in the given row area identifier.
+     *
+     * @param {AreaIdent} rowAreaIdent - The row area identifier.
+     * @param {number} rowIndex - The index of the row.
+     * @return {number} - The height of the specified row.
+     */
     getRowHeight(rowAreaIdent: AreaIdent, rowIndex: number): number;
+    /**
+     * Retrieves the model for the given row area identifier.
+     *
+     * @param {AreaIdent} rowAreaIdent - The identifier of the row area.
+     * @return {AreaModelIf} - The model of the specified row area.
+     */
     getModel(rowAreaIdent: AreaIdent): AreaModelIf;
+    /**
+     * Calculates the height of the area identified by the given area identifier.
+     *
+     * @param {AreaIdent} areaIdent - The identifier of the area.
+     * @return {number} - The height of the area.
+     */
     getAreaHeight(areaIdent: AreaIdent): number;
+    /**
+     * Returns the total width of the side area identified by sideIdent.
+     *
+     * @param {SideIdent} sideIdent - The identifier of the side area ("west" | "center" | "east").
+     * @return {number} - The total width in pixels of the side area.
+     */
     getSideAreaWidth(sideIdent: SideIdent): number;
+    /**
+     * Retrieves the start and end column indices based on the given side identifier.
+     *
+     * @param {SideIdent} sideIdent - The side identifier, which can be "west", "east", or "center".
+     * @return {[number, number]} - An array containing the start and end column indices.
+     */
     getSideStartAndEndColumnIndex(sideIdent: SideIdent): [number, number];
+    /**
+     * Returns the column definition at the specified index.
+     *
+     * @param {number} index - The index of the column definition to retrieve.
+     * @returns {ColumnDefIf | undefined} - The column definition at the specified index, or undefined if no ColumnDef is specified for the given column
+     */
     getColumnDef(index: number): ColumnDefIf | undefined;
+    /**
+     * Retrieves the count of fixed left columns.
+     *
+     * @returns {number} The count of fixed left columns.
+     */
     getFixedLeftColumnCount(): number;
+    /**
+     * Returns the number of fixed right columns.
+     *
+     * @returns {number} The number of fixed right columns.
+     */
     getFixedRightColumnCount(): number;
+    /**
+     * Retrieves the area model (header, body or footer) based on the area identification.
+     *
+     * @param {AreaIdent} area - The identifier of the area.
+     * @return {AreaModelIf} The area model corresponding to the given area identification.
+     * @throws {Error} If the area identification is invalid.
+     */
     getAreaModel(area: AreaIdent): AreaModelIf;
+    /**
+     * Returns the body area model.
+     *
+     * @returns {AreaModelIf} The body area model.
+     */
     getBodyModel(): AreaModelIf;
+    /**
+     * Checks if the footer is visible.
+     *
+     * @returns {boolean} True if the footer is visible, false otherwise.
+     */
     isFooterVisibe(): boolean;
+    /**
+     * Checks if the header area is visible.
+     * @return {boolean} Returns true if the header area is visible, otherwise false.
+     */
     isHeaderVisibe(): boolean;
+    /**
+     * Checks whether the row checkbox is visible.
+     *
+     * @returns {boolean} True if the row checkbox is visible, otherwise false.
+     */
     isRowCheckboxVisible(): boolean;
+    /**
+     * This method is called when an external filter is changed.
+     *
+     * @param {FilterFunction<T>} predictFn - The function used to predict whether an element should be filtered or not.
+     * @return {void}
+     */
     externalFilterChanged<T>(predictFn: FilterFunction<T>): void;
+    /**
+     * Sorts the items using the given sortItems array.
+     *
+     * @param {SortItem[]} sortItems - An array of sort items to sort the items.
+     * @return {boolean} - Returns true if the sorting is successful, otherwise false.
+     */
     doSort(sortItems: SortItem[]): boolean;
+    /**
+     * Returns an array of ColumnDefIf objects or undefined.
+     *
+     * @return {ColumnDefIf[] | undefined} An array of ColumnDefIf objects or undefined.
+     */
     getColumnDefs(): ColumnDefIf[] | undefined;
+    /**
+     * Retrieves the property key of the table row business object associated with the specified column index.
+     * It's only available when columnDefs are specified.
+     *
+     * @param {number} columnIndex - The index of the column to retrieve the property from.
+     * @return {string} The property associated with the specified column index.
+     */
     getColumnProperty(columnIndex: number): string;
+    /**
+     * Retrieves the row object from the body model at the specified index.
+     *
+     * @param {number} rowIndex - The index of the row to retrieve.
+     *
+     * @return {any} The row object at the specified index.
+     */
     getBodyRowByIndex(rowIndex: number): any;
+    /**
+     * Checks if a column at the given index is sortable.
+     *
+     * @param {number} columnIndex - The index of the column to check.
+     *
+     * @returns {boolean} - `true` if the column is sortable, `false` otherwise.
+     */
     isSortable(columnIndex: number): boolean;
+    /**
+     * Moves a column in the column order.
+     *
+     * @param {number} sourceColumnIndex - The index of the column to be moved.
+     * @param {number} targetColumnIndex - The index where the column should be moved to.
+     *
+     * @returns {void}
+     */
     changeColumnOrder(sourceColumnIndex: number, targetColumnIndex: number): void;
     private recalcColumnWidthes;
     private arrayMove;

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

@@ -24,33 +24,198 @@ import { SelectionModelIf } from "../../selection/selection-model.if";
  *
  */
 export interface TableModelIf {
+    /**
+     * Moves a column from the source column index to the target column index.
+     *
+     * @param {number} sourceColumnIndex - The index of the column to be moved.
+     * @param {number} targetColumnIndex - The index where the column will be moved to.
+     *
+     * @return {void} - This method does not return anything.
+     */
     changeColumnOrder(sourceColumnIndex: number, targetColumnIndex: number): void;
+    /**
+     * Checks if a column at the specified index is sortable.
+     *
+     * @param {number} colIdx - The index of the column to check.
+     * @return {boolean} - true if the column is sortable, false otherwise.
+     */
     isSortable(colIdx: number): boolean;
+    /**
+     * Triggered by TableScope.firstInit() after the table tag is attached to the dom.
+     */
     init(): void;
+    /**
+     * Returns the number of columns in a dataset.
+     *
+     * @returns {number} The number of columns in the dataset.
+     */
     getColumnCount(): number;
+    /**
+     * Retrieves the width (in pixels) of a specific column.
+     *
+     * @param {number} columnIndex - The index of the column to get the width of.
+     * @return {number} The width of the specified column.
+     */
     getColumnWidth(columnIndex: number): number;
+    /**
+     * Returns the x position corresponding to the given column index.
+     *
+     * @param {number} columnIndex - The index of the column.
+     * @return {number} - The x position corresponding to the given column index.
+     */
     getXPosByColumnIndex(columnIndex: number): number;
+    /**
+     * Retrieves the area model based on the given row area identifier.
+     *
+     * @param {AreaIdent} rowAreaIdent - The identifier of the row area.
+     * @return {AreaModelIf} The area model corresponding to the provided row area identifier.
+     */
     getAreaModel(rowAreaIdent: AreaIdent): AreaModelIf;
+    /**
+     * Retrieves the body model.
+     *
+     * @returns {AreaModelIf} The body model representing an area.
+     */
     getBodyModel(): AreaModelIf;
+    /**
+     * Retrieves the number of fixed left columns.
+     *
+     * @returns {number} The count of fixed left columns.
+     */
     getFixedLeftColumnCount(): number;
+    /**
+     * Retrieves the count of fixed right columns.
+     *
+     * @return {number} The count of fixed right columns.
+     */
     getFixedRightColumnCount(): number;
+    /**
+     * Checks if the header is visible.
+     *
+     * @return {boolean} - Returns true if the header is visible, false otherwise.
+     */
     isHeaderVisibe(): boolean;
+    /**
+     * Checks if the footer is visible.
+     *
+     * @returns {boolean} Returns true if the footer is visible, otherwise returns false.
+     */
     isFooterVisibe(): boolean;
+    /**
+     * Determines if the row checkbox is visible.
+     *
+     * @return {boolean} True if the row checkbox is visible, false otherwise.
+     */
     isRowCheckboxVisible(): boolean;
+    /**
+     * Retrieves the height of a specific row in the provided row area.
+     *
+     * @param {AreaIdent} rowAreaIdent - The identifier of the row area.
+     * @param {number} rowIndex - The index of the row for which to retrieve the height.
+     * @return {number} The height of the specified row in pixels.
+     */
     getRowHeight(rowAreaIdent: AreaIdent, rowIndex: number): number;
+    /**
+     * Retrieves the column definition for the specified index.
+     *
+     * @param {number} index - The index of the column to retrieve the definition for.
+     * @return {ColumnDefIf | undefined} - The column definition for the specified index, or undefined if not found.
+     */
     getColumnDef(index: number): ColumnDefIf | undefined;
+    /**
+     * Retrieves the column definitions for a table.
+     *
+     * @return {ColumnDefIf[] | undefined} An array of column definitions or undefined if there are no column definitions.
+     */
     getColumnDefs(): ColumnDefIf[] | undefined;
+    /**
+     * Retrieves the property of a specific column.
+     *
+     * @param {number} columnIndex - The index of the column.
+     * @return {string} The property of the column.
+     */
     getColumnProperty(columnIndex: number): string;
+    /**
+     * Retrieves the body row at the specified index.
+     *
+     * @param {number} rowIndex - The index of the desired body row.
+     * @returns {any} - The body row object at the specified index.
+     */
     getBodyRowByIndex(rowIndex: number): any;
+    /**
+     * Retrieves the width of a given column in the table.
+     *
+     * @param {number} columnIndex - The index of the column for which to get the width.
+     * @return {number} The width of the column in pixels.
+     */
     getColumnWidth(columnIndex: number): number;
+    /**
+     * Sets the width of a column in the table.
+     *
+     * @param {number} columnIndex - The index of the column to set the width for.
+     * @param {number} width - The width to set for the column, in pixels.
+     * @return {void}
+     */
     setColumnWidth(columnIndex: number, width: number): void;
+    /**
+     * Recalculates the size of the element based on the provided client width.
+     *
+     * @param {number} clientWidth - The current client width of the element.
+     * @return {void}
+     */
     recalcSize(clientWidth: number): void;
+    /**
+     * Recalculates the padding of the element based on its content.
+     * This method updates the padding of the element to ensure that its content
+     * is properly aligned and displayed.
+     *
+     * @returns {void}
+     */
     recalcPadding(): void;
+    /**
+     * Recalculates the height and padding of an element.
+     *
+     * @returns {void}
+     */
     recalcHeightAndPadding(): void;
+    /**
+     * Retrieves the padding value of the element.
+     *
+     * @returns {Padding} The padding value of the element.
+     */
     getPadding(): Padding;
+    /**
+     * Retrieves the content height in pixels.
+     *
+     * @returns {number} The height of the content in pixels.
+     */
     getContentHeightInPixel(): number;
+    /**
+     * Returns the content width in pixels.
+     *
+     * @returns {number} The width of the content in pixels.
+     */
     getContentWidthInPixel(): number;
+    /**
+     * This is triggered when an external filter has changed.
+     *
+     * @param {FilterFunction<T>} predictFn - A function that takes an element of type T and returns a boolean indicating whether the element satisfies the filter conditions.
+     * @template T - The type of elements being filtered.
+     *
+     * @return {void}
+     */
     externalFilterChanged<T>(predictFn: FilterFunction<T>): void;
+    /**
+     * Sorts an array of SortItem objects based on a predetermined sorting algorithm.
+     *
+     * @param {SortItem[]} sortItems - An array of SortItem objects to be sorted.
+     * @return {boolean} - Returns true if the sorting was successful, false otherwise.
+     */
     doSort(sortItems: SortItem[]): boolean;
+    /**
+     * Retrieves the selection model associated with the component.
+     *
+     * @returns {SelectionModelIf|undefined} The selection model instance if available, or undefined if none is found.
+     */
     getSelectionModel(): SelectionModelIf | undefined;
 }

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

@@ -3,6 +3,10 @@ import { DivScope } from "./data/div-scope.type";
 import { TableModelIf } from "./data/tablemodel/table-model.if";
 import { TableOptionsIf } from "./data/options/table-options.if";
 import { GeoData } from "./data/geo-data";
+/**
+ * Represents an store for HTML elements.
+ * @class
+ */
 export declare class EleScope {
     readonly hostElement: HTMLDivElement;
     readonly tableModel: TableModelIf;

package/lib/table/event-adapter.d.ts

@@ -1,6 +1,13 @@
 import { GeModelChangeEvent } from "./data/common/event/ge-model-change-event";
 import { GeMouseEvent } from "./data/common/event/ge-mouse-event";
 import { EventListenerIf } from "./event-listener.if";
+/**
+ * EventAdapter class implements the EventListenerIf interface.
+ * It provides empty implementations for all the event listener methods.
+ *
+ * @class
+ * @implements {EventListenerIf}
+ */
 export declare class EventAdapter implements EventListenerIf {
     onCheckboxChanged(_evt: any[]): void;
     onContextmenu(_evt: GeMouseEvent): void;

package/lib/table/event-listener.if.d.ts

@@ -1,5 +1,10 @@
 import { GeMouseEvent } from "./data/common/event/ge-mouse-event";
 import { GeModelChangeEvent } from "./data/common/event/ge-model-change-event";
+/**
+ * Interface representing an event listener.
+ *
+ * @interface
+ */
 export interface EventListenerIf {
     onContextmenu(evt: GeMouseEvent): void;
     onMouseMoved(evt: GeMouseEvent): void;

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

@@ -1,6 +1,20 @@
 import { TableScope } from "./table-scope";
+/**
+ * Class representing an input handler for table input fields (HTMLSelectElement, HTMLTextAreaElement, HTMLInputElement).
+ *
+ * @class
+ * @memberOf module:input
+ */
 export declare class InputHandler {
     protected tableScope: TableScope;
     constructor(tableScope: TableScope);
+    /**
+     * Handles the onHostElementChanged event.
+     * In case that the element is an input field, the tableScope.updateModelValueAfterEdit() method is triggered.
+     *
+     * @param {Event} event - The event object.
+     *
+     * @return {void}
+     */
     private onHostElementChanged;
 }

package/lib/table/instanceof-workaround.d.ts

@@ -1,3 +1,22 @@
+/**
+ * Checks if the given row is a tree row.
+ *
+ * @param {any} row - The row to be checked.
+ *
+ * @return {boolean} - true if the row is a tree row, false otherwise.
+ */
 export declare function isTreeRow(row: any): boolean;
+/**
+ * Determines if the given model is an AreaModelTree.
+ *
+ * @param {any} model - The model object to check.
+ * @return {boolean} - True if the model is an AreaModelTree, false otherwise.
+ */
 export declare function isAreaModelTree(model: any): boolean;
+/**
+ * Checks if the given object is a CheckboxColumnDef.
+ *
+ * @param {any} o - The object to be checked.
+ * @returns {boolean} - True if the object is a CheckboxColumnDef, false otherwise.
+ */
 export declare function isCheckboxColumnDef(o: any): boolean;

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

@@ -1,5 +1,9 @@
 import { TableScope } from "./table-scope";
 import { GeMouseEvent } from "./data/common/event/ge-mouse-event";
+/**
+ * Class representing a MouseHandler.
+ * @class
+ */
 export declare class MouseHandler {
     protected tableScope: TableScope;
     mouseEvent?: MouseEvent;
@@ -10,10 +14,44 @@ export declare class MouseHandler {
     private mouseDown;
     private dragging;
     constructor(tableScope: TableScope);
+    /**
+     * Handles the "contextmenu" event.
+     *
+     * @private
+     * @param {MouseEvent} evt - The mouse event object.
+     * @return {void}
+     */
     private onContextmenu;
+    /**
+     * Handles the click event on the host element.
+     *
+     * @param {MouseEvent} event - The click event.
+     *
+     * @return {void}
+     */
     private onHostElementClicked;
+    /**
+     * Handles the double click event on the host element.
+     * This method is private.
+     *
+     * @param {MouseEvent} event - The double click event.
+     */
     private onHostElementDblClicked;
+    /**
+     * Publishes a GeMouseEvent.
+     *
+     * @param {MouseEvent} event - The MouseEvent to publish.
+     * @param {number} clickCount - The number of clicks for the GeMouseEvent.
+     *
+     * @return {void}
+     */
     private publishGeMouseEvent;
+    /**
+     * Update the collapsed/expanded state of a tree row.
+     *
+     * @param {TreeRowIf<any>} tr - The tree row object.
+     * @returns {void}
+     */
     private updateCollapsedExpandedState;
     private getArrowColumnIndex;
     private onMouseDown;

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

@@ -71,7 +71,7 @@ export declare class RenderScope extends EleScope {
     protected findRowOfImportantRowspanCell(areaModel: AreaModelIf, rowIndex: number, colIndex: number): number;
     protected adjustColumnsToRowParent({ areaIdent, sideIdent, areaModel, geo, parent, rowIndex, columnIndexStart, columnIndexEnd, verticalFixed, lastRowOfModel }: ArgsAdjustColumnsToRowParentParams): void;
     protected getTreeArrowColumnIndex(): 0 | 1;
-    protected addAndRenderCellDiv({ areaModel, areaIdent, sideIdent, rowIndex, index, left, width, height, top, parent, lastRowOfModel }: ArgsRenderCellDiv): [HTMLDivElement, RendererCleanupFnType | undefined];
+    protected addAndRenderCellDiv({ areaModel, areaIdent, sideIdent, rowIndex, index, left, width, height, top, parent, lastRowOfModel, gammaRange }: ArgsRenderCellDiv): [HTMLDivElement, RendererCleanupFnType | undefined];
     protected applyCssClasses(ele: HTMLDivElement, cssClasses?: {
         [key: string]: boolean;
     }): void;

package/lib/table/renderer/edit/edit-input-pipe.if.d.ts

@@ -1,3 +1,11 @@
+/**
+ * Represents an editInputPipe function.
+ * @typedef {Function} editInputPipe
+ * @param {any} input - The input object.
+ * @param {number} rowIndex - The index of the row.
+ * @param {number} columnIndex - The index of the column.
+ * @returns {any|undefined} - The modified input object or undefined.
+ */
 export interface editInputPipe {
     (input: any, rowIndex: number, columnIndex: number): any | undefined;
 }

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

@@ -4,15 +4,87 @@ import { TableCellUpdateEventIf } from "./data/common/event/input/table-cell-upd
 export declare class TableApi {
     private readonly tableScope;
     constructor(tableScope: TableScope);
+    /**
+     * Updates the cells in the table based on the provided events.
+     *
+     * @param {TableCellUpdateEventIf[]} events - The array of events representing the updates to perform on the cells.
+     * @param {boolean} [repaintAll=false] - Optional parameter indicating whether to repaint all cells or not. Default value is false. If true, the full table will be rendered. If false, the table cell will be rendered immediately.
+     *
+     * @return {void} - This method doesn't return anything.
+     */
     updateCells(events: TableCellUpdateEventIf[], repaintAll?: boolean): void;
+    /**
+     * Notifies that the external filter has changed.
+     *
+     * @return {void}
+     */
     externalFilterChanged(): void;
+    /**
+     * Scrolls the table body to the specified pixel coordinates.
+     *
+     * @param {number} _px - The horizontal pixel coordinate to scroll to. Defaults to 0.
+     * @param {number} _py - The vertical pixel coordinate to scroll to. Defaults to 0.
+     * @return {void}
+     */
     scrollToPixel(_px?: number, _py?: number): void;
+    /**
+     * Scrolls to the specified index in both horizontal and vertical directions.
+     *
+     * @param {number} _indexX - The index of the column to scroll to in the horizontal direction. Default is 0.
+     * @param {number} _indexY - The index of the row to scroll to in the vertical direction. Default is 0.
+     *
+     * @return undefined
+     */
     scrollToIndex(_indexX?: number, _indexY?: number): void;
+    /**
+     * Sets whether the header is visible or not.
+     *
+     * @param _visible - A boolean value indicating whether the header should be visible. Default value is true.
+     *
+     * @return undefined
+     */
     setHeaderVisible(_visible?: boolean): void;
+    /**
+     * Sets the visibility of a column in the table.
+     *
+     * @param {_column} - The column index or column definition to set visibility for.
+     * @param {_visible=true} - The flag to set visibility to. true for visible, false for hidden.
+     *
+     * @return {void} - There is no return value.
+     */
     setColumnVisible(_column: number | ColumnDefIf, _visible?: boolean): void;
+    /**
+     * Returns whether a column is visible or not.
+     *
+     * @param {number | ColumnDefIf} _column - The column index or the column definition.
+     * @return {boolean} - True if the column is visible, false otherwise.
+     */
     isColumnVisible(_column: number | ColumnDefIf): boolean;
+    /**
+     * Checks if the header is visible.
+     *
+     * @return {boolean} - Returns true if the header is visible, otherwise returns false.
+     */
     isHeaderVisible(): boolean;
+    /**
+     * Sets the visibility of the footer.
+     *
+     * @param {boolean} _visible - Indicates whether the footer should be visible or not. Default value is true.
+     *
+     * @return {void} - This method does not return any value.
+     */
     setFooterVisible(_visible?: boolean): void;
+    /**
+     * Determines if the footer is visible.
+     *
+     * @returns {boolean} True if the footer is visible, false otherwise.
+     */
     isFooterVisible(): boolean;
+    /**
+     * Repaints the table.
+     *
+     * This method calls the repaint method of the tableScope object
+     * to update and redraw the table based on the latest data.
+     */
     repaint(): void;
 }