@next2d/events 1.18.12 → 2.0.0

package/src/HTTPStatusEvent.js

@@ -0,0 +1,99 @@
+import { Event } from "./Event";
+/**
+ * @description ネットワーク要求が HTTP ステータスコードを返すと、アプリケーションによって HTTPStatusEvent オブジェクトが送出されます。
+ *              The application dispatches HTTPStatusEvent objects when a network request returns an HTTP status code.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class HTTPStatusEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=false]
+     * @param {number}  [status=0]
+     * @param {string}  [response_url=""]
+     * @param {array}   [response_headers=[]]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = false, status = 0, response_url = "", response_headers = []) {
+        super(type, bubbles);
+        /**
+         * @description サーバーから返された HTTP ステータスコードです。
+         *              The HTTP status code returned by the server.
+         *
+         * @return {number}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "status", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 返された応答ヘッダー（URLRequestHeader オブジェクトの配列）です。
+         *              The response headers that the response returned,
+         *              as an array of URLRequestHeader objects.
+         *
+         * @return {array}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "responseHeaders", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 応答の返送元の URL です。
+         *              The URL that the response was returned from.
+         *
+         * @return {string}
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "responseURL", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @type {number}
+         * @default 0
+         * @private
+         */
+        this.status = status | 0;
+        /**
+         * @type {array}
+         * @default {array}
+         * @private
+         */
+        this.responseHeaders = response_headers;
+        /**
+         * @type {string}
+         * @default ""
+         * @private
+         */
+        this.responseURL = response_url;
+    }
+    /**
+     * @description HTTPStatusEvent.HTTP_STATUS 定数は、
+     *              httpStatus イベントオブジェクトの type プロパティの値を定義します。
+     *              The HTTPStatusEvent.HTTP_STATUS constant defines the value
+     *              of the type property of a httpStatus event object.
+     *
+     * @return {string}
+     * @default "httpStatus"
+     * @const
+     * @static
+     */
+    static get HTTP_STATUS() {
+        return "httpStatus";
+    }
+}

package/src/IOErrorEvent.d.ts

