mx.core

# FTETextField - AS3 Flex

Package | mx.core
Class | public class FTETextField
Inheritance | FTETextField Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements | IFontContextComponent
Subclasses | UIFTETextField

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

FTETextField is a Sprite which displays text by using the new Flash Text Engine to implement the old TextField API.

Related API Elements

flash.text.TextField

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance. | InteractiveObject
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | DisplayObject
|  | alpha : Number Indicates the alpha transparency value of the object specified. | DisplayObject
|  | alwaysShowSelection : Boolean This property is not implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | antiAliasType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | autoSize : String Controls automatic sizing and alignment of text fields. | FTETextField
|  | background : Boolean Specifies whether the text field has a background fill. | FTETextField
|  | backgroundColor : uint The color of the text field background. | FTETextField
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | DisplayObject
|  | blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background. | DisplayObject
|  | border : Boolean Specifies whether the text field has a border. | FTETextField
|  | borderColor : uint The color of the text field border. | FTETextField
|  | bottomScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | buttonMode : Boolean Specifies the button mode of this sprite. | Sprite
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | DisplayObject
|  | cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. | DisplayObject
|  | caretIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | condenseWhite : Boolean A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed. | FTETextField
|  | constructor : Object A reference to the class object or constructor function for a given object instance. | Object
|  | contextMenu : NativeMenu Specifies the context menu associated with this object. | InteractiveObject
|  | defaultTextFormat : flash.text:TextFormat Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the replaceSelectedText() method. | FTETextField
|  | direction : String The directionality of the text displayed by the FTETextField. | FTETextField
|  | displayAsPassword : Boolean This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events. | InteractiveObject
|  | dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped. | Sprite
|  | embedFonts : Boolean Specifies whether to render by using embedded font outlines. | FTETextField
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | DisplayObject
|  | focusRect : Object Specifies whether this object displays a focus rectangle. | InteractiveObject
|  | fontContext : IFlexModuleFactory The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. | FTETextField
|  | graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur. | Sprite
|  | gridFitType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | height : Number Indicates the height of the display object, in pixels. | DisplayObject
|  | hitArea : Sprite Designates another sprite to serve as the hit area for a sprite. | Sprite
|  | htmlText : String Contains the HTML representation of the text field contents. | FTETextField
|  | length : int [read-only] The number of characters in a text field. | FTETextField
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | DisplayObject
|  | locale : String The locale of the text displayed by FTETextField. | FTETextField
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | DisplayObject
|  | maxChars : int This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | maxScrollH : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | maxScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject
|  | mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer
|  | mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject
|  | mouseWheelEnabled : Boolean This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | multiline : Boolean This property has no effect in FTETextField because FTETextField does not support editing. | FTETextField
|  | name : String Indicates the instance name of the DisplayObject. | DisplayObject
|  | needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus. | InteractiveObject
|  | numChildren : int [read-only] Returns the number of children of this object. | DisplayObjectContainer
|  | numLines : int [read-only] Defines the number of text lines in a multiline text field. | FTETextField
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | DisplayObject
|  | parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object. | DisplayObject
|  | restrict : String This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | root : 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
|  | rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | DisplayObject
|  | rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | DisplayObject
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | DisplayObject
|  | scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point. | DisplayObject
|  | scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object. | DisplayObject
|  | scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object. | DisplayObject
|  | scrollH : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | DisplayObject
|  | scrollV : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | selectable : Boolean Setting this property has no effect in FTETextField because FTETextField does not support selection. | FTETextField
|  | selectionBeginIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | selectionEndIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | sharpness : Number This property has no effect in FTETextField. | FTETextField
|  | softKeyboard : String Controls the appearance of the soft keyboard. | InteractiveObject
|  | softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject
|  | soundTransform : flash.media:SoundTransform Controls sound within this sprite. | Sprite
|  | stage : Stage [read-only] The Stage of the display object. | DisplayObject
|  | styleSheet : StyleSheet Attaches a style sheet to the text field. | FTETextField
|  | tabChildren : Boolean Determines whether the children of the object are tab enabled. | DisplayObjectContainer
|  | tabEnabled : Boolean Specifies whether this object is in the tab order. | InteractiveObject
|  | tabIndex : int Specifies the tab ordering of objects in a SWF file. | InteractiveObject
|  | text : String A string that is the current text in the text field. | FTETextField
|  | textColor : uint The color of the text in a text field, in hexadecimal format. | FTETextField
|  | textHeight : Number [read-only] The height of the text in pixels. | FTETextField
|  | textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer
|  | textWidth : Number [read-only] The width of the text in pixels. | FTETextField
|  | thickness : Number This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject
|  | type : String The type of the text field. | FTETextField
|  | useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. | Sprite
|  | useRichTextClipboard : Boolean This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. | FTETextField
|  | visible : Boolean Whether or not the display object is visible. | DisplayObject
|  | width : Number Indicates the width of the display object, in pixels. | DisplayObject
|  | wordWrap : Boolean A Boolean value that indicates whether the text field has word wrap. | FTETextField
|  | x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | DisplayObject
|  | y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer. | DisplayObject
|  | z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container. | DisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | FTETextField() Constructor. | FTETextField
|  | addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer
|  | 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
|  | appendText(newText:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | areInaccessibleObjectsUnderPoint(point:Point):Boolean 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
|  | contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself. | DisplayObjectContainer
|  | dispatchEvent(event:Event):Boolean Dispatches an event into the event flow. | EventDispatcher
|  | 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
|  | getCharBoundaries(charIndex:int):Rectangle This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getCharIndexAtPoint(x:Number, y:Number):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name. | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance. | DisplayObjectContainer
|  | getFirstCharInParagraph(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getImageReference(id:String):DisplayObject This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineIndexAtPoint(x:Number, y:Number):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineIndexOfChar(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineLength(lineIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineMetrics(lineIndex:int):flash.text:TextLineMetrics Returns metrics information about a given text line. | FTETextField
|  | getLineOffset(lineIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getLineText(lineIndex:int):String This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer
|  | getParagraphLength(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | 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
|  | getTextFormat(beginIndex:int = -1, endIndex:int = -1):flash.text:TextFormat This method has been implemented in FTETextField to simply return a copy of the defaultTextFormat, because FTETextField does not support formatting a range. | FTETextField
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | DisplayObject
|  | globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates. | DisplayObject
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hitTestObject(obj:DisplayObject):Boolean 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
|  | 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
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | local3DToGlobal(point3d:Vector3D):Point 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
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | DisplayObject
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | replaceSelectedText(value:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | replaceText(beginIndex:int, endIndex:int, newText:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | requestSoftKeyboard():Boolean Raises a virtual keyboard. | InteractiveObject
|  | setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container. | DisplayObjectContainer
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | setSelection(beginIndex:int, endIndex:int):void This method has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | setTextFormat(format:flash.text:TextFormat, beginIndex:int = -1, endIndex:int = -1):void This method has no effect on a FTETextField if beginIndex or endIndex does not equal -1 because FTETextField does not support formatting a range. | FTETextField
|  | startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite. | Sprite
|  | startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device. | Sprite
|  | stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer
|  | stopDrag():void Ends the startDrag() method. | Sprite
|  | stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer
|  | 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
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String Returns the string representation of the specified object. | Object
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | added | Dispatched when a display object is added to the display list. | DisplayObject
|  | addedToStage | Dispatched 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
|  | clear | Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject
|  | click | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | contextMenu | Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject
|  | copy | Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject
|  | cut | Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | doubleClick | Dispatched 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
|  | enterFrame | [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject
|  | exitFrame | [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject
|  | focusIn | Dispatched after a display object gains focus. | InteractiveObject
|  | focusOut | Dispatched after a display object loses focus. | InteractiveObject
|  | frameConstructed | [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject
|  | gestureDirectionalTap | Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject
|  | gestureLongPress | Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gesturePan | Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureRotate | Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureSwipe | Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureTap | Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureZoom | Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | imeStartComposition | This event is dispatched to any client app that supports inline input with an IME | InteractiveObject
|  | keyDown | Dispatched when the user presses a key. | InteractiveObject
|  | keyFocusChange | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject
|  | keyUp | Dispatched when the user releases a key. | InteractiveObject
|  | middleClick | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | middleMouseDown | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject
|  | middleMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseFocusChange | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject
|  | mouseMove | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject
|  | mouseOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | mouseOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | mouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseWheel | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject
|  | nativeDragComplete | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject
|  | nativeDragDrop | Dispatched 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
|  | nativeDragEnter | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject
|  | nativeDragExit | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject
|  | nativeDragOver | Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject
|  | nativeDragStart | Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | nativeDragUpdate | Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | paste | Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject
|  | proximityBegin | Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject
|  | proximityEnd | Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject
|  | proximityMove | Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject
|  | proximityOut | Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityOver | Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOut | Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOver | Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject
|  | releaseOutside | Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject
|  | removed | Dispatched when a display object is about to be removed from the display list. | DisplayObject
|  | removedFromStage | Dispatched 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
|  | render | [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject
|  | rightClick | Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | rightMouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rightMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rollOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | rollOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | selectAll | Dispatched 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
|  | softKeyboardActivate | Dispatched immediately after the soft keyboard is raised. | InteractiveObject
|  | softKeyboardActivating | Dispatched immediately before the soft keyboard is raised. | InteractiveObject
|  | softKeyboardDeactivate | Dispatched immediately after the soft keyboard is lowered. | InteractiveObject
|  | tabChildrenChange | Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject
|  | tabEnabledChange | Dispatched when the object's tabEnabled flag changes. | InteractiveObject
|  | tabIndexChange | Dispatched when the value of the object's tabIndex property changes. | InteractiveObject
|  | textInput | Dispatched when a user enters one or more characters of text. | InteractiveObject
|  | touchBegin | Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchEnd | Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchMove | Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject
|  | touchOut | Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOut | Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchTap | Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject

Property Detail

### alwaysShowSelection

property

`alwaysShowSelection:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property is not implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.alwaysShowSelection

### antiAliasType

property

`antiAliasType:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. Getting it will always return `null` and setting it will do nothing.

Implementation
`public function get antiAliasType():String`
`public function set antiAliasType(value:String):void`

Related API Elements

flash.text.TextField.antiAliasType

### autoSize

property

`autoSize:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Controls automatic sizing and alignment of text fields. Acceptable values for the `TextFieldAutoSize` constants: `TextFieldAutoSize.NONE` (the default), `TextFieldAutoSize.LEFT`, `TextFieldAutoSize.RIGHT`, and `TextFieldAutoSize.CENTER`.

If `autoSize` is set to `TextFieldAutoSize.NONE` (the default) no resizing occurs.

If `autoSize` is set to `TextFieldAutoSize.LEFT`, the text is treated as left-justified text, meaning that the left margin of the text field remains fixed and any resizing of a single line of the text field is on the right margin. If the text includes a line break (for example, `"\n"` or `"\r"`), the bottom is also resized to fit the next line of text. If `wordWrap` is also set to `true`, only the bottom of the text field is resized and the right side remains fixed.

If `autoSize` is set to `TextFieldAutoSize.RIGHT`, the text is treated as right-justified text, meaning that the right margin of the text field remains fixed and any resizing of a single line of the text field is on the left margin. If the text includes a line break (for example, `"\n" or "\r")`, the bottom is also resized to fit the next line of text. If `wordWrap` is also set to `true`, only the bottom of the text field is resized and the left side remains fixed.

If `autoSize` is set to `TextFieldAutoSize.CENTER`, the text is treated as center-justified text, meaning that any resizing of a single line of the text field is equally distributed to both the right and left margins. If the text includes a line break (for example, `"\n"` or `"\r"`), the bottom is also resized to fit the next line of text. If `wordWrap` is also set to `true`, only the bottom of the text field is resized and the left and right sides remain fixed.

Implementation
`public function get autoSize():String`
`public function set autoSize(value:String):void`

### background

property

`background:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies whether the text field has a background fill. If `true`, the text field has a background fill. If `false`, the text field has no background fill. Use the `backgroundColor` property to set the background color of a text field.

Implementation
`public function get background():Boolean`
`public function set background(value:Boolean):void`

### backgroundColor

property

`backgroundColor:uint`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The color of the text field background. The default value is `0xFFFFFF` (white). This property can be retrieved or set, even if there currently is no background, but the color is visible only if the text field has the `background` property set to `true`.

Implementation
`public function get backgroundColor():uint`
`public function set backgroundColor(value:uint):void`

### border

property

`border:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies whether the text field has a border. If `true`, the text field has a border. If `false`, the text field has no border. Use the `borderColor` property to set the border color.

Implementation
`public function get border():Boolean`
`public function set border(value:Boolean):void`

### borderColor

property

`borderColor:uint`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The color of the text field border. The default value is `0x000000` (black). This property can be retrieved or set, even if there currently is no border, but the color is visible only if the text field has the `border` property set to `true`.

Implementation
`public function get borderColor():uint`
`public function set borderColor(value:uint):void`

### bottomScrollV

property

`bottomScrollV:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

Implementation
`public function get bottomScrollV():int`

Related API Elements

flash.text.TextField.bottomScrollV

### caretIndex

property

`caretIndex:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.

Implementation
`public function get caretIndex():int`

Related API Elements

flash.text.TextField.caretIndex

### condenseWhite

property

`condenseWhite:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text is removed. The default value is `false`. The `condenseWhite` property only affects text set with the `htmlText` property, not the `text` property. If you set text with the `text` property, `condenseWhite` is ignored.

If `condenseWhite` is set to `true`, use standard HTML commands such as `<BR>` and `<P>` to place line breaks in the text field.

Set the `condenseWhite` property before setting the `htmlText` property.

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

### defaultTextFormat

property

`defaultTextFormat:flash.text:TextFormat`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the `replaceSelectedText()` method.

Note: When selecting characters to be replaced with `setSelection()` and `replaceSelectedText()`, the `defaultTextFormat` will be applied only if the text has been selected up to and including the last character. Here is an example:

         var my_txt:TextField new TextField();
         my_txt.text = "Flash Macintosh version";
         var my_fmt:TextFormat = new TextFormat();
         my_fmt.color = 0xFF0000;
         my_txt.defaultTextFormat = my_fmt;
         my_txt.setSelection(6,15); // partial text selected - defaultTextFormat not applied
         my_txt.setSelection(6,23); // text selected to end - defaultTextFormat applied
         my_txt.replaceSelectedText("Windows version");

When you access the `defaultTextFormat` property, the returned TextFormat object has all of its properties defined. No property is `null`.

Note: You can't set this property if a style sheet is applied to the text field.

Implementation
`public function get defaultTextFormat():flash.text:TextFormat`
`public function set defaultTextFormat(value:flash.text:TextFormat):void`

### direction

property

`direction:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The directionality of the text displayed by the FTETextField.

The allowed values are `"ltr"` for left-to-right text, as in Latin-style scripts, and `"rtl"` for right-to-left text, as in Arabic and Hebrew.

Note: This property does not exist in the flash.text.TextField API.

The default value is `"ltr".`

Implementation
`public function get direction():String`
`public function set direction(value:String):void`

### displayAsPassword

property

`displayAsPassword:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.displayAsPassword

### embedFonts

property

`embedFonts:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Specifies whether to render by using embedded font outlines. If `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 applied to the text field. If the specified font is not embedded in the SWF file, the text is not displayed.

Implementation
`public function get embedFonts():Boolean`
`public function set embedFonts(value:Boolean):void`

### fontContext

property

`fontContext:IFlexModuleFactory`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. This is usually, but not always, an ISWFContext.

Set this if you need lines to be created in a different SWF context than the one containing the TLF code.

Note: This property does not exist in the flash.text.TextField API.

The default value is `null.`

Implementation
`public function get fontContext():IFlexModuleFactory`
`public function set fontContext(value:IFlexModuleFactory):void`

### gridFitType

property

`gridFitType:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. Getting it will always return `null` and setting it will do nothing.

Implementation
`public function get gridFitType():String`
`public function set gridFitType(value:String):void`

Related API Elements

flash.text.TextField.gridFitType

### htmlText

property

`htmlText:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Contains the HTML representation of the text field contents.

Flash Player supports the following HTML tags:

Tag | Description
--- | ---
Anchor tag | The `<a>` tag creates a hypertext link and supports the following attributes:

- `target`: Specifies the name of the target window where you load the page. Options include `_self`, `_blank`, `_parent`, and `_top`. The `_self` option specifies the current frame in the current window, `_blank` specifies a new window, `_parent` specifies the parent of the current frame, and `_top` specifies the top-level frame in the current window.
- `href`: Specifies a URL or an ActionScript `link` event.The URL can be either absolute or relative to the location of the SWF file that is loading the page. An example of an absolute reference to a URL is `http://www.adobe.com`; an example of a relative reference is `/index.html`. Absolute URLs must be prefixed with http://; otherwise, Flash Player or AIR treats them as relative URLs. You can use the `link` event to cause the link to execute an ActionScript function in a SWF file instead of opening a URL. To specify a `link` event, use the event scheme instead of the http scheme in your `href` attribute. An example is `href="event:myText"` instead of `href="http://myURL"`; when the user clicks a hypertext link that contains the event scheme, the text field dispatches a `link` TextEvent with its `text` property set to "`myText`". You can then create an ActionScript function that executes whenever the link TextEvent is dispatched. You can also define `a:link`, `a:hover`, and `a:active` styles for anchor tags by using style sheets.

Bold tag | The `<b>` tag renders text as bold. A bold typeface must be available for the font used.
Break tag | The `<br>` tag creates a line break in the text field. Set the text field to be a multiline text field to use this tag.
Font tag | The `<font>` tag specifies a font or list of fonts to display the text.The font tag supports the following attributes:

- `color`: Only hexadecimal color (`#FFFFFF`) values are supported.
- `face`: Specifies the name of the font to use. As shown in the following example, you can specify a list of comma-delimited font names, in which case Flash Player selects the first available font. If the specified font is not installed on the local computer system or isn't embedded in the SWF file, Flash Player selects a substitute font.
- `size`: Specifies the size of the font. You can use absolute pixel sizes, such as 16 or 18, or relative point sizes, such as +2 or -4.

Image tag | The `<img>` tag lets you embed external image files (JPEG, GIF, PNG), SWF files, and movie clips inside text fields. Text automatically flows around images you embed in text fields. You must set the text field to be multiline to wrap text around an image.

The `<img>` tag supports the following attributes:

- `src`: Specifies the URL to an image or SWF file, or the linkage identifier for a movie clip symbol in the library. This attribute is required; all other attributes are optional. External files (JPEG, GIF, PNG, and SWF files) do not show until they are downloaded completely.
- `width`: The width of the image, SWF file, or movie clip being inserted, in pixels.
- `height`: The height of the image, SWF file, or movie clip being inserted, in pixels.
- `align`: Specifies the horizontal alignment of the embedded image within the text field. Valid values are `left` and `right`. The default value is `left`.
- `hspace`: Specifies the amount of horizontal space that surrounds the image where no text appears. The default value is 8.
- `vspace`: Specifies the amount of vertical space that surrounds the image where no text appears. The default value is 8.
- `id`: Specifies the name for the movie clip instance (created by Flash Player) that contains the embedded image file, SWF file, or movie clip. This approach is used to control the embedded content with ActionScript.
- `checkPolicyFile`: Specifies that Flash Player checks for a URL policy file on the server associated with the image domain. If a policy file exists, SWF files in the domains listed in the file can access the data of the loaded image, for example, by calling the `BitmapData.draw()` method with this image as the `source` parameter. For more information related to security, see the Flash Player Developer Center Topic: Security.

Flash displays media embedded in a text field at full size. To specify the dimensions of the media you are embedding, use the `<img>` tag `height` and `width` attributes.

In general, an image embedded in a text field appears on the line following the `<img>` tag. However, when the `<img>` tag is the first character in the text field, the image appears on the first line of the text field.

For AIR content in the application security sandbox, AIR ignores `img` tags in HTML content in ActionScript TextField objects. This is to prevent possible phishing attacks,

Italic tag | The `<i>` tag displays the tagged text in italics. An italic typeface must be available for the font used.
List item tag | The `<li>` tag places a bullet in front of the text that it encloses. Note: Because Flash Player and AIR do not recognize ordered and unordered list tags (`<ol>` and `<ul>`, they do not modify how your list is rendered. All lists are unordered and all list items use bullets.
Paragraph tag | The `<p>` tag creates a new paragraph. The text field must be set to be a multiline text field to use this tag. The `<p>` tag supports the following attributes:

- align: Specifies alignment of text within the paragraph; valid values are `left`, `right`, `justify`, and `center`.
- class: Specifies a CSS style class defined by a flash.text.StyleSheet object.

Span tag | The `<span>` tag is available only for use with CSS text styles. It supports the following attribute:

- class: Specifies a CSS style class defined by a flash.text.StyleSheet object.

Text format tag | The `<textformat>` tag lets you use a subset of paragraph formatting properties of the TextFormat class within text fields, including line leading, indentation, margins, and tab stops. You can combine `<textformat>` tags with the built-in HTML tags.

The `<textformat>` tag has the following attributes:

- `blockindent`: Specifies the block indentation in points; corresponds to `TextFormat.blockIndent`.
- `indent`: Specifies the indentation from the left margin to the first character in the paragraph; corresponds to `TextFormat.indent`. Both positive and negative numbers are acceptable.
- `leading`: Specifies the amount of leading (vertical space) between lines; corresponds to `TextFormat.leading`. Both positive and negative numbers are acceptable.
- `leftmargin`: Specifies the left margin of the paragraph, in points; corresponds to `TextFormat.leftMargin`.
- `rightmargin`: Specifies the right margin of the paragraph, in points; corresponds to `TextFormat.rightMargin`.
- `tabstops`: Specifies custom tab stops as an array of non-negative integers; corresponds to `TextFormat.tabStops`.

Underline tag | The `<u>` tag underlines the tagged text.

Flash Player and AIR support the following HTML entities:

Entity | Description
--- | ---
&lt; | < (less than)
&gt; | > (greater than)
&amp; | & (ampersand)
&quot; | " (double quotes)
&apos; | ' (apostrophe, single quote)

Flash Player and AIR also support explicit character codes, such as &#38; (ASCII ampersand) and &#x20AC; (Unicode € symbol).

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

### length

property

`length:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The number of characters in a text field. A character such as tab (`\t`) counts as one character.

Implementation
`public function get length():int`

### locale

property

`locale:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The locale of the text displayed by FTETextField.

FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.

Implementation
`public function get locale():String`
`public function set locale(value:String):void`

### maxChars

property

`maxChars:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support editing. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.maxChars

### maxScrollH

property

`maxScrollH:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

Implementation
`public function get maxScrollH():int`

Related API Elements

flash.text.TextField.maxScrollH

### maxScrollV

property

`maxScrollV:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

Implementation
`public function get maxScrollV():int`

Related API Elements

flash.text.TextField.maxScrollV

### mouseWheelEnabled

property

`mouseWheelEnabled:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Getting it will always return `false` and setting it will do nothing.

Implementation
`public function get mouseWheelEnabled():Boolean`
`public function set mouseWheelEnabled(value:Boolean):void`

Related API Elements

flash.text.TextField.mouseWheelEnabled

### multiline

property

`multiline:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has no effect in FTETextField because FTETextField does not support editing. However, you can get and set it.

Implementation
`public function get multiline():Boolean`
`public function set multiline(value:Boolean):void`

Related API Elements

flash.text.TextField.multiline

### numLines

property

`numLines:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Defines the number of text lines in a multiline text field. If `wordWrap` property is set to `true`, the number of lines increases when text wraps.

Implementation
`public function get numLines():int`

### restrict

property

`restrict:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.restrict

### scrollH

property

`scrollH:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.scrollH

### scrollV

property

`scrollV:int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support scrolling. Accessing it will throw a runtime error.

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

Related API Elements

flash.text.TextField.scrollV

### selectable

property

`selectable:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Setting this property has no effect in FTETextField because FTETextField does not support selection. If you get it, it will always be `false`.

Implementation
`public function get selectable():Boolean`
`public function set selectable(value:Boolean):void`

Related API Elements

flash.text.TextField.selectable

### selectionBeginIndex

property

`selectionBeginIndex:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.

Implementation
`public function get selectionBeginIndex():int`

Related API Elements

flash.text.TextField.selectionBeginIndex

### selectionEndIndex

property

`selectionEndIndex:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has not been implemented in FTETextField because FTETextField does not support selection. Accessing it will throw a runtime error.

Implementation
`public function get selectionEndIndex():int`

Related API Elements

flash.text.TextField.selectionEndIndex

### sharpness

property

`sharpness:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has no effect in FTETextField. because FTE uses a newer font renderer than TextField. Getting it will always return `NaN` and setting it will do nothing.

Implementation
`public function get sharpness():Number`
`public function set sharpness(value:Number):void`

Related API Elements

flash.text.TextField.sharpness

### styleSheet

property

`styleSheet:StyleSheet`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Attaches a style sheet to the text field. For information on creating style sheets, see the StyleSheet class and the ActionScript 3.0 Developer's Guide.

You can change the style sheet associated with a text field at any time. If you change the style sheet in use, the text field is redrawn with the new style sheet. You can set the style sheet to `null` or `undefined` to remove the style sheet. If the style sheet in use is removed, the text field is redrawn without a style sheet.

Note: If the style sheet is removed, the contents of both `TextField.text` and `TextField.htmlText` change to incorporate the formatting previously applied by the style sheet. To preserve the original `TextField.htmlText` contents without the formatting, save the value in a variable before removing the style sheet.

Implementation
`public function get styleSheet():StyleSheet`
`public function set styleSheet(value:StyleSheet):void`

Related API Elements

flash.text.StyleSheet

### text

property

`text:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

A string that is the current text in the text field. Lines are separated by the carriage return character (`'\r'`, ASCII 13). This property contains unformatted text in the text field, without HTML tags.

To get the text in HTML form, use the `htmlText` property.

Note: If a style sheet is applied to the text field the content of the `text` property will be interpreted as HTML.

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

### textColor

property

`textColor:uint`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The color of the text in a text field, in hexadecimal format. The hexadecimal color system uses six digits to represent color values. Each digit has 16 possible values or characters. The characters range from 0-9 and then A-F. For example, black is `0x000000`; white is `0xFFFFFF`.

Implementation
`public function get textColor():uint`
`public function set textColor(value:uint):void`

### textHeight

property

`textHeight:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The height of the text in pixels.

Implementation
`public function get textHeight():Number`

### textWidth

property

`textWidth:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The width of the text in pixels.

Implementation
`public function get textWidth():Number`

### thickness

property

`thickness:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. Getting it will always return `NaN` and setting it will do nothing.

Implementation
`public function get thickness():Number`
`public function set thickness(value:Number):void`

Related API Elements

flash.text.TextField.thickness

### type

property

`type:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The type of the text field. Either one of the following TextFieldType constants: `TextFieldType.DYNAMIC`, which specifies a dynamic text field, which a user cannot edit, or `TextFieldType.INPUT`, which specifies an input text field, which a user can edit.

Implementation
`public function get type():String`
`public function set type(value:String):void`

### useRichTextClipboard

property

`useRichTextClipboard:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. Accessing it will throw a runtime error.

Implementation
`public function get useRichTextClipboard():Boolean`
`public function set useRichTextClipboard(value:Boolean):void`

Related API Elements

flash.text.TextField.useRichTextClipboard

### wordWrap

property

`wordWrap:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

A Boolean value that indicates whether the text field has word wrap. If the value of `wordWrap` is `true`, the text field has word wrap; if the value is `false`, the text field does not have word wrap. The default value is `false`.

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

### FTETextField

()
Constructor

`public function FTETextField()`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Constructor.

Method Detail

### appendText

()
method

`public function appendText(newText:String):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `newText:String` — n/a

Related API Elements

flash.text.TextField.appendText()

### getCharBoundaries

()
method

`public function getCharBoundaries(charIndex:int):Rectangle`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `charIndex:int` — n/a

Returns

| `Rectangle` — n/a

Related API Elements

flash.text.TextField.getCharBoundaries()

### getCharIndexAtPoint

()
method

`public function getCharIndexAtPoint(x:Number, y:Number):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `x:Number` — n/a
| `y:Number` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getCharIndexAtPoint()

### getFirstCharInParagraph

()
method

`public function getFirstCharInParagraph(charIndex:int):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `charIndex:int` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getFirstCharInParagraph()

### getImageReference

()
method

`public function getImageReference(id:String):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `id:String` — n/a

Returns

| `DisplayObject` — n/a

Related API Elements

flash.text.TextField.getImageReference()

### getLineIndexAtPoint

()
method

`public function getLineIndexAtPoint(x:Number, y:Number):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `x:Number` — n/a
| `y:Number` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getLineIndexAtPoint()

### getLineIndexOfChar

()
method

`public function getLineIndexOfChar(charIndex:int):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `charIndex:int` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getLineIndexOfChar()

### getLineLength

()
method

`public function getLineLength(lineIndex:int):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `lineIndex:int` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getLineLength()

### getLineMetrics

()
method

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

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns metrics information about a given text line.

Parameters

| `lineIndex:int` — The line number for which you want metrics information.

Returns

| `flash.text:TextLineMetrics` — A TextLineMetrics object.

### getLineOffset

()
method

`public function getLineOffset(lineIndex:int):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `lineIndex:int` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getLineOffset()

### getLineText

()
method

`public function getLineText(lineIndex:int):String`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `lineIndex:int` — n/a

Returns

| `String` — n/a

Related API Elements

flash.text.TextField.getLineText()

### getParagraphLength

()
method

`public function getParagraphLength(charIndex:int):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `charIndex:int` — n/a

Returns

| `int` — n/a

Related API Elements

flash.text.TextField.getParagraphLength()

### getTextFormat

()
method

`public function getTextFormat(beginIndex:int = -1, endIndex:int = -1):flash.text:TextFormat`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has been implemented in FTETextField to simply return a copy of the `defaultTextFormat`, because FTETextField does not support formatting a range.

Parameters

| `beginIndex:int` (default = `-1`)`` — n/a
| `endIndex:int` (default = `-1`)`` — n/a

Returns

| `flash.text:TextFormat` — n/a

Related API Elements

flash.text.TextField.getTextFormat()

### replaceSelectedText

()
method

`public function replaceSelectedText(value:String):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `value:String` — n/a

Related API Elements

flash.text.TextField.replaceSelectedText()

### replaceText

()
method

`public function replaceText(beginIndex:int, endIndex:int, newText:String):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because very few components use it in TextField. It will throw a runtime error if called.

Parameters

| `beginIndex:int` — n/a
| `endIndex:int` — n/a
| `newText:String` — n/a

Related API Elements

flash.text.TextField.replaceText()

### setSelection

()
method

`public function setSelection(beginIndex:int, endIndex:int):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has not been implemented in FTETextField because FTETextField does not support selection. It will throw a runtime error if called.

Parameters

| `beginIndex:int` — n/a
| `endIndex:int` — n/a

Related API Elements

flash.text.TextField.setSelection()

### setTextFormat

()
method

`public function setTextFormat(format:flash.text:TextFormat, beginIndex:int = -1, endIndex:int = -1):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

This method has no effect on a FTETextField if `beginIndex` or `endIndex` does not equal -1 because FTETextField does not support formatting a range.

Parameters

| `format:flash.text:TextFormat` — n/a
| `beginIndex:int` (default = `-1`)`` — n/a
| `endIndex:int` (default = `-1`)`` — n/a

Related API Elements

flash.text.TextField.setTextFormat()

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00