UITextField

(Preview)

Package	mx.core
Class	public class UITextField
Inheritance	UITextField FlexTextField TextField InteractiveObject DisplayObject EventDispatcher Object
Implements	IAutomationObject, IIMESupport, IFlexModule, IInvalidating, ISimpleStyleClient, IToolTipManagerClient, IUITextField
Subclasses	AdvancedDataGridItemRenderer, DataGridItemRenderer, UITextFieldGridItemRenderer

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The UITextField class defines the component used by many Flex components to display text. For example, the mx.controls.Button control uses a UITextField component to define the label area of the Button control.

The UITextField class extends the flash.text.TextField class to support additional functionality required by Flex, such as CSS styles, invalidation/measurement/layout, enabling/disabling, tooltips, and IME (Input Method Editor) support for entering Chinese, Japanese, and Korean text.

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

Related API Elements

flash.text.TextField
mx.core.UITextFormat

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		alwaysShowSelection : Boolean 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
		automationDelegate : Object The delegate object which is handling the automation related functionality.	UITextField
		automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise.	UITextField
		automationName : String Name that can be used as an identifier for this object.	UITextField
		automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes.	UITextField
		automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes.	UITextField
		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.	UITextField
		automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise.	UITextField
		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] The y-coordinate of the baseline of the first line of text.	UITextField
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		border : Boolean Specifies whether the text field has a border.	TextField
		borderColor : uint The color of the text field border.	TextField
		bottomScrollV : int [read-only] 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 runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		caretIndex : int [read-only] 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 is removed.	TextField
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		defaultTextFormat : flash.text:TextFormat Specifies the format applied to newly inserted text, such as text entered by a user or text inserted with the replaceSelectedText() method.	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
		enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus.	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, if the maxHeight property is set.	UITextField
		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.	UITextField
		explicitMinHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout.	UITextField
		explicitMinWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout.	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 the focus indicator.	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 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
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UITextField
		length : int [read-only] The number of characters in a text field.	TextField
		loaderInfo : LoaderInfo [read-only] 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] The maximum recommended height of the component to be considered by the parent during layout.	UITextField
		maxScrollH : int [read-only] The maximum value of scrollH.	TextField
		maxScrollV : int [read-only] The maximum value of scrollV.	TextField
		maxWidth : Number [read-only] The maximum recommended width of the component to be considered by the parent during layout.	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
		metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.	DisplayObject
		minHeight : Number [read-only] The minimum recommended height of the component to be considered by the parent during layout.	UITextField
		minWidth : Number [read-only] The minimum recommended width of the component to be considered by the parent during layout.	UITextField
		moduleFactory : IFlexModuleFactory The moduleFactory that is used to create TextFields in the correct SWF context.	UITextField
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseWheelEnabled : Boolean A Boolean value that indicates whether Flash Player automatically scrolls multiline text fields when the user clicks a text field and rolls the mouse wheel.	TextField
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		multiline : Boolean Indicates whether field is a multiline text field.	TextField
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		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
		nonZeroTextHeight : Number [read-only] Unlike textHeight, this returns a non-zero value even when the text is empty.	UITextField
		numLines : int [read-only] 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 [override] [read-only] The parent container or component for this component.	UITextField
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	UITextField
		percentWidth : Number 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
		restrict : String Indicates the set of characters that a user can enter into the text field.	TextField
		root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.	DisplayObject
		rotation : Number Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	DisplayObject
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number Indicates the horizontal scale (percentage) of the object as applied from the registration point.	DisplayObject
		scaleY : Number Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollH : int 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 [read-only] The zero-based character index value of the first character in the current selection.	TextField
		selectionEndIndex : int [read-only] 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
		softKeyboard : String Controls the appearance of the soft keyboard.	InteractiveObject
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).	InteractiveObject
		stage : Stage [read-only] 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 [read-only] The height of the text in pixels.	TextField
		textInteractionMode : String [read-only] The interaction mode property, Default value is TextInteractionMode.NORMAL.	TextField
		textWidth : Number [read-only] 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 : flash.geom: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
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		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 text field.	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):flash.text: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):flash.text:TextFormat Returns a TextFormat object that contains formatting information for the range of text that the beginIndex and endIndex parameters specify.	TextField
		getTextStyles():flash.text:TextFormat Returns the TextFormat object that represents character formatting information for this UITextField object.	UITextField
		getUITextFormat():mx.core: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
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		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
		isFontCompatible(fontName:String, fontStyle:String):Boolean [static] Returns true if an embedded font is available with the specified fontName and fontStyle where Font.fontType is flash.text.FontType.EMBEDDED.	TextField
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		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
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UITextField
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		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:flash.text: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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] 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

Click for more information on events

Hide Inherited Events

Show Inherited Events

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

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles

