x4js 1.5.21 → 1.5.23

package/lib/types/cardview.d.ts

@@ -0,0 +1,87 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file cardview.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, CProps, CEventMap } from './component';
+import { EvChange } from './x4events';
+import { IconID } from './icon';
+export type PageOrCallback = Component | (() => Component);
+export interface ICardViewItem {
+    icon?: IconID;
+    name: string;
+    title: string;
+    page: PageOrCallback;
+}
+interface CardViewEventMap extends CEventMap {
+    change?: EvChange;
+}
+export interface CardViewProps extends CProps<CardViewEventMap> {
+    pages: ICardViewItem[];
+    active?: string;
+}
+interface ICardItemEx extends ICardViewItem {
+    selector: Component;
+    active: boolean;
+}
+/**
+ * Standard CardView class
+ * a card view is composed of multiples pages with only one visible at a time.
+ * pages can be selected by a component (like tabs ou sidebar).
+ * or by code.
+ */
+export declare class CardView<P extends CardViewProps = CardViewProps, E extends CardViewEventMap = CardViewEventMap> extends Component<P, E> {
+    protected m_cards: ICardItemEx[];
+    protected m_ipage: string;
+    protected m_cpage: ICardItemEx;
+    constructor(props: P);
+    /** @ignore */
+    render(): void;
+    /**
+     * switch to a specific card
+     * @param name - card name as define in constructor
+     */
+    switchTo(name?: string): void;
+    /**
+     *
+     */
+    setPages(pages: ICardViewItem[]): void;
+    /**
+     *
+     */
+    private _initTabs;
+    protected _updateSelector(): void;
+    /**
+     * prepare the cardinfo
+     * can be used by derivations to create & set selectors
+     */
+    protected _prepareSelector(card: ICardViewItem): Component;
+    /**
+     *
+     */
+    protected _preparePage(page: Component): void;
+}
+export {};

package/lib/types/checkbox.d.ts

@@ -0,0 +1,77 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file checkbox.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 { CEventMap, Component, CProps } from './component';
+import { EvChange, EventCallback } from './x4events';
+import { HtmlString } from './tools';
+interface CheckBoxEventMap extends CEventMap {
+    change?: EvChange;
+}
+interface CheckBoxProps extends CProps<CheckBoxEventMap> {
+    name?: string;
+    text?: string | HtmlString;
+    checked?: boolean;
+    value?: string;
+    slider?: boolean;
+    labelWidth?: number;
+    labelAlign?: 'left' | 'right';
+    align?: 'left' | 'right';
+    change?: EventCallback<EvChange>;
+}
+/**
+ * Standard CheckBox
+ */
+export declare class CheckBox extends Component<CheckBoxProps, CheckBoxEventMap> {
+    constructor(props: CheckBoxProps);
+    /** @ignore */
+    render(props: CheckBoxProps): void;
+    /**
+     * check state changed
+     */
+    private _change;
+    /**
+     * focus gained/loosed
+     */
+    private _setFocus;
+    /**
+     * @return the checked value
+     */
+    get check(): boolean;
+    /**
+     * change the checked value
+     * @param {boolean} ck new checked value
+     */
+    set check(ck: boolean);
+    get text(): string | HtmlString;
+    set text(text: string | HtmlString);
+    /**
+     * toggle the checkbox
+     */
+    toggle(): void;
+}
+export {};

package/lib/types/color.d.ts

