@guiexpert/table 1.1.17 → 1.1.20

package/src/lib/table/data/options/default-row-heights.if.ts

@@ -0,0 +1,5 @@
+export interface DefaultRowHeightsIf {
+  header: number,
+  body: number,
+  footer: number
+}

package/src/lib/table/data/options/default-row-heights.ts

@@ -0,0 +1,10 @@
+import { DefaultRowHeightsIf } from "./default-row-heights.if";
+
+export class DefaultRowHeights implements DefaultRowHeightsIf {
+  constructor(
+    public header: number = 34,
+    public body: number = 34,
+    public footer: number = 34
+  ) {
+  }
+}

package/src/lib/table/data/options/header-group-options.if.ts

@@ -0,0 +1,9 @@
+import { IconIf } from "./icon.if";
+
+export interface HeaderGroupOptionsIf {
+
+
+  iconExpanded: IconIf;
+  iconCollapsed: IconIf;
+
+}

package/src/lib/table/data/options/header-group-options.ts

@@ -0,0 +1,23 @@
+import { IconIf } from "./icon.if";
+import { Icon } from "./icon";
+import { HeaderGroupOptionsIf } from './header-group-options.if';
+
+export class HeaderGroupOptions implements HeaderGroupOptionsIf {
+
+  constructor(
+    public iconExpanded: IconIf = new Icon(
+      "❯",
+      "",
+      ["gt-table-icon-expanded"]
+    ),
+    public iconCollapsed: IconIf = new Icon(
+      "❯",
+      "transform: rotate(180deg) translate(-100%, -100%); transform-origin: 0 0;",
+      ["ge-table-icon-collapsed"]
+    )
+  ) {
+  }
+
+  // `⊖ `,  `⊕ `;
+
+}

package/src/lib/table/data/options/icon.if.ts

@@ -0,0 +1,20 @@
+/**
+ * Represents an Icon with content, css style and css classes.
+ *
+ * Example:
+ *
+ * new Icon(
+ *    ">",
+ *    "transform: rotate(90deg) translate(66%, -66%); transform-origin: 0 0;",
+ *    ["gt-table-tree-arrow-expanded"]
+ * )
+ *
+ * @interface
+ */
+export interface IconIf {
+
+  content: string,
+  style: string;
+  classes: string[];
+
+}

package/src/lib/table/data/options/icon.ts

@@ -0,0 +1,10 @@
+import { IconIf } from "./icon.if";
+
+export class Icon implements IconIf {
+  constructor(
+    public content: string = ">",
+    public style: string = "",
+    public classes: string[] = []
+  ) {
+  }
+}

package/src/lib/table/data/options/sorted-options.if.ts

@@ -0,0 +1,13 @@
+import { IconIf } from "./icon.if";
+
+/**
+ * Represents a class that defines sorted icons, which will displayed in the header (if column is sortable).
+ * @interface
+ */
+export interface SortedOptionsIf {
+
+  iconAsc: IconIf,
+  iconDesc: IconIf
+  iconPlaceholder: IconIf
+
+}

package/src/lib/table/data/options/sorted-options.ts

@@ -0,0 +1,15 @@
+import { IconIf } from "./icon.if";
+import { Icon } from "./icon";
+import { SortedOptionsIf } from "./sorted-options.if";
+
+export class SortedOptions implements SortedOptionsIf {
+
+  constructor(
+    public iconAsc: IconIf = new Icon("↑", "", ["ge-header-sorted-asc"]),
+    public iconDesc: IconIf = new Icon("↓", "", ["ge-header-sorted-desc"]),
+    public iconPlaceholder: IconIf = new Icon("↑", "color:transparent;", [])
+  ) {
+  }
+
+
+}

package/src/lib/table/data/options/table-options.if.ts

