x4js 1.5.17 → 1.5.20

package/lib/src/dom_events.ts

@@ -0,0 +1,315 @@
+/**
+*  ___  ___ __
+*  \  \/  /  / _
+*   \    /  /_| |_
+*   /    \____   _|  
+*  /__/\__\   |_|
+*        
+* @file dom_events.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 X4ElementEventMap extends HTMLElementEventMap {
+	"sizechange": Event;
+	"create": Event;
+}
+
+export interface IDOMEvents {
+
+	/**
+	 * Fires when the user aborts the download.
+	 * @param ev The event.
+	 */
+
+	abort?: (ev: UIEvent) => any;
+	animationcancel?: (ev: AnimationEvent) => any;
+	animationend?: (ev: AnimationEvent) => any;
+	animationiteration?: (ev: AnimationEvent) => any;
+	animationstart?: (ev: AnimationEvent) => any;
+	auxclick?: (ev: MouseEvent) => any;
+
+	/**
+	 * Fires when the object loses the input focus.
+	 * @param ev The focus event.
+	 */
+	blur?: (ev: FocusEvent) => any;
+	cancel?: (ev: Event) => any;
+
+	/**
+	 * Occurs when playback is possible, but would require further buffering.
+	 * @param ev The event.
+	 */
+	canplay?: (ev: Event) => any;
+	canplaythrough?: (ev: Event) => any;
+	/**
+	 * Fires when the contents of the object or selection have changed.
+	 * @param ev The event.
+	 */
+	change?: (ev: Event) => any;
+	/**
+	 * Fires when the user clicks the left mouse button on the object
+	 * @param ev The mouse event.
+	 */
+	click?: (ev: MouseEvent) => any;
+	close?: (ev: Event) => any;
+	/**
+	 * Fires when the user clicks the right mouse button in the client area, opening the context menu.
+	 * @param ev The mouse event.
+	 */
+	contextmenu?: (ev: MouseEvent) => any;
+	cuechange?: (ev: Event) => any;
+	/**
+	 * Fires when the user double-clicks the object.
+	 * @param ev The mouse event.
+	 */
+	dblclick?: (ev: MouseEvent) => any;
+	/**
+	 * Fires on the source object continuously during a drag operation.
+	 * @param ev The event.
+	 */
+	drag?: (ev: DragEvent) => any;
+	/**
+	 * Fires on the source object when the user releases the mouse at the close of a drag operation.
+	 * @param ev The event.
+	 */
+	dragend?: (ev: DragEvent) => any;
+	/**
+	 * Fires on the target element when the user drags the object to a valid drop target.
+	 * @param ev The drag event.
+	 */
+	dragenter?: (ev: DragEvent) => any;
+	dragexit?: (ev: Event) => any;
+	/**
+	 * Fires on the target object when the user moves the mouse out of a valid drop target during a drag operation.
+	 * @param ev The drag event.
+	 */
+	dragleave?: (ev: DragEvent) => any;
+	/**
+	 * Fires on the target element continuously while the user drags the object over a valid drop target.
+	 * @param ev The event.
+	 */
+	dragover?: (ev: DragEvent) => any;
+	/**
+	 * Fires on the source object when the user starts to drag a text selection or selected object.
+	 * @param ev The event.
+	 */
+	dragstart?: (ev: DragEvent) => any;
+	drop?: (ev: DragEvent) => any;
+	/**
+	 * Occurs when the duration attribute is updated.
+	 * @param ev The event.
+	 */
+	durationchange?: (ev: Event) => any;
+	/**
+	 * Occurs when the media element is reset to its initial state.
+	 * @param ev The event.
+	 */
+	emptied?: (ev: Event) => any;
+	/**
+	 * Occurs when the end of playback is reached.
+	 * @param ev The event
+	 */
+	ended?: (ev: Event) => any;
+	/**
+	 * Fires when an error occurs during object loading.
+	 * @param ev The event.
+	 */
+	error?: OnErrorEventHandler;
+	/**
+	 * Fires when the object receives focus.
+	 * @param ev The event.
+	 */
+	focusin?: (ev: FocusEvent) => any;
+	focusout?: (ev: FocusEvent) => any;
+	focus?: (ev: FocusEvent) => any;
+	gotpointercapture?: (ev: PointerEvent) => any;
+	input?: (ev: Event) => any;
+	invalid?: (ev: Event) => any;
+	/**
+	 * Fires when the user presses a key.
+	 * @param ev The keyboard event
+	 */
+	keydown?: (ev: KeyboardEvent) => any;
+	/**
+	 * Fires when the user presses an alphanumeric key.
+	 * @param ev The event.
+	 */
+	keypress?: (ev: KeyboardEvent) => any;
+	/**
+	 * Fires when the user releases a key.
+	 * @param ev The keyboard event
+	 */
+	keyup?: (ev: KeyboardEvent) => any;
+	/**
+	 * Fires immediately after the browser loads the object.
+	 * @param ev The event.
+	 */
+	load?: (ev: Event) => any;
+	/**
+	 * Occurs when media data is loaded at the current playback position.
+	 * @param ev The event.
+	 */
+	loadeddata?: (ev: Event) => any;
+	/**
+	 * Occurs when the duration and dimensions of the media have been determined.
+	 * @param ev The event.
+	 */
+	loadedmetadata?: (ev: Event) => any;
+	/**
+	 * Occurs when Internet Explorer begins looking for media data.
+	 * @param ev The event.
+	 */
+	loadstart?: (ev: Event) => any;
+	lostpointercapture?: (ev: PointerEvent) => any;
+	/**
+	 * Fires when the user clicks the object with either mouse button.
+	 * @param ev The mouse event.
+	 */
+	mousedown?: (ev: MouseEvent) => any;
+	mouseenter?: (ev: MouseEvent) => any;
+	mouseleave?: (ev: MouseEvent) => any;
+	/**
+	 * Fires when the user moves the mouse over the object.
+	 * @param ev The mouse event.
+	 */
+	mousemove?: (ev: MouseEvent) => any;
+	/**
+	 * Fires when the user moves the mouse pointer outside the boundaries of the object.
+	 * @param ev The mouse event.
+	 */
+	mouseout?: (ev: MouseEvent) => any;
+	/**
+	 * Fires when the user moves the mouse pointer into the object.
+	 * @param ev The mouse event.
+	 */
+	mouseover?: (ev: MouseEvent) => any;
+	/**
+	 * Fires when the user releases a mouse button while the mouse is over the object.
+	 * @param ev The mouse event.
+	 */
+	mouseup?: (ev: MouseEvent) => any;
+	/**
+	 * Occurs when playback is paused.
+	 * @param ev The event.
+	 */
+	pause?: (ev: Event) => any;
+	/**
+	 * Occurs when the play method is requested.
+	 * @param ev The event.
+	 */
+	play?: (ev: Event) => any;
+	/**
+	 * Occurs when the audio or video has started playing.
+	 * @param ev The event.
+	 */
+	playing?: (ev: Event) => any;
+	pointercancel?: (ev: PointerEvent) => any;
+	pointerdown?: (ev: PointerEvent) => any;
+	pointerenter?: (ev: PointerEvent) => any;
+	pointerleave?: (ev: PointerEvent) => any;
+	pointermove?: (ev: PointerEvent) => any;
+	pointerout?: (ev: PointerEvent) => any;
+	pointerover?: (ev: PointerEvent) => any;
+	pointerup?: (ev: PointerEvent) => any;
+	/**
+	 * Occurs to indicate progress while downloading media data.
+	 * @param ev The event.
+	 */
+	progress?: (ev: ProgressEvent) => any;
+	/**
+	 * Occurs when the playback rate is increased or decreased.
+	 * @param ev The event.
+	 */
+	ratechange?: (ev: Event) => any;
+	/**
+	 * Fires when the user resets a form.
+	 * @param ev The event.
+	 */
+	reset?: (ev: Event) => any;
+	//resize?: (ev: UIEvent) => any;	remove to avoid errors with sizechange event
+
+	/**
+	 * Fires when the user repositions the scroll box in the scroll bar on the object.
+	 * @param ev The event.
+	 */
+	scroll?: (ev: Event) => any;
+	securitypolicyviolation?: (ev: SecurityPolicyViolationEvent) => any;
+	/**
+	 * Occurs when the seek operation ends.
+	 * @param ev The event.
+	 */
+	seeked?: (ev: Event) => any;
+	/**
+	 * Occurs when the current playback position is moved.
+	 * @param ev The event.
+	 */
+	seeking?: (ev: Event) => any;
+	/**
+	 * Fires when the current selection changes.
+	 * @param ev The event.
+	 */
+	select?: (ev: Event) => any;
+	selectionchange?: (ev: Event) => any;
+	selectstart?: (ev: Event) => any;
+	/**
+	 * Occurs when the download has stopped.
+	 * @param ev The event.
+	 */
+	stalled?: (ev: Event) => any;
+	submit?: (ev: Event) => any;
+
+	/**
+	 * Occurs if the load operation has been intentionally halted.
+	 * @param ev The event.
+	 */
+	suspend?: (ev: Event) => any;
+
+	/**
+	 * Occurs to indicate the current playback position.
+	 * @param ev The event.
+	 */
+	timeupdate?: (ev: Event) => any;
+	toggle?: (ev: Event) => any;
+	ontouchcancel?: (ev: TouchEvent) => any;
+	ontouchend?: (ev: TouchEvent) => any;
+	ontouchmove?: (ev: TouchEvent) => any;
+	ontouchstart?: (ev: TouchEvent) => any;
+	transitioncancel?: (ev: TransitionEvent) => any;
+	transitionend?: (ev: TransitionEvent) => any;
+	transitionrun?: (ev: TransitionEvent) => any;
+	transitionstart?: (ev: TransitionEvent) => any;
+
+	/**
+	 * Occurs when the volume is changed, or playback is muted or unmuted.
+	 * @param ev The event.
+	 */
+	volumechange?: (ev: Event) => any;
+
+	/**
+	 * Occurs when playback stops because the next frame of a video resource is not available.
+	 * @param ev The event.
+	 */
+	waiting?: (ev: Event) => any;
+	wheel?: (ev: WheelEvent) => any;
+
+	sizechange?: (ev: Event) => void;	// occurs when size changed
+	create?: ( ev: Event ) => void;		// occurs when inserted in the document.body (dom ok)
+}

