Apache Flex 4.16.0 API Reference | All Packages | All Classes | Index | Frames No Frames |
IUITextField

Package | mx.core
Interface | public interface IUITextField extends IIMESupport, IFlexModule, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUIComponent, IFlexDisplayObject, IFlexDisplayObject, flash.display.IBitmapDrawable, flash.events.IEventDispatcher
Implementors | UIFTETextField, UITextField

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The IUITextField interface defines the basic set of APIs for UITextField instances.

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityProperties : AccessibilityProperties | IFlexDisplayObject
|  | alpha : Number | IFlexDisplayObject
|  | alwaysShowSelection : Boolean | IUITextField
|  | antiAliasType : String | IUITextField
|  | autoSize : String | IUITextField
|  | background : Boolean | IUITextField
|  | backgroundColor : uint | IUITextField
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | IUIComponent
|  | blendMode : String | IFlexDisplayObject
|  | border : Boolean | IUITextField
|  | borderColor : uint | IUITextField
|  | bottomScrollV : int [read-only] | IUITextField
|  | cacheAsBitmap : Boolean | IFlexDisplayObject
|  | caretIndex : int [read-only] | IUITextField
|  | condenseWhite : Boolean | IUITextField
|  | defaultTextFormat : TextFormat | IUITextField
|  | displayAsPassword : Boolean | IUITextField
|  | document : Object A reference to the document object associated with this component. | IUIComponent
|  | doubleClickEnabled : Boolean | IUITextField
|  | embedFonts : Boolean | IUITextField
|  | enabled : Boolean Whether the component can accept user interaction. | IUIComponent
|  | enableIME : Boolean [read-only] Specifies whether the IME should be enabled when this component has focus. | IIMESupport
|  | explicitHeight : Number The explicitly specified height for the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitMinWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | explicitWidth : Number The explicitly specified width for the component, in pixels, as the component's coordinates. | IUIComponent
|  | filters : Array | IFlexDisplayObject
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | IUIComponent
|  | focusRect : Object | IUITextField
|  | gridFitType : String | IUITextField
|  | height : Number | IFlexDisplayObject
|  | htmlText : String | IUITextField
|  | ignorePadding : Boolean If true, the paddingLeft and paddingRight styles will not add space around the text of the component. | IUITextField
|  | imeMode : String The IME mode of the component. | IIMESupport
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | IUIComponent
|  | inheritingStyles : Object The beginning of this UITextField's chain of inheriting styles. | IUITextField
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | IUIComponent
|  | length : int [read-only] | IUITextField
|  | loaderInfo : LoaderInfo [read-only] | IFlexDisplayObject
|  | mask : DisplayObject | IFlexDisplayObject
|  | maxChars : int | IUITextField
|  | maxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | maxScrollH : int [read-only] | IUITextField
|  | maxScrollV : int [read-only] | IUITextField
|  | maxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | measuredHeight : Number [read-only] The measured height of this object. | IFlexDisplayObject
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | IUIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | IUIComponent
|  | measuredWidth : Number [read-only] The measured width of this object. | IFlexDisplayObject
|  | minHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates. | IUIComponent
|  | minWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates. | IUIComponent
|  | mouseEnabled : Boolean | IUITextField
|  | mouseWheelEnabled : Boolean | IUITextField
|  | mouseX : Number [read-only] | IFlexDisplayObject
|  | mouseY : Number [read-only] | IFlexDisplayObject
|  | multiline : Boolean | IUITextField
|  | name : String | IFlexDisplayObject
|  | nestLevel : int Depth of this object in the containment hierarchy. | IUITextField
|  | nonInheritingStyles : Object The beginning of this UITextField's chain of non-inheriting styles. | IUITextField
|  | nonZeroTextHeight : Number [read-only] Unlike textHeight, this returns a non-zero value even when the text is empty. | IUITextField
|  | numLines : int [read-only] | IUITextField
|  | opaqueBackground : Object | IFlexDisplayObject
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | IUIComponent
|  | parent : DisplayObjectContainer [read-only] | IFlexDisplayObject
|  | percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size. | IUIComponent
|  | percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size. | IUIComponent
|  | restrict : String | IUITextField
|  | root : DisplayObject [read-only] | IFlexDisplayObject
|  | rotation : Number | IFlexDisplayObject
|  | scale9Grid : Rectangle | IFlexDisplayObject
|  | scaleX : Number | IFlexDisplayObject
|  | scaleY : Number | IFlexDisplayObject
|  | scrollH : int | IUITextField
|  | scrollRect : Rectangle | IFlexDisplayObject
|  | scrollV : int | IUITextField
|  | selectable : Boolean | IUITextField
|  | selectionBeginIndex : int [read-only] | IUITextField
|  | selectionEndIndex : int [read-only] | IUITextField
|  | sharpness : Number | IUITextField
|  | stage : Stage [read-only] | IFlexDisplayObject
|  | styleName : Object The source of this object's style values. | ISimpleStyleClient
|  | styleSheet : StyleSheet | IUITextField
|  | systemManager : ISystemManager A reference to the SystemManager object for this component. | IUIComponent
|  | tabEnabled : Boolean | IUITextField
|  | tabIndex : int | IUITextField
|  | text : String | IUITextField
|  | textColor : uint | IUITextField
|  | textHeight : Number [read-only] | IUITextField
|  | textWidth : Number [read-only] | IUITextField
|  | thickness : Number | IUITextField
|  | toolTip : String The text of this component's tooltip. | IToolTipManagerClient
|  | transform : Transform | IFlexDisplayObject
|  | tweeningProperties : Array Used by EffectManager. | IUIComponent
|  | type : String | IUITextField
|  | useRichTextClipboard : Boolean | IUITextField
|  | visible : Boolean | IFlexDisplayObject
|  | width : Number | IFlexDisplayObject
|  | wordWrap : Boolean | IUITextField
|  | x : Number | IFlexDisplayObject
|  | y : Number | IFlexDisplayObject

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | appendText(newText:String):void | IUITextField
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle | IFlexDisplayObject
|  | getCharBoundaries(charIndex:int):Rectangle | IUITextField
|  | getCharIndexAtPoint(x:Number, y:Number):int | IUITextField
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | IUIComponent
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | IUIComponent
|  | getFirstCharInParagraph(charIndex:int):int | IUITextField
|  | getImageReference(id:String):DisplayObject | IUITextField
|  | getLineIndexAtPoint(x:Number, y:Number):int | IUITextField
|  | getLineIndexOfChar(charIndex:int):int | IUITextField
|  | getLineLength(lineIndex:int):int | IUITextField
|  | getLineMetrics(lineIndex:int):TextLineMetrics | IUITextField
|  | getLineOffset(lineIndex:int):int | IUITextField
|  | getLineText(lineIndex:int):String | IUITextField
|  | getParagraphLength(charIndex:int):int | IUITextField
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle | IFlexDisplayObject
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | IUITextField
|  | getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat | IUITextField
|  | getUITextFormat():UITextFormat Returns a UITextFormat object that contains formatting information for this component. | IUITextField
|  | globalToLocal(point:Point):Point | IFlexDisplayObject
|  | hitTestObject(obj:DisplayObject):Boolean | IFlexDisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean | IFlexDisplayObject
|  | initialize():void Initialize the object. | IUIComponent
|  | invalidateDisplayList():void Calling this method results in a call to the component's validateDisplayList() method before the display list is rendered. | IInvalidating
|  | invalidateProperties():void Calling this method results in a call to the component's validateProperties() method before the display list is rendered. | IInvalidating
|  | invalidateSize():void Calling this method results in a call to the component's validateSize() method before the display list is rendered. | IInvalidating
|  | localToGlobal(point:Point):Point | IFlexDisplayObject
|  | move(x:Number, y:Number):void Moves this object to the specified x and y coordinates. | IFlexDisplayObject
|  | owns(displayObject:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | IUIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | IUIComponent
|  | replaceSelectedText(value:String):void | IUITextField
|  | replaceText(beginIndex:int, endIndex:int, newText:String):void | IUITextField
|  | setActualSize(newWidth:Number, newHeight:Number):void Sets the actual size of this object. | IFlexDisplayObject
|  | setColor(color:uint):void Sets the font color of the text. | IUITextField
|  | setFocus():void Sets the focus to this component. | IUITextField
|  | setSelection(beginIndex:int, endIndex:int):void | IUITextField
|  | setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void | IUITextField
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | IUIComponent
|  | styleChanged(styleProp:String):void Called when the value of a style property is changed. | ISimpleStyleClient
|  | truncateToFit(truncationIndicator:String = null):Boolean Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. | IUITextField
|  | validateNow():void Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary. | IInvalidating

Property Detail

alwaysShowSelection | property

`alwaysShowSelection:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

antiAliasType | property |

`antiAliasType:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

autoSize | property |

`autoSize:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get bottomScrollV():int`

caretIndex | property |

`caretIndex:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get caretIndex():int`

condenseWhite | property |

`condenseWhite:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

defaultTextFormat | property |

`defaultTextFormat:TextFormat`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

displayAsPassword | property |

`displayAsPassword:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

doubleClickEnabled | property |

`doubleClickEnabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

embedFonts | property |

`embedFonts:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

focusRect | property |

`focusRect:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get focusRect():Object`
`public function set focusRect(value:Object):void`

gridFitType | property |

`gridFitType:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

htmlText | property |

`htmlText:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

ignorePadding | property |

`ignorePadding:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

If `true`, the `paddingLeft` and `paddingRight` styles will not add space around the text of the component.

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

inheritingStyles | property |

`inheritingStyles:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The beginning of this UITextField's chain of inheriting styles. The `getStyle()` method accesses `inheritingStyles[styleName]` to search the entire prototype-linked chain. This object is set up by the `initProtoChain()` method. You typically never need to access this property directly.

Implementation
`public function get inheritingStyles():Object`
`public function set inheritingStyles(value:Object):void`

length | property |

`length:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get length():int`

maxChars | property |

`maxChars:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

maxScrollH | property |

`maxScrollH:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get maxScrollH():int`

maxScrollV | property |

`maxScrollV:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get maxScrollV():int`

mouseEnabled | property |

`mouseEnabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

mouseWheelEnabled | property |

`mouseWheelEnabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

multiline | property |

`multiline:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

nestLevel | property |

`nestLevel:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Depth of this object in the containment hierarchy. This number is used by the measurement and layout code. The value is 0 if this component is not on the DisplayList.

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

nonInheritingStyles | property |

`nonInheritingStyles:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

The beginning of this UITextField's chain of non-inheriting styles. The `getStyle()` method accesses `nonInheritingStyles[styleName]` method to search the entire prototype-linked chain. This object is set up by the `initProtoChain()` method. You typically never need to access this property directly.

Implementation
`public function get nonInheritingStyles():Object`
`public function set nonInheritingStyles(value:Object):void`

nonZeroTextHeight | property |

`nonZeroTextHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Unlike textHeight, this returns a non-zero value even when the text is empty. In this case, it returns what the textHeight would be if the text weren't empty.

Implementation
`public function get nonZeroTextHeight():Number`

numLines | property |

`numLines:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get numLines():int`

restrict | property |

`restrict:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

scrollH | property |

`scrollH:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

scrollV | property |

`scrollV:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

selectable | property |

`selectable:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

selectionBeginIndex | property |

`selectionBeginIndex:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get selectionBeginIndex():int`

selectionEndIndex | property |

`selectionEndIndex:int` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get selectionEndIndex():int`

sharpness | property |

`sharpness:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

styleSheet | property |

`styleSheet:StyleSheet`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

tabEnabled | property |

`tabEnabled:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

tabIndex | property |

`tabIndex:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

text | property |

`text:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get textHeight():Number`

textWidth | property |

`textWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Implementation
`public function get textWidth():Number`

thickness | property |

`thickness:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

type | property |

`type:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

wordWrap | property |

`wordWrap:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

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

appendText | () | method

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `newText:String`

getCharBoundaries | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `charIndex:int`

Returns

| `Rectangle`

getCharIndexAtPoint | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `x:Number`
| `y:Number`

Returns

| `int`

getFirstCharInParagraph | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `charIndex:int`

Returns

| `int`

getImageReference | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `id:String`

Returns

| `DisplayObject`

getLineIndexAtPoint | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `x:Number`
| `y:Number`

Returns

| `int`

getLineIndexOfChar | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `charIndex:int`

Returns

| `int`

getLineLength | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `lineIndex:int`

Returns

| `int`

getLineMetrics | () | method |

`public function getLineMetrics(lineIndex:int):TextLineMetrics`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `lineIndex:int`

Returns

| `TextLineMetrics`

getLineOffset | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `lineIndex:int`

Returns

| `int`

getLineText | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `lineIndex:int`

Returns

| `String`

getParagraphLength | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `charIndex:int`

Returns

| `int`

getStyle | () | method |

`public function getStyle(styleProp:String):*`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Gets a style property that has been set anywhere in this component's style lookup chain.

This same method is used to get any kind of style property, so the value returned can be a Boolean, String, Number, int, uint (for an RGB color), Class (for a skin), or any kind of object. Therefore the return type is simply specified as *.

If you are getting a particular style property, you know its type and often want to store the result in a variable of that type. No casting from * to that type is necessary.

`var backgroundColor:uint = getStyle("backgroundColor");`

If the style property has not been set anywhere in the style lookup chain, the value returned by `getStyle()` is `undefined`. Note that `undefined` is a special value that is not the same as `false`, `""`, `NaN`, `0`, or `null`. No valid style value is ever `undefined`. You can use the method `IStyleManager2.isValidStyleValue()` to test whether the value was set.

Parameters

| `styleProp:String` — Name of the style property.

Returns

| `*` — Style value.

getTextFormat | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `beginIndex:int` (default = `-1`)``
| `endIndex:int` (default = `-1`)``

Returns

| `TextFormat`

getUITextFormat | () | method |

`public function getUITextFormat():UITextFormat`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Returns a UITextFormat object that contains formatting information for this component. This method is similar to the `getTextFormat()` method of the flash.text.TextField class, but it returns a UITextFormat object instead of a TextFormat object.

The UITextFormat class extends the TextFormat class to add the text measurement methods `measureText()` and `measureHTMLText()`.

Returns

| `UITextFormat` — An object that contains formatting information for this component.

replaceSelectedText | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `value:String`

replaceText | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `beginIndex:int`
| `endIndex:int`
| `newText:String`

setColor | () | method |

`public function setColor(color:uint):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets the font color of the text.

Parameters

| `color:uint` — The new font color.

setFocus | () | method |

`public function setFocus():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Sets the focus to this component. The component can in turn pass focus to a subcomponent.

Note: Only the TextInput and TextArea controls show a highlight when this method sets the focus. All controls show a highlight when the user tabs to the control.

setSelection | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `beginIndex:int`
| `endIndex:int`

setTextFormat | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Parameters

| `format:TextFormat`
| `beginIndex:int` (default = `-1`)``
| `endIndex:int` (default = `-1`)``

truncateToFit | () | method |

`public function truncateToFit(truncationIndicator:String = null):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 3

Runtime Versions : | Flash Player 9, AIR 1.1

Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.

Parameters

| `truncationIndicator:String` (default = `null`)`` — The text to be appended after truncation. If you pass `null`, a localizable string such as `"..."` will be used.

Returns

| `Boolean` — `true` if the text needed truncation.

Sun Mar 5 2017, 03:42 PM +11:00