@@ -0,0 +1,39 @@
+import { Event } from "./Event";
+/**
+ * @description IOErrorEvent オブジェクトは、エラーが発生して入力操作または出力操作が失敗したときに送出されます。
+ *              An IOErrorEvent object is dispatched when an error causes input or output operations to fail.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export declare class IOErrorEvent extends Event {
+    /**
+     * @description エラーテキストです。
+     *              error text.
+     *
+     * @return {string}
+     * @default ""
+     * @readonly
+     * @public
+     */
+    readonly text: string;
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     * @param {string}  [text=""]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type: string, bubbles?: boolean, text?: string);
+    /**
+     * @description ioError イベントオブジェクトの type プロパティ値を定義します。
+     *              Defines the value of the type property of an ioError event object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get IO_ERROR(): string;
+}

package/src/IOErrorEvent.js

@@ -0,0 +1,49 @@
+import { Event } from "./Event";
+/**
+ * @description IOErrorEvent オブジェクトは、エラーが発生して入力操作または出力操作が失敗したときに送出されます。
+ *              An IOErrorEvent object is dispatched when an error causes input or output operations to fail.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class IOErrorEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     * @param {string}  [text=""]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = false, text = "") {
+        super(type, bubbles);
+        /**
+         * @description エラーテキストです。
+         *              error text.
+         *
+         * @return {string}
+         * @default ""
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "text", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.text = `${text}`;
+    }
+    /**
+     * @description ioError イベントオブジェクトの type プロパティ値を定義します。
+     *              Defines the value of the type property of an ioError event object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get IO_ERROR() {
+        return "ioError";
+    }
+}

package/src/JobEvent.d.ts

@@ -0,0 +1,29 @@
+import { Event } from "./Event";
+/**
+ * @description Tween処理に関するイベントを示します。
+ *              Indicates events related to Tween processing.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export declare class JobEvent extends Event {
+    /**
+     * @description Jobのプロパティが更新されたときに発生します。
+     *              Occurs when the Job property is updated.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get UPDATE(): string;
+    /**
+     * @description TweenのJobが停止したときに発生します。
+     *              Occurs when the Tween Job is stopped.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get STOP(): string;
+}

package/src/JobEvent.js

@@ -0,0 +1,33 @@
+import { Event } from "./Event";
+/**
+ * @description Tween処理に関するイベントを示します。
+ *              Indicates events related to Tween processing.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class JobEvent extends Event {
+    /**
+     * @description Jobのプロパティが更新されたときに発生します。
+     *              Occurs when the Job property is updated.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get UPDATE() {
+        return "jobupdate";
+    }
+    /**
+     * @description TweenのJobが停止したときに発生します。
+     *              Occurs when the Tween Job is stopped.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get STOP() {
+        return "jobstop";
+    }
+}

package/src/KeyboardEvent.d.ts

@@ -0,0 +1,37 @@
+import { Event } from "./Event";
+/**
+ * @description キーボードによるユーザーの操作を示します。
+ *              Indicates user operation via keyboard.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export declare class KeyboardEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type: string, bubbles?: boolean);
+    /**
+     * @description キーボードのキーが押される度に発生します。
+     *              Occurs each time a key is pressed on the keyboard.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get KEY_DOWN(): string;
+    /**
+     * @description キーボードのキーが離されたときに発生します。
+     *              Occurs when a key on the keyboard is released.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get KEY_UP(): string;
+}

package/src/KeyboardEvent.js

@@ -0,0 +1,66 @@
+import { $getEvent } from "./EventUtil";
+import { Event } from "./Event";
+/**
+ * @description キーボードによるユーザーの操作を示します。
+ *              Indicates user operation via keyboard.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class KeyboardEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = true) {
+        super(type, bubbles);
+        return new Proxy(this, {
+            "get": (object, name) => {
+                if (name in object) {
+                    return object[name];
+                }
+                const event = $getEvent();
+                if (!event) {
+                    return undefined;
+                }
+                switch (event.type) {
+                    case KeyboardEvent.KEY_DOWN:
+                    case KeyboardEvent.KEY_UP:
+                        if (name in event) {
+                            // @ts-ignore
+                            return $event[name];
+                        }
+                        return undefined;
+                    default:
+                        return undefined;
+                }
+            }
+        });
+    }
+    /**
+     * @description キーボードのキーが押される度に発生します。
+     *              Occurs each time a key is pressed on the keyboard.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get KEY_DOWN() {
+        return "keydown";
+    }
+    /**
+     * @description キーボードのキーが離されたときに発生します。
+     *              Occurs when a key on the keyboard is released.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get KEY_UP() {
+        return "keyup";
+    }
+}

package/src/PointerEvent.d.ts

@@ -0,0 +1,84 @@
+import { Event } from "./Event";
+/**
+ * @description ポインターは、入力機器（マウス、ペン、またはタッチ可能な面の上の接触点など）のハードウェアにとらわれない表現です。
+ *              ポインターは、画面などの接触面上の特定の座標（または座標の集合）をターゲットにすることができます。
+ *              A pointer is a hardware-agnostic representation of an input device (such as a mouse, pen, or point of contact on a touchable surface).
+ *              A pointer can target a specific coordinate (or set of coordinates) on a screen or other contact surface.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export declare class PointerEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type: string, bubbles?: boolean);
+    /**
+     * @description ボタンが連続で押された時に発生します。
+     *              Occurs when a button is pressed continuously.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get DOUBLE_CLICK(): string;
+    /**
+     * @description ボタンが押されていない状態から 1 つ以上のボタンが押されている状態に遷移したときに発生します
+     *              Occurs when one or more buttons are pressed from the state where no buttons are pressed.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_DOWN(): string;
+    /**
+     * @description ポインティングデバイスが要素のヒットテスト領域を出た時に発生します
+     *              Occurs when the pointing device leaves the hit test area of an element
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_LEAVE(): string;
+    /**
+     * @description ポインターの座標が変化し、かつタッチ操作によってポインターがキャンセルされていないときに発生します。
+     *              Occurs when the pointer coordinates change and the pointer is not canceled by a touch operation.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_MOVE(): string;
+    /**
+     * @description ヒットテスト境界を出たに発生します。ホバーに対応していない端末では発生しません。
+     *              Occurs when the hit test boundary is exited. Does not occur on devices that do not support hover.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_OUT(): string;
+    /**
+     * @description インティングデバイスが要素のヒットテスト境界内に移動したときに発生します。
+     *              Occurs when the pointing device moves into the hit test boundary of an element.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_OVER(): string;
+    /**
+     * @description ポインターがアクティブではなくなったときに発生します。
+     *              Occurs when the pointer is no longer active.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_UP(): string;
+}

package/src/PointerEvent.js

@@ -0,0 +1,127 @@
+import { Event } from "./Event";
+import { $getEvent } from "./EventUtil";
+/**
+ * @description ポインターは、入力機器（マウス、ペン、またはタッチ可能な面の上の接触点など）のハードウェアにとらわれない表現です。
+ *              ポインターは、画面などの接触面上の特定の座標（または座標の集合）をターゲットにすることができます。
+ *              A pointer is a hardware-agnostic representation of an input device (such as a mouse, pen, or point of contact on a touchable surface).
+ *              A pointer can target a specific coordinate (or set of coordinates) on a screen or other contact surface.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class PointerEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = true) {
+        super(type, bubbles);
+        return new Proxy(this, {
+            "get": (object, name) => {
+                if (name in object) {
+                    return object[name];
+                }
+                const event = $getEvent();
+                if (!event) {
+                    return undefined;
+                }
+                switch (event.type) {
+                    case PointerEvent.POINTER_DOWN:
+                    case PointerEvent.POINTER_MOVE:
+                    case PointerEvent.POINTER_UP:
+                    case PointerEvent.POINTER_LEAVE:
+                    case PointerEvent.POINTER_OVER:
+                    case PointerEvent.POINTER_OUT:
+                        if (name in event) {
+                            // @ts-ignore
+                            return $event[name];
+                        }
+                        return undefined;
+                    default:
+                        return undefined;
+                }
+            }
+        });
+    }
+    /**
+     * @description ボタンが連続で押された時に発生します。
+     *              Occurs when a button is pressed continuously.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get DOUBLE_CLICK() {
+        return "dblclick";
+    }
+    /**
+     * @description ボタンが押されていない状態から 1 つ以上のボタンが押されている状態に遷移したときに発生します
+     *              Occurs when one or more buttons are pressed from the state where no buttons are pressed.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_DOWN() {
+        return "pointerdown";
+    }
+    /**
+     * @description ポインティングデバイスが要素のヒットテスト領域を出た時に発生します
+     *              Occurs when the pointing device leaves the hit test area of an element
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_LEAVE() {
+        return "pointerleave";
+    }
+    /**
+     * @description ポインターの座標が変化し、かつタッチ操作によってポインターがキャンセルされていないときに発生します。
+     *              Occurs when the pointer coordinates change and the pointer is not canceled by a touch operation.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_MOVE() {
+        return "pointermove";
+    }
+    /**
+     * @description ヒットテスト境界を出たに発生します。ホバーに対応していない端末では発生しません。
+     *              Occurs when the hit test boundary is exited. Does not occur on devices that do not support hover.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_OUT() {
+        return "pointerout";
+    }
+    /**
+     * @description インティングデバイスが要素のヒットテスト境界内に移動したときに発生します。
+     *              Occurs when the pointing device moves into the hit test boundary of an element.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_OVER() {
+        return "pointerover";
+    }
+    /**
+     * @description ポインターがアクティブではなくなったときに発生します。
+     *              Occurs when the pointer is no longer active.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get POINTER_UP() {
+        return "pointerup";
+    }
+}

package/src/ProgressEvent.d.ts

@@ -0,0 +1,53 @@
+import { Event } from "./Event";
+/**
+ * @description ProgressEvent オブジェクトは、ロード処理が開始されたとき、またはソケットがデータを受信したときに送出されます。
+ *              これらのイベントは通常、JSON ファイル、イメージまたはデータがアプリケーションにロードされるときに生成されます。
+ *              A ProgressEvent object is dispatched when a load operation has begun or a socket has received data.
+ *              These events are usually generated when JSON files, images or data are loaded into an application.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export declare class ProgressEvent extends Event {
+    /**
+     * @description リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。
+     *              The number of items or bytes loaded when the listener processes the event.
+     *
+     * @return {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    readonly bytesLoaded: number;
+    /**
+     * @description 読み込みプロセスが成功した場合に読み込まれるアイテムまたはバイトの総数です。
+     *              The total number of items or bytes that will be loaded
+     *              if the loading process succeeds.
+     *
+     * @return {number}
+     * @default 0
+     * @readonly
+     * @public
+     */
+    readonly bytesTotal: number;
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     * @param {number}  [bytes_loaded=0]
+     * @param {number}  [bytes_total=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type: string, bubbles?: boolean, bytes_loaded?: number, bytes_total?: number);
+    /**
+     * @description progress イベントオブジェクトの type プロパティ値を定義します。
+     *              Defines the value of the type property of a progress event object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get PROGRESS(): string;
+}

package/src/ProgressEvent.js

@@ -0,0 +1,69 @@
+import { Event } from "./Event";
+/**
+ * @description ProgressEvent オブジェクトは、ロード処理が開始されたとき、またはソケットがデータを受信したときに送出されます。
+ *              これらのイベントは通常、JSON ファイル、イメージまたはデータがアプリケーションにロードされるときに生成されます。
+ *              A ProgressEvent object is dispatched when a load operation has begun or a socket has received data.
+ *              These events are usually generated when JSON files, images or data are loaded into an application.
+ *
+ * @class
+ * @memberOf next2d.events
+ * @extends  Event
+ */
+export class ProgressEvent extends Event {
+    /**
+     * @param {string}  type
+     * @param {boolean} [bubbles=true]
+     * @param {number}  [bytes_loaded=0]
+     * @param {number}  [bytes_total=0]
+     *
+     * @constructor
+     * @public
+     */
+    constructor(type, bubbles = false, bytes_loaded = 0, bytes_total = 0) {
+        super(type, bubbles);
+        /**
+         * @description リスナーがイベントを処理しているときに読み込まれたアイテム数またはバイト数です。
+         *              The number of items or bytes loaded when the listener processes the event.
+         *
+         * @return {number}
+         * @default 0
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "bytesLoaded", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        /**
+         * @description 読み込みプロセスが成功した場合に読み込まれるアイテムまたはバイトの総数です。
+         *              The total number of items or bytes that will be loaded
+         *              if the loading process succeeds.
+         *
+         * @return {number}
+         * @default 0
+         * @readonly
+         * @public
+         */
+        Object.defineProperty(this, "bytesTotal", {
+            enumerable: true,
+            configurable: true,
+            writable: true,
+            value: void 0
+        });
+        this.bytesLoaded = bytes_loaded | 0;
+        this.bytesTotal = bytes_total | 0;
+    }
+    /**
+     * @description progress イベントオブジェクトの type プロパティ値を定義します。
+     *              Defines the value of the type property of a progress event object.
+     *
+     * @return {string}
+     * @const
+     * @static
+     */
+    static get PROGRESS() {
+        return "progress";
+    }
+}