x4js 1.4.52 → 1.5.0

package/lib/esm/popup.js

@@ -0,0 +1,379 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file popup.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 { x4document } from './x4dom';
+import { Container, flyWrap, SizerOverlay, Component, EvSize } from './component';
+import { Size, getMousePos } from './tools';
+import { BasicEvent } from './x4events';
+import { Application } from './application';
+export function EvMove(pos) {
+    return BasicEvent({ pos });
+}
+/**
+ * base class for all popup elements
+ */
+export class Popup extends Container {
+    m_ui_mask;
+    m_hasMask = true;
+    static modal_stack = [];
+    constructor(props) {
+        super(props);
+        this.addClass('@hidden');
+    }
+    enableMask(enable = true) {
+        this.m_hasMask = enable;
+    }
+    /**
+     * display the popup on screen
+     */
+    show(modal) {
+        if (modal !== undefined) {
+            this.m_hasMask = modal ? true : false;
+        }
+        else {
+            modal = this.m_hasMask;
+        }
+        if (this.m_hasMask) {
+            // remove the focus
+            const focus = x4document.activeElement;
+            if (focus) {
+                focus.blur();
+            }
+            this.m_ui_mask = x4document.body.lastChild;
+            while (this.m_ui_mask) {
+                if (this.m_ui_mask.nodeType == 1) { // only element nodes
+                    let elUI = flyWrap(this.m_ui_mask);
+                    if (elUI.hasClass('@menu') || elUI.hasClass('@non-maskable')) {
+                        /* avoid circular dependencies instanceof Menu*/
+                        /* avoid nonmaskable elements tobe masked */
+                    }
+                    else if (elUI.getStyleValue('display') == 'none' || !elUI.isUserVisible()) {
+                        /* avoid masking hidden elements */
+                    }
+                    else if (!elUI.hasClass('@comp')) {
+                        /* avoid masking element that are not to us */
+                    }
+                    else {
+                        break;
+                    }
+                }
+                this.m_ui_mask = this.m_ui_mask.previousSibling;
+            }
+            if (this.m_ui_mask) {
+                flyWrap(this.m_ui_mask).addClass('@mask');
+            }
+        }
+        if (modal) {
+            Application.instance().enterModal(true);
+        }
+        // to avoid body growing because of appendChild
+        this.setStyle({
+            left: 0,
+            top: 0
+        });
+        x4document.body.appendChild(this._build());
+        this.removeClass('@hidden');
+        this.centerOnScreen();
+        if (modal) {
+            let focus = x4document.activeElement;
+            if (!this.dom.contains(focus)) {
+                const autofocus = this.queryItem('[autofocus]');
+                if (autofocus) {
+                    autofocus.focus();
+                }
+                else {
+                    let tabbable = this.queryAll('[tabindex]');
+                    if (tabbable) {
+                        // remove hidden elements
+                        tabbable = tabbable.filter((el) => el.offsetParent !== null);
+                        if (tabbable.length) {
+                            tabbable[0].focus();
+                        }
+                    }
+                }
+            }
+            Popup.modal_stack.push(this.dom);
+        }
+    }
+    centerOnScreen() {
+        let rc = this.getBoundingRect();
+        //let x = (x4document.body.clientWidth - rc.width) / 2,
+        //	y = (x4document.body.clientHeight - rc.height) / 2;
+        const x = `max( 0px, 50vw - ${rc.width / 2}px )`; //(x4dom_1.x4document.body.clientWidth - rc.width) / 2;
+        const y = `max( 0px, 50vh - ${rc.height / 2}px )`; //(x4dom_1.x4document.body.clientHeight - rc.height) / 2;
+        this.setStyleValue('left', x);
+        this.setStyleValue('top', y);
+    }
+    /**
+    * display the popup at a specific position
+    * @param x
+    * @param y
+    */
+    displayAt(x, y, align = 'top left', offset) {
+        this.show();
+        let halign = 'l', valign = 't';
+        if (align.indexOf('right') >= 0) {
+            halign = 'r';
+        }
+        if (align.indexOf('bottom') >= 0) {
+            valign = 'b';
+        }
+        // @TODO: this is a minimal overflow problem solution
+        let rc = x4document.body.getBoundingClientRect(), rm = this.getBoundingRect();
+        if (halign == 'r') {
+            x -= rm.width;
+        }
+        if (valign == 'b') {
+            y -= rm.height;
+        }
+        if (offset) {
+            x += offset.x;
+            y += offset.y;
+        }
+        if (x < 4) {
+            x = 4;
+        }
+        if ((x + rm.width) > rc.right - 4) {
+            x = rc.right - 4 - rm.width;
+            if (offset?.x < 0) {
+                x += offset.x;
+            }
+        }
+        if (y < 4) {
+            y = 4;
+        }
+        if ((y + rm.height) > rc.bottom - 4) {
+            y = rc.bottom - 4 - rm.height;
+            if (offset?.y < 0) {
+                y += offset.y;
+            }
+        }
+        this.setStyle({ left: x, top: y });
+    }
+    /**
+     * close the popup
+     */
+    close() {
+        this.hide();
+        if (this.m_hasMask && this.m_ui_mask) {
+            flyWrap(this.m_ui_mask).removeClass('@mask');
+            const app = Application.instance();
+            app.enterModal(false);
+        }
+        let index = Popup.modal_stack.indexOf(this.dom);
+        if (index >= 0) {
+            Popup.modal_stack.splice(index);
+        }
+        this.dispose();
+    }
+    componentCreated() {
+        if (this.m_props.sizable) {
+            this.addClass('@size-all');
+            let els = ['top', 'right', 'bottom', 'left', 'topleft', 'topright', 'bottomleft', 'bottomright'];
+            for (let sens of els) {
+                new SizerOverlay({
+                    target: this,
+                    sens: sens,
+                    events: { rawresize: (e) => this._mouseResize(e) }
+                });
+            }
+        }
+    }
+    /**
+     * resize for 'all' resize attribute
+     */
+    _mouseResize(event) {
+        event.preventDefault();
+        let irc = this.getBoundingRect();
+        let st = this.getComputedStyle();
+        let ev = event.ui_event;
+        let tm = st.parse('marginTop'), lm = st.parse('marginLeft'), rm = st.parse('marginRight'), bm = st.parse('marginBottom');
+        let ix = 0, iy = 0;
+        let mp = getMousePos(ev, true);
+        // horz
+        switch (event.sens) {
+            case 'topright':
+            case 'bottomright':
+            case 'right':
+                ix = (irc.right - rm) - mp.x;
+                break;
+            case 'topleft':
+            case 'bottomleft':
+            case 'left':
+                ix = (irc.left - lm) - mp.x;
+                break;
+        }
+        // vert
+        switch (event.sens) {
+            case 'bottomleft':
+            case 'bottomright':
+            case 'bottom':
+                iy = (irc.bottom - bm) - mp.y;
+                break;
+            case 'topleft':
+            case 'topright':
+            case 'top':
+                iy = (irc.top - tm) - mp.y;
+                break;
+        }
+        // left & top are with margin
+        // width & height not
+        irc.left -= lm;
+        irc.top -= tm;
+        //console.log( 'capture' );
+        let sens = event.sens;
+        Component.setCapture(this, (ne) => {
+            //console.log( ne );
+            let __move = (ex, ey) => {
+                let left = irc.left, top = irc.top, width = irc.width, height = irc.height;
+                let dx, dy;
+                let px = ex + ix, py = ey + iy;
+                if (px < 0) {
+                    px = 0;
+                }
+                if (py < 0) {
+                    py = 0;
+                }
+                // horz
+                switch (sens) {
+                    case 'topright':
+                    case 'bottomright':
+                    case 'right':
+                        width = px - left;
+                        break;
+                    case 'topleft':
+                    case 'bottomleft':
+                    case 'left':
+                        dx = left - px;
+                        width += dx;
+                        left -= dx;
+                        break;
+                }
+                // vert
+                switch (sens) {
+                    case 'bottomleft':
+                    case 'bottomright':
+                    case 'bottom':
+                        height = py - top;
+                        break;
+                    case 'topleft':
+                    case 'topright':
+                    case 'top':
+                        dy = top - py;
+                        height += dy;
+                        top -= dy;
+                        break;
+                }
+                let newsize = new Size(width, height);
+                this.setStyle({ left, top, width: newsize.width, height: newsize.height });
+                this.emit('size', EvSize(newsize));
+            };
+            if (ne.type == 'mouseup' || ne.type == 'touchend') {
+                Component.releaseCapture();
+            }
+            else if (ne.type == 'mousemove') {
+                let me = ne;
+                __move(me.pageX, me.pageY);
+            }
+            else if (ne.type == 'touchmove') {
+                let tev = ne;
+                __move(tev.touches[0].pageX, tev.touches[0].pageY);
+            }
+        });
+    }
+}
+/**
+ * handle tab key
+ */
+function x4handleKeyDown(e) {
+    if (e.key == 'Tab' || e.key == 'Enter') {
+        const target = e.target;
+        if (target.tagName == 'TEXTAREA') {
+            return;
+        }
+        const el = Component.getElement(target);
+        if (el && (el.hasAttribute('wants-tab') || el.hasAttribute('wants-enter'))) {
+            return;
+        }
+        let topStack = x4document.body;
+        if (Popup.modal_stack.length) {
+            topStack = Popup.modal_stack[Popup.modal_stack.length - 1];
+        }
+        _nextTab(topStack, e.target, e.shiftKey);
+        e.stopPropagation();
+        e.preventDefault();
+    }
+}
+/**
+ * cycle through tabs
+ */
+function _nextTab(root, el, prev) {
+    // first check if the focus is one of our child (disabled...)
+    let focusEl = x4document.activeElement;
+    if (!root.contains(focusEl)) {
+        return;
+    }
+    let comp = Component.getElement(el);
+    // get a list of elements with tab index, this way we should abble to
+    // cycle on them (not on browser address nor under dialog elements)
+    let tab_indexes = Array.from(root.querySelectorAll('[tabindex]'));
+    // remove hidden elements
+    tab_indexes = tab_indexes.filter((el) => el.offsetParent !== null);
+    if (!tab_indexes.length) {
+        return;
+    }
+    let ct = tab_indexes.indexOf(el);
+    if (ct < 0) {
+        ct = 0;
+    }
+    else {
+        if (prev) {
+            if (ct > 0) {
+                ct--;
+            }
+            else {
+                ct = tab_indexes.length - 1;
+            }
+        }
+        else {
+            if (ct < tab_indexes.length - 1) {
+                ct++;
+            }
+            else {
+                ct = 0;
+            }
+        }
+    }
+    tab_indexes[ct].focus();
+}
+function installKBHandler() {
+    // set on body to be called after document (where all component domevent go)
+    x4document.body.addEventListener('keydown', x4handleKeyDown, true);
+}
+// too early ?
+x4document.body ? installKBHandler() : window.addEventListener('load', installKBHandler);

