@next2d/events 1.18.11 → 2.0.0

package/package.json

@@ -1,26 +1,18 @@
 {
   "name": "@next2d/events",
-  "version": "1.18.11",
-  "description": "Next2D Events Packages",
-  "author": "Toshiyuki Ienaga<ienaga@tvon.jp> (https://github.com/ienaga/)",
+  "version": "2.0.0",
+  "description": "Next2D Events Package",
+  "author": "Toshiyuki Ienaga<ienaga@next2d.app> (https://github.com/ienaga/)",
   "license": "MIT",
   "homepage": "https://next2d.app",
   "bugs": "https://github.com/Next2D/Player/issues",
-  "main": "dist/index.js",
-  "types": "dist/index.d.ts",
-  "files": [
-    "dist"
-  ],
+  "main": "src/index.js",
+  "types": "src/index.d.ts",
+  "type": "module",
   "exports": {
     ".": {
-      "import": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      },
-      "require": {
-        "types": "./dist/index.d.ts",
-        "default": "./dist/index.js"
-      }
+      "import": "./src/index.js",
+      "require": "./src/index.js"
     }
   },
   "keywords": [
@@ -30,13 +22,5 @@
   "repository": {
     "type": "git",
     "url": "git+https://github.com/Next2D/Player.git"
-  },
-  "peerDependencies": {
-    "@next2d/interface": "1.18.11",
-    "@next2d/display": "1.18.11",
-    "@next2d/core": "1.18.11",
-    "@next2d/util": "1.18.11",
-    "@next2d/net": "1.18.11",
-    "@next2d/share": "1.18.11"
   }
 }

package/src/Event.d.ts

