@next2d/text 1.18.12 → 2.0.0

package/src/TextField.d.ts

@@ -0,0 +1,602 @@
+import type { IBounds } from "./interface/IBounds";
+import type { ITextFieldAutoSize } from "./interface/ITextFieldAutoSize";
+import type { ITextFieldType } from "./interface/ITextFieldType";
+import type { ICharacter } from "./interface/ICharacter";
+import type { LoaderInfo } from "@next2d/display";
+import { TextData } from "./TextData";
+import { TextFormat } from "./TextFormat";
+import { InteractiveObject, Shape } from "@next2d/display";
+/**
+ * @description TextField クラスは、テキストの表示と入力用の表示オブジェクトを作成するために使用されます。
+ *              プロパティインスペクターを使用して、テキストフィールドにインスタンス名を付けることができます。
+ *              また、TextField クラスのメソッドとプロパティを使用して、JavaScript でテキストフィールドを操作できます。
+ *
+ *              The TextField class is used to create display objects for text display and input.
+ *              You can give a text field an instance name in the Property inspector
+ *              nd use the methods and properties of the TextField class to manipulate it with JavaScript.
+ *
+ * @class
+ * @memberOf next2d.display
+ * @extends  InteractiveObject
+ */
+export declare class TextField extends InteractiveObject {
+    /**
+     * @description TextFieldの機能を所持しているかを返却
+     *              Returns whether the display object has TextField functionality.
+     *
+     * @type {boolean}
+     * @readonly
+     * @public
+     */
+    readonly isText: boolean;
+    /**
+     * @description セットされたテキストを描画用に分解したデータ
+     *              Data that breaks down the set text for drawing
+     *
+     * @member {TextData}
+     * @protected
+     */
+    $textData: TextData | null;
+    /**
+     * @description テキストが HTML であるかどうかを示します。
+     *              Indicates whether the text is HTML.
+     *
+     * @member {boolean}
+     * @private
+     */
+    private _$isHTML;
+    /**
+     * @description バウンディングボックスのxMin座標
+     *              Bounding box coordinates
+     *
+     * @member {number}
+     * @public
+     */
+    xMin: number;
+    /**
+     * @description バウンディングボックスのyMin座標
+     *              Bounding box coordinates
+     *
+     * @member {number}
+     * @public
+     */
+    yMin: number;
+    /**
+     * @description バウンディングボックスのxMax座標
+     *              Bounding box coordinates
+     *
+     * @member {number}
+     * @public
+     */
+    xMax: number;
+    /**
+     * @description バウンディングボックスのyMax座標
+     *              Bounding box coordinates
+     *
+     * @member {number}
+     * @public
+     */
+    yMax: number;
+    /**
+     * @description テキストフィールドの描画範囲のバウンディングボックス
+     *              The bounding box of the drawing area of the text field
+     *
+     * @member {IBounds}
+     * @private
+     */
+    readonly bounds: IBounds;
+    /**
+     * @description スクロール機能のON/OFFの制御。
+     *              Control ON/OFF of the scroll function.
+     *
+     * @member  {boolean}
+     * @default true
+     * @public
+     */
+    scrollEnabled: boolean;
+    /**
+     * @description xスクロールバーの表示用の Shape オブジェクト
+     *              Shape object for x scroll bar display
+     *
+     * @member {Shape}
+     * @protected
+     */
+    readonly xScrollShape: Shape;
+    /**
+     * @description yスクロールバーの表示用の Shape オブジェクト
+     *              Shape object for y scroll bar display
+     *
+     * @member {Shape | null}
+     * @protected
+     */
+    readonly yScrollShape: Shape;
+    /**
+     * @description テキストフィールドの点滅線の表示・非表示を制御します。
+     *              Controls the visibility of the text field's blinking line.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    focusVisible: boolean;
+    /**
+     * @description テキストフィールドのフォーカス位置のインデックス
+     *              Index of the focus position of the text field
+     *
+     * @member {number}
+     * @default -1
+     * @public
+     */
+    focusIndex: number;
+    /**
+     * @description テキストフィールドの選択位置のインデックス
+     *              Index of the selected position of the text field
+     *
+     * @member {number}
+     * @default -1
+     * @public
+     */
+    selectIndex: number;
+    /**
+     * @description ユーザーが入力するときに、テキストフィールドに入力できる最大の文字数です。
+     *              The maximum number of characters that the text field can contain,
+     *              as entered by a user.
+     *
+     * @member {number}
+     * @default 0
+     * @public
+     */
+    maxChars: number;
+    /**
+     * @description ユーザーがテキストフィールドに入力できる文字のセットを指定します。
+     *              Indicates the set of characters that a user can enter into the text field.
+     *
+     * @member {string}
+     * @default null
+     * @public
+     */
+    restrict: string;
+    /**
+     * @description テキストフィールドのタイプです。
+     *              The type of the text field.
+     *
+     * @member {string}
+     * @default TextFieldType.STATIC
+     * @public
+     */
+    type: ITextFieldType;
+    /**
+     * @description テキストフィールドのコンポジション開始インデックス
+     *              Composition start index of the text field
+     *
+     * @member {number}
+     * @default -1
+     * @public
+     */
+    compositionStartIndex: number;
+    /**
+     * @description テキストフィールドのコンポジション終了インデックス
+     *              Composition end index of the text field
+     *
+     * @member {number}
+     * @default -1
+     * @public
+     */
+    compositionEndIndex: number;
+    /**
+     * @description テキストフィールドのテキストフォーマットの配列です。
+     *              An array of text formats for the text field.
+     *
+     * @member {TextFormat[]}
+     * @default null
+     * @protected
+     */
+    $textFormats: TextFormat[] | null;
+    /**
+     * @description x軸のスクロール位置
+     *              Scroll position on the x-axis
+     *
+     * @member {number}
+     * @default 0
+     * @protected
+     */
+    $scrollX: number;
+    /**
+     * @description y軸のスクロール位置
+     *              Scroll position on the y-axis
+     *
+     * @member {number}
+     * @default 0
+     * @protected
+     */
+    $scrollY: number;
+    /**
+     * @description ビルドされたキャッシュキー
+     *              Built cache key
+     *
+     * @type {number}
+     * @default 0
+     * @public
+     */
+    cacheKey: number;
+    /**
+     * @description キャッシュのビルドに利用されるパラメータ
+     *              Parameters used to build the cache
+     *
+     * @type {number[]}
+     * @public
+     */
+    readonly cacheParams: number[];
+    private _$background;
+    private _$backgroundColor;
+    private _$border;
+    private _$borderColor;
+    private _$htmlText;
+    private _$multiline;
+    private _$text;
+    private _$wordWrap;
+    private _$defaultTextFormat;
+    private _$rawHtmlText;
+    private _$autoSize;
+    private _$autoFontSize;
+    private _$focus;
+    private _$thickness;
+    private _$thicknessColor;
+    private _$stopIndex;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.TextField
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトの空間名を返します。
+     *              Returns the space name of the specified object.
+     *
+     * @return  {string}
+     * @default next2d.display.TextField
+     * @const
+     * @public
+     */
+    get namespace(): string;
+    /**
+     * @description テキストサイズの自動的な拡大 / 縮小および整列を制御します。
+     *              Controls automatic sizing and alignment of text size.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get autoFontSize(): boolean;
+    set autoFontSize(auto_font_size: boolean);
+    /**
+     * @description テキストフィールドの自動的な拡大 / 縮小および整列を制御します。
+     *              Controls automatic sizing and alignment of text fields.
+     *
+     * @member {string}
+     * @default "none"
+     * @public
+     */
+    get autoSize(): ITextFieldAutoSize;
+    set autoSize(auto_size: ITextFieldAutoSize);
+    /**
+     * @description テキストフィールドに背景の塗りつぶしがあるかどうかを指定します。
+     *              Specifies whether the text field has a background fill.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get background(): boolean;
+    set background(background: boolean);
+    /**
+     * @description テキストフィールドの背景の色です。
+     *              The color of the text field background.
+     *
+     * @member {number}
+     * @default 0xffffff
+     * @public
+     */
+    get backgroundColor(): number;
+    set backgroundColor(background_color: string | number);
+    /**
+     * @description テキストフィールドに境界線があるかどうかを指定します。
+     *              Specifies whether the text field has a border.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get border(): boolean;
+    set border(border: boolean);
+    /**
+     * @description テキストフィールドの境界線の色です。
+     *              The color of the text field border.
+     *
+     * @member {number}
+     * @default 0x000000
+     * @public
+     */
+    get borderColor(): number;
+    set borderColor(border_color: string | number);
+    /**
+     * @description テキストの任意の表示終了位置の設定
+     *              Setting an arbitrary display end position for text.
+     *
+     * @member {number}
+     * @default -1
+     * @public
+     */
+    get stopIndex(): number;
+    set stopIndex(stop_index: number);
+    /**
+     * @description テキストに適用するフォーマットを指定します。
+     *              Specifies the formatting to be applied to the text.
+     *
+     * @member {TextFormat}
+     * @public
+     */
+    get defaultTextFormat(): TextFormat;
+    set defaultTextFormat(text_format: TextFormat);
+    /**
+     * @description このオブジェクトでマウスまたはその他のユーザー入力メッセージを
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get focus(): boolean;
+    set focus(focus: boolean);
+    /**
+     * @description テキストフィールドの内容を HTML で表します。
+     *              Contains the HTML representation of the text field contents.
+     *
+     * @member {string}
+     * @default ""
+     * @public
+     */
+    get htmlText(): string;
+    set htmlText(html_text: string);
+    /**
+     * @description テキストフィールド内の文字数です。
+     *              The int of characters in a text field.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get length(): number;
+    /**
+     * @description フィールドが複数行テキストフィールドであるかどうかを示します。
+     *              Indicates whether field is a multiline text field.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get multiline(): boolean;
+    set multiline(multiline: boolean);
+    /**
+     * @description フィールドが複数行テキストフィールドであるかどうかを示します。
+     *              Indicates whether field is a multiline text field.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get numLines(): number;
+    /**
+     * @description テキストフィールドのスクロール垂直位置です。
+     *              The scroll vertical position of the text field.
+     *
+     * @member {number}
+     * @public
+     */
+    get scrollX(): number;
+    set scrollX(scroll_x: number);
+    /**
+     * @description テキストフィールドのスクロール垂直位置です。
+     *              The scroll vertical position of the text field.
+     *
+     * @member {number}
+     * @public
+     */
+    get scrollY(): number;
+    set scrollY(scroll_y: number);
+    /**
+     * @description テキストフィールド内の現在のテキストであるストリングです。
+     *              A string that is the current text in the text field.
+     *
+     * @member {string}
+     * @default ""
+     * @public
+     */
+    get text(): string;
+    set text(text: string);
+    /**
+     * @description テキストの高さです（ピクセル単位）。
+     *              The height of the text in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get textHeight(): number;
+    /**
+     * @description テキストの幅です（ピクセル単位）。
+     *              The width of the text in pixels.
+     *
+     * @member {number}
+     * @readonly
+     * @public
+     */
+    get textWidth(): number;
+    /**
+     * @description 輪郭のテキスト幅です。0(デフォルト値)で無効にできます。
+     *              The text width of the outline, which can be disabled with 0 (the default value).
+     *
+     * @member {number}
+     * @default 0
+     * @public
+     */
+    get thickness(): number;
+    set thickness(thickness: number);
+    /**
+     * @description 輪郭のテキストの色です（16 進数形式）。
+     *              The color of the outline text. (Hexadecimal format)
+     *
+     * @member {number}
+     * @default 0
+     * @public
+     */
+    get thicknessColor(): number;
+    set thicknessColor(thickness_color: number);
+    /**
+     * @description テキストフィールドのテキストを折り返すかどうかを示すブール値です。
+     *              A Boolean value that indicates whether the text field has word wrap.
+     *
+     * @member {boolean}
+     * @default false
+     * @public
+     */
+    get wordWrap(): boolean;
+    set wordWrap(word_wrap: boolean);
+    /**
+     * @description 表示オブジェクトの幅を示します（ピクセル単位）。
+     *              Indicates the width of the display object, in pixels.
+     *
+     * @member {number}
+     * @public
+     */
+    get width(): number;
+    set width(width: number);
+    /**
+     * @description 表示オブジェクトの高さを示します（ピクセル単位）。
+     *              Indicates the height of the display object, in pixels.
+     *
+     * @member {number}
+     * @public
+     */
+    get height(): number;
+    set height(height: number);
+    /**
+     * @description newText パラメーターで指定されたストリングを、
+     *              テキストフィールドのテキストの最後に付加します。
+     *              Appends the string specified by the newText parameter
+     *              to the end of the text of the text field.
+     *
+     * @param  {string} new_text
+     * @return void
+     * @method
+     * @public
+     */
+    appendText(new_text: string): void;
+    /**
+     * @description テキストフィールドのフォーカス位置にテキスtを追加します。
+     *              Adds text to the focus position of the text field.
+     *
+     * @param  {string} new_text
+     * @return {void}
+     * @method
+     * @public
+     */
+    insertText(new_text: string): void;
+    /**
+     * @description テキストフィールドの選択範囲を削除します。
+     *              Deletes the selection range of the text field.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    deleteText(): void;
+    /**
+     * @description lineIndex パラメーターで指定された行のテキストを返します。
+     *              Returns the text of the line specified by the lineIndex parameter.
+     *
+     * @param  {number} line_index
+     * @return {string}
+     * @public
+     */
+    getLineText(line_index: number): string;
+    /**
+     * @description beginIndex パラメーターと endIndex パラメーターで指定された文字範囲を、
+     *              newText パラメーターの内容に置き換えます。
+     *              Replaces the range of characters that the beginIndex
+     *              and endIndex parameters specify with the contents of the newText parameter.
+     *
+     * @param  {string} new_text
+     * @param  {number} begin_index
+     * @param  {number} end_index
+     * @return {void}
+     * @method
+     * @public
+     */
+    replaceText(new_text: string, begin_index: number, end_index: number): void;
+    /**
+     * @return {void}
+     * @method
+     * @public
+     */
+    selectAll(): void;
+    /**
+     * @description テキストフィールドの選択範囲をコピーします。
+     *              Copy a selection of text fields.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    copy(): void;
+    /**
+     * @description コピーしたテキストを選択範囲に貼り付けます。
+     *              Paste the copied text into the selected range.
+     *
+     * @return {void}
+     * @method
+     * @public
+     */
+    paste(): void;
+    /**
+     * @description テキストフィールドのフォーカス位置を設定します。
+     *              Sets the focus position of the text field.
+     *
+     * @param  {number} stage_x
+     * @param  {number} stage_y
+     * @param  {boolean} [selected=false]
+     * @return {void}
+     * @method
+     * @public
+     */
+    setFocusIndex(stage_x: number, stage_y: number, selected?: boolean): void;
+    /**
+     * @description キーダウンイベントを処理します。
+     *              Processes the key down event.
+     *
+     * @param {KeyboardEvent} event
+     * @return {void}
+     * @method
+     * @public
+     */
+    keyDown(event: KeyboardEvent): void;
+    /**
+     * @description character 情報を元に DisplayObject を構築
+     *              Build DisplayObject based on character
+     *
+     * @param  {ICharacter} character
+     * @param  {LoaderInfo} [loader_info=null]
+     * @return {void}
+     * @method
+     * @protected
+     */
+    $sync(character: ICharacter, loader_info?: LoaderInfo | null): void;
+}