package/lib/esm/property_editor.d.ts

@@ -0,0 +1,71 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file propertyeditor.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 { InputProps } from './input';
+import { Spreadsheet } from './spreadsheet';
+import { Record } from './datastore';
+export interface SaveCallback {
+    (id: any, record: any[]): void;
+}
+export declare type IPropertyField = {
+    id: any;
+    title: string;
+    type: Function | "string" | 'number' | 'boolean' | 'choice' | 'password' | 'button' | 'color';
+    value?: any;
+    data?: any;
+    editorProps?: InputProps;
+    readOnly?: boolean;
+};
+interface PropertyEditorEventMap extends CEventMap {
+    change: EvChange;
+}
+export interface PropertyEditorProps extends CProps<PropertyEditorEventMap> {
+    fields: IPropertyField[];
+    labelWidth?: number;
+    record?: Record;
+    change: EventCallback<EvChange>;
+}
+export declare class PropertyEditor extends Component<PropertyEditorProps, PropertyEditorEventMap> {
+    m_fields: IPropertyField[];
+    m_record: Record;
+    m_sheet: Spreadsheet;
+    m_label_w: number;
+    constructor(props: PropertyEditorProps);
+    render(props: PropertyEditorProps): void;
+    setFields(fields: IPropertyField[]): void;
+    setRecord(record: Record): void;
+    private _updateProperties;
+    private _cellChange;
+    _renderCell(text: any, rec: any): any;
+    _editCell(props: any, row: number, col: number): Component<CProps<CEventMap>, CEventMap>;
+    private _choicesFromArray;
+    private _choicesFromStore;
+}
+export {};