Click for more information on styles

	Description	Defined By
color	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label. The default value for the Halo theme is `0x0B333C`. The default value for the Spark theme is `0x000000`.	UITextField
disabledColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled. The default value is `0xAAB3B3`.	UITextField
fontAntiAliasType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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 advanced anti-aliasing for the font. Set to `"normal"` to disable the advanced anti-aliasing. This style has no effect for system fonts. This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others. The default value is `"advanced"`. Related API Elements flash.text.TextField flash.text.AntiAliasType	UITextField
fontFamily	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default font for the Halo theme is `"Verdana"`. The default font for the Spark theme is `"Arial"`.	UITextField
fontGridFitType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. The possible values are `"none"` (`flash.text.GridFitType.NONE`), `"pixel"` (`flash.text.GridFitType.PIXEL`), and `"subpixel"` (`flash.text.GridFitType.SUBPIXEL`). This property only applies when you are using an embedded font and the `fontAntiAliasType` property is set to `"advanced"`. 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 `"pixel"`. Related API Elements flash.text.TextField flash.text.GridFitType	UITextField
fontSharpness	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `sharpness` property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400. This property only applies when you are using an embedded font and the `fontAntiAliasType` property is set to `"advanced"`. 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 `0`. Related API Elements flash.text.TextField	UITextField
fontSize	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels. In the Halo theme, the default value is 10 for all controls except the ColorPicker control. For the Halo themed ColorPicker control, the default value is 11. In the Spark theme, the default value is 12 for all controls except the ColorPicker control. For the Spark themed ColorPicker control, the default value is 11.	UITextField
fontStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font. Recognized values are `"normal"` and `"italic"`. The default value is `"normal"`.	UITextField
fontThickness	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `thickness` property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200. This property only applies when you are using an embedded font and the `fontAntiAliasType` property is set to `"advanced"`. This style has no effect on 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 `0`. Related API Elements flash.text.TextField	UITextField
fontWeight	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface. Recognized values are `normal` and `bold`. The default value for Button controls is `bold`. The default value for all other controls is `normal`.	UITextField
kerning	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is `false`.	UITextField
leading	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Additional vertical space between lines of text. The default value is 2. The default value for the ComboBox control is 0.	UITextField
letterSpacing	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is `0`.	UITextField
locale	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts. Note: This style only applies when an MX component specifies UIFTETextField as its `textFieldClass`. The default value is `"en"`.	UITextField
paddingLeft	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control in the Halo theme is 10 and in the Spark theme is 6. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2.	UITextField
paddingRight	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control in the Halo theme is 10 and in the Spark theme is 6. The default value for the ComboBox control is 5. The default value for the Form container is 16.	UITextField
textAlign	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container. Possible values are `"left"`, `"right"`, or `"center"`. The default value for most components is `"left"`. For the FormItem component, the default value is `"right"`. For the Button, LinkButton, and AccordionHeader components, the default value is `"center"`, and this property is only recognized when the `labelPlacement` property is set to `"left"` or `"right"`. If `labelPlacement` is set to `"top"` or `"bottom"`, the text and any icon are centered.	UITextField
textDecoration	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined. Possible values are `"none"` and `"underline"`. The default value is `"none"`.	UITextField
textFieldClass	Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). The default value is `mx.core.UITextField`.	UITextField
textIndent	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. The default value is `0`.	UITextField

Property Detail

Constructor Detail

Method Detail

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

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

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

	`w:Number` — Width of the object.

	`h:Number` — Height of the object.

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

	`value:*` — New value for the style.

	`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.

UITextField - AS3 Flex

Packagesx

Language Elements

Appendixes

Package mx.core

automationDelegate

automationEnabled

automationName

automationOwner

automationParent

automationValue

automationVisible

baselinePosition

className

document

enabled

enableIME

explicitHeight

explicitMaxHeight

explicitMaxWidth

explicitMinHeight

explicitMinWidth

explicitWidth

focusPane

ignorePadding

imeMode

includeInLayout

inheritingStyles

initialized

isPopUp

maxHeight

maxWidth

measuredHeight

measuredMinHeight

measuredMinWidth

measuredWidth

minHeight

minWidth

moduleFactory

nestLevel

nonInheritingStyles

nonZeroTextHeight

owner

parent

percentHeight

percentWidth

processedDescriptors

styleName

systemManager

toolTip

tweeningProperties

updateCompletePendingFlag

getExplicitOrMeasuredHeight

getExplicitOrMeasuredWidth

getStyle

getTextStyles

getUITextFormat

initialize

invalidateDisplayList

invalidateProperties

invalidateSize

move

owns

parentChanged

replayAutomatableEvent

setActualSize

setColor

setFocus

setStyle

setVisible

styleChanged

truncateToFit

validateNow