Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
UIFTETextField

Package | mx.core
Class | public class UIFTETextField
Inheritance | UIFTETextField FTETextField flash.display.Sprite
Implements | IAutomationObject, IIMESupport, IFlexModule, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUITextField
Subclasses | DefaultGridItemRenderer, FTEAdvancedDataGridItemRenderer, FTEDataGridItemRenderer

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The UIFTETextField class is an alternative to the UITextField class for displaying text in MX components.

UIFTETextField extends FTETextField in the same way that UITextField extends TextField. By extending FTETextField, it makes it possible for MX components to use the Flash Text Engine. Benefits of using FTE over TextField include higher-quality typography, bidirectional text, and rotatable text.

When MX components use FTE, they can use the same embedded fonts as Spark components, which always use FTE. Otherwise, a font must be embedded with `embedAsCFF="false"` for use by TextField-based components, and with `embedAsCFF="true"` for use by FTE-based components.

MX components that display text use the `textFieldClass` style to determine whether to create instances of UITextField or UIFTETextField. They are able to use either class because both classes implement the IUITextField interface.

Warning: if UIFTETextField inherits `layoutDirection="rtl"`, it will modify its own `transform.matrix` to restore the default coordinate system locally.

See also

mx.core.UITextField
mx.core.FTETextField

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | 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
|  | automationDelegate : Object The delegate object which is handling the automation related functionality. | UIFTETextField
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIFTETextField
|  | automationName : String Name that can be used as an identifier for this object. | UIFTETextField
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIFTETextField
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIFTETextField
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIFTETextField
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIFTETextField
|  | autoSize : String | FTETextField
|  | background : Boolean | FTETextField
|  | backgroundColor : uint | FTETextField
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text. | UIFTETextField
|  | border : Boolean | FTETextField
|  | borderColor : uint | FTETextField
|  | bottomScrollV : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | caretIndex : int [read-only] This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | className : String [read-only] The name of this instance's class, such as "DataGridItemRenderer". | UIFTETextField
|  | condenseWhite : Boolean | FTETextField
|  | defaultTextFormat : TextFormat | 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
|  | document : Object A reference to the document object associated with this UITextField object. | UIFTETextField
|  | embedFonts : Boolean | FTETextField
|  | enabled : Boolean A Boolean value that indicates whether the component is enabled. | UIFTETextField
|  | enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus. | UIFTETextField
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIFTETextField
|  | explicitMaxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, in the component's coordinates, if the maxHeight property is set. | UIFTETextField
|  | explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, in the component's coordinates, if the maxWidth property is set. | UIFTETextField
|  | explicitMinHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | explicitMinWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIFTETextField
|  | focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. | UIFTETextField
|  | fontContext : IFlexModuleFactory The IFlexModuleFactory instance that FTETextField uses for creating TextLine objects. | FTETextField
|  | gridFitType : String This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | htmlText : String | FTETextField
|  | ignorePadding : Boolean If true, the paddingLeft and paddingRight styles will not add space around the text of the component. | UIFTETextField
|  | imeMode : String Specifies the IME (input method editor) mode. | UIFTETextField
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | UIFTETextField
|  | inheritingStyles : Object The beginning of this UITextField's chain of inheriting styles. | UIFTETextField
|  | initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIFTETextField
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIFTETextField
|  | length : int [read-only] | FTETextField
|  | locale : String The locale of the text displayed by FTETextField. | FTETextField
|  | maxChars : int This property has not been implemented in FTETextField because FTETextField does not support editing. | FTETextField
|  | maxHeight : Number [read-only] The maximum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | 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
|  | maxWidth : Number [read-only] The maximum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | measuredHeight : Number [read-only] The default height of the component, in pixels. | UIFTETextField
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIFTETextField
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIFTETextField
|  | measuredWidth : Number [read-only] The default width of the component, in pixels. | UIFTETextField
|  | minHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout. | UIFTETextField
|  | minWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout. | UIFTETextField
|  | moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context. | UIFTETextField
|  | mouseWheelEnabled : Boolean This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | multiline : Boolean This property has no effect in FTETextField because FTETextField does not support editing. | FTETextField
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIFTETextField
|  | nonInheritingStyles : Object The beginning of this UITextField's chain of non-inheriting styles. | UIFTETextField
|  | nonZeroTextHeight : Number [read-only] The height of the text, in pixels. | UIFTETextField
|  | numLines : int [read-only] | FTETextField
|  | owner : DisplayObjectContainer By default, set to the parent container of this object. | UIFTETextField
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIFTETextField
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIFTETextField
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIFTETextField
|  | processedDescriptors : Boolean Set to true after the createChildren() method creates any internal component children. | UIFTETextField
|  | restrict : String This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | scrollH : int This property has not been implemented in FTETextField because FTETextField does not support scrolling. | FTETextField
|  | 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
|  | styleName : Object The class style used by this component. | UIFTETextField
|  | styleSheet : StyleSheet | FTETextField
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIFTETextField
|  | text : String | FTETextField
|  | textColor : uint | FTETextField
|  | textHeight : Number [read-only] | FTETextField
|  | textWidth : Number [read-only] | FTETextField
|  | thickness : Number This property has no effect in FTETextField because FTE uses a newer font renderer than TextField. | FTETextField
|  | toolTip : String Text to display in the ToolTip. | UIFTETextField
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIFTETextField
|  | type : String | FTETextField
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required) | UIFTETextField
|  | useRichTextClipboard : Boolean This property is not implemented in FTETextField because FTETextField does not support selection or clipboard operations. | FTETextField
|  | wordWrap : Boolean | FTETextField

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | UIFTETextField() Constructor. | UIFTETextField
|  | appendText(newText:String):void This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | 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
|  | getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height | UIFTETextField
|  | getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width | UIFTETextField
|  | 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):TextLineMetrics | 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
|  | getParagraphLength(charIndex:int):int This method has not been implemented in FTETextField because very few components use it in TextField. | FTETextField
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIFTETextField
|  | getTextFormat(beginIndex:int = -1, endIndex:int = -1):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
|  | getTextStyles():TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object. | UIFTETextField
|  | getUITextFormat():UITextFormat Returns a UITextFormat object that contains formatting information for this component. | UIFTETextField
|  | initialize():void Initializes this component. | UIFTETextField
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIFTETextField
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIFTETextField
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIFTETextField
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIFTETextField
|  | owns(child:DisplayObject):Boolean Returns true if the child is parented or owned by this object. | UIFTETextField
|  | parentChanged(p:DisplayObjectContainer):void This function is called when a UITextField object is assigned a parent. | UIFTETextField
|  | 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
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIFTETextField
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIFTETextField
|  | setColor(color:uint):void Sets the font color of the text. | UIFTETextField
|  | setFocus():void Sets the focus to this component. | UIFTETextField
|  | setSelection(beginIndex:int, endIndex:int):void This method has not been implemented in FTETextField because FTETextField does not support selection. | FTETextField
|  | setStyle(styleProp:String, value:*):void Does nothing. | UIFTETextField
|  | setTextFormat(format: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
|  | setVisible(visible:Boolean, noEvent:Boolean = false):void Sets the visible property of this UITextField object. | UIFTETextField
|  | styleChanged(styleProp:String):void Detects changes to style properties. | UIFTETextField
|  | 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. | UIFTETextField
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIFTETextField

Property Detail

automationDelegate | property

`automationDelegate:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The delegate object which is handling the automation related functionality.

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

automationEnabled | property |

`automationEnabled:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

True if this component is enabled for automation, false otherwise.

Implementation
`public function get automationEnabled():Boolean`

automationName | property |

`automationName:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Name that can be used as an identifier for this object.

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

automationOwner | property |

`automationOwner:DisplayObjectContainer` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

The owner of this component for automation purposes.

Implementation
`public function get automationOwner():DisplayObjectContainer`

automationParent | property |

`automationParent:DisplayObjectContainer` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

The parent of this component for automation purposes.

Implementation
`public function get automationParent():DisplayObjectContainer`

automationValue | property |

`automationValue:Array` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.

Implementation
`public function get automationValue():Array`

automationVisible | property |

`automationVisible:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 9, AIR 1.1

True if this component is visible for automation, false otherwise.

Implementation
`public function get automationVisible():Boolean`

baselinePosition | property |

`baselinePosition:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The y-coordinate of the baseline of the first line of text.

Implementation
`public function get baselinePosition():Number`

className | property |

`className:String` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The name of this instance's class, such as `"DataGridItemRenderer"`.

This string does not include the package name. If you need the package name as well, call the `getQualifiedClassName()` method in the flash.utils package. It will return a string such as `"mx.controls.dataGridClasses::DataGridItemRenderer"`.

Implementation
`public function get className():String`

document | property |

`document:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A reference to the document object associated with this UITextField object. A document object is an Object at the top of the hierarchy of an application, MXML component, or ActionScript component.

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

enabled | property |

`enabled: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 component is enabled. This property only affects the color of the text and not whether the UITextField is editable. To control editability, use the `flash.text.TextField.type` property.

The default value is `true`.

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

See also

flash.text.TextField

enableIME | property |

`enableIME:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A flag that indicates whether the IME should be enabled when the component receives focus.

Implementation
`public function get enableIME():Boolean`

explicitHeight | property |

`explicitHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Number that specifies the explicit height of the component, in pixels, in the component's coordinates.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `explicitHeight` with respect to its parent is affected by the `scaleY` property.

Setting the `height` property also sets this property to the specified height value.

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

explicitMaxHeight | property |

`explicitMaxHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Number that specifies the maximum height of the component, in pixels, in the component's coordinates, if the maxHeight property is set. Because maxHeight is read-only, this method returns NaN. You must override this method and add a setter to use this property.

The default value is `NaN`.

Implementation
`public function get explicitMaxHeight():Number`

See also

mx.core.UIComponent.explicitMaxHeight

explicitMaxWidth | property |

`explicitMaxWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Number that specifies the maximum width of the component, in pixels, in the component's coordinates, if the `maxWidth` property is set. Because the `maxWidth` property is read-only, this method returns `NaN`. You must override this method and add a setter to use this property.

The default value is `NaN`.

Implementation
`public function get explicitMaxWidth():Number`

See also

mx.core.UIComponent.explicitMaxWidth

explicitMinHeight | property |

`explicitMinHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

Application developers typically do not set the explicitMinHeight property. Instead, they set the value of the minHeight property, which sets the explicitMinHeight property. The value of minHeight does not change.

At layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used. Otherwise, the value of measuredMinHeight is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minHeight` with respect to its parent is affected by the `scaleY` property.

Implementation
`public function get explicitMinHeight():Number`

explicitMinWidth | property |

`explicitMinWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels.

Application developers typically do not set the explicitMinWidth property. Instead, they set the value of the minWidth property, which sets the explicitMinWidth property. The value of minWidth does not change.

At layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used. Otherwise, the value of measuredMinWidth is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minWidth` with respect to its parent is affected by the `scaleX` property.

Implementation
`public function get explicitMinWidth():Number`

explicitWidth | property |

`explicitWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Number that specifies the explicit width of the component, in pixels, in the component's coordinates.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `explicitWidth` with respect to its parent is affected by the `scaleX` property.

Setting the `width` property also sets this property to the specified width value.

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

focusPane | property |

`focusPane:Sprite`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A single Sprite object that is shared among components and used as an overlay for drawing the focus indicator. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.

Implementation
`public function get focusPane():Sprite`
`public function set focusPane(value:Sprite):void`

ignorePadding | property |

`ignorePadding:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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

The default value is `true`.

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

imeMode | property |

`imeMode:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets the focus, and sets it back to the previous value when the control loses the focus.

The flash.system.IMEConversionMode class defines constants for the valid values for this property. You can also specify `null` to specify no IME.

The default value is `null`.

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

See also

flash.system.IMEConversionMode

includeInLayout | property |

`includeInLayout:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies whether this component is included in the layout of the parent container. If `true`, the object is included in its parent container's layout and is sized and positioned by its parent container as per its layout rules. If `false`, the object size and position are not affected by its parent container's layout.

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

inheritingStyles | property |

`inheritingStyles:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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`

initialized | property |

`initialized:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A flag that determines if an object has been through all three phases of layout validation (provided that any were required).

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

isPopUp | property |

`isPopUp:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Set to `true` by the PopUpManager to indicate that component has been popped up.

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

maxHeight | property |

`maxHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The maximum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the height of the component.

If the application developer overrides the default value of maxHeight, the new value is stored in explicitMaxHeight. The default value of maxHeight does not change. As a result, at layout time, if maxHeight was explicitly set by the application developer, then the value of explicitMaxHeight is used for the component's maximum recommended height. If maxHeight is not set explicitly by the user, then the default value is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `maxHeight` with respect to its parent is affected by the `scaleY` property. Some components have no theoretical limit to their height. In those cases their `maxHeight` is set to `UIComponent.DEFAULT_MAX_HEIGHT`.

Implementation
`public function get maxHeight():Number`

maxWidth | property |

`maxWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The maximum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value of this property is set by the component developer.

The component developer uses this property to set an upper limit on the width of the component.

If the application developer overrides the default value of maxWidth, the new value is stored in explicitMaxWidth. The default value of maxWidth does not change. As a result, at layout time, if maxWidth was explicitly set by the application developer, then the value of explicitMaxWidth is used for the component's maximum recommended width. If maxWidth is not set explicitly by the user, then the default value is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `maxWidth` with respect to its parent is affected by the `scaleX` property. Some components have no theoretical limit to their width. In those cases their `maxWidth` is set to `UIComponent.DEFAULT_MAX_WIDTH`.

Implementation
`public function get maxWidth():Number`

measuredHeight | property |

`measuredHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The default height of the component, in pixels. This value is set by the `measure()` method.

Implementation
`public function get measuredHeight():Number`

measuredMinHeight | property |

`measuredMinHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The default minimum height of the component, in pixels. This value is set by the `measure()` method.

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

measuredMinWidth | property |

`measuredMinWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The default minimum width of the component, in pixels. This value is set by the `measure()` method.

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

measuredWidth | property |

`measuredWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The default width of the component, in pixels. This value is set by the `measure()` method.

Implementation
`public function get measuredWidth():Number`

minHeight | property |

`minHeight:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The minimum recommended height of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minHeight, the new value is stored in explicitMinHeight. The default value of minHeight does not change. As a result, at layout time, if minHeight was explicitly set by the application developer, then the value of explicitMinHeight is used for the component's minimum recommended height. If minHeight is not set explicitly by the application developer, then the value of measuredMinHeight is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minHeight` with respect to its parent is affected by the `scaleY` property.

Implementation
`public function get minHeight():Number`

minWidth | property |

`minWidth:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The minimum recommended width of the component to be considered by the parent during layout. This value is in the component's coordinates, in pixels. The default value depends on the component's implementation.

If the application developer sets the value of minWidth, the new value is stored in explicitMinWidth. The default value of minWidth does not change. As a result, at layout time, if minWidth was explicitly set by the application developer, then the value of explicitMinWidth is used for the component's minimum recommended width. If minWidth is not set explicitly by the application developer, then the value of measuredMinWidth is used.

This value is used by the container in calculating the size and position of the component. It is not used by the component itself in determining its default size. Thus this property may not have any effect if parented by Container, or containers that don't factor in this property. Because the value is in component coordinates, the true `minWidth` with respect to its parent is affected by the `scaleX` property.

Implementation
`public function get minWidth():Number`

moduleFactory | property |

`moduleFactory:IFlexModuleFactory`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The moduleFactory that is used to create TextFields in the correct SWF context. This is necessary so that embedded fonts will work.

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

nestLevel | property |

`nestLevel:int`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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 4

Runtime Versions : | Flash Player 10, AIR 1.5

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 4

Runtime Versions : | Flash Player 10, AIR 1.5

The height of the text, in pixels. Unlike the `textHeight` property, the `nonZeroTextHeight` property returns a non-zero value of what the height of the text would be, even if the text is empty.

Implementation
`public function get nonZeroTextHeight():Number`

owner | property |

`owner:DisplayObjectContainer`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

By default, set to the parent container of this object. However, if this object is a child component that is popped up by its parent, such as the dropdown list of a ComboBox control, the owner is the component that popped up this object.

This property is not managed by Flex, but by each component. Therefore, if you use the `PopUpManger.createPopUp()` or `PopUpManger.addPopUp()` method to pop up a child component, you should set the `owner` property of the child component to the component that popped it up.

The default value is the value of the `parent` property.

Implementation
`public function get owner():DisplayObjectContainer`
`public function set owner(value:DisplayObjectContainer):void`

parent | property |

`parent:DisplayObjectContainer` [read-only] [override]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The parent container or component for this component.

Implementation
`public function get parent():DisplayObjectContainer`

percentHeight | property |

`percentHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the height of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the `height` or `explicitHeight` properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

This property is always set to NaN for the UITextField control.

When used with Spark layouts, this property is used to calculate the height of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying `percentHeight` will affect the component's width.

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

percentWidth | property |

`percentWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Specifies the width of a component as a percentage of its parent's size. Allowed values are 0-100. The default value is NaN. Setting the `width` or `explicitWidth` properties resets this property to NaN.

This property returns a numeric value only if the property was previously set; it does not reflect the exact size of the component in percent.

This property is always set to NaN for the UITextField control.

When used with Spark layouts, this property is used to calculate the width of the component's bounds after scaling and rotation. For example if the component is rotated at 90 degrees, then specifying `percentWidth` will affect the component's height.

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

processedDescriptors | property |

`processedDescriptors:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Set to `true` after the `createChildren()` method creates any internal component children.

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

styleName | property |

`styleName:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

The class style used by this component. This can be a String, CSSStyleDeclaration or an IStyleClient.

If this is a String, it is the name of one or more whitespace delimited class declarations in an `<fx:Style>` tag or CSS file. You do not include the period in the `styleName`. For example, if you have a class style named `".bigText"`, set the `styleName` property to `"bigText"` (no period).

If this is an IStyleClient (typically a UIComponent), all styles in the `styleName` object are used by this component.

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

systemManager | property |

`systemManager:ISystemManager`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the SystemManager object used by this component.

Implementation
`public function get systemManager():ISystemManager`
`public function set systemManager(value:ISystemManager):void`

toolTip | property |

`toolTip:String`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Text to display in the ToolTip.

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

tweeningProperties | property |

`tweeningProperties:Array`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Array of properties that are currently being tweened on this object.

Used to alert the EffectManager that certain properties of this object are being tweened, so that the EffectManger doesn't attempt to animate the same properties.

Implementation
`public function get tweeningProperties():Array`
`public function set tweeningProperties(value:Array):void`

updateCompletePendingFlag | property |

`updateCompletePendingFlag:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A flag that determines if an object has been through all three phases of layout validation (provided that any were required)

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

UIFTETextField | () | Constructor

`public function UIFTETextField()`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Constructor.

Method Detail

getExplicitOrMeasuredHeight | () | method

`public function getExplicitOrMeasuredHeight():Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A convenience method for determining whether to use the explicit or measured height

Returns

| `Number` — A Number which is explicitHeight if defined or measuredHeight if not.

getExplicitOrMeasuredWidth | () | method |

`public function getExplicitOrMeasuredWidth():Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

A convenience method for determining whether to use the explicit or measured width

Returns

| `Number` — A Number which is explicitWidth if defined or measuredWidth if not.

getStyle | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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.

getTextStyles | () | method |

`public function getTextStyles():TextFormat`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the TextFormat object that represents character formatting information for this UITextField object.

Returns

| `TextFormat` — A TextFormat object.

See also

flash.text.TextFormat

getUITextFormat | () | method |

`public function getUITextFormat():UITextFormat`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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.

See also

mx.core.UITextFormat
flash.text.TextField

initialize | () | method |

`public function initialize():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Initializes this component.

This method is required by the IUIComponent interface, but it actually does nothing for a UITextField.

invalidateDisplayList | () | method |

`public function invalidateDisplayList():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Marks a component so that its `updateDisplayList()` method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the width and height, it would be wasteful to update the component immediately after you change the width and then update again with the new height. It is more efficient to change both properties and then render the component with its new size once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

invalidateProperties | () | method |

`public function invalidateProperties():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Marks a component so that its `commitProperties()` method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text color and size, it would be wasteful to update the color immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size and color once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

invalidateSize | () | method |

`public function invalidateSize():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Marks a component so that its `measure()` method gets called during a later screen update.

Invalidation is a useful mechanism for eliminating duplicate work by delaying processing of changes to a component until a later screen update. For example, if you want to change the text and font size, it would be wasteful to update the text immediately after you change it and then update the size when it gets set. It is more efficient to change both properties and then render the text with its new size once.

Invalidation methods rarely get called. In general, setting a property on a component automatically calls the appropriate invalidation method.

move | () | method |

`public function move(x:Number, y:Number):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Moves the component to a specified position within its parent. Calling this method is exactly the same as setting the component's `x` and `y` properties.

If you are overriding the `updateDisplayList()` method in a custom component, call the `move()` method rather than setting the `x` and `y` properties. The difference is that the `move()` method changes the location of the component and then dispatches a `move` event when you call the method, while setting the `x` and `y` properties changes the location of the component and dispatches the event on the next screen refresh.

Parameters

| `x:Number` — Left position of the component within its parent.
| `y:Number` — Top position of the component within its parent.

owns | () | method |

`public function owns(child:DisplayObject):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns `true` if the child is parented or owned by this object.

Parameters

| `child:DisplayObject` — The child DisplayObject.

Returns

| `Boolean` — `true` if the child is parented or owned by this UITextField object.

See also

owner

parentChanged | () | method |

`public function parentChanged(p:DisplayObjectContainer):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

This function is called when a UITextField object is assigned a parent. You typically never need to call this method.

Parameters

| `p:DisplayObjectContainer` — The parent of this UITextField object.

replayAutomatableEvent | () | method |

`public function replayAutomatableEvent(event:Event):Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.

Parameters

| `event:Event` — The event to replay.

Returns

| `Boolean` — `true` if a replay was successful.

setActualSize | () | method |

`public function setActualSize(w:Number, h:Number):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sizes the object. Unlike directly setting the `width` and `height` properties, calling the `setActualSize()` method does not set the `explictWidth` and `explicitHeight` properties, so a future layout calculation can result in the object returning to its previous size. This method is used primarily by component developers implementing the `updateDisplayList()` method, by Effects, and by the LayoutManager.

Parameters

| `w:Number` — Width of the object.
| `h:Number` — Height of the object.

setColor | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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 4

Runtime Versions : | Flash Player 10, AIR 1.5

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.

setStyle | () | method |

`public function setStyle(styleProp:String, value:*):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Does nothing. A UITextField cannot have inline styles.

Parameters

| `styleProp:String` — n/a
| `value:*` — n/a

setVisible | () | method |

`public function setVisible(visible:Boolean, noEvent:Boolean = false):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sets the `visible` property of this UITextField object.

Parameters

| `visible:Boolean` — `true` to make this UITextField visible, and `false` to make it invisible.
| `noEvent:Boolean` (default = `false`)`` — `true` to suppress generating an event when you change visibility.

styleChanged | () | method |

`public function styleChanged(styleProp:String):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Detects changes to style properties. When any style property is set, Flex calls the `styleChanged()` method, passing to it the name of the style being set.

This is an advanced method that you might override when creating a subclass of UIComponent. When you create a custom component, you can override the `styleChanged()` method to check the style name passed to it, and handle the change accordingly. This lets you override the default behavior of an existing style, or add your own custom style properties.

If you handle the style property, your override of the `styleChanged()` method should call the `invalidateDisplayList()` method to cause Flex to execute the component's `updateDisplayList()` method at the next screen update.

Parameters

| `styleProp:String` — The name of the style property, or null if all styles for this component have changed.

truncateToFit | () | method |

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

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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.

validateNow | () | method |

`public function validateNow():void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Validate and update the properties and layout of this object and redraw it, if necessary. Processing properties that require substantial computation are normally not processed until the script finishes executing. For example setting the `width` property is delayed, because it can require recalculating the widths of the objects children or its parent. Delaying the processing prevents it from being repeated multiple times if the script sets the `width` property more than once. This method lets you manually override this behavior.

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