@@ -0,0 +1,222 @@
+import type { EventDispatcher } from "./EventDispatcher";
+import type { IEventDispatcher } from "./interface/IEventDispatcher";
+/**
+ * @description Event クラスのメソッドは、イベントリスナー関数で使用してイベントオブジェクトの動作に影響を与えることができます。
+ *              一部のイベントにはデフォルトの動作が関連付けられています。
+ *              例えば、doubleClick イベントには、イベント時にマウスポインター位置の単語がハイライト表示されるというデフォルトの動作が関連付けられています。
+ *              イベントリスナーで preventDefault() メソッドを呼び出してこの動作をキャンセルできます。
+ *              また、stopPropagation() メソッドまたは stopImmediatePropagation() メソッドを呼び出すと、
+ *              現在のイベントリスナーを、イベントを処理する最後のイベントリスナーにすることができます。
+ *
+ *              The methods of the Event class can be used in event listener functions to affect the behavior of the event object.
+ *              Some events have an associated default behavior. For example,
+ *              the doubleClick event has an associated default behavior that highlights the word under the mouse pointer at the time of the event.
+ *              Your event listener can cancel this behavior by calling the preventDefault() method.
+ *              You can also make the current event listener the last one to process
+ *              an event by calling the stopPropagation() or stopImmediatePropagation() method.
+ *
+ * @class
+ * @memberOf next2d.events
+ */
+export declare class Event {
+    /**
+     * @description イベントのタイプです。
+     *              The type of event.
+     *
+     * @member {string}
+     * @readonly
+     * @public
+     */
+    readonly type: string;
+    /**
+     * @description イベントがバブリングイベントかどうかを示します。
+     *              Indicates whether an event is a bubbling event.
+     *
+     * @member {boolean}
+     * @default false
+     * @readonly
+     * @public
+     */
+    readonly bubbles: boolean;
+    /**
+     * @description 実行される関数
+     *              The function to execute.
+     *
+     * @type {Function | null}
+     * @default null
+     * @public
+     */
+    listener: Function | null;
+    /**
+     * @description イベント登録を行なったオブジェクト
+     *              The object that registered the event.
+     *
+     * @type {EventDispatcher | null}
+     * @default null
+     * @public
+     */
+    target: IEventDispatcher<EventDispatcher> | null;
+    /**
+     * @description イベントを発火したオブジェクト
+     *              The object that fired the event.
+     *
+     * @type {EventDispatcher | null}
+     * @default null
+     * @public
+     */
+    currentTarget: IEventDispatcher<EventDispatcher> | null;
+    /**
+     * @description イベントフェーズ
+     *              Event phase.
+     *
+     * @see {EventPhase}
+     * @type {number}
+     * @default EventPhase.AT_TARGET
+     * @public
+     */
+    eventPhase: number;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    _$stopImmediatePropagation: boolean;
+    /**
+     * @type {boolean}
+     * @private
+     */
+    _$stopPropagation: boolean;
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=false]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type: string, bubbles?: boolean);
+    /**
+     * @description Sprite または MovieClip を親に持つオブジェクトに追加されたときに発生します。
+     *              Occurs when the object is added to a parent object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ADDED(): string;
+    /**
+     * @description Stage に追加されたときに発生します。
+     *              Occurs when the object is added to the Stage.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ADDED_TO_STAGE(): string;
+    /**
+     * @description 読み込みや、処理完了時に発生します。
+     *              Occurs when loading or processing is complete.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get COMPLETE(): string;
+    /**
+     * @description サウンドやビデオなどの再生処理の終了時に発生します。
+     *              Occurs when playback of a sound or video ends.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ENDED(): string;
+    /**
+     * @description MovieClip のフレームが変更される度に発生します。
+     *              Occurs when the frame of a MovieClip changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ENTER_FRAME(): string;
+    /**
+     * @description MovieClip のフレームラベルのキーフレームに到達したときに発生します。
+     *              Occurs when a MovieClip reaches a keyframe that designates a frame label.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get FRAME_LABEL(): string;
+    /**
+     * @description データの読み込み開始時に発生します。
+     *              Occurs when sound data loading starts.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get INPUT(): string;
+    /**
+     * @description データの読み込み開始時に発生します。
+     *              Occurs when sound data loading starts.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get OPEN(): string;
+    /**
+     * @description Sprite または MovieClip を親に持つオブジェクトから削除されたときに発生します。
+     *              Occurs when the object is removed from a parent object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get REMOVED(): string;
+    /**
+     * @description Stage から削除されたときに発生します。
+     *              Occurs when the object is removed from the Stage.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get REMOVED_FROM_STAGE(): string;
+    /**
+     * @description 画面のサイズが変更されたときに発生します。
+     *              Occurs when the screen size changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get RESIZE(): string;
+    /**
+     * @description スクロール位置が変更されたときに発生します。
+     *              Occurs when the scroll position changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get SCROLL(): string;
+    /**
+     * @description イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
+     *              Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stopImmediatePropagation(): void;
+    /**
+     * @description イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
+     *              Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stopPropagation(): void;
+}

package/src/Event.js

@@ -0,0 +1,337 @@
+import { EventPhase } from "./EventPhase";
+/**
+ * @description Event クラスのメソッドは、イベントリスナー関数で使用してイベントオブジェクトの動作に影響を与えることができます。
+ *              一部のイベントにはデフォルトの動作が関連付けられています。
+ *              例えば、doubleClick イベントには、イベント時にマウスポインター位置の単語がハイライト表示されるというデフォルトの動作が関連付けられています。
+ *              イベントリスナーで preventDefault() メソッドを呼び出してこの動作をキャンセルできます。
+ *              また、stopPropagation() メソッドまたは stopImmediatePropagation() メソッドを呼び出すと、
+ *              現在のイベントリスナーを、イベントを処理する最後のイベントリスナーにすることができます。
+ *
+ *              The methods of the Event class can be used in event listener functions to affect the behavior of the event object.
+ *              Some events have an associated default behavior. For example,
+ *              the doubleClick event has an associated default behavior that highlights the word under the mouse pointer at the time of the event.
+ *              Your event listener can cancel this behavior by calling the preventDefault() method.
+ *              You can also make the current event listener the last one to process
+ *              an event by calling the stopPropagation() or stopImmediatePropagation() method.
+ *
+ * @class
+ * @memberOf next2d.events
+ */
+export class Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=false]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = false) {
+        /**
+         * @description イベントのタイプです。
+         *              The type of event.
+         *
+         * @member {string}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "type", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description イベントがバブリングイベントかどうかを示します。
+         *              Indicates whether an event is a bubbling event.
+         *
+         * @member {boolean}
+         * @default false
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "bubbles", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 実行される関数
+         *              The function to execute.
+         *
+         * @type {Function | null}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "listener", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description イベント登録を行なったオブジェクト
+         *              The object that registered the event.
+         *
+         * @type {EventDispatcher | null}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "target", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description イベントを発火したオブジェクト
+         *              The object that fired the event.
+         *
+         * @type {EventDispatcher | null}
+         * @default null
+         * @public
+         */
+        Object.defineProperty(this, "currentTarget", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description イベントフェーズ
+         *              Event phase.
+         *
+         * @see {EventPhase}
+         * @type {number}
+         * @default EventPhase.AT_TARGET
+         * @public
+         */
+        Object.defineProperty(this, "eventPhase", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {boolean}
+         * @private
+         */
+        Object.defineProperty(this, "_$stopImmediatePropagation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {boolean}
+         * @private
+         */
+        Object.defineProperty(this, "_$stopPropagation", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {string}
+         * @private
+         */
+        this.type = `${type}`;
+        /**
+         * @type {boolean}
+         * @default false
+         * @private
+         */
+        this.bubbles = bubbles;
+        /**
+         * @type {EventDispatcher | null}
+         * @default null
+         * @private
+         */
+        this.target = null;
+        /**
+         * @type {EventDispatcher | null}
+         * @default null
+         * @private
+         */
+        this.currentTarget = null;
+        /**
+         * @type {number}
+         * @default EventPhase.AT_TARGET
+         * @private
+         */
+        this.eventPhase = EventPhase.AT_TARGET;
+        /**
+         * @type {function}
+         * @default null
+         * @private
+         */
+        this.listener = null;
+        /**
+         * @type {boolean}
+         * @default false
+         * @private
+         */
+        this._$stopImmediatePropagation = false;
+        /**
+         * @type {boolean}
+         * @default false
+         * @private
+         */
+        this._$stopPropagation = false;
+    }
+    /**
+     * @description Sprite または MovieClip を親に持つオブジェクトに追加されたときに発生します。
+     *              Occurs when the object is added to a parent object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ADDED() {
+        return "added";
+    }
+    /**
+     * @description Stage に追加されたときに発生します。
+     *              Occurs when the object is added to the Stage.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ADDED_TO_STAGE() {
+        return "addedToStage";
+    }
+    /**
+     * @description 読み込みや、処理完了時に発生します。
+     *              Occurs when loading or processing is complete.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get COMPLETE() {
+        return "complete";
+    }
+    /**
+     * @description サウンドやビデオなどの再生処理の終了時に発生します。
+     *              Occurs when playback of a sound or video ends.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ENDED() {
+        return "ended";
+    }
+    /**
+     * @description MovieClip のフレームが変更される度に発生します。
+     *              Occurs when the frame of a MovieClip changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get ENTER_FRAME() {
+        return "enterFrame";
+    }
+    /**
+     * @description MovieClip のフレームラベルのキーフレームに到達したときに発生します。
+     *              Occurs when a MovieClip reaches a keyframe that designates a frame label.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get FRAME_LABEL() {
+        return "frameLabel";
+    }
+    /**
+     * @description データの読み込み開始時に発生します。
+     *              Occurs when sound data loading starts.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get INPUT() {
+        return "input";
+    }
+    /**
+     * @description データの読み込み開始時に発生します。
+     *              Occurs when sound data loading starts.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get OPEN() {
+        return "open";
+    }
+    /**
+     * @description Sprite または MovieClip を親に持つオブジェクトから削除されたときに発生します。
+     *              Occurs when the object is removed from a parent object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get REMOVED() {
+        return "removed";
+    }
+    /**
+     * @description Stage から削除されたときに発生します。
+     *              Occurs when the object is removed from the Stage.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get REMOVED_FROM_STAGE() {
+        return "removedFromStage";
+    }
+    /**
+     * @description 画面のサイズが変更されたときに発生します。
+     *              Occurs when the screen size changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get RESIZE() {
+        return "resize";
+    }
+    /**
+     * @description スクロール位置が変更されたときに発生します。
+     *              Occurs when the scroll position changes.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get SCROLL() {
+        return "scroll";
+    }
+    /**
+     * @description イベントフローの現在のノードおよび後続するノードで、イベントリスナーが処理されないようにします。
+     *              Prevents processing of any event listeners in the current node and any subsequent nodes in the event flow.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stopImmediatePropagation() {
+        this._$stopImmediatePropagation = true;
+    }
+    /**
+     * @description イベントフローの現在のノードに後続するノードで、イベントリスナーが処理されないようにします。
+     *              Prevents processing of any event listeners in nodes subsequent to the current node in the event flow.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    stopPropagation() {
+        this._$stopPropagation = true;
+    }
+}

package/src/EventDispatcher/service/EventDispatcherAddEventListenerService.d.ts

@@ -0,0 +1,14 @@
+import type { EventDispatcher } from "../../EventDispatcher";
+/**
+ * @description 指定イベントに関数を登録、既に登録されている場合は上書。
+ *              Register a function in the specified event, or overwrite if already registered.
+ *
+ * @param {EventDispatcher} scope
+ * @param {string} type
+ * @param {Function} listener
+ * @param {boolean} [use_capture = false]
+ * @param {number} [priority = 0]
+ * @method
+ * @protected
+ */
+export declare const execute: <D extends EventDispatcher>(scope: D, type: string, listener: Function, use_capture?: boolean, priority?: number) => void;