x4js 1.4.52 → 1.5.0

package/lib/esm/settings.d.ts

@@ -0,0 +1,37 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file local_storage.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+export declare class Settings {
+    private m_data;
+    private m_name;
+    constructor(name?: string);
+    set(name: string, value: any): void;
+    get(name: string, defValue?: any): any;
+    private _save;
+    private _load;
+}

package/lib/{settings.js → esm/settings.js}

@@ -1,4 +1,3 @@
-"use strict";
 /**
 *  ___   ___ __
 *  \  \_/  /  / _
@@ -27,9 +26,7 @@
 * OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
 * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
 **/
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.Settings = void 0;
-class Settings {
+export class Settings {
     m_data;
     m_name;
     constructor(name) {
@@ -67,4 +64,3 @@ class Settings {
         // console.info('There was an error attempting to read your settings.');
     }
 }
-exports.Settings = Settings;

package/lib/esm/sidebarview.d.ts

@@ -0,0 +1,49 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file sidebarview.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component } from './component';
+import { VLayout } from './layout';
+import { CardView, CardViewProps, ICardViewItem } from './cardview';
+export interface SideBarItem extends ICardViewItem {
+}
+export interface SideBarProps extends CardViewProps {
+    bar_sizable?: boolean;
+    bar_width?: number;
+}
+/**
+ *
+ */
+export declare class SideBarView extends CardView<SideBarProps> {
+    m_sidebar: VLayout;
+    m_content: Component;
+    constructor(props: SideBarProps);
+    /** @ignore */
+    render(): void;
+    protected _prepareSelector(card: ICardViewItem): Component;
+    protected _preparePage(page: Component): void;
+}

package/lib/esm/sidebarview.js

@@ -0,0 +1,79 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file sidebarview.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Separator } from './component';
+import { HLayout, VLayout } from './layout';
+import { Button } from './button';
+import { CardView } from './cardview';
+/**
+ *
+ */
+export class SideBarView extends CardView {
+    m_sidebar;
+    m_content;
+    constructor(props) {
+        super(props);
+        this.addClass('@hlayout');
+        this.m_sidebar = new VLayout({
+            cls: '@side-bar',
+            width: props.bar_width ?? undefined,
+        });
+        this.m_content = new HLayout({ flex: 1, cls: '@tab-container' });
+    }
+    /** @ignore */
+    render() {
+        let tabs = [];
+        this.m_cards.forEach((p) => {
+            tabs.push(p.selector);
+        });
+        this.m_sidebar.setContent(new VLayout({
+            flex: 1,
+            cls: 'content',
+            content: tabs
+        }));
+        this.setContent([
+            this.m_sidebar,
+            this.m_props.bar_sizable ? new Separator({ orientation: "horizontal", sizing: "before" }) : undefined,
+            this.m_content
+        ]);
+    }
+    _prepareSelector(card) {
+        return new Button({
+            text: card.title,
+            icon: card.icon,
+            tooltip: card.title,
+            click: () => { this.switchTo(card.name); }
+        });
+    }
+    _preparePage(page) {
+        super._preparePage(page);
+        if (!page.dom) {
+            this.m_content.appendChild(page);
+        }
+    }
+}

package/lib/esm/spreadsheet.d.ts

