Packagefl.controls
Classpublic class TextArea
InheritanceTextArea Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The TextArea component is a multiline text field with a border and optional scroll bars. The TextArea component supports the HTML rendering capabilities of Adobe Flash Player.

View the examples

See also

TextInput


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
  alwaysShowSelection : Boolean
Gets or sets a Boolean value that indicates whether Flash Player highlights a selection in the text field when the text field does not have focus.
TextArea
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
  condenseWhite : Boolean
Gets or sets a Boolean value that indicates whether extra white space is removed from a TextArea component that contains HTML text.
TextArea
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  displayAsPassword : Boolean
Gets or sets a Boolean value that indicates whether the TextArea component instance is the text field for a password.
TextArea
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
  editable : Boolean
Gets or sets a Boolean value that indicates whether the user can edit the text in the component.
TextArea
  enabled : Boolean
[override] Gets or sets a value that indicates whether the component can accept user interaction.
TextArea
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedfocusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 Inheritedheight : Number
[override] Gets or sets the height of the component, in pixels.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  horizontalScrollBar : UIScrollBar
[read-only] Gets a reference to the horizontal scroll bar.
TextArea
  horizontalScrollPolicy : String
Gets or sets the scroll policy for the horizontal scroll bar.
TextArea
  horizontalScrollPosition : Number
Gets or sets the change in the position of the scroll bar thumb, in pixels, after the user scrolls the text field horizontally.
TextArea
  htmlText : String
Gets or sets the HTML representation of the string that the text field contains.
TextArea
  imeMode : String
Gets or sets the mode of the input method editor (IME).
TextArea
  length : Number
[read-only] Gets the count of characters that the TextArea component contains.
TextArea
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
  maxChars : int
Gets or sets the maximum number of characters that a user can enter in the text field.
TextArea
  maxHorizontalScrollPosition : int
[read-only] Gets the maximum value of the horizontalScrollPosition property.
TextArea
  maxVerticalScrollPosition : int
[read-only] Gets the maximum value of the verticalScrollPosition property.
TextArea
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Gets or sets a value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  restrict : String
Gets or sets the string of characters that the text field accepts from a user.
TextArea
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 InheritedrotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Multiplies the current width of the component by a scale factor.
UIComponent
 InheritedscaleY : Number
[override] Multiplies the current height of the component by a scale factor.
UIComponent
 InheritedscaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
  selectionBeginIndex : int
[read-only] Gets the index position of the first selected character in a selection of one or more characters.
TextArea
  selectionEndIndex : int
[read-only] Gets the index position of the last selected character in a selection of one or more characters.
TextArea
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
  text : String
Gets or sets a string which contains the text that is currently in the TextInput component.
TextArea
  textField : flash.text:TextField
A reference to the internal text field of the TextArea component.
TextArea
  textHeight : Number
[read-only] Gets the height of the text, in pixels.
TextArea
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
  textWidth : Number
[read-only] Gets the width of the text, in pixels.
TextArea
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
 Inheritedversion : String = "3.0.0.16"
The version number of the components.
UIComponent
  verticalScrollBar : UIScrollBar
[read-only] Gets a reference to the vertical scroll bar.
TextArea
  verticalScrollPolicy : String
Gets or sets the scroll policy for the vertical scroll bar.
TextArea
  verticalScrollPosition : Number
Gets or sets the change in the position of the scroll bar thumb, in pixels, after the user scrolls the text field vertically.
TextArea
 Inheritedvisible : Boolean
[override] Gets or sets a value that indicates whether the current component instance is visible.
UIComponent
 Inheritedwidth : Number
[override] Gets or sets the width of the component, in pixels.
UIComponent
  wordWrap : Boolean
Gets or sets a Boolean value that indicates whether the text wraps at the end of the line.
TextArea
 Inheritedx : Number