@@ -0,0 +1,240 @@
+import { DefaultRowHeightsIf } from "./default-row-heights.if";
+import { TreeOptionsIf } from "./tree-options.if";
+import { FilterFunction } from "../common/filter-function";
+import { SortState } from "../common/sort-state.type";
+import { SortedOptionsIf } from "./sorted-options.if";
+import { AutoRestoreOptionsIf } from "./auto-restore-options.if";
+import { GetEditRenderer } from "../../renderer/edit/edit-cell-renderer.type";
+import { SelectionModelIf } from "../../selection/selection-model.if";
+import { GetT } from "../common/get-t";
+import { FocusModelIf } from "../../focus/focus-model.if";
+import { ShortcutActionIdMapping } from "../../action/shortcut-actionid-mapping.type";
+import { HeaderGroupOptionsIf } from './header-group-options.if';
+
+/**
+ * Represents the options for configuring a table.
+ *
+ * | Class Property                   | Description                                                                                   |
+ * |----------------------------------|-----------------------------------------------------------------------------------------------|
+ * | headerSeparatorBorderVisible     | Indicates whether the header separator border is visible.                                      |
+ * | footerSeparatorBorderVisible     | Indicates whether the footer separator border is visible or not.                                |
+ * | fixedEastSeparatorBorderVisible  | Determines whether the fixed east separator border is visible.                                  |
+ * | fixedWestSeparatorBorderVisible  | Indicates whether the fixed west separator border should be visible.                            |
+ * | verticalBorderVisible            | Indicates whether the vertical border is visible.                                               |
+ * | horizontalBorderVisible          | Represents the visibility of the horizontal border.                                             |
+ * | overflowX                        | Determines the behavior of horizontal overflow for the table body (scroll port).               |
+ * | overflowY                        | Determines the behavior of vertical overflow for the table body (scroll port).                 |
+ * | tableTopBorderVisible            | Indicates whether the top border of a table is visible or hidden.                                |
+ * | tableBottomBorderVisible         | Specifies whether the bottom border of a table is visible.                                       |
+ * | hoverRowVisible                  | Flag indicating whether the hover color of a row is visible or not in general.                  |
+ * | hoverColumnVisible               | Flag indicating whether the hover color of a column is visible or not in general.               |
+ * | columnsResizable                 | Represents whether the columns are resizable.                                                    |
+ * | columnsDraggable                 | Flag indicating whether the columns are draggable.                                               |
+ * | columnResizeHandleWidthInPx      | The width of the column resize handle in pixels.                                                 |
+ * | headerVerticalSeparator          | Represents whether a vertical separator should be displayed in a header.                        |
+ * | footerVerticalSeparator          | Indicates whether a vertical separator should be displayed in the footer.                       |
+ * | defaultRowHeights                | Represents the default row heights for a given table.                                            |
+ * | headerToggleExpandCollapseIcons  | Indicates whether to show toggle icons in the header.                                            |
+ * | treeOptions                      | Represents the options for configuring a tree.                                                   |
+ * | headerGroupOptions               | Represents the options for expnded/collapsed icons of the header groups.                                                   |
+ * | showCheckboxWihoutExtraColumn    | Indicates whether to show checkbox without an extra column.                                       |
+ * | externalFilterFunction           | Represents the external filter function used to filter table rows.                                |
+ * | sortedOptions                    | Represents a sorted options object.                                                              |
+ * | sortOrder                        | Represents the sort order of the columns.                                                        |
+ * | autoRestoreOptions               | Represents auto restoration options.                                                             |
+ * | getEditRenderer                  | Retrieves the edit renderer for a specific action.                                                |
+ * | getSelectionModel                | Retrieves the selection model for a specific object.                                              |
+ * | getFocusModel                    | Retrieves the focus model of the component.                                                       |
+ * | shortcutActionIdMapping          | Represents a mapping of shortcut action IDs.                                                     |
+ */
+export interface TableOptionsIf {
+  /**
+   * Indicates whether the header separator border is visible.
+   *
+   * @type {boolean}
+   */
+  headerSeparatorBorderVisible: boolean;
+  /**
+   * Indicates whether the footer separator border is visible or not.
+   *
+   * @type {boolean}
+   */
+  footerSeparatorBorderVisible: boolean;
+  /**
+   * Determines whether the fixed east separator border is visible.
+   *
+   * @type {boolean}
+   */
+  fixedEastSeparatorBorderVisible: boolean;
+  /**
+   * Indicates whether the fixed west separator border should be visible.
+   *
+   * @type {boolean}
+   */
+  fixedWestSeparatorBorderVisible: boolean;
+  /**
+   * Indicates whether the vertical border is visible.
+   *
+   * @type {boolean}
+   */
+  verticalBorderVisible: boolean;
+  /**
+   * Represents the visibility of the horizontal border.
+   *
+   * @type {boolean}
+   */
+  horizontalBorderVisible: boolean;
+
+  /**
+   * The value of the css `overflowX` determines the behavior of horizontal overflow for the table body (scroll port).
+   *
+   * @typedef {'auto' | 'scroll'} OverflowX
+   */
+  overflowX: "auto" | "scroll";
+  /**
+   * The value of the css `overflowX` determines the behavior of vertical overflow for the table body (scroll port).
+   *
+   * @typedef {'auto' | 'scroll'} OverflowX
+   */
+  overflowY: "auto" | "scroll";
+
+  /**
+   * Indicates whether the top border of a table is visible or hidden.
+   *
+   * @type {boolean}
+   */
+  tableTopBorderVisible: boolean;
+  /**
+   * Specifies whether the bottom border of a table is visible.
+   *
+   * @type {boolean}
+   */
+  tableBottomBorderVisible: boolean;
+  /**
+   * Flag indicating whether the hover color of a row is visible or not in general.
+   * If true, the row get the hover background color while the mouse is over the row.
+   *
+   * @type {boolean}
+   */
+  hoverRowVisible: boolean;
+  /**
+   * Flag indicating whether the hover color of a column is visible or not in general.
+   * If true, the column get the hover background color while the mouse is over the column.
+   *
+   * @typedef {boolean} hoverColumnVisible
+   */
+  hoverColumnVisible: boolean;
+  /**
+   * Represents whether the columns are resizable.
+   *
+   * @type {boolean}
+   */
+  columnsResizable: boolean;
+  /**
+   * Flag indicating whether the columns are draggable.
+   *
+   * @type {boolean}
+   */
+  columnsDraggable: boolean;
+  /**
+   * The width of the column resize handle in pixels.
+   *
+   * @type {number}
+   */
+  columnResizeHandleWidthInPx: number;
+
+  /**
+   * Represents whether a vertical separator should be displayed in a header.
+   *
+   * @type {boolean}
+   * @since 1.0.0
+   */
+  headerVerticalSeparator: boolean;
+  /**
+   * Indicates whether a vertical separator should be displayed in the footer.
+   *
+   * @type {boolean}
+   */
+  footerVerticalSeparator: boolean;
+
+  /**
+   * Represents the default row heights (for header, body and footer) for a given table.
+   *
+   * @typedef {number[]} DefaultRowHeightsIf
+   * @description An array of numbers representing the default height for each row in a table.
+   */
+  defaultRowHeights: DefaultRowHeightsIf;
+
+  headerToggleExpandCollapseIcons: boolean;
+
+
+  treeOptions: TreeOptionsIf;
+
+
+
+  headerGroupOptions: HeaderGroupOptionsIf;
+
+  /**
+   * Indicates whether to show checkbox without an extra column.
+   * If true and the row is checkable, a checkbox is rendered in the first column.
+   * If false and the row is checkable, a checkbox is rendered in an extra column left to the first column.
+   *
+   * @type {boolean}
+   */
+  showCheckboxWihoutExtraColumn: boolean;
+
+  /**
+   * Represents the external filter function that will be used to filter the table rows.
+   *
+   * @typedef {FilterFunction<any> | undefined} externalFilterFunction
+   */
+  externalFilterFunction: FilterFunction<any> | undefined;
+
+  /**
+   * Represents a sorted options object.
+   *
+   * @class
+   * @classdesc The SortedOptions represents a class that defines sorted icons, which will displayed in the header (if column is sortable).
+   */
+  sortedOptions: SortedOptionsIf;
+  /**
+   * Represents the sort order of the columns.
+   *
+   * @typedef {SortState[]} sortOrder
+   */
+  sortOrder: SortState[],
+
+  autoRestoreOptions?: AutoRestoreOptionsIf<any>;
+
+  /**
+   * Retrieves the edit renderer for a specific action.
+   *
+   * @function
+   * @name getEditRenderer
+   * @param {string} action - The action for which to retrieve the edit renderer.
+   * @returns {GetEditRenderer} - The edit renderer for the specified action.
+   */
+  getEditRenderer?: GetEditRenderer;
+  /**
+   * Retrieves the selection model for a specific object.
+   *
+   * @param {SelectionModelIf} targetObj - The target object to retrieve the selection model from.
+   * @return {GetT<SelectionModelIf>} - The selection model for the given object.
+   */
+  getSelectionModel?: GetT<SelectionModelIf>;
+  /**
+   * Retrieves the focus model of the component.
+   *
+   * @returns {GetT<FocusModelIf>} The focus model of the component.
+   */
+  getFocusModel?: GetT<FocusModelIf>;
+
+  /**
+   * Represents a mapping of shortcut action IDs.
+   *
+   * @typedef {Object} ShortcutActionIdMapping
+   * @property {string} [shortcutId] - The ID of the shortcut.
+   * @property {string} [actionId] - The ID of the action associated with the shortcut.
+   */
+  shortcutActionIdMapping?: ShortcutActionIdMapping;
+}

