Packagemx.core
Interfacepublic 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
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
IFlexDisplayObject
 Inheritedalpha : Number
IFlexDisplayObject
  alwaysShowSelection : Boolean
IUITextField
  antiAliasType : String
IUITextField
  autoSize : String
IUITextField
  background : Boolean
IUITextField
  backgroundColor : uint
IUITextField
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
IUIComponent
 InheritedblendMode : String
IFlexDisplayObject
  border : Boolean
IUITextField
  borderColor : uint
IUITextField
  bottomScrollV : int
[read-only]
IUITextField
 InheritedcacheAsBitmap : Boolean
IFlexDisplayObject
  caretIndex : int
[read-only]
IUITextField
  condenseWhite : Boolean
IUITextField
  defaultTextFormat : TextFormat
IUITextField
  displayAsPassword : Boolean
IUITextField
 Inheriteddocument : Object
A reference to the document object associated with this component.
IUIComponent
  doubleClickEnabled : Boolean
IUITextField
  embedFonts : Boolean
IUITextField
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
IUIComponent
 InheritedenableIME : Boolean
[read-only] Specifies whether the IME should be enabled when this component has focus.
IIMESupport
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxHeight : Number
[read-only] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitMinWidth : Number
[read-only] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
IUIComponent
 Inheritedfilters : Array
IFlexDisplayObject
 InheritedfocusPane : 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
 Inheritedheight : 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
 InheritedimeMode : String
The IME mode of the component.
IIMESupport
 InheritedincludeInLayout : 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
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
IUIComponent
  length : int
[read-only]
IUITextField
 InheritedloaderInfo : LoaderInfo
[read-only]
IFlexDisplayObject
 Inheritedmask : DisplayObject
IFlexDisplayObject
  maxChars : int
IUITextField
 InheritedmaxHeight : 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
 InheritedmaxWidth : Number
[read-only] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
IFlexDisplayObject
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
IUIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
IUIComponent
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
IFlexDisplayObject
 InheritedminHeight : Number
[read-only] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
IUIComponent
 InheritedminWidth : 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
 InheritedmouseX : Number
[read-only]
IFlexDisplayObject
 InheritedmouseY : Number
[read-only]
IFlexDisplayObject
  multiline : Boolean
IUITextField
 Inheritedname : 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
 InheritedopaqueBackground : Object
IFlexDisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
IUIComponent
 Inheritedparent : DisplayObjectContainer
[read-only]
IFlexDisplayObject
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
IUIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
IUIComponent
  restrict : String
IUITextField
 Inheritedroot : DisplayObject
[read-only]
IFlexDisplayObject
 Inheritedrotation : Number
IFlexDisplayObject
 Inheritedscale9Grid : Rectangle
IFlexDisplayObject
 InheritedscaleX : Number
IFlexDisplayObject
 InheritedscaleY : Number
IFlexDisplayObject
  scrollH : int
IUITextField
 InheritedscrollRect : Rectangle
IFlexDisplayObject
  scrollV : int
IUITextField
  selectable : Boolean
IUITextField
  selectionBeginIndex : int
[read-only]
IUITextField
  selectionEndIndex : int
[read-only]
IUITextField
  sharpness : Number
IUITextField
 Inheritedstage : Stage
[read-only]
IFlexDisplayObject
 InheritedstyleName : Object
The source of this object's style values.
ISimpleStyleClient
  styleSheet : StyleSheet
IUITextField
 InheritedsystemManager : 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
 InheritedtoolTip : String
The text of this component's tooltip.
IToolTipManagerClient
 Inheritedtransform : Transform
IFlexDisplayObject
 InheritedtweeningProperties : Array
Used by EffectManager.
IUIComponent
  type : String
IUITextField
  useRichTextClipboard : Boolean
IUITextField
 Inheritedvisible : Boolean
IFlexDisplayObject
 Inheritedwidth : Number
IFlexDisplayObject
  wordWrap : Boolean
IUITextField
 Inheritedx : Number
IFlexDisplayObject
 Inheritedy : Number
IFlexDisplayObject
Public Methods
 MethodDefined By
  
appendText(newText:String):void
IUITextField
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
IFlexDisplayObject
  
getCharBoundaries(charIndex:int):Rectangle
IUITextField
  
getCharIndexAtPoint(x:Number, y:Number):int
IUITextField
 Inherited
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the explicit or measured height
IUIComponent
 Inherited
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
 Inherited
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
 Inherited
globalToLocal(point:Point):Point
IFlexDisplayObject
 Inherited
hitTestObject(obj:DisplayObject):Boolean
IFlexDisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
IFlexDisplayObject
 Inherited
initialize():void
Initialize the object.
IUIComponent
 Inherited
invalidateDisplayList():void
Calling this method results in a call to the component's validateDisplayList() method before the display list is rendered.
IInvalidating
 Inherited
invalidateProperties():void
Calling this method results in a call to the component's validateProperties() method before the display list is rendered.
IInvalidating
 Inherited
invalidateSize():void
Calling this method results in a call to the component's validateSize() method before the display list is rendered.
IInvalidating
 Inherited
localToGlobal(point:Point):Point
IFlexDisplayObject
 Inherited
move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
IFlexDisplayObject
 Inherited
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
IUIComponent
 Inherited
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
 Inherited
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
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
IUIComponent
 Inherited
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
 Inherited
validateNow():void
Validates and updates the properties and layout of this object by immediately calling validateProperties(), validateSize(), and validateDisplayList(), if necessary.
IInvalidating
Property Detail
alwaysShowSelectionproperty
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
antiAliasTypeproperty 
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
autoSizeproperty 
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
backgroundproperty 
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
backgroundColorproperty 
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
borderproperty 
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
borderColorproperty 
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
bottomScrollVproperty 
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
caretIndexproperty 
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
condenseWhiteproperty 
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
defaultTextFormatproperty 
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
displayAsPasswordproperty 
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
doubleClickEnabledproperty 
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
embedFontsproperty 
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
focusRectproperty 
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
gridFitTypeproperty 
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
htmlTextproperty 
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
ignorePaddingproperty 
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
inheritingStylesproperty 
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
lengthproperty 
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
maxCharsproperty 
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
maxScrollHproperty 
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
maxScrollVproperty 
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
mouseEnabledproperty 
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
mouseWheelEnabledproperty 
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
multilineproperty 
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
nestLevelproperty 
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
nonInheritingStylesproperty 
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
nonZeroTextHeightproperty 
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
numLinesproperty 
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
restrictproperty 
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
scrollHproperty 
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
scrollVproperty 
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
selectableproperty 
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
selectionBeginIndexproperty 
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
selectionEndIndexproperty 
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
sharpnessproperty 
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
styleSheetproperty 
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
tabEnabledproperty 
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
tabIndexproperty 
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
textproperty 
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
textColorproperty 
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
textHeightproperty 
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
textWidthproperty 
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
thicknessproperty 
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
typeproperty 
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
useRichTextClipboardproperty 
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
wordWrapproperty 
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.



The Apache Software Foundation

Wed Nov 15 2017, 09:50 AM +01:00