[override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.
UIComponent
 Inheritedy : Number
[override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.
UIComponent
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Public Methods
 MethodDefined By
  
Creates a new TextArea component instance.
TextArea
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
  
Appends the specified string after the last character that the TextArea component contains.
TextArea
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
[override] Shows or hides the focus indicator on this component.
TextArea
 Inherited
Initiates an immediate draw operation, without invalidating everything as invalidateNow does.
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Retrieves the object that currently has focus.
UIComponent
  
Retrieves information about a specified line of text.
TextArea
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
Retrieves a style property that is set in the style lookup chain of the component.
UIComponent
  
[static] Retrieves the default style map for the current component.
TextArea
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
invalidate(property:String, callLater:Boolean = true):void
Marks a property as invalid and redraws the component on the next frame unless otherwise specified.
UIComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
[static] Merges the styles from multiple classes into one object.
UIComponent
 Inherited
Moves the component to the specified position within its parent.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
setSelection(setSelection:int, endIndex:int):void
Sets the range of a selection made in a text area that has focus.
TextArea
 Inherited
setSize(width:Number, height:Number):void
Sets the component to the specified width and height.
UIComponent
 Inherited
setStyle(style:String, value:Object):void
Sets a style property on this component instance.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Validates and updates the properties and layout of this object, redrawing it if necessary.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Returns the specified style for a component, considering all styles set on the global level, component level and instance level.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
  Dispatched when the text in the TextArea component changes.TextArea
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
  Dispatched when the user presses the Enter key while in the component.TextArea
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched after the component visibility changes from visible to invisible.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched after the component is moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched after the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
  Dispatched when the content is scrolled.TextArea
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched after the component visibility changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
  Dispatched when the user enters, deletes, or pastes text into the component.TextArea
Styles
 Style Description Defined By
  
disabledSkin
Type: Class
The class that provides the background for the TextArea component when its enabled property is set to false. The default value is TextArea_disabledSkin.
TextArea
 InheritedType: flash.text.TextFormat
The TextFormat object to use to render the component label when the button is disabled.
UIComponent
  
embedFonts
Type: Boolean
Indicates whether embedded font outlines are used to render the text field. If this value is true, Flash Player renders the text field by using embedded font outlines. If this value is false, Flash Player renders the text field by using device fonts.

If you set the embedFonts property to true for a text field, you must specify a font for that text by using the font property of a TextFormat object that is applied to the text field. If the specified font is not embedded in the SWF file, the text is not displayed.

The default value is false.
TextArea
 InheritedType: Number Format: Length
The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.
UIComponent
 InheritedType: Class
The skin to be used to display focus indicators.
UIComponent
 InheritedType: flash.text.TextFormat
The TextFormat object to use to render the component label.
UIComponent
  
textPadding
Type: Number Format: Length
The padding that separates the component border from the text, in pixels. The default value is 3.
TextArea
  
upSkin
Type: Class
The class that provides the background for the TextArea component. The default value is TextArea_upSkin.
TextArea
Property Detail
alwaysShowSelectionproperty
alwaysShowSelection:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether Flash Player highlights a selection in the text field when the text field does not have focus. If this value is set to true and the text field does not have focus, Flash Player highlights the selection in gray. If this value is set to false and the text field does not have focus, Flash Player does not highlight the selection.

The default value is false.



Implementation
    public function get alwaysShowSelection():Boolean
    public function set alwaysShowSelection(value:Boolean):void

See also

condenseWhiteproperty 
condenseWhite:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether extra white space is removed from a TextArea component that contains HTML text. Examples of extra white space in the component include spaces and line breaks. A value of true indicates that extra white space is removed; a value of false indicates that extra white space is not removed.

This property affects only text that is set by using the htmlText property; it does not affect text that is set by using the text property. If you use the text property to set text, the condenseWhite property is ignored.

If the condenseWhite property is set to true, you must use standard HTML commands, such as <br> and <p>, to place line breaks in the text field.

The default value is false.



Implementation
    public function get condenseWhite():Boolean
    public function set condenseWhite(value:Boolean):void

See also


Example
The following example uses a CheckBox component to toggle a TextArea component's condenseWhite property:

import fl.controls.CheckBox;
import fl.controls.ScrollPolicy;
import fl.controls.TextArea;

var str:String;

var plainTextArea:TextArea = new TextArea();
plainTextArea.verticalScrollPolicy = ScrollPolicy.ON;
plainTextArea.setSize(260, 360);
plainTextArea.move(10, 10);
addChild(plainTextArea);

var htmlTextArea:TextArea = new TextArea();
htmlTextArea.verticalScrollPolicy = ScrollPolicy.ON;
htmlTextArea.condenseWhite = true;
htmlTextArea.setSize(260, 360);
htmlTextArea.move(280, 10);
addChild(htmlTextArea);

var condenseCheckBox:CheckBox = new CheckBox();
condenseCheckBox.textField.autoSize = TextFieldAutoSize.LEFT;
condenseCheckBox.label = "condenseWhite:";
condenseCheckBox.selected = htmlTextArea.condenseWhite;
condenseCheckBox.move(htmlTextArea.x, htmlTextArea.y + htmlTextArea.height);
condenseCheckBox.addEventListener(MouseEvent.CLICK, clickHandler);
addChild(condenseCheckBox);

var urlLdr:URLLoader = new URLLoader();
urlLdr.addEventListener(Event.COMPLETE, completeHandler);
urlLdr.dataFormat = URLLoaderDataFormat.TEXT;
urlLdr.load(new URLRequest("http://www.helpexamples.com/flash/lorem.html"));

function completeHandler(event:Event):void {
    str = event.target.data as String;
    plainTextArea.text = str;
    htmlTextArea.htmlText = str;
}

function clickHandler(event:MouseEvent):void {
    var sel:Boolean = event.currentTarget.selected;
    htmlTextArea.condenseWhite = sel;
    htmlTextArea.htmlText = str;
}
displayAsPasswordproperty 
displayAsPassword:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether the TextArea component instance is the text field for a password. A value of true indicates that the current instance was created to contain a password; a value of false indicates that it was not.

If the value of this property is true, the characters that the user enters in the text area cannot be seen. Instead, an asterisk is displayed in place of each character that the user enters. Additionally, the Cut and Copy commands and their keyboard shortcuts are disabled to prevent the recovery of a password from an unattended computer.

The default value is false.



Implementation
    public function get displayAsPassword():Boolean
    public function set displayAsPassword(value:Boolean):void
editableproperty 
editable:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether the user can edit the text in the component. A value of true indicates that the user can edit the text that the component contains; a value of false indicates that it cannot.

The default value is true.



Implementation
    public function get editable():Boolean
    public function set editable(value:Boolean):void
enabledproperty 
enabled:Boolean[override]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a value that indicates whether the component can accept user interaction. A value of true indicates that the component can accept user interaction; a value of false indicates that it cannot.

If you set the enabled property to false, the color of the container is dimmed and user input is blocked (with the exception of the Label and ProgressBar components).



Implementation
    override public function get enabled():Boolean
    override public function set enabled(value:Boolean):void
horizontalScrollBarproperty 
horizontalScrollBar:UIScrollBar  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets a reference to the horizontal scroll bar.



Implementation
    public function get horizontalScrollBar():UIScrollBar

See also

horizontalScrollPolicyproperty 
horizontalScrollPolicy:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the scroll policy for the horizontal scroll bar. This can be one of the following values:

The default value is ScrollPolicy.AUTO.



Implementation
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void

See also


Example
The following example creates a TextArea component instance and sets its horizontalScrollPolicy property to ScrollPolicy.ON so the horizontal scroll bar will always be visible, regardless of the amount of content currently in the text area:

import fl.controls.TextArea;
import fl.controls.ScrollPolicy;

var myTextArea:TextArea = new TextArea();
myTextArea.wordWrap = false;
myTextArea.horizontalScrollPolicy = ScrollPolicy.ON;
myTextArea.text = "The quick brown fox jumped over the lazy dog.";
myTextArea.setSize(320, 120);
myTextArea.move(10, 10);
addChild(myTextArea);
horizontalScrollPositionproperty 
horizontalScrollPosition:Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the change in the position of the scroll bar thumb, in pixels, after the user scrolls the text field horizontally. If this value is 0, the text field was not horizontally scrolled.

The default value is 0.



Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void

See also

htmlTextproperty 
htmlText:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the HTML representation of the string that the text field contains.

The default value is "".



Implementation
    public function get htmlText():String
    public function set htmlText(value:String):void

See also


Example
The following example creates a TextArea component instance and uses various HTML tags to style the text:

import fl.controls.TextArea;

var myText:String = "";
myText += "<p>You can use the <b> tag to create <b>bold</b> text.</p>";
myText += "<p>You can use the <i> tag to create <i>italic</i> text.</p>";
myText += "<p>You can use the <u> tag to create <u>underlined</a> text.</p>";
myText += "<p>You can use the <a> tag to create <a href='http://www.adobe.com'>links to other sites</a>.</p>";
myText += "<p>You can use the <br> tag to create<br>new lines of text<br>whenever you want.</p>";
myText += "<p>You can use the <font> tag to specificy different font <font color='#FF0000'>colors</font>, <font size='16'>sizes</font>, or <font face='Times New Roman'>faces</font>.</p>";
myText += "<p>You can use the <img> tag to load images or SWF files:<br><img src='http://www.helpexamples.com/flash/images/logo.png'>.</p>";

var myTextArea:TextArea = new TextArea();
myTextArea.htmlText = myText;
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
addChild(myTextArea);
The following example creates a TextArea component instance and creates links using HTML anchor tag:

import fl.controls.TextArea;

var str:String = "<p>Check out the following links:</p>";
str += "<li><a href=\"event:flash\"><u>Flash</u></a></li>";
str += "<li><a href=\"event:flex\"><u>Flex</u></a></li>";
str += "<li><a href=\"event:devnet\"><u>Developer Center</u></a></li>";

var myTextArea:TextArea = new TextArea();
myTextArea.htmlText += str;
myTextArea.setSize(320, 120);
myTextArea.move(10, 10);
myTextArea.addEventListener(TextEvent.LINK, linkHandler);
addChild(myTextArea);

function linkHandler(event:TextEvent):void {
    var url:String = "http://www.adobe.com/go/" + event.text;
    var urlReq:URLRequest = new URLRequest(url);
    navigateToURL(urlReq);
}
imeModeproperty 
imeMode:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the mode of the input method editor (IME). The IME makes it possible for users to use a QWERTY keyboard to enter characters from the Chinese, Japanese, and Korean character sets.

Flash sets the IME to the specified mode when the component gets focus, and restores it to the original value after the component loses focus.

The flash.system.IMEConversionMode class defines constants for the valid values for this property. Set this property to null to prevent the use of the IME with the component.



Implementation
    public function get imeMode():String
    public function set imeMode(value:String):void

See also

lengthproperty 
length:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the count of characters that the TextArea component contains.

The default value is 0.



Implementation
    public function get length():Number

See also

maxCharsproperty 
maxChars:int

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the maximum number of characters that a user can enter in the text field.

The default value is 0.



Implementation
    public function get maxChars():int
    public function set maxChars(value:int):void

See also


Example
The following example creates a TextArea component instance and sets its maxChars property to limit the amount of text that can entered into the text area:

import fl.controls.Label;
import fl.controls.TextArea;

var myTextArea:TextArea = new TextArea();
myTextArea.maxChars = 500;
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
myTextArea.addEventListener(TextEvent.TEXT_INPUT, textInputHandler);
addChild(myTextArea);

var charCountLabel:Label = new Label();
charCountLabel.autoSize = TextFieldAutoSize.LEFT;
charCountLabel.move(myTextArea.x, myTextArea.y + myTextArea.height);
addChild(charCountLabel);

charCountLabel.text = myTextArea.length + " of " + myTextArea.maxChars;

function textInputHandler(event:TextEvent):void {
    updateCount();
}

function updateCount():void {
    charCountLabel.text = myTextArea.length + " of " + myTextArea.maxChars;
}
maxHorizontalScrollPositionproperty 
maxHorizontalScrollPosition:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the maximum value of the horizontalScrollPosition property.

The default value is 0.



Implementation
    public function get maxHorizontalScrollPosition():int

See also

maxVerticalScrollPositionproperty 
maxVerticalScrollPosition:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the maximum value of the verticalScrollPosition property.

The default value is 1.



Implementation
    public function get maxVerticalScrollPosition():int

See also

restrictproperty 
restrict:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the string of characters that the text field accepts from a user.

Note that characters that are not included in this string are accepted in the text field if they are entered programmatically.

The characters in the string are read from left to right. You can specify a character range by using the hyphen (-) character.

If the value of this property is null, the text field accepts all characters. If this property is set to an empty string (""), the text field accepts no characters.

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 default value is null.



Implementation
    public function get restrict():String
    public function set restrict(value:String):void

See also

selectionBeginIndexproperty 
selectionBeginIndex:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the index position of the first selected character in a selection of one or more characters.

The index position of a selected character is zero-based and calculated from the first character that appears in the text area. If there is no selection, this value is set to the position of the caret.

The default value is 0.



Implementation
    public function get selectionBeginIndex():int

See also

selectionEndIndexproperty 
selectionEndIndex:int  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the index position of the last selected character in a selection of one or more characters.

The index position of a selected character is zero-based and calculated from the first character that appears in the text area. If there is no selection, this value is set to the position of the caret.

The default value is 0.



Implementation
    public function get selectionEndIndex():int

See also

textproperty 
text:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a string which contains the text that is currently in the TextInput component. This property contains text that is unformatted and does not have HTML tags. To retrieve this text formatted as HTML, use the htmlText property.

The default value is "".



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

See also

textFieldproperty 
public var textField:flash.text:TextField

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

A reference to the internal text field of the TextArea component.

textHeightproperty 
textHeight:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the height of the text, in pixels.

The default value is 0.



Implementation
    public function get textHeight():Number

See also


Example
The following example creates a TextArea component instance and displays the textWidth and textHeight properties whenever the change event is dispatched:

import fl.controls.Label;
import fl.controls.TextArea;

var myTextArea:TextArea = new TextArea()
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
myTextArea.addEventListener(Event.CHANGE, changeHandler);
addChild(myTextArea);

var widthLabel:Label = new Label();
widthLabel.autoSize = TextFieldAutoSize.LEFT;
widthLabel.text = "textWidth: " + myTextArea.textWidth;
widthLabel.move(340, 10);
addChild(widthLabel);

var heightLabel:Label = new Label();
heightLabel.autoSize = TextFieldAutoSize.LEFT;
heightLabel.text = "textHeight: " + myTextArea.textHeight;
heightLabel.move(340, 30);
addChild(heightLabel);

function changeHandler(event:Event):void {
    widthLabel.text = "textWidth: " + myTextArea.textWidth;
    heightLabel.text = "textHeight: " + myTextArea.textHeight;
}
textWidthproperty 
textWidth:Number  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets the width of the text, in pixels.

The default value is 0.



Implementation
    public function get textWidth():Number

See also


Example
The following example creates a TextArea component instance and displays the textWidth and textHeight properties whenever the change event is dispatched:

import fl.controls.Label;
import fl.controls.TextArea;

var myTextArea:TextArea = new TextArea()
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
myTextArea.addEventListener(Event.CHANGE, changeHandler);
addChild(myTextArea);

var widthLabel:Label = new Label();
widthLabel.autoSize = TextFieldAutoSize.LEFT;
widthLabel.text = "textWidth: " + myTextArea.textWidth;
widthLabel.move(340, 10);
addChild(widthLabel);

var heightLabel:Label = new Label();
heightLabel.autoSize = TextFieldAutoSize.LEFT;
heightLabel.text = "textHeight: " + myTextArea.textHeight;
heightLabel.move(340, 30);
addChild(heightLabel);

function changeHandler(event:Event):void {
    widthLabel.text = "textWidth: " + myTextArea.textWidth;
    heightLabel.text = "textHeight: " + myTextArea.textHeight;
}
verticalScrollBarproperty 
verticalScrollBar:UIScrollBar  [read-only]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets a reference to the vertical scroll bar.



Implementation
    public function get verticalScrollBar():UIScrollBar

See also


Example
The following example creates a TextArea component instance and sets the pageSize property on the components vertical scroll bar:

import fl.controls.TextArea;
import fl.events.ScrollEvent;

var myTextArea:TextArea = new TextArea();
myTextArea.setSize(160, 120);
myTextArea.move(10, 10);
myTextArea.verticalScrollBar.pageSize = 1;
myTextArea.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myTextArea);

var myURLLoader:URLLoader = new URLLoader();
myURLLoader.addEventListener(Event.COMPLETE, completeHandler);
myURLLoader.load(new URLRequest("http://www.helpexamples.com/flash/lorem.txt"));

function scrollHandler(event:ScrollEvent):void {
    trace("scroll: " + myTextArea.verticalScrollPosition + " of " + myTextArea.maxVerticalScrollPosition);
}

function completeHandler(event:Event):void {
    var txt:String = URLLoader(event.currentTarget).data as String;
    myTextArea.text = txt;
}
verticalScrollPolicyproperty 
verticalScrollPolicy:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the scroll policy for the vertical scroll bar. This can be one of the following values:

The default value is ScrollPolicy.AUTO.



Implementation
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void

See also


Example
The following example creates a TextArea component instance and sets its verticalScrollPolicy property to ScrollPolicy.ON so the vertical scroll bar will always be visible, regardless of the amount of content currently in the text area:

import fl.controls.TextArea;
import fl.controls.ScrollPolicy;

var myTextArea:TextArea = new TextArea();
myTextArea.verticalScrollPolicy = ScrollPolicy.ON;
myTextArea.text = "The quick brown fox jumped over the lazy dog.";
myTextArea.setSize(160, 120);
myTextArea.move(10, 10);
addChild(myTextArea);
verticalScrollPositionproperty 
verticalScrollPosition:Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the change in the position of the scroll bar thumb, in pixels, after the user scrolls the text field vertically. If this value is 1, the text field was not vertically scrolled.

The default value is 1.



Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void

See also


Example
The following example uses a Slider component to scroll the contents of a TextArea component:

import fl.controls.ScrollPolicy;
import fl.controls.Slider;
import fl.controls.SliderDirection
import fl.controls.TextArea;
import fl.events.ScrollEvent;
import fl.events.SliderEvent;

var myTextArea:TextArea = new TextArea();
myTextArea.horizontalScrollPolicy = ScrollPolicy.OFF;
myTextArea.verticalScrollPolicy = ScrollPolicy.OFF;
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
myTextArea.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myTextArea)