@@ -0,0 +1,218 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file spreadsheet.ts
+* @author Etienne Cochard
+*
+* Copyright (c) 2019-2022 R-libre ingenierie
+*
+* Permission is hereby granted, free of charge, to any person obtaining a copy
+* of this software and associated documentation files (the "Software"), to deal
+* in the Software without restriction, including without limitation the rights
+* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
+* of the Software, and to permit persons to whom the Software is furnished to do so,
+* subject to the following conditions:
+* The above copyright notice and this permission notice shall be included in all copies
+* or substantial portions of the Software.
+*
+* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
+* INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
+* PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+* HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+* OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+* SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+**/
+import { Component, EvDblClick, ContainerEventMap, ContainerProps } from './component';
+import { InputProps } from './input';
+import { VLayout } from './layout';
+import * as Formatters from './formatters';
+import { EvContextMenu, EvChange, EvSelectionChange, EventCallback } from './x4events';
+export interface EditorFactory {
+    (props: InputProps, row: number, col: number): Component;
+}
+/**
+ *
+ */
+export interface ColProp {
+    title: string;
+    width: number;
+    formatter?: string;
+    align?: string;
+    cls?: string;
+    min_width?: number;
+    renderer?: Formatters.FormatFunc;
+    createEditor?: EditorFactory;
+}
+/**
+ *
+ */
+export interface SpreadsheetEventSet extends ContainerEventMap {
+    change?: EvChange;
+    dblClick?: EvDblClick;
+    selectionChange?: EvSelectionChange;
+    contextMenu?: EvContextMenu;
+}
+/**
+ *
+ */
+export interface SpreadsheetProps extends ContainerProps {
+    columns: ColProp[];
+    maxrows?: number;
+    autoedit?: boolean;
+    change?: EventCallback<EvChange>;
+    dblClick?: EventCallback<EvDblClick>;
+    selectionChange?: EventCallback<EvSelectionChange>;
+    contextMenu?: EventCallback<EvContextMenu>;
+}
+/**
+ *
+ */
+export declare class Spreadsheet extends VLayout<SpreadsheetProps, SpreadsheetEventSet> {
+    private m_columns;
+    private m_row_limit;
+    private m_cells_data;
+    private m_rows_data;
+    protected m_view: Component;
+    protected m_container: Component;
+    protected m_header: Component;
+    private m_itemHeight;
+    private m_topIndex;
+    private m_visible_cells;
+    private m_row_count;
+    private m_selection;
+    private m_editor;
+    private m_autoedit;
+    private m_lockupdate;
+    private m_auto_row_count;
+    private m_recycler;
+    private m_used_cells;
+    constructor(props: SpreadsheetProps);
+    componentCreated(): void;
+    setColWidth(col: number, width: number): void;
+    getColWidth(col: number): number;
+    setColTitle(col: number, title: string): void;
+    reset(columns: ColProp[]): void;
+    /**
+     * insert a row
+     * @param before row number before wich insert the new row
+     */
+    insertRow(before: number): void;
+    /**
+     * remove a row
+     * @param rowtodel row number to remove
+     */
+    deleteRow(rowtodel: number): void;
+    /**
+     * insert a new column
+     * @param before column index before to insert the new column or <0 to append
+     */
+    insertCol(before: number, column: ColProp): void;
+    /**
+     * remove a column
+     * @param coltodel
+     */
+    deleteCol(coltodel: number): void;
+    /**
+     *
+     * @param row
+     * @param col
+     */
+    private _getCellData;
+    private _focus;
+    private _ctxMenu;
+    /** @ignore */
+    render(): void;
+    /**
+     *
+     */
+    private _on_col_resize;
+    /**
+     * compute misc dimensions
+     * - item height
+     * - scroll width
+     */
+    private _computeItemHeight;
+    /**
+     * compute columns widths
+     * use col.width for fixed size columns
+     * if col.width < 0 that mean that this is a proportion of the remaining space
+     */
+    private _calcColWidths;
+    /**
+     * create a cell (component)
+     * and append it to the parent view
+     * if a cell was reviously recyled, use it
+     */
+    private _createCell;
+    /**
+     * build cells of the spreadsheet
+     * cells are recycled when scrolling,
+     * only visibles cells exists
+     */
+    private _buildItems;
+    /** @ignore */
+    private _itemClick;
+    private _itemDblClick;
+    /**
+     *
+     * @param rowIdx
+     * @param colIdx
+     * @param scrollIntoView
+     */
+    protected _selectItem(rowIdx: number, colIdx: number, scrollIntoView?: boolean): void;
+    private _scrollIntoView;
+    /**
+     *
+     * @param row
+     * @param col
+     */
+    private _findItem;
+    /**
+     *
+     */
+    private _updateScroll;
+    /**
+     *
+     * @param event
+     * @param t
+     */
+    private _moveSel;
+    private _handleKey;
+    private _keyPress;
+    /**
+     * return the selection
+     * { row, col }
+     */
+    getSelection(): {
+        row: number;
+        col: number;
+    };
+    select(row: number, col: number, scrollIntoView?: boolean): void;
+    /**
+     * return the row count
+     */
+    rowCount(): number;
+    /**
+     * return the maximum row index filled with something
+     */
+    getMaxRowCount(): number;
+    getColCount(): number;
+    setRowStyle(row: number, cls: string): void;
+    getRowStyle(row: number): string;
+    setCellStyle(row: number, col: number, cls: string): void;
+    getCellText(row: number, col: number): string;
+    getCellNumber(row: number, col: number): number;
+    clearRow(row: number): void;
+    clearCell(row: number, col: number): void;
+    editCurCell(forceText?: string): void;
+    editCell(row: number, col: number, forcedText?: string): void;
+    _setupEditor(): void;
+    killEditor(save: boolean): void;
+    clearData(): void;
+    setCellText(row: number, col: number, value: string): void;
+    lockUpdate(start: boolean): void;
+}