package/src/lib/table/data/options/table-options.ts

@@ -0,0 +1,68 @@
+import { DefaultRowHeightsIf } from "./default-row-heights.if";
+import { TableOptionsIf } from "./table-options.if";
+import { TreeOptions } from "./tree-options";
+import { FilterFunction } from "../common/filter-function";
+import { SortState } from "../common/sort-state.type";
+import { SortedOptions } from "./sorted-options";
+import { InputCellRenderer } from "../../renderer/edit/input-cell-renderer";
+import { GetEditRenderer } from "../../renderer/edit/edit-cell-renderer.type";
+import { SelectionModelIf } from "../../selection/selection-model.if";
+import { SelectionModel } from "../../selection/selection-model";
+import { GetT } from "../common/get-t";
+import { FocusModelIf } from "../../focus/focus-model.if";
+import { FocusModel } from "../../focus/focus-model";
+import { ShortcutActionIdMapping } from "../../action/shortcut-actionid-mapping.type";
+import { HeaderGroupOptions } from './header-group-options';
+
+const selectionModel = new SelectionModel();
+const focusModel = new FocusModel("cell");
+
+export class TableOptions implements TableOptionsIf {
+
+  overflowX: "auto" | "scroll" = "auto";
+  overflowY: "auto" | "scroll" = "auto";
+
+  horizontalBorderVisible = true;
+  verticalBorderVisible = true;
+  footerSeparatorBorderVisible = true;
+  headerSeparatorBorderVisible = true;
+  fixedEastSeparatorBorderVisible = true;
+  fixedWestSeparatorBorderVisible = true;
+
+  tableTopBorderVisible = true;
+  tableBottomBorderVisible = true;
+  // TODO tableLeftBorderVisible = true;
+  // TODO tableRightBorderVisible = true;
+
+  hoverRowVisible = true;
+  hoverColumnVisible = true;
+  columnsResizable = true;
+  columnsDraggable = true;
+  columnResizeHandleWidthInPx = 4;
+
+  defaultRowHeights: DefaultRowHeightsIf = {
+    header: 34,
+    body: 34,
+    footer: 34
+  };
+
+  footerVerticalSeparator = false;
+
+  headerToggleExpandCollapseIcons = false;
+  headerVerticalSeparator = false;
+
+  treeOptions = new TreeOptions();
+  headerGroupOptions = new HeaderGroupOptions();
+  showCheckboxWihoutExtraColumn = false;
+
+  externalFilterFunction: FilterFunction<any> | undefined = undefined;
+  sortedOptions = new SortedOptions();
+  sortOrder: SortState[] = ["asc", "desc"];
+  shortcutActionIdMapping?: ShortcutActionIdMapping;
+
+  getEditRenderer?: GetEditRenderer = (_rowIndex: number, _columnIndex: number) => new InputCellRenderer();
+
+  getSelectionModel?: GetT<SelectionModelIf> = () => selectionModel;
+
+  getFocusModel?: GetT<FocusModelIf> = () => focusModel;
+}