var mySlider:Slider = new Slider();
mySlider.liveDragging = true;
mySlider.snapInterval = 1;
mySlider.tickInterval = 1;
mySlider.width = myTextArea.width;
mySlider.move(myTextArea.x, myTextArea.y + myTextArea.height + 10);

var urlLdr:URLLoader = new URLLoader();
urlLdr.addEventListener(Event.COMPLETE, completeHandler);
urlLdr.dataFormat = URLLoaderDataFormat.TEXT;
urlLdr.load(new URLRequest("http://www.helpexamples.com/flash/text/lorem.txt"));

function completeHandler(event:Event):void {
    var txt:String = event.target.data as String;
    myTextArea.text = txt;
    myTextArea.drawNow();

    mySlider.minimum = myTextArea.verticalScrollPosition;
    mySlider.maximum = myTextArea.maxVerticalScrollPosition;
    mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
    addChild(mySlider);
}

function scrollHandler(event:ScrollEvent):void {
    trace("scrolled:");
    mySlider.value = event.position;
}

function changeHandler(event:SliderEvent):void {
    trace("changed:");
    myTextArea.verticalScrollPosition = event.value;
}
wordWrapproperty 
wordWrap:Boolean

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets a Boolean value that indicates whether the text wraps at the end of the line. A value of true indicates that the text wraps; a value of false indicates that the text does not wrap.

