x4js 1.5.18 → 1.5.20

package/lib/src/property_editor.ts

@@ -0,0 +1,337 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|  
+*  /__/ \__\   |_|
+*        
+* @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, Input } from './input'
+import { TextEdit } from './textedit'
+import { CheckBox } from './checkbox'
+import { Spreadsheet } from './spreadsheet'
+import { DataView, Record } from './datastore'
+import { _tr } from './i18n'
+
+
+//@TODO: review all
+
+export interface SaveCallback {
+	(id: any, record: any[]) : void;
+}
+
+export type IPropertyField = {
+	id: any;
+	title: string;
+	type: Function | "string" | 'number' | 'boolean' | 'choice' | 'password' | 'button' | 'color';
+	value?: any;
+
+	data?: any;	// associated data if needed
+	editorProps?: InputProps;
+	readOnly?: boolean;
+	//values?: any[] | DataView;
+}
+
+interface PropertyEditorEventMap extends CEventMap {
+	change: EvChange;
+}
+
+export interface PropertyEditorProps extends CProps<PropertyEditorEventMap> {
+	fields: IPropertyField[];
+	labelWidth?: number;
+	record?: Record;
+	change: EventCallback<EvChange>;
+}
+
+
+export class PropertyEditor extends Component<PropertyEditorProps, PropertyEditorEventMap> {
+
+	m_fields: IPropertyField[];
+	m_record: Record;
+	m_sheet: Spreadsheet;
+	m_label_w: number;
+
+	constructor(props: PropertyEditorProps) {
+		super(props);
+		this.mapPropEvents( props, 'change' );
+	}
+
+	render(props: PropertyEditorProps) {
+
+		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: IPropertyField[]) {
+		if (fields) {
+			this.m_fields = fields;
+			this._updateProperties();
+		}
+		else {
+			this.m_sheet.clearData();
+		}
+	}
+
+	setRecord(record: Record) {
+		this.m_record = record;
+		this._updateProperties();
+	}
+
+	private _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);
+	}
+
+
+	private _cellChange(ev: EvChange) {
+
+		let ctx: { row: number, col: number } = ev.context;
+		let text: number = ev.value as number;
+
+		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: number, col: number) {
+
+		let fld = this.m_fields[row];
+
+		let editor: Component;
+		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;
+	}
+
+	private _choicesFromArray(values): any[] {
+		let choices = values.map((e) => {
+
+			if (typeof (e) == 'object') {
+				return { id: e.id, text: e.value };
+			}
+			else {
+				return { id: e, text: '' + e };
+			}
+		});
+
+		return choices;
+	}
+
+	private _choicesFromStore(view: DataView, field: string): any[] {
+
+		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;
+	}
+
+
+}
+
+

package/lib/src/radiobtn.ts

