Packagenet.user1.reactor.ui
Classpublic class FastTextField
InheritanceFastTextField Inheritance flash.display.Sprite

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

FastTextArea


Public Variables
 VariableDefined 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
Public Methods
 MethodDefined By
  
FastTextField
  
appendText(text:String, color:Object = null):void
Adds the specified text to the end of existing text in the text field.
FastTextField
  
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
Variable Descriptions
autoScrollvariable
autoScroll:Boolean

Since : ReactorGUI 1.0.0

When true, the text field automatically stays scrolled to the last line.


Implementation
    public function get autoScroll():Boolean
    public function set autoScroll(value:Boolean):void
backgroundAlphavariable 
backgroundAlpha:Number


Implementation
    public function get backgroundAlpha():Number
    public function set backgroundAlpha(value:Number):void
backgroundColorvariable 
backgroundColor:uint


Implementation
    public function get backgroundColor():uint
    public function set backgroundColor(value:uint):void
borderAlphavariable 
borderAlpha:Number


Implementation
    public function get borderAlpha():Number
    public function set borderAlpha(value:Number):void
borderColorvariable 
borderColor:uint


Implementation
    public function get borderColor():uint
    public function set borderColor(value:uint):void
borderThicknessvariable 
borderThickness:int


Implementation
    public function get borderThickness():int
    public function set borderThickness(value:int):void
heightvariable 
height:Number[override]


Implementation
    public function get height():Number
    public function set height(value:Number):void
maxLengthvariable 
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.


Implementation
    public function get maxLength():int
    public function set maxLength(value:int):void
maxScrollHvariable 
maxScrollH:int  [read-only]

Since : ReactorGUI 1.0.0

The current maximum allowed value of scrollH.


Implementation
    public function get maxScrollH():int
maxScrollVvariable 
maxScrollV:int  [read-only]

Since : ReactorGUI 1.0.0

The current maximum allowed value of scrollV.


Implementation
    public function get maxScrollV():int
pageLineCountvariable 
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.


Implementation
    public function get pageLineCount():int
pageWidthvariable 
pageWidth:int  [read-only]

Since : ReactorGUI 1.0.0

Returns the width of the text field, not including its border, in pixels.


Implementation
    public function get pageWidth():int
scrollHvariable 
scrollH:int

Since : ReactorGUI 1.0.0

The amount, in pixels, the text in the text field is scrolled to the left.


Implementation
    public function get scrollH():int
    public function set scrollH(value:int):void
scrollVvariable 
scrollV:int

Since : ReactorGUI 1.0.0

The line number currently displayed as the top line of the text field.


Implementation
    public function get scrollV():int
    public function set scrollV(value:int):void
textvariable 
text:String  [write-only]

Since : ReactorGUI 1.0.0

Replaces all text in the text field with the supplied value.


Implementation
    public function set text(value:String):void

See also

appendText()
widthvariable 
width:Number[override]


Implementation
    public function get width():Number
    public function set width(value:Number):void
Constructor Description
FastTextField()Constructor
public function FastTextField()



Method Descriptions
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

appendText()
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:
  • font
  • size
  • color
  • bold
  • italics
  • leading
  • letterSpacing

See also

appendText()