The default value is true.



Implementation
    public function get wordWrap():Boolean
    public function set wordWrap(value:Boolean):void

See also

Constructor Detail
TextArea()Constructor
public function TextArea()

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates a new TextArea component instance.

Method Detail
appendText()method
public function appendText(text:String):void

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Appends the specified string after the last character that the TextArea component contains. This method is more efficient than concatenating two strings by using an addition assignment on a text property--for example, myTextArea.text += moreText. This method is particularly useful when the TextArea component contains a significant amount of content.

Parameters

text:String — The string to be appended to the existing text.

drawFocus()method 
override public function drawFocus(draw:Boolean):void

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Shows or hides the focus indicator on this component.

The UIComponent class implements this method by creating and positioning an instance of the class that is specified by the focusSkin style.

Parameters

draw:Boolean — Indicates whether to show or hide the focus indicator. If this value is true, the focus indicator is shown; if this value is false, the focus indicator is hidden.

getLineMetrics()method 
public function getLineMetrics(lineIndex:int):flash.text:TextLineMetrics

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Retrieves information about a specified line of text.

Parameters

lineIndex:int — The line number for which information is to be retrieved.

Returns
flash.text:TextLineMetrics
getStyleDefinition()method 
public static function getStyleDefinition():Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns
Object — Default styles object.