package/src/lib/table/data/options/tree-options.if.ts

@@ -0,0 +1,10 @@
+import { IconIf } from "./icon.if";
+
+export interface TreeOptionsIf {
+
+  arrowExpandCollapseAll: IconIf;
+  arrowExpanded: IconIf;
+  arrowCollapsed: IconIf;
+  arrowPlaceholder: IconIf;
+
+}

package/src/lib/table/data/options/tree-options.ts

@@ -0,0 +1,32 @@
+import { IconIf } from "./icon.if";
+import { TreeOptionsIf } from "./tree-options.if";
+import { Icon } from "./icon";
+
+export class TreeOptions implements TreeOptionsIf {
+
+  constructor(
+    public arrowExpanded: IconIf = new Icon(
+      ">",
+      "transform: rotate(90deg) translate(66%, -66%); transform-origin: 0 0;",
+      ["gt-table-tree-arrow-expanded"]
+    ),
+    public arrowCollapsed: IconIf = new Icon(
+      ">",
+      "",
+      ["ge-table-tree-arrow-collapsed"]
+    ),
+    public arrowPlaceholder: IconIf = new Icon(
+      ">",
+      "color:transparent;",
+      ["gt-table-tree-arrow-hidden"]
+    ),
+    public arrowExpandCollapseAll: IconIf = new Icon(
+      "↕",
+      "",
+      ["gt-table-tree-arrow-expanded-all"]
+    )
+  ) {
+  }
+
+
+}