package/lib/esm/property_editor.js

@@ -0,0 +1,251 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|
+*  /__/ \__\   |_|
+*
+* @file propertyeditor.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 { EvChange } from './x4events';
+import { Input } from './input';
+import { TextEdit } from './textedit';
+import { CheckBox } from './checkbox';
+import { Spreadsheet } from './spreadsheet';
+import { _tr } from './i18n';
+export class PropertyEditor extends Component {
+    m_fields;
+    m_record;
+    m_sheet;
+    m_label_w;
+    constructor(props) {
+        super(props);
+        this.mapPropEvents(props, 'change');
+    }
+    render(props) {
+        this.m_record = props.record;
+        this.m_fields = props.fields ?? [];
+        this.m_label_w = props.labelWidth;
+        this.m_sheet = new Spreadsheet({
+            cls: '@fit',
+            columns: [
+                {
+                    title: _tr.global.property,
+                    width: this.m_label_w > 0 ? this.m_label_w : -1,
+                    cls: 'property'
+                },
+                {
+                    title: _tr.global.value,
+                    width: -1,
+                    createEditor: (...a) => this._editCell(...a),
+                    renderer: (...a) => this._renderCell(...a)
+                },
+            ],
+            autoedit: true,
+            change: (e) => this._cellChange(e)
+        });
+        this._updateProperties();
+        this.setContent(this.m_sheet);
+    }
+    setFields(fields) {
+        if (fields) {
+            this.m_fields = fields;
+            this._updateProperties();
+        }
+        else {
+            this.m_sheet.clearData();
+        }
+    }
+    setRecord(record) {
+        this.m_record = record;
+        this._updateProperties();
+    }
+    _updateProperties() {
+        this.m_sheet.lockUpdate(true);
+        this.m_sheet.clearData();
+        this.m_fields.forEach((fld, lno) => {
+            this.m_sheet.setCellText(lno, 0, fld.title);
+            if (this.m_record) {
+                this.m_sheet.setCellText(lno, 1, this.m_record.getField(fld.id));
+            }
+            else {
+                this.m_sheet.setCellText(lno, 1, fld.value);
+            }
+        });
+        this.m_sheet.lockUpdate(false);
+    }
+    _cellChange(ev) {
+        let ctx = ev.context;
+        let text = ev.value;
+        if (ctx.col != 1) {
+            return;
+        }
+        let fld = this.m_fields[ctx.row];
+        switch (fld.type) {
+            default:
+            case 'string': {
+                break;
+            }
+            case 'number': {
+                break;
+            }
+            case 'password': {
+                break;
+            }
+            case 'boolean': {
+                break;
+            }
+            case 'choice': {
+                /*
+                let cprops = <ComboBoxProps>fprops;
+                if( cprops!==fld.props ) {
+                    
+                    let choices;
+                    if( isArray(fld.values) ) {
+                        choices = this._choicesFromArray( fld.values );
+                    }
+                    else if( fld.values instanceof DataStore ) {
+                        choices = this._choicesFromStore( fld.values, 'name' );
+                    }
+                                                
+                    cprops.items = choices;
+                }
+
+                editor = new ComboBox( cprops );
+                */
+                break;
+            }
+        }
+        if (this.m_record) {
+            this.m_record.setField(fld.id, text);
+        }
+        else {
+            fld.value = text;
+        }
+        this.emit('change', EvChange(text, fld));
+    }
+    _renderCell(text, rec) {
+        let fld = this.m_fields[rec.row];
+        switch (fld.type) {
+            default:
+            case 'string': {
+                break;
+            }
+            case 'number': {
+                break;
+            }
+            case 'password': {
+                text = '●●●●●●';
+                break;
+            }
+            case 'boolean': {
+                break;
+            }
+            case 'choice': {
+                /*
+                let cprops = <ComboBoxProps>fprops;
+                if( cprops!==fld.props ) {
+                    
+                    let choices;
+                    if( isArray(fld.values) ) {
+                        choices = this._choicesFromArray( fld.values );
+                    }
+                    else if( fld.values instanceof DataStore ) {
+                        choices = this._choicesFromStore( fld.values, 'name' );
+                    }
+                                                
+                    cprops.items = choices;
+                }
+
+                editor = new ComboBox( cprops );
+                */
+                break;
+            }
+        }
+        return text;
+    }
+    _editCell(props, row, col) {
+        let fld = this.m_fields[row];
+        let editor;
+        switch (fld.type) {
+            default:
+            case 'string': {
+                editor = new TextEdit(props);
+                break;
+            }
+            case 'number': {
+                editor = new TextEdit(props);
+                break;
+            }
+            case 'password': {
+                props.type = 'password';
+                props.value = this.m_record.getField(fld.id);
+                editor = new Input(props);
+                break;
+            }
+            case 'boolean': {
+                editor = new CheckBox(props);
+                break;
+            }
+            case 'choice': {
+                /*let cprops = <ComboBoxProps>props;
+                if( cprops!==fld.props ) {
+                    
+                    let choices;
+                    if( isArray(fld.values) ) {
+                        choices = this._choicesFromArray( fld.values );
+                    }
+                    else if( fld.values instanceof DataStore ) {
+                        choices = this._choicesFromStore( fld.values, 'name' );
+                    }
+                                                
+                    cprops.items = choices;
+                }
+
+                editor = new ComboBox( cprops );
+                */
+                break;
+            }
+        }
+        return editor;
+    }
+    _choicesFromArray(values) {
+        let choices = values.map((e) => {
+            if (typeof (e) == 'object') {
+                return { id: e.id, text: e.value };
+            }
+            else {
+                return { id: e, text: '' + e };
+            }
+        });
+        return choices;
+    }
+    _choicesFromStore(view, field) {
+        let choices = [];
+        for (let i = 0, n = view.count; i < n; i++) {
+            let rec = view.getByIndex(i);
+            choices.push({ id: rec.getID(), text: rec.getField(field) });
+        }
+        return choices;
+    }
+}