x4js 1.5.22 → 1.5.24

package/lib/types/base_component.d.ts

@@ -0,0 +1,88 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file base_component.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 { EventMap, MapEvents, EventSource, EvTimer } from './x4events';
+/**
+ * Timer Callback
+ * @see EvTimer, startTimer, stopTimer
+ */
+interface TimerCallback {
+    (name: string, time: number): void;
+}
+/**
+ * BaseComponent EventMap
+ */
+export interface BaseComponentEventMap extends EventMap {
+    timer: EvTimer;
+}
+/**
+ * BaseCompoment Properties
+ */
+export interface BaseComponentProps<T = BaseComponentEventMap> {
+    events?: MapEvents<T>;
+    [key: string]: any;
+}
+/**
+ * BaseComponent class
+ */
+export declare class BaseComponent<P extends BaseComponentProps<BaseComponentEventMap>, E extends BaseComponentEventMap> extends EventSource<E> {
+    #private;
+    protected m_props: P;
+    constructor(props: P);
+    /**
+     * start a new timer
+     * @param name timer name
+     * @param timeout time out in ms
+     * @param repeat if true this is an auto repeat timer
+     * @param callback if !null, the callback to call else a EvTimer is fired
+     */
+    startTimer(name: string, timeout: number, repeat?: boolean, callback?: TimerCallback): void;
+    /**
+     * stop the given timer
+     * @param name
+     */
+    stopTimer(name: string): void;
+    /**
+     * stop all timers
+     */
+    disposeTimers(): void;
+    /**
+     *
+     * @param callback
+     * @param timeout
+     */
+    singleShot(callback: TimerCallback, timeout?: number): void;
+    /**
+     *
+     * @param props
+     * @param elements
+     */
+    mapPropEvents<N extends keyof E>(props: P, ...elements: N[]): void;
+}
+export {};

package/lib/types/button.d.ts

@@ -0,0 +1,151 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file button.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, HtmlString } from './component';
+import { EventCallback, EvClick, EvChange } from './x4events';
+import { Action } from './action';
+import { IconID } from './icon';
+import { MenuItem, MenuOrSep } from './menu';
+/**
+ * Button events
+ */
+interface ButtonEventMap extends CEventMap {
+    click: EvClick;
+}
+type MenuCallBack = () => MenuOrSep[];
+/**
+ * Button properties
+ */
+interface ButtonProps<E extends ButtonEventMap = ButtonEventMap> extends CProps<E> {
+    text?: string | HtmlString;
+    icon?: IconID;
+    rightIcon?: IconID;
+    align?: 'center' | 'left' | 'right';
+    autoRepeat?: number;
+    menu?: MenuOrSep[] | MenuCallBack;
+    click?: EventCallback<EvClick>;
+    action?: Action;
+}
+/**
+ * Base button
+ */
+export declare class BaseButton<P extends ButtonProps = ButtonProps, E extends ButtonEventMap = ButtonEventMap> extends Component<P, E> {
+    constructor(props: P);
+    render(props: ButtonProps): void;
+    /**
+     * starts/stops the autorepeat
+     */
+    private _startAutoRep;
+    /**
+     *
+     */
+    protected _handleKeyDown(ev: KeyboardEvent): void;
+    /**
+     * called by the system on click event
+     */
+    protected _handleClick(ev: MouseEvent): void;
+    /**
+     * sends a click to the observers
+     */
+    protected _sendClick(): void;
+    /**
+     * change the button text
+     * @example
+     * ```ts
+     * let btn = new Button( {
+     * 	text: 'hello'
+     * });
+     *
+     * btn.text = 'world';
+     * ```
+     */
+    set text(text: string | HtmlString);
+    get text(): string | HtmlString;
+    /**
+     * change the button icon
+     * todo: do nothing if no icon defined at startup
+     *
+     * @example
+     * ```ts
+     * let btn = new Button( {
+     * 	text: 'hello',
+     *  icon: 'close'
+     * });
+     * btn.setIcon( 'open' );
+     * ```
+     */
+    set icon(icon: IconID);
+    get icon(): IconID;
+    /**
+     * change the button right icon
+     * todo: do nothing if no icon defined at startup
+     *
+     * @example
+     * ```ts
+     * let btn = new Button( {
+     * 	text: 'hello',
+     *  icon: 'close'
+     * });
+     * btn.setIcon( 'open' );
+     * ```
+     */
+    set rightIcon(icon: IconID);
+    get rightIcon(): IconID;
+    /**
+     *
+     */
+    set menu(items: MenuItem[]);
+}
+/**
+ *
+ */
+export declare class Button extends BaseButton<ButtonProps> {
+}
+interface ToggleButtonEventMap extends ButtonEventMap {
+    change: EvChange;
+}
+interface ToggleButtonProps extends ButtonProps<ToggleButtonEventMap> {
+    checked: boolean;
+    checkedIcon?: IconID;
+}
+/**
+ *
+ */
+export declare class ToggleButton extends BaseButton<ToggleButtonProps, ToggleButtonEventMap> {
+    constructor(props: ToggleButtonProps);
+    /**
+     *
+     */
+    render(props: ToggleButtonProps): void;
+    /**
+     *
+     */
+    protected _sendClick(): void;
+    private _updateIcon;
+}
+export {};

