import { Point } from '@pixi/core';
import type { EventBoundary } from './EventBoundary';
import type { FederatedEventTarget } from './FederatedEventTarget';
/**
* An DOM-compatible synthetic event implementation that is "forwarded" on behalf of an original
* FederatedEvent or native Event.
* @memberof PIXI
* @typeParam N - The type of native event held.
*/
export class FederatedEvent<N extends UIEvent = UIEvent> implements UIEvent
{
/** Flags whether this event bubbles. This will take effect only if it is set before propagation. */
public bubbles = true;
/** @deprecated since 7.0.0 */
public cancelBubble = true;
/**
* Flags whether this event can be canceled using FederatedEvent.preventDefault. This is always
* false (for now).
*/
public readonly cancelable = false;
/**
* Flag added for compatibility with DOM Event. It is not used in the Federated Events
* API.
* @see https://dom.spec.whatwg.org/#dom-event-composed
*/
public readonly composed = false;
/** The listeners of the event target that are being notified. */
public currentTarget: FederatedEventTarget;
/** Flags whether the default response of the user agent was prevent through this event. */
public defaultPrevented = false;
/**
* The propagation phase.
* @default FederatedEvent.NONE
*/
public eventPhase = FederatedEvent.prototype.NONE;
/** Flags whether this is a user-trusted event */
public isTrusted: boolean;
/** @deprecated since 7.0.0 */
public returnValue: boolean;
/** @deprecated since 7.0.0 */
public srcElement: EventTarget;
/** The event target that this will be dispatched to. */
public target: FederatedEventTarget;
/** The timestamp of when the event was created. */
public timeStamp: number;
/** The type of event, e.g. "mouseup". */
public type: string;
/** The native event that caused the foremost original event. */
public nativeEvent: N;
/** The original event that caused this event, if any. */
public originalEvent: FederatedEvent<N>;
/** Flags whether propagation was stopped. */
public propagationStopped = false;
/** Flags whether propagation was immediately stopped. */
public propagationImmediatelyStopped = false;
/** The composed path of the event's propagation. The target is at the end. */
public path: FederatedEventTarget[];
/** The EventBoundary that manages this event. Null for root events. */
public readonly manager: EventBoundary;
/** Event-specific detail */
public detail: number;
/** The global Window object. */
public view: WindowProxy;
/**
* Not supported.
* @deprecated since 7.0.0
*/
public which: number;
/** The coordinates of the evnet relative to the nearest DOM layer. This is a non-standard property. */
public layer: Point = new Point();
/** @readonly */
get layerX(): number { return this.layer.x; }
/** @readonly */
get layerY(): number { return this.layer.y; }
/** The coordinates of the event relative to the DOM document. This is a non-standard property. */
public page: Point = new Point();
/** @readonly */
get pageX(): number { return this.page.x; }
/** @readonly */
get pageY(): number { return this.page.y; }
/**
* @param manager - The event boundary which manages this event. Propagation can only occur
* within the boundary's jurisdiction.
*/
constructor(manager: EventBoundary)
{
this.manager = manager;
}
/**
* Fallback for the deprecated PIXI.InteractionEvent.data.
* @deprecated since 7.0.0
*/
get data(): this
{
return this;
}
/** The propagation path for this event. Alias for EventBoundary.propagationPath. */
composedPath(): FederatedEventTarget[]
{
// Find the propagation path if it isn't cached or if the target has changed since since
// the last evaluation.
if (this.manager && (!this.path || this.path[this.path.length - 1] !== this.target))
{
this.path = this.target ? this.manager.propagationPath(this.target) : [];
}
return this.path;
}
/**
* Unimplemented method included for implementing the DOM interface Event. It will throw an Error.
* @deprecated
* @param _type
* @param _bubbles
* @param _cancelable
*/
initEvent(_type: string, _bubbles?: boolean, _cancelable?: boolean): void
{
throw new Error('initEvent() is a legacy DOM API. It is not implemented in the Federated Events API.');
}
/**
* Unimplemented method included for implementing the DOM interface UIEvent. It will throw an Error.
* @deprecated
* @param _typeArg
* @param _bubblesArg
* @param _cancelableArg
* @param _viewArg
* @param _detailArg
*/
initUIEvent(_typeArg: string, _bubblesArg?: boolean, _cancelableArg?: boolean, _viewArg?: Window | null,
_detailArg?: number): void
{
throw new Error('initUIEvent() is a legacy DOM API. It is not implemented in the Federated Events API.');
}
/** Prevent default behavior of PixiJS and the user agent. */
preventDefault(): void
{
if (this.nativeEvent instanceof Event && this.nativeEvent.cancelable)
{
this.nativeEvent.preventDefault();
}
this.defaultPrevented = true;
}
/**
* Stop this event from propagating to any addition listeners, including on the
* currentTarget and also the following
* event targets on the propagation path.
*/
stopImmediatePropagation(): void
{
this.propagationImmediatelyStopped = true;
}
/**
* Stop this event from propagating to the next FederatedEventTarget. The rest of the listeners
* on the currentTarget will still be notified.
*/
stopPropagation(): void
{
this.propagationStopped = true;
}
AT_TARGET = 1;
BUBBLING_PHASE = 2;
CAPTURING_PHASE = 3;
NONE = 0;
}