StyleableTextField

Package	spark.components.supportClasses
Class	public class StyleableTextField
Inheritance	StyleableTextField FlexTextField TextField InteractiveObject DisplayObject EventDispatcher Object
Implements	IEditableText, ISimpleStyleClient, IVisualElement

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The StyleableTextField class is a text primitive for use in ActionScript skins and item renderers. It cannot be used in MXML markup and is not compatible with effects.

More examples

Use text in custom mobile skins

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
		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
		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
		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
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		editable : Boolean Specifies whether the text is editable, true, or not, false.	StyleableTextField
		embedFonts : Boolean Specifies whether to render by using embedded font outlines.	TextField
		enabled : Boolean Whether the component can accept user interaction.	StyleableTextField
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	StyleableTextField
		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
		horizontalScrollPosition : Number The horizontal scroll position of the text.	StyleableTextField
		htmlText : String Contains the HTML representation of the text field contents.	TextField
		isTruncated : Boolean [read-only] Indicates whether the text has been truncated, true, or not, false.	StyleableTextField
		length : int [read-only] The number of characters in a text field.	TextField
		lineBreak : String Controls word wrapping within the text.	StyleableTextField
		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
		maxScrollH : int [read-only] The maximum value of scrollH.	TextField
		maxScrollV : int [read-only] The maximum value of scrollV.	TextField
		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 The minimum recommended height of the component to be considered by the parent during layout.	StyleableTextField
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	StyleableTextField
		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
		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
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		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
		selectionActivePosition : int [read-only] The active, or last clicked position, of the selection.	StyleableTextField
		selectionAnchorPosition : int [read-only] The anchor, or first clicked position, of the selection.	StyleableTextField
		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
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	StyleableTextField
		styleName : Object The class style used by this component.	StyleableTextField
		styleSheet : StyleSheet Attaches a style sheet to the text field.	TextField
		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 [override] The text displayed by this text component.	StyleableTextField
		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
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		type : String The type of the text field.	TextField
		useRichTextClipboard : Boolean Specifies whether to copy and paste the text formatting along with the text.	TextField
		verticalScrollPosition : Number The vertical scroll position of the text.	StyleableTextField
		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
		StyleableTextField() Constructor.	StyleableTextField
		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(text:String):void [override] Appends the specified text to the end of the text component, as if you had clicked at the end and typed.	StyleableTextField
		commitStyles():void Commit the styles into the TextField.	StyleableTextField
		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
		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.	StyleableTextField
		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
		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
		insertText(text:String):void Inserts the specified text into the text component as if you had typed it.	StyleableTextField
		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
		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
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		scrollToRange(anchorPosition:int, activePosition:int):void Scroll so the specified range is in view.	StyleableTextField
		selectAll():void Selects all of the text.	StyleableTextField
		selectRange(anchorIndex:int, activeIndex:int):void Selects a specified range of characters.	StyleableTextField
		setFocus():void Set focus to this text field.	StyleableTextField
		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 Sets a style property on this component instance.	StyleableTextField
		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
		styleChanged(styleProp:String):void Detects changes to style properties.	StyleableTextField
		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 = "..."):Boolean Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text.	StyleableTextField
		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 4.5 Runtime Versions: AIR2.5, 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`. The default value for the Mobile theme is `0xFFFFFF`.	StyleableTextField
fontFamily	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, 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"`. The default font for the Mobile theme is `"_sans"`.	StyleableTextField
fontSize	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, 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. The default value for the Mobile theme is 24.	StyleableTextField
fontStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Determines whether the text is italic font. Recognized values are `"normal"` and `"italic"`. The default value is `"normal"`.	StyleableTextField
fontWeight	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, 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`.	StyleableTextField
leading	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Additional vertical space between lines of text. The default value is 0.	StyleableTextField
letterSpacing	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, 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`.	StyleableTextField
textAlign	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, 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.	StyleableTextField
textDecoration	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Determines whether the text is underlined. Possible values are `"none"` and `"underline"`. The default value is `"none"`.	StyleableTextField
textIndent	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: AIR2.5, Offset of first line of text from the left side of the container, in pixels. This property cannot be a negative number when used with the mobile theme. The default value is `0`.	StyleableTextField

Property Detail

editable

property

editable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Specifies whether the text is editable, true, or not, false.

The default value is true if type is TextFieldType.INPUT, otherwise false..

Implementation
public function get editable():Boolean
public function set editable(value:Boolean):void

enabled

property

enabled:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Whether the component can accept user interaction. After setting the enabled property to false, some components still respond to mouse interactions such as mouseOver. As a result, to fully disable the component, you should also set the value of the mouseEnabled property to false.

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

focusEnabled

property

focusEnabled:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Indicates whether the component can receive focus when tabbed to. You can set focusEnabled to false when a component is used as a subcomponent of another component so that the outer component becomes the focusable entity. If this property is false, focus is transferred to the first parent that has focusEnable set to true.