package/lib/src/drag_manager.ts

@@ -0,0 +1,199 @@
+/**
+*  ___   ___ __
+*  \  \_/  /  / _
+*   \     /  /_| |_
+*   /  _  \____   _|  
+*  /__/ \__\   |_|
+*        
+* @file drag_manager.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 { Component } from './component';
+import { Point } from './tools';
+
+const x_drag_cb = Symbol( 'x-drag-cb' );
+
+type DropCallback = ( command: 'enter' | 'leave' | 'drag' | 'drop', el: Component, point: Point ) => void;
+type FilterCallback = ( el: Component ) => boolean;
+
+/**
+ * 
+ */
+
+
+class DragManager {
+
+	dragSource: Component;
+	dragGhost: HTMLElement;
+	dropTarget: Component;
+	
+	notified: Component;
+	
+	timer;
+
+	/**
+	 * 
+	 */
+
+	registerDraggableElement(el: Component) {
+
+		el.setDomEvent('dragstart', (ev: DragEvent) => {
+
+			this.dragSource = el;
+			this.dragGhost = el.dom.cloneNode(true) as HTMLElement;
+			
+			this.dragGhost.classList.add('dragged');
+			x4document.body.appendChild(this.dragGhost);
+
+			el.addClass( 'dragging' );
+
+			ev.dataTransfer.setData('text/string', '1');
+			ev.dataTransfer.setDragImage(new Image(), 0, 0);
+
+			ev.stopPropagation( );
+		});
+
+		el.setDomEvent('drag', (ev: DragEvent) => {
+			this.dragGhost.style.left = ev.pageX + "px";
+			this.dragGhost.style.top = ev.pageY + "px";
+		});
+
+		el.setDomEvent('dragend', (ev: DragEvent) => {
+			el.removeClass( 'dragging' );
+			this.dragGhost.remove();
+		});
+
+		el.setAttribute('draggable', "true");
+	}
+
+	/**
+	 * 
+	 */
+
+	registerDropTarget(el: Component, cb: DropCallback, filterCB: FilterCallback ) {
+
+		const dragEnter = (ev: DragEvent) => {
+			if( !filterCB(this.dragSource) ) {
+				console.log( 'reject ', el );
+				ev.dataTransfer.dropEffect = 'none';	
+				return;
+			}
+
+			console.log( 'accepted ', el );
+			ev.preventDefault();
+			ev.dataTransfer.dropEffect = 'copy';
+		};
+
+		const dragOver = (ev: DragEvent) => {
+			//console.log( "dragover", ev.target );
+			
+			if( !filterCB(this.dragSource) ) {
+				console.log( 'reject ', el );
+				ev.dataTransfer.dropEffect = 'none';	
+				return;
+			}
+			
+			ev.preventDefault();
+									
+			if (this.dropTarget != el) {
+				this.dropTarget = el;
+				this._startCheck();
+			}
+
+			if( this.dropTarget ) {
+				cb( 'drag', this.dragSource, {x:ev.pageX,y:ev.pageY} );
+			}
+
+			ev.dataTransfer.dropEffect = 'copy';
+		};
+
+		const dragLeave = (ev: DragEvent) => {
+			//console.log( "dragleave", ev.target );
+			this.dropTarget = null;
+			ev.preventDefault();
+		};
+
+		const drop = (ev: DragEvent) => {
+			cb('drop', this.dragSource, {x:ev.pageX,y:ev.pageY} );
+			
+			this.dropTarget = null;
+			el.removeClass('drop-over');
+		}
+
+		el.setDomEvent('dragenter', dragEnter);
+		el.setDomEvent('dragover', dragOver);
+		el.setDomEvent('dragleave', dragLeave);
+		el.setDomEvent('drop', drop);
+
+		el.setData( x_drag_cb, cb );
+	}
+
+	_startCheck() {
+
+		if (this.timer) {
+			clearInterval(this.timer);
+			this._check( );
+		}
+
+		this.timer = setInterval( () => this._check(), 300 );
+	}
+
+	_check( ) {
+
+		const leaving = ( x ) => {
+			x.removeClass('drop-over');
+
+			const cb = x.getData( x_drag_cb );
+			cb( 'leave', this.dragSource );
+		}
+
+		const entering = ( x ) => {
+			x.addClass('drop-over');
+			const cb = x.getData( x_drag_cb );
+			cb( 'enter', this.dragSource );
+		}
+	
+		if (this.dropTarget) {
+			if (!this.notified || this.notified != this.dropTarget) {
+
+				if( this.notified ) {
+					leaving( this.notified );
+				}
+		
+				this.notified = this.dropTarget;
+				entering( this.notified );
+			}
+		}
+		else {
+			if (this.notified) {
+				leaving( this.notified );
+				this.notified = null;
+
+				clearInterval(this.timer);
+			}
+		}
+	}
+}
+
+export const dragManager = new DragManager();