@next2d/display 1.16.0 → 1.17.1

package/dist/TextField.d.ts

@@ -0,0 +1,555 @@
+import { InteractiveObject } from "@next2d/display";
+import { TextData, TextFormat } from "@next2d/text";
+import { BoundsImpl, TextFieldTypeImpl, TextFormatVerticalAlignImpl, TextFieldAutoSizeImpl, ParentImpl, TextObjectImpl, DictionaryTagImpl, TextCharacterImpl, PlayerHitObjectImpl, Character } from "@next2d/interface";
+import { CanvasToWebGLContext } from "@next2d/webgl";
+/**
+ * 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
+ * and 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 {
+    private readonly _$bounds;
+    private readonly _$originBounds;
+    private _$textData;
+    private _$background;
+    private _$backgroundColor;
+    private _$border;
+    private _$borderColor;
+    private _$htmlText;
+    private _$multiline;
+    private _$text;
+    private _$wordWrap;
+    private _$scrollX;
+    private _$scrollY;
+    private _$maxChars;
+    private _$defaultTextFormat;
+    private _$rawHtmlText;
+    private _$restrict;
+    private _$isHTML;
+    private _$textarea;
+    private _$autoSize;
+    private _$autoFontSize;
+    private _$textAreaActive;
+    private _$scrollEnabled;
+    private _$xScrollShape;
+    private _$yScrollShape;
+    private _$type;
+    private _$focus;
+    private _$isComposing;
+    private _$thickness;
+    private _$thicknessColor;
+    private _$verticalAlign;
+    private _$cacheKeys;
+    private _$cacheParams;
+    /**
+     * @constructor
+     * @public
+     */
+    constructor();
+    /**
+     * @description 指定されたクラスのストリングを返します。
+     *              Returns the string representation of the specified class.
+     *
+     * @return  {string}
+     * @default [class TextField]
+     * @method
+     * @static
+     */
+    static toString(): string;
+    /**
+     * @description 指定されたクラスの空間名を返します。
+     *              Returns the space name of the specified class.
+     *
+     * @return  {string}
+     * @default next2d.display.TextField
+     * @const
+     * @static
+     */
+    static get namespace(): string;
+    /**
+     * @description 指定されたオブジェクトのストリングを返します。
+     *              Returns the string representation of the specified object.
+     *
+     * @return  {string}
+     * @default [object TextField]
+     * @method
+     * @public
+     */
+    toString(): 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 TextFieldAutoSize.NONE
+     * @public
+     */
+    get autoSize(): TextFieldAutoSizeImpl;
+    set autoSize(auto_size: TextFieldAutoSizeImpl);
+    /**
+     * @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 テキストに適用するフォーマットを指定します。
+     *              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 ユーザーが入力するときに、テキストフィールドに入力できる最大の文字数です。
+     *              The maximum number of characters that the text field can contain,
+     *              as entered by a user.
+     *
+     * @member {number}
+     * @default 0
+     * @public
+     */
+    get maxChars(): number;
+    set maxChars(max_chars: 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 ユーザーがテキストフィールドに入力できる文字のセットを指定します。
+     *              Indicates the set of characters that a user can enter into the text field.
+     *
+     * @member {string}
+     * @default null
+     * @public
+     */
+    get restrict(): string;
+    set restrict(restrict: string);
+    /**
+     * @description スクロール機能のON/OFFの制御。
+     *              Control ON/OFF of the scroll function.
+     *
+     * @member {boolean}
+     * @default true
+     * @public
+     */
+    get scrollEnabled(): boolean;
+    set scrollEnabled(scroll_enabled: boolean);
+    /**
+     * @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 | null);
+    /**
+     * @description テキストフィールドのテキストの色です（16 進数形式）。
+     *              The color of the text in a text field, in hexadecimal format.
+     *
+     * @member {number}
+     * @public
+     */
+    get textColor(): number;
+    set textColor(text_color: number);
+    /**
+     * @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 テキストフィールドのタイプです。
+     *              The type of the text field.
+     *
+     * @member {string}
+     * @default TextFieldType.STATIC
+     * @public
+     */
+    get type(): TextFieldTypeImpl;
+    set type(type: TextFieldTypeImpl);
+    /**
+     * @description 縦方向の揃え位置を指定するプロパティです。
+     *              This property specifies the vertical alignment position.
+     *
+     * @member {string}
+     * @default "bottom"
+     * @public
+     */
+    get verticalAlign(): TextFormatVerticalAlignImpl;
+    set verticalAlign(vertical_align: TextFormatVerticalAlignImpl);
+    /**
+     * @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 親 DisplayObjectContainer のローカル座標を基準にした
+     *              DisplayObject インスタンスの x 座標を示します。
+     *              Indicates the x coordinate
+     *              of the DisplayObject instance relative to the local coordinates
+     *              of the parent DisplayObjectContainer.
+     *
+     * @member {number}
+     * @public
+     */
+    get x(): number;
+    set x(x: number);
+    /**
+     * @description 親 DisplayObjectContainer のローカル座標を基準にした
+     *              DisplayObject インスタンスの y 座標を示します。
+     *              Indicates the y coordinate
+     *              of the DisplayObject instance relative to the local coordinates
+     *              of the parent DisplayObjectContainer.
+     *
+     * @member {number}
+     * @public
+     */
+    get y(): number;
+    set y(y: 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 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  {number} begin_index
+     * @param  {number} end_index
+     * @param  {string} new_text
+     * @return {void}
+     * @method
+     * @public
+     */
+    replaceText(begin_index: number, end_index: number, new_text: string): void;
+    /**
+     * @description text、htmlTextに登録したテキスト情報をTextDataクラスで返却
+     *              Return text information registered in text and htmlText with TextData class.
+     *
+     * @param  {number} [sub_font_size = 0]
+     * @return {array}
+     * @method
+     * @public
+     */
+    getTextData(sub_font_size?: number): TextData;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$reset(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$reload(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$resize(): void;
+    /**
+     * @param  {object} text_object
+     * @param  {number} width
+     * @return {number}
+     * @method
+     * @private
+     */
+    _$getAlignOffset(text_object: TextObjectImpl, width: number): number;
+    /**
+     * @param   {Float32Array} [matrix=null]
+     * @returns {object}
+     * @method
+     * @private
+     */
+    _$getBounds(matrix?: Float32Array | null): BoundsImpl;
+    /**
+     * @param  {object} character
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$buildCharacter(character: Character<TextCharacterImpl>): void;
+    /**
+     * @param  {object} character
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$sync(character: TextCharacterImpl): void;
+    /**
+     * @param  {object} tag
+     * @param  {DisplayObjectContainer} parent
+     * @return {object}
+     * @method
+     * @private
+     */
+    _$build(tag: DictionaryTagImpl, parent: ParentImpl<any>): TextCharacterImpl;
+    /**
+     * @param   {CanvasToWebGLContext} context
+     * @param   {Float32Array} matrix
+     * @returns {void}
+     * @method
+     * @private
+     */
+    _$clip(context: CanvasToWebGLContext, matrix: Float32Array): void;
+    /**
+     * @param  {CanvasToWebGLContext} context
+     * @param  {Float32Array} matrix
+     * @param  {Float32Array} color_transform
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$draw(context: CanvasToWebGLContext, matrix: Float32Array, color_transform: Float32Array): void;
+    /**
+     * @param  {CanvasRenderingContext2D} context
+     * @param  {Float32Array} color_transform
+     * @param  {number} width
+     * @param  {number} line_width
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$doDraw(context: CanvasRenderingContext2D, color_transform: Float32Array, width: number, line_width: number): void;
+    /**
+     * @param  {CanvasRenderingContext2D} context
+     * @param  {Float32Array} matrix
+     * @param  {object}  options
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$mouseHit(context: CanvasRenderingContext2D, matrix: Float32Array, options: PlayerHitObjectImpl): boolean;
+    /**
+     * @param  {CanvasRenderingContext2D} context
+     * @param  {Float32Array} matrix
+     * @param  {object} options
+     * @return {boolean}
+     * @method
+     * @private
+     */
+    _$hit(context: CanvasRenderingContext2D, matrix: Float32Array, options: PlayerHitObjectImpl): boolean;
+    /**
+     * @param  {number} scale
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$createTextAreaElement(scale: number): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$createWorkerInstance(): void;
+    /**
+     * @return {void}
+     * @method
+     * @private
+     */
+    _$postProperty(): void;
+}