See also


Example

The following example creates a style browser for several component classes:
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}
setSelection()method 
public function setSelection(setSelection:int, endIndex:int):void

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Sets the range of a selection made in a text area that has focus. The selection range begins at the index that is specified by the start parameter, and ends at the index that is specified by the end parameter. The selected text is treated as a zero-based string of characters in which the first selected character is located at index 0, the second character at index 1, and so on.

This method has no effect if the text field does not have focus.

Parameters

setSelection:int — The index location of the first character in the selection.
 
endIndex:int — The index position of the last character in the selection.

Event Detail
change Event
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CHANGE

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Dispatched when the text in the TextArea component changes.

The Event.CHANGE constant defines the value of the type property of a change event object.

This event has the following properties:

PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that has had its value modified. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
enter Event  
Event Object Type: fl.events.ComponentEvent
property ComponentEvent.type = fl.events.ComponentEvent.ENTER

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Dispatched when the user presses the Enter key while in the component.

Defines the value of the type property of an enter event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.
scroll Event  
Event Object Type: fl.events.ScrollEvent
property ScrollEvent.type = fl.events.ScrollEvent.SCROLL

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Dispatched when the content is scrolled.

Defines the value of the type property of a scroll event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
delta1; a value that indicates how much scrolling was done.
directionvertical; the direction of the ScrollBar.
position0; the position of the Scrollbar thumb after it was moved.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

