Displays the text for a specific line within a TextEditor.

Constructor

new()

Creates a new TextLineRenderer object.

Variables

@:style@:flash.propertybackgroundSkin:DisplayObject

The default background skin to display behind the text line renderer's content.

@:flash.propertybreakpoint:Bool

Determines if the current line has a breakpoint.

See also:

@:style@:flash.propertybreakpointGutterBackgroundSkin:DisplayObject

The optional background skin to display behind the gutter when a breakpoint has been added to this line.

@:style@:flash.propertybreakpointSkin:DisplayObject

The skin to display a breakpoint in the renderer's gutter.

See also:

@:flash.propertybreakpointVerified:Bool

Determines if the current line's breakpoint is considered to be verified. If unverified, it may be displayed in a less prominent visual style.

See also:

@:flash.propertycaretIndex:Int

The character index of the caret on this line, or -1, if the caret is currently on a different line.

@:flash.propertyread onlycaretX:Float

Returns the current x position of the caret, if it appears on this line.

@:flash.propertydebuggerStopped:Bool

Indicates if the debugger is currently stopped on this line.

@:style@:flash.propertydebuggerStoppedBackgroundSkin:DisplayObject

The background skin to display behind the text line renderer's content when the debugger is stopped at this line.

@:flash.propertydefaultTextStyleContext:Int

The default text style context for the current language.

@:style@:flash.propertyembedFonts:Bool

Determines if an embedded font is used for the text displayed by the text line renderer.

@:style@:flash.propertyfocusedBackgroundSkin:DisplayObject

The background skin to display behind the text line renderer's content when the line has focus.

@:style@:flash.propertygutterBackgroundSkin:DisplayObject

The optional background skin to display behind the gutter.

@:style@:flash.propertygutterGap:Float

The space, measured in pixels, between items added to the renderer's gutter.

See also:

@:style@:flash.propertygutterPaddingLeft:Float

The space, measured in pixels, that appears on the left side of the gutter.

See also:

@:style@:flash.propertygutterPaddingRight:Float

The space, measured in pixels, that appears on the right side of the gutter.

See also:

@:flash.propertyread onlygutterWidth:Float

Returns the width of the gutter.

@:style@:flash.propertyhighlightAllFindResults:Bool

@:flash.propertylineIndex:Int

The index of the line within the TextEditor.

@:style@:flash.propertylineNumberTextFormat:TextFormat

The text format used for line numbers.

@:flash.propertylineNumberWidth:Null<Float>

@:flash.propertylinkEndChar:Int

The end character index of a link on this line, or -1 if there is no link on this line.

See also:

@:flash.propertylinkStartChar:Int

The start character index of a link on this line, or -1 if there is no link on this line.

See also:

@:flash.propertynumLines:Int

The total number of lines in the TextEditor.

@:flash.propertysearchResult:TextEditorSearchResult

The current search result displayed by the text editor.

@:style@:flash.propertyselectedTextBackgroundSkin:DisplayObject

Deprecated:

The background skin to display behind selected text.

@:style@:flash.propertyselectedTextUnfocusedBackgroundSkin:DisplayObject

Deprecated:

The background skin to display behind selected text when the text line renderer is not focused.

@:flash.propertyselectionEndIndex:Int

The end character index of this line's current selection, or -1 if there is no selection on this line.

See also:

@:flash.propertyselectionStartIndex:Int

The start character index of this line's current selection, or -1 if there is no selection on this line.

See also:

@:flash.propertyshowLineNumbers:Bool

@:flash.propertystyleRanges:Array<Int>

Alternating text index values and identifiers from the textStyles that indicate ranges for syntax highlighting.

See also:

@:flash.propertytabWidth:Int

@:flash.propertytext:String

The line's text.

@:flash.propertytextEditorHasFocus:Bool

Indicates if the TextEditor currently has focus.

@:flash.propertytextEditorOwner:TextEditor

The TextEditor that owns this text line renderer.

@:style@:flash.propertytextStyles:Map<Int, TextFormat>

Maps identifiers for syntax highlighting styles to TextFormat values.

See also:

@:style@:flash.propertyunverifiedBreakpointSkin:DisplayObject

The skin to display an unverified breakpoint in the renderer's gutter.

See also:

@:flash.propertywordWrap:Bool

Determines if the line wraps or scrolls horizontally.

@:style@:flash.propertysearchResultBackgroundSkinFactory:() ‑> DisplayObject

Creates background skins for search results.

@:style@:flash.propertyselectedTextBackgroundSkinFactory:() ‑> DisplayObject

Creates background skins to display behind selected text.

@:style@:flash.propertyselectedTextUnfocusedBackgroundSkinFactory:() ‑> DisplayObject

Creates background skins to display behind selected text.

Methods

getCharBoundaries(charIndex:Int):Rectangle

Returns the boundaries of the specified character index. If the index is out of the text length, returns null.

getCharIndexAtPoint(localX:Float, localY:Float):Int

Returns the character index of the specified local x/y point. If the local point is out of bounds, returns -1.

Similar to TextField.getCharIndexAtPoint()

@:value({ returnNextAfterCenter : true })getSelectionCharIndexAtPoint(localX:Float, localY:Float, returnNextAfterCenter:Bool = true):Int

Similar to getCharIndexAtPoint(), but avoids returning -1. When out of bounds, returns either the first or last index.