x4js 1.5.21 → 1.5.23

package/lib/types/radiobtn.d.ts

@@ -0,0 +1,73 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file radiobtn.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 { HtmlString } from './tools';
+import { Component, CProps, CEventMap } from './component';
+import { EvChange, EventCallback } from './x4events';
+import { IconID } from './icon';
+import { Input } from './input';
+interface RadioBtnEventMap extends CEventMap {
+    change?: EvChange;
+}
+export interface RadioBtnProps extends CProps {
+    group: string;
+    value: string;
+    tabIndex?: number | boolean;
+    name?: string;
+    icon?: IconID;
+    text?: string;
+    checked?: boolean;
+    labelWidth?: number | 'flex';
+    align?: 'left' | 'right';
+    change?: EventCallback<EvChange>;
+}
+/**
+ * Standard RadioBtn
+ */
+export declare class RadioBtn extends Component<RadioBtnProps, RadioBtnEventMap> {
+    protected m_ui_input: Input;
+    constructor(props: RadioBtnProps);
+    /** @ignore */
+    render(props: RadioBtnProps): void;
+    /**
+     * check state changed
+     */
+    private _change;
+    /**
+     * @return the checked value
+     */
+    get check(): boolean;
+    /**
+     * change the checked value
+     * @param {boolean} ck new checked value
+     */
+    set check(ck: boolean);
+    get text(): HtmlString | string;
+    set text(text: HtmlString | string);
+}
+export {};

package/lib/types/rating.d.ts

@@ -0,0 +1,53 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file rating.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 { CProps, ContainerEventMap } from './component';
+import { HLayout } from './layout';
+import { EvChange, EventCallback } from './x4events';
+interface RatingEventMap extends ContainerEventMap {
+    change: EvChange;
+}
+export interface RatingProps extends CProps<RatingEventMap> {
+    steps?: number;
+    value?: number;
+    shape?: string;
+    name?: string;
+    change?: EventCallback<EvChange>;
+}
+export declare class Rating extends HLayout<RatingProps, RatingEventMap> {
+    private m_els;
+    private m_input;
+    constructor(props: RatingProps);
+    render(props: RatingProps): void;
+    getValue(): number;
+    set value(v: number);
+    set steps(n: number);
+    set shape(shape: string);
+    private _onclick;
+}
+export {};

package/lib/types/request.d.ts

@@ -0,0 +1,52 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file request.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 interface RequestProps {
+    url: string;
+    method?: 'GET' | 'POST';
+    headers?: string[];
+    params?: any;
+    timeout?: number;
+    responseType?: 'text' | 'json' | 'arraybuffer';
+    userData?: any;
+    success: (data: any, userData: any) => void;
+    failure?: (status: number, statusText: string, userData: any) => void;
+    progress?: (length: number, total: number, display: string) => void;
+}
+export declare function ajaxRequest(cfg: RequestProps): Function;
+interface AjaxRequestInit extends Omit<RequestInit, 'body'> {
+    body?: BodyInit | null | object;
+    noGenX?: boolean;
+}
+export declare function ajaxAsJSON(url: string, init?: AjaxRequestInit): Promise<any>;
+export declare function ajaxAsText(url: string, init?: AjaxRequestInit): Promise<any>;
+/**
+ * use encodeURIComponent for elements in url
+ */
+export declare function ajax(url: string, init?: AjaxRequestInit, type?: string): Promise<Response>;
+export {};

package/lib/types/router.d.ts

@@ -0,0 +1,42 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file router.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 { EventSource, EvError, EventMap } from "./x4events";
+type RouteHandler = (params: any, path: string) => void;
+interface RouterEventMap extends EventMap {
+    error: EvError;
+}
+export declare class Router extends EventSource<RouterEventMap> {
+    private routes;
+    constructor();
+    get(uri: string | RegExp, handler: RouteHandler): void;
+    init(): void;
+    navigate(uri: string, notify?: boolean): void;
+    private _find;
+}
+export {};

package/lib/types/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/types/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/types/spreadsheet.d.ts

@@ -0,0 +1,222 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @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 { FormatFunc } 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?: 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 the spreadsheet
+     * @param columns
+     */
+    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;
+}

package/lib/types/styles.d.ts

@@ -0,0 +1,85 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file styles.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.
+**/
+/**
+ *  -- [ @STYLESHEET ] -----------------------------------------------------------------
+ */
+export declare class Stylesheet {
+    private m_sheet;
+    private m_rules;
+    constructor();
+    /**
+     * add a new rule to the style sheet
+     * @param {string} name - internal rule name
+     * @param {string} definition - css definition of the rule
+     * @example
+     * setRule('xbody', "body { background-color: #ff0000; }" );
+     */
+    setRule(name: string, definition: any): void;
+    /**
+     * return the style variable value
+     * @param name - variable name
+     * @example
+     * ```
+     * let color = Component.getCss( ).getVar( 'button-color' );
+     * ```
+     */
+    static getVar(name: string): any;
+    static guid: number;
+    static doc_style: CSSStyleDeclaration;
+}
+/**
+ *  -- [ @CSSPARSER ] -----------------------------------------------------------------
+ *
+ * adaptation of jss-for-node-js
+ */
+export declare class CSSParser {
+    private result;
+    parse(css: any): string;
+    static mk_string(rules: any): string;
+    private parse_json;
+    private makePropertyName;
+    private makeSelectorName;
+    addProperty(scope: string, property: string, value: any): void;
+}
+export declare class ComputedStyle {
+    m_style: CSSStyleDeclaration;
+    constructor(style: CSSStyleDeclaration);
+    /**
+     * return the raw value
+     */
+    value(name: string): string;
+    /**
+     * return the interpreted value
+     */
+    parse(name: string): number;
+    /**
+     *
+     */
+    get style(): CSSStyleDeclaration;
+}