package/lib/types/calendar.d.ts

@@ -0,0 +1,82 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file calendar.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 { Popup } from './popup';
+import { CProps, ContainerEventMap } from './component';
+import { EvChange, EventCallback } from './x4events';
+import { Point } from "./tools";
+import { VLayout } from './layout';
+interface CalendarEventMap extends ContainerEventMap {
+    change?: EvChange;
+}
+interface CalendarProps extends CProps<CalendarEventMap> {
+    date?: Date;
+    minDate?: Date;
+    maxDate?: Date;
+    change?: EventCallback<EvChange>;
+}
+/**
+ * default calendar control
+ *
+ * fires:
+ * 	EventChange ( value = Date )
+ */
+export declare class Calendar extends VLayout<CalendarProps, CalendarEventMap> {
+    private m_date;
+    constructor(props: CalendarProps);
+    /** @ignore */
+    render(props: CalendarProps): void;
+    /**
+     * select the given date
+     * @param date
+     */
+    private select;
+    /**
+     *
+     */
+    private _next;
+    /**
+     *
+     */
+    private _choose;
+    get date(): Date;
+    set date(date: Date);
+}
+/**
+ * default popup calendar
+ */
+export declare class PopupCalendar extends Popup {
+    m_cal: Calendar;
+    constructor(props: CalendarProps);
+    private _handleClick;
+    /** @ignore */
+    show(modal?: boolean, at?: Point): void;
+    /** @ignore */
+    close(): void;
+}
+export {};

package/lib/types/canvas.d.ts

@@ -0,0 +1,92 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|
+*  /__/\__\   |_|
+*
+* @file canvas.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 { BasicEvent, EventCallback } from './x4events';
+interface EvPaint extends BasicEvent {
+    ctx: CanvasPainter;
+}
+declare function EvPaint(ctx: CanvasPainter): EvPaint;
+interface CanvasEventMap extends CEventMap {
+    paint: EvPaint;
+}
+interface CanvasProps extends CProps<CanvasEventMap> {
+    autoClear?: boolean;
+    painter?: PaintHandler;
+    paint: EventCallback<EvPaint>;
+}
+export interface CanvasPainter extends CanvasRenderingContext2D {
+    width: number;
+    height: number;
+    smoothLine(points: any[], path: CanvasPath, move: boolean): void;
+    smoothLineEx(_points: any[], tension: number, numOfSeg: number, path: CanvasPath, move?: boolean, close?: boolean): void;
+    line(x1: number, y1: number, x2: number, y2: number, color: string, lineWidth: number): void;
+    roundRect(x: number, y: number, width: number, height: number, radius: number): void;
+    calcTextSize(text: string, rounded: boolean): {
+        width: number;
+        height: number;
+    };
+    setFontSize(fs: number): void;
+    circle(x: number, y: number, radius: number): void;
+}
+type PaintHandler = (ctx: CanvasPainter) => any;
+/**
+ *
+ */
+/**
+ * Standard Canvas
+ */
+export declare class Canvas extends Component<CanvasProps, CanvasEventMap> {
+    private m_iwidth;
+    private m_iheight;
+    private m_scale;
+    private m_canvas;
+    constructor(props: CanvasProps);
+    /** @ignore */
+    render(): void;
+    update(delay?: number): void;
+    /**
+     * scale the whole canvas
+     */
+    scale(scale: number): void;
+    /**
+     * return the internal canvas
+     */
+    get canvas(): Component;
+    /**
+     * redraw the canvas (force a paint)
+     */
+    private $update_rep;
+    redraw(wait?: number): void;
+    /**
+     *
+     */
+    private _paint;
+    protected paint(ctx: CanvasPainter): void;
+}
+export {};

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 {};