Package | net.user1.reactor.ui |
Class | public class FastTextField |
Inheritance | FastTextField ![]() |
Since : | ReactorGUI 1.0.0 |
A high-performance text field for displaying high volumes of text, such as the contents of a debugging log. FastTextField has the following features:
For the sake of performance, FastTextField does not support word wrapping, per-character font formatting, nor most other styling features of regular text fields. All text in FastTextField must have the same format. However, each line of text can have its own color (see appendText() and setTextFormat()).
FastTextField does not include scrollbars; for a high-performance text area with scrollbars, see FastTextArea.
See also
Variable | Defined By | ||
---|---|---|---|
autoScroll : Boolean
When true, the text field automatically stays scrolled to the last line. | FastTextField | ||
backgroundAlpha : Number | FastTextField | ||
backgroundColor : uint | FastTextField | ||
borderAlpha : Number | FastTextField | ||
borderColor : uint | FastTextField | ||
borderThickness : int | FastTextField | ||
height : Number [override] | FastTextField | ||
maxLength : int
The current maximum number of lines allowed in the text field. | FastTextField | ||
maxScrollH : int [read-only]
The current maximum allowed value of scrollH. | FastTextField | ||
maxScrollV : int [read-only]
The current maximum allowed value of scrollV. | FastTextField | ||
pageLineCount : int [read-only]
Returns the number of lines that can currently be displayed in the text
field without scrolling. | FastTextField | ||
pageWidth : int [read-only]
Returns the width of the text field, not including its border, in pixels. | FastTextField | ||
scrollH : int
The amount, in pixels, the text in the text field is scrolled to the left. | FastTextField | ||
scrollV : int
The line number currently displayed as the top line of the
text field. | FastTextField | ||
text : String [write-only]
Replaces all text in the text field with the supplied value. | FastTextField | ||
width : Number [override] | FastTextField |
Method | Defined By | ||
---|---|---|---|
FastTextField | |||
appendText(text:String, color:Object = null):void
Adds the specified text to the end of existing text in the text field. | FastTextField | ||
copyToClipboard():void
Copies all of the text field's text ( including any text that is
scrolled out of view) to the system clipboard. | FastTextField | ||
setTextFormat(format:TextFormat):void
Sets the font format of all text in the text. | FastTextField |
autoScroll | variable |
autoScroll:Boolean
Since : | ReactorGUI 1.0.0 |
When true, the text field automatically stays scrolled to the last line.
public function get autoScroll():Boolean
public function set autoScroll(value:Boolean):void
backgroundAlpha | variable |
backgroundAlpha:Number
public function get backgroundAlpha():Number
public function set backgroundAlpha(value:Number):void
backgroundColor | variable |
backgroundColor:uint
public function get backgroundColor():uint
public function set backgroundColor(value:uint):void
borderAlpha | variable |
borderAlpha:Number
public function get borderAlpha():Number
public function set borderAlpha(value:Number):void
borderColor | variable |
borderColor:uint
public function get borderColor():uint
public function set borderColor(value:uint):void
borderThickness | variable |
borderThickness:int
public function get borderThickness():int
public function set borderThickness(value:int):void
height | variable |
height:Number
[override] public function get height():Number
public function set height(value:Number):void
maxLength | variable |
maxLength:int
Since : | ReactorGUI 1.0.0 |
The current maximum number of lines allowed in the text field. When this value is exceeded, adding a new last line of text automatically causes the removal of the text field's current first line of text.
public function get maxLength():int
public function set maxLength(value:int):void
maxScrollH | variable |
maxScrollH:int
[read-only] Since : | ReactorGUI 1.0.0 |
The current maximum allowed value of scrollH.
public function get maxScrollH():int
maxScrollV | variable |
maxScrollV:int
[read-only] Since : | ReactorGUI 1.0.0 |
The current maximum allowed value of scrollV.
public function get maxScrollV():int
pageLineCount | variable |
pageLineCount:int
[read-only] Since : | ReactorGUI 1.0.0 |
Returns the number of lines that can currently be displayed in the text field without scrolling.
public function get pageLineCount():int
pageWidth | variable |
pageWidth:int
[read-only] Since : | ReactorGUI 1.0.0 |
Returns the width of the text field, not including its border, in pixels.
public function get pageWidth():int
scrollH | variable |
scrollH:int
Since : | ReactorGUI 1.0.0 |
The amount, in pixels, the text in the text field is scrolled to the left.
public function get scrollH():int
public function set scrollH(value:int):void
scrollV | variable |
scrollV:int
Since : | ReactorGUI 1.0.0 |
The line number currently displayed as the top line of the text field.
public function get scrollV():int
public function set scrollV(value:int):void
text | variable |
text:String
[write-only] Since : | ReactorGUI 1.0.0 |
Replaces all text in the text field with the supplied value.
public function set text(value:String):void
See also
width | variable |
width:Number
[override] public function get width():Number
public function set width(value:Number):void
FastTextField | () | Constructor |
public function FastTextField()
appendText | () | method |
public function appendText(text:String, color:Object = null):void
Since : | ReactorGUI 1.0.0 |
Adds the specified text to the end of existing text in the text field. If color is specified, the color of the new text and all preceding text on the same line will be set to the specified color.
Parameters
text:String | |
color:Object (default = null )
|
See also
copyToClipboard | () | method |
public function copyToClipboard():void
Since : | ReactorGUI 1.0.0 |
Copies all of the text field's text ( including any text that is scrolled out of view) to the system clipboard.
setTextFormat | () | method |
public function setTextFormat(format:TextFormat):void
Since : | ReactorGUI 1.0.0 |
Sets the font format of all text in the text.
Parameters
format:TextFormat — A TextFormat object that specifies formatting settings for
text in the FastTextField. For the sake of performance,
FastTextField supports a limited set of formatting options
only, as follows:
|
See also