@@ -0,0 +1,197 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|  
+*  /__/ \__\   |_|
+*        
+* @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 { x4document } from './x4dom'
+import { HtmlString } from './tools'
+
+import { Component, CProps, CEventMap } from './component'
+import { EvChange, EventCallback } from './x4events'
+
+import { IconID } from './icon';
+import { Input } from './input'
+import { Label } from './label'
+
+// ============================================================================
+// [RADIOBTN]
+// ============================================================================
+
+interface RadioBtnEventMap extends CEventMap {
+	change?: EvChange;
+}
+
+export interface RadioBtnProps extends CProps {
+
+	group: string;	// same as 'name' but required
+	value: string;
+	
+	tabIndex?: number | boolean;
+	name?: string;
+
+	icon?: IconID;
+	text?: string;
+	checked?: boolean;
+	labelWidth?: number | 'flex';	// flex | value
+	align?: 'left' | 'right';
+
+	change?: EventCallback<EvChange>; // shortcut to events: { change: xxx }
+}
+
+
+/**
+ * Standard RadioBtn
+ */
+
+export class RadioBtn extends Component<RadioBtnProps,RadioBtnEventMap> {
+
+	protected m_ui_input: Input;	// todo: remove that / use ref
+
+	constructor(props: RadioBtnProps) {
+
+		super( props );
+		this.mapPropEvents( props, 'change' );
+	}
+
+	/** @ignore */
+	render( props: RadioBtnProps) {
+
+		let text = props.text ?? '';
+		let name = props.name ?? props.group;
+		let labelWidth = props.labelWidth ?? -1;
+		let checked = props.checked ?? false;
+		let align = props.align ?? 'left';
+		let value = props.value;
+		let icon = props.icon;
+		
+		this.setTag( 'label' );
+		this.addClass( '@hlayout' );
+		
+		this.addClass( align );
+		this._setTabIndex( props.tabIndex );
+
+		if( checked ) {
+			this.addClass( 'checked' );
+		}
+
+		this.setContent( [
+			this.m_ui_input = new Input({
+				type: 'radio',				
+				name: name,
+				tabIndex: props.tabIndex,
+				value: value,
+				attrs: {
+					checked: checked ? '' : undefined
+				},
+				dom_events: {
+					change: ( ) => this._change( ),
+					focus: 	( ) => this.m_ui_input.focus( ),
+				}
+			}),
+			new Label( {
+				ref: 'label',
+				icon: icon,
+				text: text,
+				width: labelWidth==='flex' ? undefined : labelWidth,
+				flex: labelWidth==='flex' ? 1 : undefined,
+				style: {
+					order: align=='right' ? -1 : undefined,
+				},		
+			} )
+		] );
+	}
+
+	/**
+	 * check state changed
+	 */
+
+	private _change( ) {
+
+		let props = this.m_props;
+
+		let query = '.x-input[name='+props.name+']';
+		let nlist = x4document.querySelectorAll( query );		//todo: document ?
+
+		nlist.forEach( (dom) => {
+			let radio = Component.getElement( <HTMLElement>dom, RadioBtn );
+			radio.removeClass( 'checked' );
+		});
+
+		let dom = (<HTMLInputElement>this.m_ui_input.dom);
+		this.setClass( 'checked', dom.checked )
+
+		this.emit( 'change', EvChange( true ) );
+	}
+
+	/**
+     * @return the checked value
+     */
+
+    public get check( ) {
+		if( this.m_ui_input ) {
+			return (<HTMLInputElement>this.m_ui_input.dom).checked;
+		}
+		
+		return this.m_props.checked;
+    }
+
+    /**
+     * change the checked value
+     * @param {boolean} ck new checked value	
+     */
+
+    public set check( ck ) {
+
+		let dom = (<HTMLInputElement>this.m_ui_input.dom);
+		
+        if ( ck ) {
+			//this.addClass( 'checked' );
+			if( dom ) {
+				dom.checked = true;
+			}
+			
+			this.m_props.checked = true;
+        }
+        else {
+			//this.removeClass( 'checked' );
+            if( dom ) {
+				dom.checked = false;
+			}
+
+			this.m_props.checked = false;
+		}
+	}
+
+	get text( ): HtmlString | string {
+		return this.itemWithRef<Label>('label').text;
+	}
+
+	set text( text: HtmlString | string ) {
+		this.itemWithRef<Label>('label').text = text;
+	}
+}
+

package/lib/src/rating.ts

@@ -0,0 +1,135 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|  
+*  /__/ \__\   |_|
+*        
+* @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, Component, ContainerEventMap } from './component'
+import { HLayout } from './layout';
+import { Input } from './input'
+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 class Rating extends HLayout<RatingProps,RatingEventMap> {
+
+	private m_els: Component[];
+	private m_input: Input;
+	
+	constructor( props: RatingProps ) {
+		super( props );
+
+		props.steps = props.steps ?? 5;
+	}
+
+	render( props: RatingProps ) {
+		
+		let shape = props.shape ?? 'star';
+		let value = props.value ?? 0;
+
+		this.m_input = new Input( {
+			cls: '@hidden',
+			name: props.name,
+			value: ''+value
+		} );
+
+		this.addClass( shape );
+		this.setDomEvent( 'click', (e) => this._onclick(e) );
+
+		this.m_els = [];
+		for( let i=0; i<props.steps; i++ ) {
+			
+			let cls = 'item';
+			if( i+1 <= value ) {
+				cls += ' checked';
+			}
+
+			let c = new Component( { 
+				tag: 'option',
+				cls,
+				data: { value: i+1 }
+			} );
+
+			this.m_els.push( c );
+		}
+
+		this.m_els.push( this.m_input );
+		this.setContent( this.m_els );
+	}
+
+	getValue( ) {
+		return this.m_props.value ?? 0;
+	}
+
+	set value( v: number ) {
+		this.m_props.value = v;
+
+		for( let c=0; c<this.m_props.steps; c++ ) {
+			this.m_els[c].setClass( 'checked', this.m_els[c].getData('value')<=v );
+		}
+
+		this.m_input.value = ''+this.m_props.value;
+	}
+
+	set steps( n: number ) {
+		this.m_props.steps = n;
+		this.update( );
+	}
+
+	set shape( shape: string ) {
+		this.removeClass( this.m_props.shape );
+		this.m_props.shape = shape;
+		this.addClass( this.m_props.shape );
+	}
+
+	private _onclick( ev: MouseEvent ) {
+
+		let on = true;
+		for( let el=this.dom.firstChild; el; el = el.nextSibling ) {
+			let comp = Component.getElement( <HTMLElement>el );
+			comp.setClass( 'checked', on )
+
+			if( el==ev.target ) {
+				this.m_input.value = comp.getData( 'value' );
+				on = false;
+			}
+		}
+
+		this.emit( 'change', EvChange( this.m_props.value) );
+	} 
+}