awayjs-display

import Rectangle from "awayjs-core/lib/geom/Rectangle"; import DisplayObject from "../display/DisplayObject"; import AntiAliasType from "../text/AntiAliasType"; import GridFitType from "../text/GridFitType"; import TextFieldAutoSize from "../text/TextFieldAutoSize"; import TextFieldType from "../text/TextFieldType"; import TextFormat from "../text/TextFormat"; import TextInteractionMode from "../text/TextInteractionMode"; import TextLineMetrics from "../text/TextLineMetrics"; import Sprite from "../display/Sprite"; import Graphics from "../graphics/Graphics"; /** * The TextField class is used to create display objects for text display and * input. <ph outputclass="flexonly">You can use the TextField class to * perform low-level text rendering. However, in Flex, you typically use the * Label, Text, TextArea, and TextInput controls to process text. <ph * outputclass="flashonly">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 ActionScript. TextField instance names are * displayed in the Movie Explorer and in the Insert Target Path dialog box in * the Actions panel. * * To create a text field dynamically, use the <code>TextField()</code> * constructor. * * The methods of the TextField class let you set, select, and manipulate * text in a dynamic or input text field that you create during authoring or * at runtime. * * ActionScript provides several ways to format your text at runtime. The * TextFormat class lets you set character and paragraph formatting for * TextField objects. You can apply Cascading Style Sheets(CSS) styles to * text fields by using the <code>TextField.styleSheet</code> property and the * StyleSheet class. You can use CSS to style built-in HTML tags, define new * formatting tags, or apply styles. You can assign HTML formatted text, which * optionally uses CSS styles, directly to a text field. HTML text that you * assign to a text field can contain embedded media(movie clips, SWF files, * GIF files, PNG files, and JPEG files). The text wraps around the embedded * media in the same way that a web browser wraps text around media embedded * in an HTML document. * * Flash Player supports a subset of HTML tags that you can use to format * text. See the list of supported HTML tags in the description of the * <code>htmlText</code> property. * * @event change Dispatched after a control value is * modified, unlike the * <code>textInput</code> event, which is * dispatched before the value is modified. * Unlike the W3C DOM Event Model version of * the <code>change</code> event, which * dispatches the event only after the * control loses focus, the ActionScript 3.0 * version of the <code>change</code> event * is dispatched any time the control * changes. For example, if a user types text * into a text field, a <code>change</code> * event is dispatched after every keystroke. * @event link Dispatched when a user clicks a hyperlink * in an HTML-enabled text field, where the * URL begins with "event:". The remainder of * the URL after "event:" is placed in the * text property of the LINK event. * * Note: The default behavior, * adding the text to the text field, occurs * only when Flash Player generates the * event, which in this case happens when a * user attempts to input text. You cannot * put text into a text field by sending it * <code>textInput</code> events. * @event scroll Dispatched by a TextField object * after the user scrolls. * @event textInput Flash Player dispatches the * <code>textInput</code> event when a user * enters one or more characters of text. * Various text input methods can generate * this event, including standard keyboards, * input method editors(IMEs), voice or * speech recognition systems, and even the * act of pasting plain text with no * formatting or style information. * @event textInteractionModeChange Flash Player dispatches the * <code>textInteractionModeChange</code> * event when a user changes the interaction * mode of a text field. for example on * Android, one can toggle from NORMAL mode * to SELECTION mode using context menu * options */ declare class TextField extends Sprite { private static _textFields; static assetType: string; private _textGraphicsDirty; private _bottomScrollV; private _caretIndex; private _length; private _maxScrollH; private _maxScrollV; private _numLines; private _selectionBeginIndex; private _selectionEndIndex; private _text; private _textHeight; private _textInteractionMode; private _textWidth; private _charBoundaries; private _charIndexAtPoint; private _firstCharInParagraph; private _imageReference; private _lineIndexAtPoint; private _lineIndexOfChar; private _lineLength; private _lineMetrics; private _lineOffset; private _lineText; private _paragraphLength; private _textFormat; private _textElements; private _textGraphic; /** * When set to <code>true</code> and the text field is not in focus, Flash * Player highlights the selection in the text field in gray. When set to * <code>false</code> and the text field is not in focus, Flash Player does * not highlight the selection in the text field. * * @default false */ alwaysShowSelection: boolean; /** * The type of anti-aliasing used for this text field. Use * <code>flash.text.AntiAliasType</code> constants for this property. You can * control this setting only if the font is embedded(with the * <code>embedFonts</code> property set to <code>true</code>). The default * setting is <code>flash.text.AntiAliasType.NORMAL</code>. * * To set values for this property, use the following string values: */ antiAliasType: AntiAliasType; /** * Controls automatic sizing and alignment of text fields. Acceptable values * for the <code>TextFieldAutoSize</code> constants: * <code>TextFieldAutoSize.NONE</code>(the default), * <code>TextFieldAutoSize.LEFT</code>, <code>TextFieldAutoSize.RIGHT</code>, * and <code>TextFieldAutoSize.CENTER</code>. * * If <code>autoSize</code> is set to <code>TextFieldAutoSize.NONE</code> * (the default) no resizing occurs. * * If <code>autoSize</code> is set to <code>TextFieldAutoSize.LEFT</code>, * the text is treated as left-justified text, meaning that the left margin * of the text field remains fixed and any resizing of a single line of the * text field is on the right margin. If the text includes a line break(for * example, <code>"\n"</code> or <code>"\r"</code>), the bottom is also * resized to fit the next line of text. If <code>wordWrap</code> is also set * to <code>true</code>, only the bottom of the text field is resized and the * right side remains fixed. * * If <code>autoSize</code> is set to * <code>TextFieldAutoSize.RIGHT</code>, the text is treated as * right-justified text, meaning that the right margin of the text field * remains fixed and any resizing of a single line of the text field is on * the left margin. If the text includes a line break(for example, * <code>"\n" or "\r")</code>, the bottom is also resized to fit the next * line of text. If <code>wordWrap</code> is also set to <code>true</code>, * only the bottom of the text field is resized and the left side remains * fixed. * * If <code>autoSize</code> is set to * <code>TextFieldAutoSize.CENTER</code>, the text is treated as * center-justified text, meaning that any resizing of a single line of the * text field is equally distributed to both the right and left margins. If * the text includes a line break(for example, <code>"\n"</code> or * <code>"\r"</code>), the bottom is also resized to fit the next line of * text. If <code>wordWrap</code> is also set to <code>true</code>, only the * bottom of the text field is resized and the left and right sides remain * fixed. * * @throws ArgumentError The <code>autoSize</code> specified is not a member * of flash.text.TextFieldAutoSize. */ autoSize: TextFieldAutoSize; /** * * @returns {string} */ readonly assetType: string; /** * Specifies whether the text field has a background fill. If * <code>true</code>, the text field has a background fill. If * <code>false</code>, the text field has no background fill. Use the * <code>backgroundColor</code> property to set the background color of a * text field. * * @default false */ background: boolean; /** * The color of the text field background. The default value is * <code>0xFFFFFF</code>(white). This property can be retrieved or set, even * if there currently is no background, but the color is visible only if the * text field has the <code>background</code> property set to * <code>true</code>. */ backgroundColor: number; /** * Specifies whether the text field has a border. If <code>true</code>, the * text field has a border. If <code>false</code>, the text field has no * border. Use the <code>borderColor</code> property to set the border color. * * @default false */ border: boolean; /** * The color of the text field border. The default value is * <code>0x000000</code>(black). This property can be retrieved or set, even * if there currently is no border, but the color is visible only if the text * field has the <code>border</code> property set to <code>true</code>. */ borderColor: number; /** * An integer(1-based index) that indicates the bottommost line that is * currently visible in the specified text field. Think of the text field as * a window onto a block of text. The <code>scrollV</code> property is the * 1-based index of the topmost visible line in the window. * * All the text between the lines indicated by <code>scrollV</code> and * <code>bottomScrollV</code> is currently visible in the text field. */ readonly bottomScrollV: number; /** * The index of the insertion point(caret) position. If no insertion point * is displayed, the value is the position the insertion point would be if * you restored focus to the field(typically where the insertion point last * was, or 0 if the field has not had focus). * * Selection span indexes are zero-based(for example, the first position * is 0, the second position is 1, and so on). */ readonly caretIndex: number; /** * A Boolean value that specifies whether extra white space(spaces, line * breaks, and so on) in a text field with HTML text is removed. The default * value is <code>false</code>. The <code>condenseWhite</code> property only * affects text set with the <code>htmlText</code> property, not the * <code>text</code> property. If you set text with the <code>text</code> * property, <code>condenseWhite</code> is ignored. * * If <code>condenseWhite</code> is set to <code>true</code>, use standard * HTML commands such as <code> </code> and <code></code> to place line * breaks in the text field. * * Set the <code>condenseWhite</code> property before setting the * <code>htmlText</code> property. */ condenseWhite: boolean; /** * Specifies the format applied to newly inserted text, such as text entered * by a user or text inserted with the <code>replaceSelectedText()</code> * method. * * Note: When selecting characters to be replaced with * <code>setSelection()</code> and <code>replaceSelectedText()</code>, the * <code>defaultTextFormat</code> will be applied only if the text has been * selected up to and including the last character. Here is an example: * <pre xml:space="preserve"> public my_txt:TextField new TextField(); * my_txt.text = "Flash Macintosh version"; public my_fmt:TextFormat = new * TextFormat(); my_fmt.color = 0xFF0000; my_txt.defaultTextFormat = my_fmt; * my_txt.setSelection(6,15); // partial text selected - defaultTextFormat * not applied my_txt.setSelection(6,23); // text selected to end - * defaultTextFormat applied my_txt.replaceSelectedText("Windows version"); * </pre> * * When you access the <code>defaultTextFormat</code> property, the * returned TextFormat object has all of its properties defined. No property * is <code>null</code>. * * Note: You can't set this property if a style sheet is applied to * the text field. * * @throws Error This method cannot be used on a text field with a style * sheet. */ defaultTextFormat: TextFormat; /** * Specifies whether the text field is a password text field. If the value of * this property is <code>true</code>, the text field is treated as a * password text field and hides the input characters using asterisks instead * of the actual characters. If <code>false</code>, the text field is not * treated as a password text field. When password mode is enabled, the Cut * and Copy commands and their corresponding keyboard shortcuts will not * function. This security mechanism prevents an unscrupulous user from using * the shortcuts to discover a password on an unattended computer. * * @default false */ displayAsPassword: boolean; /** * Specifies whether to render by using embedded font outlines. If * <code>false</code>, Flash Player renders the text field by using device * fonts. * * If you set the <code>embedFonts</code> property to <code>true</code> * for a text field, you must specify a font for that text by using the * <code>font</code> property of a TextFormat object applied to the text * field. If the specified font is not embedded in the SWF file, the text is * not displayed. * * @default false */ embedFonts: boolean; /** * The type of grid fitting used for this text field. This property applies * only if the <code>flash.text.AntiAliasType</code> property of the text * field is set to <code>flash.text.AntiAliasType.ADVANCED</code>. * * The type of grid fitting used determines whether Flash Player forces * strong horizontal and vertical lines to fit to a pixel or subpixel grid, * or not at all. * * For the <code>flash.text.GridFitType</code> property, you can use the * following string values: * * @default pixel */ gridFitType: GridFitType; /** * Contains the HTML representation of the text field contents. * * Flash Player supports the following HTML tags: * * Flash Player and AIR also support explicit character codes, such as * &(ASCII ampersand) and €(Unicode € symbol). */ htmlText: string; /** * The number of characters in a text field. A character such as tab * (<code>\t</code>) counts as one character. */ readonly length: number; /** * The maximum number of characters that the text field can contain, as * entered by a user. A script can insert more text than * <code>maxChars</code> allows; the <code>maxChars</code> property indicates * only how much text a user can enter. If the value of this property is * <code>0</code>, a user can enter an unlimited amount of text. * * @default 0 */ maxChars: number; /** * The maximum value of <code>scrollH</code>. */ maxScrollH(): number; /** * The maximum value of <code>scrollV</code>. */ maxScrollV(): number; /** * A Boolean value that indicates whether Flash Player automatically scrolls * multiline text fields when the user clicks a text field and rolls the * mouse wheel. By default, this value is <code>true</code>. This property is * useful if you want to prevent mouse wheel scrolling of text fields, or * implement your own text field scrolling. */ mouseWheelEnabled: boolean; /** * Indicates whether field is a multiline text field. If the value is * <code>true</code>, the text field is multiline; if the value is * <code>false</code>, the text field is a single-line text field. In a field * of type <code>TextFieldType.INPUT</code>, the <code>multiline</code> value * determines whether the <code>Enter</code> key creates a new line(a value * of <code>false</code>, and the <code>Enter</code> key is ignored). If you * paste text into a <code>TextField</code> with a <code>multiline</code> * value of <code>false</code>, newlines are stripped out of the text. * * @default false */ multiline: boolean; /** * Defines the number of text lines in a multiline text field. If * <code>wordWrap</code> property is set to <code>true</code>, the number of * lines increases when text wraps. */ readonly numLines: number; /** * Indicates the set of characters that a user can enter into the text field. * If the value of the <code>restrict</code> property is <code>null</code>, * you can enter any character. If the value of the <code>restrict</code> * property is an empty string, you cannot enter any character. If the value * of the <code>restrict</code> property is a string of characters, you can * enter only characters in the string into the text field. The string is * scanned from left to right. You can specify a range by using the hyphen * (-) character. Only user interaction is restricted; a script can put any * text into the text field. <ph outputclass="flashonly">This property does * not synchronize with the Embed font options in the Property inspector. * * If the string begins with a caret(^) character, all characters are * initially accepted and succeeding characters in the string are excluded * from the set of accepted characters. If the string does not begin with a * caret(^) character, no characters are initially accepted and succeeding * characters in the string are included in the set of accepted * characters. * * The following example allows only uppercase characters, spaces, and * numbers to be entered into a text field: * <pre xml:space="preserve"> my_txt.restrict = "A-Z 0-9"; </pre> * * The following example includes all characters, but excludes lowercase * letters: * <pre xml:space="preserve"> my_txt.restrict = "^a-z"; </pre> * * You can use a backslash to enter a ^ or - verbatim. The accepted * backslash sequences are \-, \^ or \\. The backslash must be an actual * character in the string, so when specified in ActionScript, a double * backslash must be used. For example, the following code includes only the * dash(-) and caret(^): * <pre xml:space="preserve"> my_txt.restrict = "\\-\\^"; </pre> * * The ^ can be used anywhere in the string to toggle between including * characters and excluding characters. The following code includes only * uppercase letters, but excludes the uppercase letter Q: * <pre xml:space="preserve"> my_txt.restrict = "A-Z^Q"; </pre> * * You can use the <code>\u</code> escape sequence to construct * <code>restrict</code> strings. The following code includes only the * characters from ASCII 32(space) to ASCII 126(tilde). * <pre xml:space="preserve"> my_txt.restrict = "\u0020-\u007E"; </pre> * * @default null */ restrict: string; /** * The current horizontal scrolling position. If the <code>scrollH</code> * property is 0, the text is not horizontally scrolled. This property value * is an integer that represents the horizontal position in pixels. * * The units of horizontal scrolling are pixels, whereas the units of * vertical scrolling are lines. Horizontal scrolling is measured in pixels * because most fonts you typically use are proportionally spaced; that is, * the characters can have different widths. Flash Player performs vertical * scrolling by line because users usually want to see a complete line of * text rather than a partial line. Even if a line uses multiple fonts, the * height of the line adjusts to fit the largest font in use. * * Note: The <code>scrollH</code> property is zero-based, not * 1-based like the <code>scrollV</code> vertical scrolling property. */ scrollH: number; /** * The vertical position of text in a text field. The <code>scrollV</code> * property is useful for directing users to a specific paragraph in a long * passage, or creating scrolling text fields. * * The units of vertical scrolling are lines, whereas the units of * horizontal scrolling are pixels. If the first line displayed is the first * line in the text field, scrollV is set to 1(not 0). Horizontal scrolling * is measured in pixels because most fonts are proportionally spaced; that * is, the characters can have different widths. Flash performs vertical * scrolling by line because users usually want to see a complete line of * text rather than a partial line. Even if there are multiple fonts on a * line, the height of the line adjusts to fit the largest font in use. */ scrollV: number; /** * A Boolean value that indicates whether the text field is selectable. The * value <code>true</code> indicates that the text is selectable. The * <code>selectable</code> property controls whether a text field is * selectable, not whether a text field is editable. A dynamic text field can * be selectable even if it is not editable. If a dynamic text field is not * selectable, the user cannot select its text. * * If <code>selectable</code> is set to <code>false</code>, the text in * the text field does not respond to selection commands from the mouse or * keyboard, and the text cannot be copied with the Copy command. If * <code>selectable</code> is set to <code>true</code>, the text in the text * field can be selected with the mouse or keyboard, and the text can be * copied with the Copy command. You can select text this way even if the * text field is a dynamic text field instead of an input text field. * * @default true */ selectable: boolean; /** * The zero-based character index value of the first character in the current * selection. For example, the first character is 0, the second character is * 1, and so on. If no text is selected, this property is the value of * <code>caretIndex</code>. */ readonly selectionBeginIndex: number; /** * The zero-based character index value of the last character in the current * selection. For example, the first character is 0, the second character is * 1, and so on. If no text is selected, this property is the value of * <code>caretIndex</code>. */ readonly selectionEndIndex: number; /** * The sharpness of the glyph edges in this text field. This property applies * only if the <code>flash.text.AntiAliasType</code> property of the text * field is set to <code>flash.text.AntiAliasType.ADVANCED</code>. The range * for <code>sharpness</code> is a number from -400 to 400. If you attempt to * set <code>sharpness</code> to a value outside that range, Flash sets the * property to the nearest value in the range(either -400 or 400). * * @default 0 */ sharpness: number; /** * Attaches a style sheet to the text field. For information on creating * style sheets, see the StyleSheet class and the ActionScript 3.0 * Developer's Guide. * * You can change the style sheet associated with a text field at any * time. If you change the style sheet in use, the text field is redrawn with * the new style sheet. You can set the style sheet to <code>null</code> or * <code>undefined</code> to remove the style sheet. If the style sheet in * use is removed, the text field is redrawn without a style sheet. * * Note: If the style sheet is removed, the contents of both * <code>TextField.text</code> and <code> TextField.htmlText</code> change to * incorporate the formatting previously applied by the style sheet. To * preserve the original <code>TextField.htmlText</code> contents without the * formatting, save the value in a variable before removing the style * sheet. */ styleSheet: StyleSheet; /** * A string that is the current text in the text field. Lines are separated * by the carriage return character(<code>'\r'</code>, ASCII 13). This * property contains unformatted text in the text field, without HTML tags. * * To get the text in HTML form, use the <code>htmlText</code> * property. */ text: string; textFormat: TextFormat; /** * The graphics used by the sprite that provides it with its shape. */ readonly graphics: Graphics; /** * The color of the text in a text field, in hexadecimal format. The * hexadecimal color system uses six digits to represent color values. Each * digit has 16 possible values or characters. The characters range from 0-9 * and then A-F. For example, black is <code>0x000000</code>; white is * <code>0xFFFFFF</code>. * * @default 0(0x000000) */ _textColor: number; textColor: number; /** * The interaction mode property, Default value is * TextInteractionMode.NORMAL. On mobile platforms, the normal mode implies * that the text can be scrolled but not selected. One can switch to the * selectable mode through the in-built context menu on the text field. On * Desktop, the normal mode implies that the text is in scrollable as well as * selection mode. */ readonly textInteractionMode: TextInteractionMode; /** * The width of the text in pixels. */ textWidth: number; /** * The width of the text in pixels. */ textHeight: number; /** * The thickness of the glyph edges in this text field. This property applies * only when <code>AntiAliasType</code> is set to * <code>AntiAliasType.ADVANCED</code>. * * The range for <code>thickness</code> is a number from -200 to 200. If * you attempt to set <code>thickness</code> to a value outside that range, * the property is set to the nearest value in the range(either -200 or * 200). * * @default 0 */ thickness: number; /** * The type of the text field. Either one of the following TextFieldType * constants: <code>TextFieldType.DYNAMIC</code>, which specifies a dynamic * text field, which a user cannot edit, or <code>TextFieldType.INPUT</code>, * which specifies an input text field, which a user can edit. * * @default dynamic * @throws ArgumentError The <code>type</code> specified is not a member of * flash.text.TextFieldType. */ type: TextFieldType; /** * Specifies whether to copy and paste the text formatting along with the * text. When set to <code>true</code>, Flash Player copies and pastes * formatting(such as alignment, bold, and italics) when you copy and paste * between text fields. Both the origin and destination text fields for the * copy and paste procedure must have <code>useRichTextClipboard</code> set * to <code>true</code>. The default value is <code>false</code>. */ useRichTextClipboard: boolean; /** * A Boolean value that indicates whether the text field has word wrap. If * the value of <code>wordWrap</code> is <code>true</code>, the text field * has word wrap; if the value is <code>false</code>, the text field does not * have word wrap. The default value is <code>false</code>. */ wordWrap: boolean; /** * */ readonly isEntity: boolean; /** * Creates a new TextField instance. After you create the TextField instance, * call the <code>addChild()</code> or <code>addChildAt()</code> method of * the parent DisplayObjectContainer object to add the TextField instance to * the display list. * * The default size for a text field is 100 x 100 pixels. */ constructor(); clear(): void; /** * @inheritDoc */ dispose(): void; /** * @inheritDoc */ disposeValues(): void; /** * Reconstructs the Graphics for this Text-field. */ reConstruct(): void; /** * Appends the string specified by the <code>newText</code> parameter to the * end of the text of the text field. This method is more efficient than an * addition assignment(<code>+=</code>) on a <code>text</code> property * (such as <code>someTextField.text += moreText</code>), particularly for a * text field that contains a significant amount of content. * * @param newText The string to append to the existing text. */ appendText(newText: string): void; /** * *tells the Textfield that a paragraph is defined completly. * e.g. the textfield will start a new line for future added text. */ closeParagraph(): void; /** * Returns a rectangle that is the bounding box of the character. * * @param charIndex The zero-based index value for the character(for * example, the first position is 0, the second position is * 1, and so on). * @return A rectangle with <code>x</code> and <code>y</code> minimum and * maximum values defining the bounding box of the character. */ getCharBoundaries(charIndex: number): Rectangle; /** * Returns the zero-based index value of the character at the point specified * by the <code>x</code> and <code>y</code> parameters. * * @param x The x coordinate of the character. * @param y The y coordinate of the character. * @return The zero-based index value of the character(for example, the * first position is 0, the second position is 1, and so on). Returns * -1 if the point is not over any character. */ getCharIndexAtPoint(x: number, y: number): number; /** * Given a character index, returns the index of the first character in the * same paragraph. * * @param charIndex The zero-based index value of the character(for example, * the first character is 0, the second character is 1, and * so on). * @return The zero-based index value of the first character in the same * paragraph. * @throws RangeError The character index specified is out of range. */ getFirstCharInParagraph(charIndex: number): number; /** * Returns a DisplayObject reference for the given <code>id</code>, for an * image or SWF file that has been added to an HTML-formatted text field by * using an <code><img></code> tag. The <code><img></code> tag is in the * following format: * * <pre xml:space="preserve"><code> <img src = 'filename.jpg' id = * 'instanceName' ></code></pre> * * @param id The <code>id</code> to match(in the <code>id</code> attribute * of the <code><img></code> tag). * @return The display object corresponding to the image or SWF file with the * matching <code>id</code> attribute in the <code><img></code> tag * of the text field. For media loaded from an external source, this * object is a Loader object, and, once loaded, the media object is a * child of that Loader object. For media embedded in the SWF file, * it is the loaded object. If no <code><img></code> tag with the * matching <code>id</code> exists, the method returns * <code>null</code>. */ getImageReference(id: string): DisplayObject; /** * Returns the zero-based index value of the line at the point specified by * the <code>x</code> and <code>y</code> parameters. * * @param x The x coordinate of the line. * @param y The y coordinate of the line. * @return The zero-based index value of the line(for example, the first * line is 0, the second line is 1, and so on). Returns -1 if the * point is not over any line. */ getLineIndexAtPoint(x: number, y: number): number; /** * Returns the zero-based index value of the line containing the character * specified by the <code>charIndex</code> parameter. * * @param charIndex The zero-based index value of the character(for example, * the first character is 0, the second character is 1, and * so on). * @return The zero-based index value of the line. * @throws RangeError The character index specified is out of range. */ getLineIndexOfChar(charIndex: number): number; /** * Returns the number of characters in a specific text line. * * @param lineIndex The line number for which you want the length. * @return The number of characters in the line. * @throws RangeError The line number specified is out of range. */ getLineLength(lineIndex: number): number; /** * Returns metrics information about a given text line. * * @param lineIndex The line number for which you want metrics information. * @return A TextLineMetrics object. * @throws RangeError The line number specified is out of range. */ getLineMetrics(lineIndex: number): TextLineMetrics; /** * Returns the character index of the first character in the line that the * <code>lineIndex</code> parameter specifies. * * @param lineIndex The zero-based index value of the line(for example, the * first line is 0, the second line is 1, and so on). * @return The zero-based index value of the first character in the line. * @throws RangeError The line number specified is out of range. */ getLineOffset(lineIndex: number): number; /** * Returns the text of the line specified by the <code>lineIndex</code> * parameter. * * @param lineIndex The zero-based index value of the line(for example, the * first line is 0, the second line is 1, and so on). * @return The text string contained in the specified line. * @throws RangeError The line number specified is out of range. */ getLineText(lineIndex: number): string; /** * Given a character index, returns the length of the paragraph containing * the given character. The length is relative to the first character in the * paragraph(as returned by <code>getFirstCharInParagraph()</code>), not to * the character index passed in. * * @param charIndex The zero-based index value of the character(for example, * the first character is 0, the second character is 1, and * so on). * @return Returns the number of characters in the paragraph. * @throws RangeError The character index specified is out of range. */ getParagraphLength(charIndex: number): number; /** * Returns a TextFormat object that contains formatting information for the * range of text that the <code>beginIndex</code> and <code>endIndex</code> * parameters specify. Only properties that are common to the entire text * specified are set in the resulting TextFormat object. Any property that is * mixed, meaning that it has different values at different points in * the text, has a value of <code>null</code>. * * If you do not specify values for these parameters, this method is * applied to all the text in the text field. * * The following table describes three possible usages: * * @return The TextFormat object that represents the formatting properties * for the specified text. * @throws RangeError The <code>beginIndex</code> or <code>endIndex</code> * specified is out of range. */ getTextFormat(beginIndex?: number, endIndex?: number): TextFormat; /** * Replaces the current selection with the contents of the <code>value</code> * parameter. The text is inserted at the position of the current selection, * using the current default character format and default paragraph format. * The text is not treated as HTML. * * You can use the <code>replaceSelectedText()</code> method to insert and * delete text without disrupting the character and paragraph formatting of * the rest of the text. * * Note: This method does not work if a style sheet is applied to * the text field. * * @param value The string to replace the currently selected text. * @throws Error This method cannot be used on a text field with a style * sheet. */ replaceSelectedText(value: string): void; /** * Replaces the range of characters that the <code>beginIndex</code> and * <code>endIndex</code> parameters specify with the contents of the * <code>newText</code> parameter. As designed, the text from * <code>beginIndex</code> to <code>endIndex-1</code> is replaced. * * Note: This method does not work if a style sheet is applied to * the text field. * * @param beginIndex The zero-based index value for the start position of the * replacement range. * @param endIndex The zero-based index position of the first character * after the desired text span. * @param newText The text to use to replace the specified range of * characters. * @throws Error This method cannot be used on a text field with a style * sheet. */ replaceText(beginIndex: number, endIndex: number, newText: string): void; /** * Sets as selected the text designated by the index values of the first and * last characters, which are specified with the <code>beginIndex</code> and * <code>endIndex</code> parameters. If the two parameter values are the * same, this method sets the insertion point, as if you set the * <code>caretIndex</code> property. * * @param beginIndex The zero-based index value of the first character in the * selection(for example, the first character is 0, the * second character is 1, and so on). * @param endIndex The zero-based index value of the last character in the * selection. */ setSelection(beginIndex: number, endIndex: number): void; /** * Applies the text formatting that the <code>format</code> parameter * specifies to the specified text in a text field. The value of * <code>format</code> must be a TextFormat object that specifies the desired * text formatting changes. Only the non-null properties of * <code>format</code> are applied to the text field. Any property of * <code>format</code> that is set to <code>null</code> is not applied. By * default, all of the properties of a newly created TextFormat object are * set to <code>null</code>. * * Note: This method does not work if a style sheet is applied to * the text field. * * The <code>setTextFormat()</code> method changes the text formatting * applied to a range of characters or to the entire body of text in a text * field. To apply the properties of format to all text in the text field, do * not specify values for <code>beginIndex</code> and <code>endIndex</code>. * To apply the properties of the format to a range of text, specify values * for the <code>beginIndex</code> and the <code>endIndex</code> parameters. * You can use the <code>length</code> property to determine the index * values. * * The two types of formatting information in a TextFormat object are * character level formatting and paragraph level formatting. Each character * in a text field can have its own character formatting settings, such as * font name, font size, bold, and italic. * * For paragraphs, the first character of the paragraph is examined for * the paragraph formatting settings for the entire paragraph. Examples of * paragraph formatting settings are left margin, right margin, and * indentation. * * Any text inserted manually by the user, or replaced by the * <code>replaceSelectedText()</code> method, receives the default text field * formatting for new text, and not the formatting specified for the text * insertion point. To set the default formatting for new text, use * <code>defaultTextFormat</code>. * * @param format A TextFormat object that contains character and paragraph * formatting information. * @throws Error This method cannot be used on a text field with a style * sheet. * @throws RangeError The <code>beginIndex</code> or <code>endIndex</code> * specified is out of range. */ setTextFormat(format: TextFormat, beginIndex?: number, endIndex?: number): void; /** * Returns true if an embedded font is available with the specified * <code>fontName</code> and <code>fontStyle</code> where * <code>Font.fontType</code> is <code>flash.text.FontType.EMBEDDED</code>. * Starting with Flash Player 10, two kinds of embedded fonts can appear in a * SWF file. Normal embedded fonts are only used with TextField objects. CFF * embedded fonts are only used with the flash.text.engine classes. The two * types are distinguished by the <code>fontType</code> property of the * <code>Font</code> class, as returned by the <code>enumerateFonts()</code> * function. * * TextField cannot use a font of type <code>EMBEDDED_CFF</code>. If * <code>embedFonts</code> is set to <code>true</code> and the only font * available at run time with the specified name and style is of type * <code>EMBEDDED_CFF</code>, Flash Player fails to render the text, as if no * embedded font were available with the specified name and style. * * If both <code>EMBEDDED</code> and <code>EMBEDDED_CFF</code> fonts are * available with the same name and style, the <code>EMBEDDED</code> font is * selected and text renders with the <code>EMBEDDED</code> font. * * @param fontName The name of the embedded font to check. * @param fontStyle Specifies the font style to check. Use * <code>flash.text.FontStyle</code> * @return <code>true</code> if a compatible embedded font is available, * otherwise <code>false</code>. * @throws ArgumentError The <code>fontStyle</code> specified is not a member * of <code>flash.text.FontStyle</code>. */ static isFontCompatible(fontName: string, fontStyle: string): boolean; clone(): TextField; copyTo(newInstance: TextField): void; } export default TextField;