mx.core.UITextField (Flex™ 2 Language Reference)

Public Properties

	Property		Defined by
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		alwaysShowSelection : Boolean When set to `true` and the text field is not in focus, Flash Player highlights the selection in the text field in gray.	TextField
		antiAliasType : String The type of anti-aliasing used for this text field.	TextField
		autoSize : String Controls automatic sizing and alignment of text fields.	TextField
		background : Boolean Specifies whether the text field has a background fill.	TextField
		backgroundColor : uint The color of the text field background.	TextField
		baselinePosition : Number [read-only] Determines the baseline y-coordinate of the first line of text of the component.	UITextField
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		border : Boolean Specifies whether the text field has a border.	TextField
		borderColor : uint The color of the text field border.	TextField
		bottomScrollV : int An integer (1-based index) that indicates the bottommost line that is currently visible in the specified text field.	TextField
		cacheAsBitmap : Boolean If set to `true`, Flash Player caches an internal bitmap representation of the display object.	DisplayObject
		caretIndex : int The index of the insertion point (caret) position.	TextField
		className : String [read-only] The name of this instance's class, such as `"DataGridItemRenderer"`.	UITextField
		condenseWhite : Boolean A Boolean value that specifies whether extra white space (spaces, line breaks, and so on) in a text field with HTML text should be removed.	TextField
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : ContextMenu Specifies the context menu associated with this object.	InteractiveObject
		defaultTextFormat : TextFormat Specifies the format applied to newly inserted text, such as text inserted with the `replaceSelectedText()` method or text entered by a user.	TextField
		displayAsPassword : Boolean Specifies whether the text field is a password text field.	TextField
		document : Object A reference to the document object associated with this UITextField object.	UITextField
		doubleClickEnabled : Boolean Specifies whether the object receives `doubleClick` events.	InteractiveObject
		embedFonts : Boolean Specifies whether to render by using embedded font outlines.	TextField
		enabled : Boolean A Boolean value that indicates whether the component is enabled.	UITextField
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UITextField
		explicitMaxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UITextField
		explicitMaxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	UITextField
		explicitMinHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UITextField
		explicitMinWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	UITextField
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UITextField
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusPane : Sprite A single Sprite object that is shared among components and used as an overlay for drawing focus.	UITextField
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		gridFitType : String The type of grid fitting used for this text field.	TextField
		height : Number Indicates the height of the display object, in pixels.	DisplayObject
		htmlText : String Contains the HTML representation of the text field's contents.	TextField
		ignorePadding : Boolean If `true`, the `paddingLeft` and `paddingRight` styles will not add space around the text of the component.	UITextField
		imeMode : String Specifies the IME (input method editor) mode.	UITextField
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UITextField
		inheritingStyles : Object The beginning of this UITextField's chain of inheriting styles.	UITextField
		initialized : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required)	UITextField
		length : int The number of characters in a text field.	TextField
		loaderInfo : LoaderInfo Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		mask : DisplayObject The calling display object is masked by the specified `mask` object.	DisplayObject
		maxChars : int The maximum number of characters that the text field can contain, as entered by a user.	TextField
		maxHeight : Number [read-only] Number that specifies the maximum height of the component, in pixels, in the component's coordinates.	UITextField
		maxScrollH : int The maximum value of `scrollH`.	TextField
		maxScrollV : int The maximum value of `scrollV`.	TextField
		maxWidth : Number [read-only] Number that specifies the maximum width of the component, in pixels, in the component's coordinates.	UITextField
		measuredHeight : Number [read-only] The default height of the component, in pixels.	UITextField
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UITextField
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UITextField
		measuredWidth : Number [read-only] The default width of the component, in pixels.	UITextField
		minHeight : Number [read-only] Number that specifies the minimum height of the component, in pixels, in the component's coordinates.	UITextField
		minWidth : Number [read-only] Number that specifies the minimum width of the component, in pixels, in the component's coordinates.	UITextField
		mouseEnabled : Boolean Specifies whether this object receives mouse messages.	InteractiveObject
		mouseWheelEnabled : Boolean A Boolean value that indicates whether Flash Player should automatically scroll multiline text fields when the user clicks a text field and rolls the mouse wheel.	TextField
		mouseX : Number Indicates the x coordinate of the mouse position, in pixels.	DisplayObject
		mouseY : Number Indicates the y coordinate of the mouse position, in pixels.	DisplayObject
		multiline : Boolean Indicates whether the text field is a multiline text field.	TextField
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		nestLevel : int Depth of this object in the containment hierarchy.	UITextField
		nonInheritingStyles : Object The beginning of this UITextField's chain of non-inheriting styles.	UITextField
		numLines : int Defines the number of text lines in a multiline text field.	TextField
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		owner : DisplayObjectContainer By default, set to the parent container of this object.	UITextField
		parent : DisplayObjectContainer [read-only] The parent container or component for this component.	UITextField
		percentHeight : Number Number that specifies the height of a component as a percentage of its parent's size.	UITextField
		percentWidth : Number Number that specifies the width of a component as a percentage of its parent's size.	UITextField
		processedDescriptors : Boolean Set to `true` after the `createChildren()` method creates any internal component children.	UITextField
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		restrict : String Indicates the set of characters that a user can enter into the text field.	TextField
		root : DisplayObject For a display object in a loaded SWF file, the `root` property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Indicates the horizontal scale (`percentage`) of the object as applied from the registration point.	DisplayObject
		scaleY : Number Indicates the vertical scale (`percentage`) of an object as applied from the registration point of the object.	DisplayObject
		scrollH : int The current horizontal scrolling position.	TextField
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		scrollV : int The vertical position of text in a text field.	TextField
		selectable : Boolean A Boolean value that indicates whether the text field is selectable.	TextField
		selectionBeginIndex : int The zero-based character index value of the first character in the current selection.	TextField
		selectionEndIndex : int The zero-based character index value of the last character in the current selection.	TextField
		sharpness : Number The sharpness of the glyph edges in this text field.	TextField
		stage : Stage The Stage of the display object.	DisplayObject
		styleName : Object The class style used by this component.	UITextField
		styleSheet : StyleSheet Attaches a style sheet to the text field.	TextField
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UITextField
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		text : String A string that is the current text in the text field.	TextField
		textColor : uint The color of the text in a text field, in hexadecimal format.	TextField
		textHeight : Number The height of the text in pixels.	TextField
		textWidth : Number The width of the text in pixels.	TextField
		thickness : Number The thickness of the glyph edges in this text field.	TextField
		toolTip : String Text to display in the ToolTip.	UITextField
		transform : Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UITextField
		type : String The type of the text field.	TextField
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required)	UITextField
		useRichTextClipboard : Boolean Specifies whether to copy and paste the text formatting along with the text.	TextField
		visible : Boolean Whether or not the display object is visible.	DisplayObject
		width : Number Indicates the width of the display object, in pixels.	DisplayObject
		wordWrap : Boolean A Boolean value that indicates whether the text field has word wrap.	TextField
		x : Number Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject
		y : Number Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined by
		UITextField() Constructor.	UITextField
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		appendText(newText:String):void Appends the string specified by the `newText` parameter to the end of the text of the TextField.	TextField
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the `targetCoordinateSpace` object.	DisplayObject
		getCharBoundaries(charIndex:int):Rectangle Returns a rectangle that is the bounding box of the character.	TextField
		getCharIndexAtPoint(x:Number, y:Number):int Returns the zero-based index value of the character at the point specified by the `x` and `y` parameters.	TextField
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UITextField
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UITextField
		getFirstCharInParagraph(charIndex:int):int Given a character index, returns the index of the first character in the same paragraph.	TextField
		getImageReference(id:String):DisplayObject Returns a DisplayObject reference for the given `id`, for an image or SWF file that has been added to an HTML-formatted text field by using an `<img>` tag.	TextField
		getLineIndexAtPoint(x:Number, y:Number):int Returns the zero-based index value of the line at the point specified by the `x` and `y` parameters.	TextField
		getLineIndexOfChar(charIndex:int):int Returns the zero-based index value of the line containing the character specified by the `charIndex` parameter.	TextField
		getLineLength(lineIndex:int):int Returns the number of characters in a specific text line.	TextField
		getLineMetrics(lineIndex:int):TextLineMetrics Returns metrics information about a given text line.	TextField
		getLineOffset(lineIndex:int):int Returns the character index of the first character in the line that the `lineIndex` parameter specifies.	TextField
		getLineText(lineIndex:int):String Returns the text of the line specified by the `lineIndex` parameter.	TextField
		getParagraphLength(charIndex:int):int Given a character index, returns the length of the paragraph containing the given character.	TextField
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the `targetCoordinateSpace` parameter, excluding any strokes on shapes.	DisplayObject
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UITextField
		getTextFormat(beginIndex:int = -1, endIndex:int = -1):TextFormat Returns a TextFormat object that contains formatting information for the range of text that the `beginIndex` and `endIndex` parameters specify.	TextField
		getTextStyles():TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object.	UITextField
		getUITextFormat():UITextFormat Returns a UITextFormat object that contains formatting information for this component.	UITextField
		globalToLocal(point:Point):Point Converts the `point` object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the display object to see if it overlaps or intersects with the `obj` display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the `x` and `y` parameters.	DisplayObject
		initialize():void Initializes this component.	UITextField
		invalidateDisplayList():void Marks a component so that its `updateDisplayList()` method gets called during a later screen update.	UITextField
		invalidateProperties():void Marks a component so that its `commitProperties()` method gets called during a later screen update.	UITextField
		invalidateSize():void Marks a component so that its `measure()` method gets called during a later screen update.	UITextField
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		localToGlobal(point:Point):Point Converts the `point` object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UITextField
		owns(child:DisplayObject):Boolean Returns `true` if the child is parented or owned by this object.	UITextField
		parentChanged(p:DisplayObjectContainer):void This function is called when a UITextField object is assigned a parent.	UITextField
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		replaceSelectedText(value:String):void Replaces the current selection with the contents of the `value` parameter.	TextField
		replaceText(beginIndex:int, endIndex:int, newText:String):void Replaces the range of characters that the `beginIndex` and `endIndex` parameters specify with the contents of the `newText` parameter.	TextField
		setActualSize(w:Number, h:Number):void Sizes the object.	UITextField
		setColor(color:uint):void Sets the font color of the text.	UITextField
		setFocus():void Sets the focus to this component.	UITextField
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setSelection(beginIndex:int, endIndex:int):void Sets as selected the text designated by the index values of the first and last characters, which are specified with the `beginIndex` and `endIndex` parameters.	TextField
		setStyle(styleProp:String, value:*):void Does nothing.	UITextField
		setTextFormat(format:TextFormat, beginIndex:int = -1, endIndex:int = -1):void Applies the text formatting that the `format` parameter specifies to the specified text in a text field.	TextField
		setVisible(visible:Boolean, noEvent:Boolean = false):void Sets the `visible` property of this UITextField object.	UITextField
		styleChanged(styleProp:String):void Detects changes to style properties.	UITextField
		toString():String Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexTextField
		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.	UITextField
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UITextField
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined by
activate	Dispatched when Flash Player gains operating system focus and becomes active.	DisplayObject
added	Dispatched when a display object is added to the display list.	DisplayObject
change	Dispatched after a control's value is modified.	TextField
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
deactivate	Dispatched when Flash Player loses operating system focus and is becoming inactive.	DisplayObject
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's `doubleClickEnabled` flag is set to `true`.	InteractiveObject
enterFrame	Dispatched when the playhead is entering a new frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
link	Dispatched when a user clicks a hyperlink in an HTML-enabled text field, where the URL begins with "event:".	TextField
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance in the Flash Player window.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance in the Flash Player window.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window.	InteractiveObject
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
render	Dispatched when the display list is about to be updated and rendered.	DisplayObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
scroll	Dispatched by a TextField object after the user scrolls.	TextField
tabChildrenChange	Dispatched when the value of the object's `tabChildren` flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's `tabEnabled` flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's `tabIndex` property changes.	InteractiveObject
textInput	Flash Player dispatches the `textInput` event when a user enters one or more characters of text.	TextField

Adobe^® Flex™ 2 Language Reference		All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
Class UITextField	Properties \| Methods \| Events \| Styles

Package	mx.core
Class	public class UITextField
Inheritance	UITextField FlexTextField TextField InteractiveObject DisplayObject EventDispatcher Object
Implements	IIMESupport, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUIComponent
Subclasses	DataGridItemRenderer

	Description	Defined by
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. The default value is `0x0B333C`.	UITextField
disabledColor	Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. The default value is `0xAAB3B3`.	UITextField
fontAntiAliasType	Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields. The possible values are `"normal"` (`flash.text.AntiAliasType.NORMAL`) and `"advanced"` (`flash.text.AntiAliasType.ADVANCED`). The default value is `"advanced"`, which enables the FlashType renderer if you are using an embedded FlashType font. Set to `"normal"` to disable the FlashType renderer. This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others. The default value is `"advanced"`.	UITextField
font