Example

The following example loads text into a TextArea component and traces the scroll direction, scroll position and maximum scroll position when the user scrolls the TextArea:

import fl.controls.ScrollBarDirection;
import fl.controls.TextArea;
import fl.events.ScrollEvent;

var myTextArea:TextArea = new TextArea();
myTextArea.setSize(320, 240);
myTextArea.move(10, 10);
myTextArea.addEventListener(ScrollEvent.SCROLL, scrollHandler);
addChild(myTextArea);

var urlLdr:URLLoader = new URLLoader();
urlLdr.addEventListener(Event.COMPLETE, completeHandler);
urlLdr.dataFormat = URLLoaderDataFormat.TEXT;
urlLdr.load(new URLRequest("http://www.helpexamples.com/flash/text/lorem.txt"));

function completeHandler(event:Event):void {
    var txt:String = event.target.data as String;
    myTextArea.text = txt;
}

function scrollHandler(event:ScrollEvent):void {
    var myTA:TextArea = event.currentTarget as TextArea;
    var pos:Number = event.position;
    var maxPos:Number;
    
    if (event.direction == ScrollBarDirection.VERTICAL) {
        maxPos = myTA.maxVerticalScrollPosition;
    } else {
        maxPos = myTA.maxHorizontalScrollPosition;
    }
    trace("scroll: " + event.direction + " (" + pos.toFixed(2) + " of " + maxPos + ")");
}
textInput Event  
Event Object Type: flash.events.TextEvent
property TextEvent.type = flash.events.TextEvent.TEXT_INPUT

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Dispatched when the user enters, deletes, or pastes text into the component.