@@ -0,0 +1,148 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file color.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 Color {
+    private m_value;
+    private static custom;
+    /**
+     * @example
+     * ```ts
+     * let c = new Color( 255, 255, 255, 0.2 );
+     * let d = new Color( "fff" );
+     * let e = new Color( "css:selection-color" );
+     * let f = new Color( "rgba(255,0,255,0.6)" );
+     * ```
+     */
+    constructor();
+    constructor(value: number | string);
+    constructor(value: number | string, alpha: number);
+    constructor(r: number, g: number, b: number);
+    constructor(r: number, g: number, b: number, a: number);
+    /**
+     *
+     */
+    private _shade;
+    /**
+     * return a color darken by percent
+     * @param percent
+     */
+    darken(percent: number): Color;
+    /**
+     * return a color lighten by percent
+     * @param percent
+     */
+    lighten(percent: number): Color;
+    /**
+     * mix 2 colors
+     * @param {rgb} c1 - color 1
+     * @param {rgb} c2 - color 2
+     * @param {float} percent - 0.0 to 1.0
+     * @example
+     * ```js
+     * let clr = Color.mix( color1, color2, 0.5 );
+     * ```
+     */
+    static mix(c1: Color, c2: Color, p: number): Color;
+    /**
+     * split the color into it's base element r,g,b & a (!a 1-255)
+     */
+    private _split;
+    /**
+     * change the alpha value
+     */
+    fadeout(percent: number): Color;
+    /**
+     *
+     */
+    static fromHSV(h: number, s: number, v: number, a?: number): Color;
+    /**
+     *
+     */
+    static toHSV(c: Color): {
+        h: any;
+        s: number;
+        v: number;
+        a: number;
+    };
+    /**
+     *
+     */
+    static fromHLS(h: number, l: number, s: number): Color;
+    /**
+     *
+     */
+    static toHLS(color: Color): {
+        h: number;
+        l: number;
+        s: any;
+    };
+    /**
+     * get the red value of the color
+     */
+    red(): number;
+    /**
+     * get the green value of the color
+     */
+    green(): number;
+    /**
+     * get the blue value of the color
+     */
+    blue(): number;
+    /**
+     * get the alpha value of the color
+     */
+    alpha(): number;
+    /**
+     *
+     */
+    value(): number;
+    /**
+     * convert the color into string value
+     */
+    toString(): string;
+    toHex(with_alpha?: boolean): string;
+    static addCustomColor(name: string, value: Color): void;
+    static addCssColor(name: string): void;
+    static parse(str: string): Color;
+    private _getCustomColor;
+    static contrastColor(color: Color): Color;
+    /**
+     *
+     */
+    static WHITE: Color;
+    /**
+     *
+     */
+    static BLACK: Color;
+    /**
+     *
+     */
+    static NONE: Color;
+    static valueFromColorName(name: string): Color;
+    static fromCssVar(varName: string): string;
+}

package/lib/types/colorpicker.d.ts

@@ -0,0 +1,107 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file colorpicker.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.
+**/
+/**
+ * ARGH this code is awfull
+ */
+import { Container, ContainerProps, ContainerEventMap } from './component';
+import { Dialog, DialogBoxEventMap, DialogProps } from './dialog';
+import { EvChange, EventCallback } from './x4events';
+import { HLayout } from './layout';
+import { Color } from './color';
+interface ColorPickerEventMap extends ContainerEventMap {
+    change: EvChange;
+}
+export interface ColorPickerProps extends ContainerProps<ColorPickerEventMap> {
+    color: Color;
+    hasAlpha?: boolean;
+}
+export declare class ColorPicker extends Container<ColorPickerProps, ColorPickerEventMap> {
+    private m_colorSel;
+    private m_colorHue;
+    private m_colorAlpha;
+    private m_sample;
+    private m_selMark;
+    private m_hueMark;
+    private m_alphaMark;
+    private m_baseHSV;
+    private m_baseColor;
+    private m_transpCk;
+    private m_colorEdit;
+    private m_palmode;
+    static last_palmode: boolean;
+    constructor(props: ColorPickerProps);
+    private _showCtx;
+    render(props: ColorPickerProps): void;
+    set color(clr: Color);
+    get color(): Color;
+    private _selChange;
+    private _hueChange;
+    private _alphaChange;
+    private _updateColor;
+    private _change;
+}
+interface ColorPickerBoxEventMap extends DialogBoxEventMap {
+    change: EvChange;
+}
+export interface ColorPickerBoxProps extends DialogProps<ColorPickerBoxEventMap> {
+    color: Color;
+    hasAlpha?: boolean;
+    cust_colors?: Color[];
+    change?: EventCallback<EvChange>;
+}
+export declare class ColorPickerBox extends Dialog<ColorPickerBoxProps, ColorPickerBoxEventMap> {
+    private m_picker;
+    constructor(props: ColorPickerBoxProps);
+    private _makeCustoms;
+    set color(clr: Color);
+    get color(): Color;
+    /**
+     * display a messagebox
+     */
+    static show(props: string | ColorPickerBoxProps): ColorPickerBox;
+}
+export interface ColorPickerEditorProps extends ColorPickerProps {
+    label?: string;
+    labelWidth?: number;
+    cust_colors?: Color[];
+    displayValue?: false;
+    change?: EventCallback<EvChange>;
+    name?: string;
+}
+export declare class ColorPickerEditor extends HLayout<ColorPickerEditorProps, ColorPickerEventMap> {
+    constructor(props: ColorPickerEditorProps);
+    render(props: ColorPickerEditorProps): void;
+    set value(color: Color);
+    get value(): Color;
+    set custom_colors(v: Color[]);
+    private _showPicker;
+    private _change;
+    private _isTransp;
+}
+export {};