The default value is true.

Implementation
public function get focusEnabled():Boolean
public function set focusEnabled(value:Boolean):void

horizontalScrollPosition

property

horizontalScrollPosition:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The horizontal scroll position of the text.

Implementation
public function get horizontalScrollPosition():Number
public function set horizontalScrollPosition(value:Number):void

isTruncated

property

isTruncated:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Indicates whether the text has been truncated, true, or not, false.

Implementation
public function get isTruncated():Boolean

lineBreak

property

lineBreak:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Controls word wrapping within the text. This property corresponds to the lineBreak style.

Text may be set to fit the width of the container (LineBreak.TO_FIT), or can be set to break only at explicit return or line feed characters (LineBreak.EXPLICIT).

Legal values are flashx.textLayout.formats.LineBreak.EXPLICIT, flashx.textLayout.formats.LineBreak.TO_FIT, and flashx.textLayout.formats.FormatValue.INHERIT.

Implementation
public function get lineBreak():String
public function set lineBreak(value:String):void

minHeight

property

public var minHeight:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.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.

minWidth

property

public var minWidth:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.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.

selectionActivePosition

property

selectionActivePosition:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The active, or last clicked position, of the selection. If the implementation does not support selection anchor this is the last character of the selection.

Implementation
public function get selectionActivePosition():int

selectionAnchorPosition

property

selectionAnchorPosition:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The anchor, or first clicked position, of the selection. If the implementation does not support selection anchor this is the first character of the selection.

Implementation
public function get selectionAnchorPosition():int

styleDeclaration

property

styleDeclaration:CSSStyleDeclaration

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Storage for the inline inheriting styles on this object. This CSSStyleDeclaration is created the first time that the setStyle() method is called on this component to set an inheriting style. Developers typically never need to access this property directly.

Implementation
public function get styleDeclaration():CSSStyleDeclaration
public function set styleDeclaration(value:CSSStyleDeclaration):void

styleName

property

styleName:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The class style used by this component. This should be an IStyleClient.

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

text

property

text:String[override]

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The text displayed by this text component.

The formatting of this text is controlled by CSS styles. The supported styles depend on the subclass.

The default value is "".

Implementation
override public function get text():String
override public function set text(value:String):void

verticalScrollPosition

property

verticalScrollPosition:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

The vertical scroll position of the text.

Implementation
public function get verticalScrollPosition():Number
public function set verticalScrollPosition(value:Number):void

Constructor Detail

()

Constructor

public function StyleableTextField()

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Constructor.

Method Detail

appendText

()

method

override public function appendText(text:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Appends the specified text to the end of the text component, as if you had clicked at the end and typed.

An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.

Parameters

text:String — The text to be appended.

commitStyles

()

method

public function commitStyles():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Commit the styles into the TextField. This method must be called before the text is displayed, and any time the styles have changed. This method does nothing if the styles have already been committed.

getStyle

()

method

public function getStyle(styleProp:String):*

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.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.

insertText

()

method

public function insertText(text:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Inserts the specified text into the text component as if you had typed it.

If a range was selected, the new text replaces the selected text. If there was an insertion point, the new text is inserted there.

An insertion point is then set after the new text. If necessary, the text will scroll to ensure that the insertion point is visible.

Parameters

text:String — The text to be inserted.

Throws

Error — This method or property cannot be used on a text field with a style sheet.

scrollToRange

()

method

public function scrollToRange(anchorPosition:int, activePosition:int):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Scroll so the specified range is in view.

Parameters

	`anchorPosition:int` — The anchor position of the selection range.

	`activePosition:int` — The active position of the selection range.

selectAll

()

method

public function selectAll():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Selects all of the text.

selectRange

()

method

public function selectRange(anchorIndex:int, activeIndex:int):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Selects a specified range of characters.

If either position is negative, it will deselect the text range.

Parameters

	`anchorIndex:int` — The character position specifying the end of the selection that stays fixed when the selection is extended.

	`activeIndex:int` — The character position specifying the end of the selection that moves when the selection is extended.

setFocus

()

method

public function setFocus():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Set focus to this text field.

setStyle

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Sets a style property on this component instance.

This can override a style that was set globally.

Calling the setStyle() method can result in decreased performance. Use it only when necessary.

Parameters

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

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

styleChanged

()

method

public function styleChanged(styleProp:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.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 = "..."):Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

AIR 2.5

Truncate text to make it fit horizontally in the area defined for the control, and append an ellipsis, three periods (...), to the text. This function only works for single line text.

Parameters

truncationIndicator:String (default = "...") — 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.

StyleableTextField - AS3 Flex

Classes x

editable

enabled

focusEnabled

horizontalScrollPosition

isTruncated

lineBreak

minHeight

minWidth

selectionActivePosition

selectionAnchorPosition

styleDeclaration

styleName

text

verticalScrollPosition