Defines the value of the type property of a textInput event object.

Note: This event is not dispatched for the Delete or Backspace keys.

This event has the following properties:

PropertyValue
bubblestrue
cancelabletrue; call the preventDefault() method to cancel default behavior.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe text field into which characters are being entered. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.
textThe character or sequence of characters entered by the user.
Examples How to use this example
TextAreaExample.as

This example demonstrates how to listen to the events of an instance of the TextArea class
  1. Drag a TextArea component to the stage and name it ta1.
  2. Drag a TextArea component to the stage and name it ta2.
  3. Save this code as TextAreaExample.as in the same directory as your FLA.
  4. Set the DocumentClass in the FLA to TextAreaExample.
package
{
    import flash.display.Sprite;
    import flash.events.Event;
    import flash.events.TextEvent;
    import flash.text.TextField;
    import fl.events.ComponentEvent;
    import fl.controls.TextArea;
    
    public class TextAreaExample extends Sprite
    {
        private var testString:String         = 'Lorem ipsum dolor sit amet, consectetuer adipiscing elit. Vivamus quis nisl vel tortor nonummy vulputate. Quisque sit amet eros sed purus euismod tempor. Morbi tempor. Class aptent taciti sociosqu ad litora torquent per conubia nostra, per inceptos hymenaeos. Curabitur diam. Suspendisse at purus in ipsum volutpat viverra. Nulla pellentesque libero id libero. Proin pretium suscipit lectus. Donec in sapien vel nulla egestas semper. Mauris massa. In aliquet sem ac libero. In eget orci. Sed feugiat. Vestibulum vel felis in lectus imperdiet scelerisque. Vestibulum vestibulum neque at est. Etiam purus quam, laoreet quis, accumsan sed, porttitor ut, erat. Proin volutpat. In facilisis dolor gravida felis. Curabitur nisi lacus, euismod non, pharetra et, mollis a, tellus. Donec lectus orci, viverra at, luctus ac, sodales id, quam. Phasellus faucibus lacus ut est. Curabitur id diam eu massa bibendum lobortis. Vivamus quis elit. Donec mi justo, dictum vitae, cursus sit amet, lacinia consectetuer, d ut, vulputate sed, molestie et, arcu. Nullam mi.';
        private var testStringHTML:String     = 'This is <font color="#FF0000">HTML text</font> in a <b>TextArea control</b>. Use the <u>htmlText property</u> of the <font color="#008800">TextArea control</font> to include basic HTML markup in your text.';
        
        public function TextAreaExample() {
            ta1.text = testString;
            ta2.htmlText = testStringHTML;
            configureListeners(ta1);
            configureListeners(ta2);
        }
        private function configureListeners(ta:TextArea):void {
            ta.addEventListener(TextEvent.TEXT_INPUT,announceEvent);
            ta.addEventListener(Event.CHANGE,announceEvent);
            ta.addEventListener(ComponentEvent.ENTER,announceEvent);
            ta.addEventListener(Event.SCROLL,announceEvent);            
        }
        private function announceEvent(e:Event):void {
            trace(e.toString());    
        }
    }
}




TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea TextArea
fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea fl.controls.TextArea