package/src/lib/table/data/side-ident.type.ts

@@ -0,0 +1,4 @@
+/**
+ * Represents a class that identifies a (vertical) side of the table.
+ */
+export type SideIdent = "west" | "center" | "east";

package/src/lib/table/data/table-model-and-options.if.ts

@@ -0,0 +1,11 @@
+import { TableModelIf } from "./tablemodel/table-model.if";
+import { TableOptions } from "./options/table-options";
+
+
+/**
+ * Interface for a container object for one table model and one table options object.
+ */
+export interface TableModelAndOptionsIf {
+  tableModel: TableModelIf;
+  tableOptions: TableOptions;
+}

package/src/lib/table/data/table-model-and-options.ts

@@ -0,0 +1,16 @@
+
+import { TableModelAndOptionsIf } from "./table-model-and-options.if";
+import { TableModelIf } from "./tablemodel/table-model.if";
+import { TableOptions } from "./options/table-options";
+
+
+/**
+ * Container object for one table model and one table options object.
+ */
+export class TableModelAndOptions implements TableModelAndOptionsIf {
+  constructor(
+    public tableModel: TableModelIf,
+    public tableOptions: TableOptions
+  ) {
+  }
+}

package/src/lib/table/data/tablemodel/area-ident.type.ts

@@ -0,0 +1,18 @@
+/**
+ * The AreaIdent is an identifier for the three areas : header, body, and footer.
+ */
+export type AreaIdent = "header" | "body" | "footer";
+
+/**
+ * Converts a string to the identifier of type AreaIdent.
+ * @param s should be "header"|"body"|"footer". The fallback return value is 'body'
+ */
+export const getAreaIdentByString = (s: string | null): AreaIdent => {
+  if (s === "header") {
+    return "header";
+  }
+  if (s === "footer") {
+    return "footer";
+  }
+  return "body";
+};