package/lib/types/combobox.d.ts

@@ -0,0 +1,107 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file combobox.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.
+**/
+/**
+ * TODO: replace custom combo list by listview or gridview
+ */
+import { Component, CProps, ContainerEventMap } from './component';
+import { EvChange, EvSelectionChange, EventCallback } from './x4events';
+import { Input } from './input';
+import { HLayout } from './layout';
+import { ListViewItem, EvCancel, PopulateItems } from './listview';
+import { DataStore, DataView, Record } from './datastore';
+import { HtmlString } from './tools';
+export interface ComboStoreProxyProps {
+    store: DataView | DataStore;
+    display: (rec: Record) => string | HtmlString;
+}
+export interface ComboItemRender {
+    (itm: ListViewItem): Component;
+}
+interface ComboBoxEventMap extends ContainerEventMap {
+    readonly change: EvChange;
+    readonly selectionChange?: EvSelectionChange;
+    readonly cancel?: EvCancel;
+}
+export interface ComboBoxProps extends CProps<ComboBoxEventMap> {
+    tabIndex?: number | boolean;
+    name?: string;
+    readOnly?: boolean;
+    label?: string;
+    labelWidth?: number;
+    labelAlign?: 'left' | 'right';
+    items?: ListViewItem[] | PopulateItems;
+    value?: any;
+    renderer?: ComboItemRender;
+    selectionChange?: EventCallback<EvSelectionChange>;
+    editable?: boolean;
+}
+/**
+ * @review use textedit
+ */
+export declare class ComboBox extends HLayout<ComboBoxProps, ComboBoxEventMap> {
+    private m_ui_input;
+    private m_ui_button;
+    private m_popup;
+    private m_lockpop;
+    private m_lockchg;
+    private m_popvis;
+    private m_selection;
+    constructor(props: ComboBoxProps);
+    _onKey(e: any): void;
+    set items(items: ListViewItem[]);
+    /** @ignore */
+    render(props: ComboBoxProps): void;
+    componentDisposed(): void;
+    /**
+     * display the popup
+     */
+    showPopup(filter_items?: boolean): ListViewItem[];
+    /** @ignore
+      */
+    private _selectItem;
+    /**
+     *
+     */
+    private _setInput;
+    /**
+     *
+     */
+    get value(): any;
+    get valueText(): string | HtmlString;
+    /**
+     *
+     */
+    set value(id: any);
+    get input(): Input;
+    _checkFocus(): void;
+    _hidePopup(): void;
+    static storeProxy(props: ComboStoreProxyProps): PopulateItems;
+    focus(): void;
+}
+export {};