RichEditableText

Package	spark.components
Class	public class RichEditableText
Inheritance	RichEditableText UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements	IFocusManagerComponent, IIMESupport, ISystemCursorClient, IViewport, IEditableText

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Adobe recommends that you not use this component in an application that uses the mobileDevice profile.

RichEditableText is a low-level UIComponent for displaying, scrolling, selecting, and editing richly-formatted text.

The rich text can contain clickable hyperlinks and inline graphics that are either embedded or loaded from URLs.

RichEditableText does not have scrollbars, but it implements the IViewport interface for programmatic scrolling so that it can be controlled by a Scroller, which does provide scrollbars. It also supports vertical scrolling with the mouse wheel.

It does not include any user interface for changing the formatting of the text. But it offers APIs which can do this programmatically; these make it possible, for example, for you to create a Bold button that makes the selected text bold.

This class is used in the skins of the Spark versions of TextInput and TextArea. (TextInput does not expose its ability to handle rich text, but TextArea does.) By default, RichEditableText has a transparent background, and it does not support drawing a border.

RichEditableText uses the Text Layout Framework (TLF) library, which in turn builds on the new Flash Text Engine (FTE) in Flash Player 10. In combination, these layers provide text editing with high-quality international typography and layout.

The Spark architecture provides three text "primitives" -- Label, RichText, and RichEditableText. Label is the fastest and most lightweight because it uses only FTE, not TLF, but it is limited in its capabilities: no rich text, no scrolling, no selection, and no editing. RichText adds the ability to display rich text with complex layout, but is still completely non-interactive. RichEditableText is the heaviest-weight, but offers most of what TLF can do. In general, use the fastest text primitive that meets your needs.

RichEditableText is similar to the UITextField class used in MX components. This class did not use FTE or TLF but rather extended the older TextField class.

The most important differences between UITextField and RichEditableText are:

RichEditableText offers better typography, better support for international languages, and better text layout.
RichEditableText has an object-oriented model of rich text, while UITextField does not.
RichEditableText has better support for displaying large amounts of text.
RichEditableText requires that fonts be embedded differently than UITextField. Consult the documentation regarding how to use the embedAsCFF attribute when you embed a font.

RichEditableText uses TLF's object-oriented model of rich text, in which text layout elements such as divisions, paragraphs, spans, hyperlinks, and images are represented at runtime by ActionScript objects which can be programmatically accessed and manipulated. The central object in TLF for representing rich text is a TextFlow, so you specify rich text for a RichEditableText control to display by setting its textFlow property to a TextFlow instance. See the description of the textFlow property for information about how to create one, such as by importing TLF markup. If you don't need to display text that has multiple formats, you can use the text property to set a "plain text" String. See the description of the text and textFlow properties for information about how they interact; for example, you can set one and get the other.

At compile time, you can put TLF markup tags inside the RichEditableText tag, as the following example shows:

      <s:RichEditableText>Hello <s:span fontWeight="bold">World!</s:span></s:RichEditableText>

In this case, the MXML compiler sets the content property, causing a TextFlow to be automatically created from the FlowElements that you specify.

The default text formatting is determined by CSS styles such as fontFamily, fontSize. Any formatting information in the TextFlow overrides the default formatting provided by the CSS styles.

You can control the spacing between lines with the lineHeight style and the spacing between paragraphs with the paragraphSpaceBefore and paragraphSpaceAfter styles. You can align or justify the text using the textAlign and textAlignLast styles. You can inset the text from the component's edges using the paddingLeft, paddingTop, paddingRight, and paddingBottom styles.

By default, a RichEditableText "autosizes": it starts out very small if it has no text, and grows in width up to maxWidth as you type. It grows in height when you press the Enter key to start a new line.

The widthInChars and heightInLines properties provide a convenient way to specify the width and height in a way that scales with the font size. You can use the typicalText property as well. Note that if you use typicalText, the widthInChars and heightInLines are ignored. You can also specify an explicit width or height in pixels, or use a percent width and height, or use constraints such as left and right or top and bottom.

When you specify some kind of width -- whether an explicit or percent width, a maxWidth or left and right constraints -- the text wraps at the right edge of the component and the text becomes vertically scrollable when there is more text than fits. If you set the lineBreak style to explicit, new lines will start only at explicit lines breaks, such as if you use CR (\r), LF (\n), or CR+LF (\r\n) in text or if you use <p> and <br/> in TLF markup. In that case, the text becomes horizontally scrollable if any lines are wider than the control.

You can use the maxChars property to limit the number of character that the user can enter, and the restrict to limit which characters the user can enter.

The multiline property determines what happens when you press the Enter key. If it is true, the Enter key starts a new paragraph. If it is false, it causes a FlexEvent.ENTER event to be dispatched.

If you don't want the text to be editable, set the editable property to false. If you don't even want the text to be selectable, set the selectable property to false.

Because RichEditableText uses TLF, it supports displaying left-to-right (LTR) text such as French, right-to-left (RTL) text such as Arabic, and bidirectional text such as a French phrase inside of an Arabic one. If the predominant text direction is right-to-left, set the direction style to rtl. The textAlign style defaults to "start", which makes the text left-aligned when direction is ltr and right-aligned when direction is rtl. To get the opposite alignment, set textAlign to end.

As a result of using TLF, the RichEditableText supports unlimited undo/redo within one editing session. An editing session starts when the component gets keyboard focus and ends when it loses focus.

RichEditableText uses TLF's TextContainerManager class to handle its text display, scrolling, selection, editing and context menu.

To use this component in a list-based component, such as a List or DataGrid, create an item renderer. For information about creating an item renderer, see Custom Spark item renderers.

MXML Syntax expanded

Hide MXML Syntax

The <s:RichEditableText> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

      <s:RichEditableText
        Properties
        clipAndEnableScrolling="false|true"
        contentHeight="Calculated default"
        contentWidth="Calculated default"
        displayAsPassword="false"
        editable="true"
        heightInLines="NaN"
        horizontalScrollPosition="0"
        imeMode="null"
        maxChars="0"
        multiline="true"
        restrict="null"
        selectable="true"
        selectionActivePosition="-1"
        selectionAnchorPosition="-1"
        selectionHighlighting="TextSelectionHighlighting.WHEN_FOCUSED"
        text=""
        textFlow="TextFlow"
        typicalText=null
        verticalScrollPosition="0"
        widthInChars="NaN"
      
        Events
        change="No default"
        changing="No default"
        enter="No default"
        selectionChange="No default"
      />

Default MXML Propertycontent

View the examples

More examples

RichEditableText control
Styling TLF-based text controls
Setting character ranges
Text in FXG and MXML graphics

Learn more

About the Spark text controls
RichEditableText control
Adding content to text controls
Selecting text
Using Text Layout Framework
Markup tags supported in TextFlow objects
Mirroring and bidirectional text
Embed fonts
Mirroring with text controls

Related API Elements

spark.components.Label
spark.components.RichText
spark.utils.TextFlowUtil
flashx.textLayout.container.TextContainerManager

Public Properties

	Property		Defined By
		accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object.	UIComponent
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.	UIComponent
		activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.	UIComponent
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		automationDelegate : Object The delegate object that handles the automation-related functionality.	UIComponent
		automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise.	UIComponent
		automationName : String Name that can be used as an identifier for this object.	UIComponent
		automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes.	UIComponent
		automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes.	UIComponent
		automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.	UIComponent
		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.	UIComponent
		automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise.	UIComponent
		baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component.	UIComponent
		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
		bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		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
		cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object.	UIComponent
		cachePolicy : String Specifies the bitmap caching policy for this object.	UIComponent
		className : String [read-only] The name of this instance's class, such as "Button".	UIComponent
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	RichEditableText
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		content : Object This property is intended for use in MXML at compile time; to get or set rich text content at runtime, please use the textFlow property instead.	RichEditableText
		contentHeight : Number [read-only] The height of the text.	RichEditableText
		contentMouseX : Number [read-only] Returns the x position of the mouse, in the content coordinate system.	UIComponent
		contentMouseY : Number [read-only] Returns the y position of the mouse, in the content coordinate system.	UIComponent
		contentWidth : Number [read-only] The width of the text.	RichEditableText
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		currentState : String The current view state of the component.	UIComponent
		cursorManager : ICursorManager [read-only] Gets the CursorManager that controls the cursor for this component and its peers.	UIComponent
		depth : Number Determines the order in which items inside of containers are rendered.	UIComponent
		descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.	UIComponent
		designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element.	UIComponent
		displayAsPassword : Boolean Specifies whether the text field is a password text field.	RichEditableText
		document : Object A reference to the document object associated with this UIComponent.	UIComponent
		doubleClickEnabled : Boolean [override] Specifies whether the UIComponent object receives doubleClick events.	UIComponent
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		editable : Boolean A flag indicating whether the user is allowed to edit the text in this control.	RichEditableText
		enabled : Boolean Whether the component can accept user interaction.	UIComponent
		enableIME : Boolean [read-only] A flag that indicates whether the IME should be enabled when the component receives focus.	RichEditableText
		errorString : String The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.	UIComponent
		explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates.	UIComponent
		explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.	Sprite
		hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus.	UIComponent
		hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix.	UIComponent
		height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates.	UIComponent
		heightInLines : Number The default height of the control, measured in lines.	RichEditableText
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		horizontalScrollPosition : Number The number of pixels by which the text is scrolled horizontally.	RichEditableText
		id : String ID of the component.	UIComponent
		imeMode : String Specifies the IME (input method editor) mode.	RichEditableText
		includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container.	UIComponent
		inheritingStyles : Object The beginning of this component's chain of inheriting styles.	UIComponent
		initialized : Boolean A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).	UIComponent
		instanceIndex : int [read-only] The index of a repeated component.	UIComponent
		instanceIndices : Array An Array containing the indices required to reference this UIComponent object from its parent document.	UIComponent
		is3D : Boolean [read-only] Contains true when the element is in 3D.	UIComponent
		isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object.	UIComponent
		isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up.	UIComponent
		layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.	UIComponent
		left : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.	DisplayObject
		maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box.	UIComponent
		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.	RichEditableText
		maxHeight : Number The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		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.	UIComponent
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component.	UIComponent
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Whether you can receive focus when clicked on.	UIComponent
		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 Determines whether the user can enter multiline text.	RichEditableText
		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.	UIComponent
		nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles.	UIComponent
		numAutomationChildren : int [read-only] The number of automation children this container has.	UIComponent
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		owner : DisplayObjectContainer The owner of this IVisualElement object.	UIComponent
		parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component.	UIComponent
		parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object [read-only] A reference to the parent document object for this UIComponent.	UIComponent
		percentHeight : Number Specifies the height of a component as a percentage of its parent's size.	UIComponent
		percentWidth : Number Specifies the width of a component as a percentage of its parent's size.	UIComponent
		postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.	UIComponent
		processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens.	UIComponent
		repeater : IRepeater [read-only] A reference to the Repeater object in the parent document that produced this UIComponent.	UIComponent
		repeaterIndex : int [read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.	UIComponent
		repeaterIndices : Array An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.	UIComponent
		repeaters : Array An Array containing references to the Repeater objects in the parent document that produced this UIComponent.	UIComponent
		restrict : String Indicates the set of characters that a user can enter into the text field.	RichEditableText
		right : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		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 [override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.	UIComponent
		rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		rotationZ : Number [override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	UIComponent
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number [override] Number that specifies the vertical scaling factor.	UIComponent
		scaleZ : Number [override] Number that specifies the scaling factor along the z axis.	UIComponent
		screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object.	UIComponent
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selectable : Boolean A flag indicating whether the content is selectable with the mouse, or with the keyboard when the control has the keyboard focus.	RichEditableText
		selectionActivePosition : int [read-only] A character position, relative to the beginning of the text String, specifying the end of the selection that moves when the selection is extended with the arrow keys.	RichEditableText
		selectionAnchorPosition : int [read-only] A character position, relative to the beginning of the text String, specifying the end of the selection that stays fixed when the selection is extended with the arrow keys.	RichEditableText
		selectionHighlighting : String Determines when the text selection is highlighted.	RichEditableText
		showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy.	UIComponent
		showSystemCursor : Boolean [read-only] True if the system cursor should always be shown when the mouse moves over the component.	RichEditableText
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		states : Array The view states that are defined for this component.	UIComponent
		styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object.	UIComponent
		styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component.	UIComponent
		styleName : Object The class style used by this component.	UIComponent
		styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors.	UIComponent
		systemManager : ISystemManager Returns the SystemManager object used by this component.	UIComponent
		tabChildren : Boolean Determines whether the children of the object are tab enabled.	DisplayObjectContainer
		tabEnabled : Boolean Specifies whether this object is in the tab order.	InteractiveObject
		tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.	UIComponent
		tabIndex : int Specifies the tab ordering of objects in a SWF file.	InteractiveObject
		text : String The text String displayed by this component.	RichEditableText
		textFlow : flashx.textLayout.elements:TextFlow The TextFlow representing the rich text displayed by this component.	RichEditableText
		textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		toolTip : String Text to display in the ToolTip.	UIComponent
		top : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		transform : flash.geom:Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	UIComponent
		transformX : Number Sets the x coordinate for the transform center of the component.	UIComponent
		transformY : Number Sets the y coordinate for the transform center of the component.	UIComponent
		transformZ : Number Sets the z coordinate for the transform center of the component.	UIComponent
		transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.	UIComponent
		tweeningProperties : Array Array of properties that are currently being tweened on this object.	UIComponent
		typicalText : String Text that is used to determine the default width and height of the control, without actually being displayed.	RichEditableText
		uid : String A unique identifier for the object.	UIComponent
		updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required).	UIComponent
		useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.	Sprite
		validationSubField : String Used by a validator to associate a subfield with this component.	UIComponent
		verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style.	UIComponent
		verticalScrollPosition : Number The number of pixels by which the text is scrolled vertically.	RichEditableText
		visible : Boolean [override] Whether or not the display object is visible.	UIComponent
		width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		widthInChars : Number The default width of the control, measured in em units.	RichEditableText
		x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent
		z : Number [override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	UIComponent

Protected Properties

	Property		Defined By
		currentCSSState : String [read-only] The state to be used when matching CSS pseudo-selectors.	UIComponent
		hasComplexLayoutMatrix : Boolean [read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.	UIComponent
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().	UIComponent

Public Methods

	Method		Defined By
		RichEditableText() Constructor.	RichEditableText
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		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
		addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance.	UIComponent
		appendText(text:String):void Appends the specified text to the end of the RichEditableText, as if you had clicked at the end and typed.	RichEditableText
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		contentToGlobal(point:Point):Point Converts a Point object from content coordinates to global coordinates.	UIComponent
		contentToLocal(point:Point):Point Converts a Point object from content to local coordinates.	UIComponent
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties that identify the child within this container.	UIComponent
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object.	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object.	UIComponent
		determineTextFormatFromStyles():mx.core:UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow.	UIComponent
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void Executes all the bindings for which the UIComponent object is the destination.	UIComponent
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getAutomationChildren():Array Provides the automation object list .	UIComponent
		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
		getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size.	UIComponent
		getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size.	UIComponent
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getFormatOfRange(requestedFormats:Vector.<String> = null, anchorPosition:int = -1, activePosition:int = -1):flashx.textLayout.formats:TextLayoutFormat Returns a TextLayoutFormat object specifying the computed formats for the specified range of characters.	RichEditableText
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.	RichEditableText
		getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height.	UIComponent
		getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width.	UIComponent
		getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen.	UIComponent
		getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen.	UIComponent
		getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings.	UIComponent
		getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element.	UIComponent
		getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height.	UIComponent
		getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width.	UIComponent
		getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height.	UIComponent
		getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height.	UIComponent
		getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width.	UIComponent
		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
		getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.	UIComponent
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.	RichEditableText
		globalToContent(point:Point):Point Converts a Point object from global to content coordinates.	UIComponent
		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
		hasCSSState():Boolean Returns true if currentCSSState is not null.	UIComponent
		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
		hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent.	UIComponent
		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
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.	UIComponent
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		insertText(text:String):void Inserts the specified text into the RichEditableText as if you had typed it.	RichEditableText
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	UIComponent
		invalidateLayering():void Called by a component's items to indicate that their depth property has changed.	UIComponent
		invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.	UIComponent
		invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its measure() method gets called during a later screen update.	UIComponent
		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
		localToContent(point:Point):Point Converts a Point object from local to content coordinates.	UIComponent
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState.	UIComponent
		matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type.	UIComponent
		measureHTMLText(htmlText:String):flash.text:TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		measureText(text:String):flash.text:TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	UIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.	UIComponent
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance.	UIComponent
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().	UIComponent
		scrollToRange(anchorPosition:int, activePosition:int):void Scrolls so that the text range is visible in the container.	RichEditableText
		selectAll():void Selects all of the text.	RichEditableText
		selectRange(anchorPosition:int, activePosition:int):void Selects a specified range of characters.	RichEditableText
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setFormatOfRange(format:flashx.textLayout.formats:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void Applies the specified formats to each element in the specified range that correspond to the given format.	RichEditableText
		setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen.	UIComponent
		setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element.	UIComponent
		setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	UIComponent
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object.	DisplayObjectContainer
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		styleChanged(styleProp:String):void [override] Detects changes to style properties.	RichEditableText
		stylesInitialized():void [override] Flex calls the stylesInitialized() method when the styles for a component are first initialized.	RichEditableText
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		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.	FlexSprite
		transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.	UIComponent
		transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.	UIComponent
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method.	UIComponent
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.	UIComponent
		validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.	UIComponent
		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

Protected Methods

	Method		Defined By
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		applyComputedMatrix():void Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.	UIComponent
		attachOverlay():void This is an internal method used by the Flex framework to support the Dissolve effect.	UIComponent
		canSkipMeasurement():Boolean Determines if the call to the measure() method can be skipped.	UIComponent
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createChildren():void Create child objects of the component.	UIComponent
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		dispatchPropertyChangeEvent(prop:String, oldValue:, value:):void Helper method for dispatching a PropertyChangeEvent when a property is updated.	UIComponent
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		initAdvancedLayoutFeatures():void Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.	UIComponent
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		invalidateParentSizeAndDisplayList():void Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event.	UIComponent
		keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event.	UIComponent
		measure():void Calculates the default size, and optionally the default minimum size, of the component.	UIComponent
		resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	UIComponent
		setStretchXY(stretchX:Number, stretchY:Number):void Specifies a transform stretch factor in the horizontal and vertical direction.	UIComponent
		stateChanged(oldState:String, newState:String, recursive:Boolean):void This method is called when a state changes to check whether state-specific styles apply to this component.	UIComponent
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void Draws the object and/or sizes and positions its children.	UIComponent

Events

Click for more information on events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
add	Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.	UIComponent
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 user editing operation is complete.	RichEditableText
changing	Dispatched before a user editing operation occurs.	RichEditableText
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
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
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
dragComplete	Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.	UIComponent
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
effectStop	Dispatched after an effect is stopped, which happens only by a call to stop() on the effect.	UIComponent
enter	Dispatched when the user presses the Enter key, if the multiline property is false.	RichEditableText
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
enterState	Dispatched after the component has entered a view state.	UIComponent
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
exitState	Dispatched just before the component exits a view state.	UIComponent
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
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
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
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
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
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
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
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
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
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
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
remove	Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.	UIComponent
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
resize	Dispatched when the component is resized.	UIComponent
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
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
selectionChange	Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason.	RichEditableText
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
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
stateChangeComplete	Dispatched after the component has entered a new state and any state transition animation to that state has finished playing.	UIComponent
stateChangeInterrupted	Dispatched when a component interrupts a transition to its current state in order to switch to a new state.	UIComponent
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	Dispatched when a user enters one or more characters of text.	InteractiveObject
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and is to be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
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
touchInteractionEnd	A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.	UIComponent
touchInteractionStart	A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.	UIComponent
touchInteractionStarting	A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.	UIComponent
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
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

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
alignmentBaseline	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline to which the dominant baseline aligns. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline	RichEditableText
backgroundAlpha	Type: Number CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The alpha level of the color defined by the `backgroundColor` style. Valid values range from 0.0 to 1.0. The default value is `1.0`.	RichEditableText
backgroundColor	Type: uint Format: Color CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of the background of the entire bounding rectangle of this component. If this style is `undefined`, no background is drawn. Otherwise, this RGB color is drawn with an alpha level determined by the `backgroundAlpha` style. The default value is `undefined`.	RichEditableText
baseline	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position.	UIComponent
baselineShift	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Amount to shift the baseline. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.baselineShift	RichEditableText
blockProgression	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies a vertical or horizontal progression of line placement. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.blockProgression	RichEditableText
bottom	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.	UIComponent
breakOpportunity	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls where lines are allowed to break when breaking wrapping text into multiple lines. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity	RichEditableText
cffHinting	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of CFF hinting used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.cffHinting	RichEditableText
clearFloats	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls how text wraps around a float. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.clearFloats. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.clearFloats	RichEditableText
color	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style color, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style color. The default value is `0x000000`. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.color spark.components.supportClasses.StyleableTextField.color spark.components.supportClasses.StyleableStageText.color	RichEditableText
columnCount	Type: Object CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Number of text columns. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnCount. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.columnCount	RichEditableText
columnGap	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Amount of gutter space, in pixels, to leave between the columns. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnGap. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.columnGap	RichEditableText
columnWidth	Type: Object CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Column width in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnWidth. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.columnWidth	RichEditableText
digitCase	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of digit case used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.digitCase	RichEditableText
digitWidth	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Type of digit width used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.digitWidth	RichEditableText
direction	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the default bidirectional embedding level of the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.direction	RichEditableText
dominantBaseline	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies which element baseline snaps to the `alignmentBaseline` to determine the vertical position of the element on the line. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline	RichEditableText
errorColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails.	UIComponent
firstBaselineOffset	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the baseline position of the first line in the container. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset	RichEditableText
focusBlendMode	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Blend mode used by the focus rectangle.	UIComponent
focusedTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled and has focus. For the Mobile theme, this is not supported.	RichEditableText
focusSkin	Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle.	UIComponent
focusThickness	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Thickness, in pixels, of the focus rectangle outline.	UIComponent
fontFamily	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The name of the font to use, or a comma-separated list of font names. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontFamily, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontFamily. The default value for the Spark theme is `Arial`. The default value for the Mobile theme is `_sans`. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.fontFamily spark.components.supportClasses.StyleableStageText.fontFamily spark.components.supportClasses.StyleableTextField.fontFamily	RichEditableText
fontLookup	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Font lookup to use. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.fontLookup	RichEditableText
fontSize	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Height of the text, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontSize, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontSize. The default value for the Spark theme is `12`. The default value for the Mobile theme is `24`. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.fontSize spark.components.supportClasses.StyleableStageText.fontSize spark.components.supportClasses.StyleableTextField.fontSize	RichEditableText
fontStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is italic font. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontStyle, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontStyle. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.fontStyle spark.components.supportClasses.StyleableStageText.fontStyle spark.components.supportClasses.StyleableTextField.fontStyle	RichEditableText
fontWeight	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is boldface. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style fontWeight, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style fontWeight. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.fontWeight spark.components.supportClasses.StyleableStageText.fontWeight spark.components.supportClasses.StyleableTextField.fontWeight	RichEditableText
horizontalCenter	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component.	UIComponent
inactiveTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is disabled. For the Mobile theme, this is not supported.	RichEditableText
interactionMode	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component.	UIComponent
justificationRule	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Rule used to justify text in a paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.justificationRule	RichEditableText
justificationStyle	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.justificationStyle	RichEditableText
kerning	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The style used for justification of the paragraph. Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret `default` as `auto`, while MX components interpret `default` as `false`. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.kerning	RichEditableText
layoutDirection	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component.	UIComponent
leadingModel	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the leading model, which is a combination of leading basis and leading direction. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.leadingModel. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.leadingModel	RichEditableText
left	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.	UIComponent
ligatureLevel	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls which of the ligatures that are defined in the font may be used in the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel	RichEditableText
lineBreak	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Controls word wrapping within the container. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.lineBreak	RichEditableText
lineHeight	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Leading controls for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight. For the Mobile theme, this is not supported. See `leading`. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.lineHeight leading	RichEditableText
lineThrough	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 If true, applies strikethrough, a line drawn through the middle of the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.lineThrough	RichEditableText
listAutoPadding	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 This specifies an auto indent for the start edge of lists when the padding value of the list on that side is `auto`. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding	RichEditableText
listStylePosition	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the placement of a list item marker relative to the list item. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStylePosition. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.listStylePosition	RichEditableText
listStyleType	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 This controls the appearance of items in a list. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStyleType. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.listStyleType	RichEditableText
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. Controls case transformations and shaping. Uses standard locale identifiers as described in Unicode Technical Standard #35. For example "en", "en_US" and "en-US" are all English, "ja" is Japanese. The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global `locale` style. During the application initialization, if the global `locale` style is undefined, then the default value is set to "en". When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the `LocaleID.DEFAULT` constant. Those classes will then use the client operating system's international preferences. The default value is `undefined`. Learn more http://www.unicode.org/reports/tr35/	RichEditableText
paddingBottom	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Bottom inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingBottom. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paddingBottom	RichEditableText
paddingLeft	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Left inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingLeft. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paddingLeft	RichEditableText
paddingRight	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Right inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paddingRight	RichEditableText
paddingTop	Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Top inset, in pixels. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paddingRight	RichEditableText
paragraphEndIndent	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's end edge. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent	RichEditableText
paragraphSpaceAfter	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave after the paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter	RichEditableText
paragraphSpaceBefore	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of space to leave before the paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore	RichEditableText
paragraphStartIndent	Type: Number Format: length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount to indent the paragraph's start edge. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent	RichEditableText
renderingMode	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The rendering mode used for this text which applies only to embedded fonts. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.renderingMode	RichEditableText
right	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.	UIComponent
showErrorSkin	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid	UIComponent
showErrorTip	Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it	UIComponent
tabStops	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies the tab stops associated with the paragraph. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.tabStops. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.tabStops	RichEditableText
textAlign	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of text within a container. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textAlign, and if using StyleableStageText, see spark.components.supportClasses.StyleableStageText Style textAlign. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textAlign spark.components.supportClasses.StyleableStageText.textAlign spark.components.supportClasses.StyleableTextField.textAlign	RichEditableText
textAlignLast	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alignment of the last line in the paragraph relative to the container in justified text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textAlignLast	RichEditableText
textAlpha	Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha (transparency) value for the text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textAlpha	RichEditableText
textDecoration	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines whether the text is underlined. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textDecoration, and if using StyleableStageText, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textDecoration spark.components.supportClasses.StyleableTextField.textDecoration	RichEditableText
textIndent	Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Offset of first line of text from the left side of the container. . For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textIndent. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField Style textIndent, and if using StyleableStageText this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textIndent spark.components.supportClasses.StyleableTextField.textIndent	RichEditableText
textJustify	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Specifies options for justifying text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textJustify	RichEditableText
textRotation	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Determines the number of degrees to rotate this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textRotation. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.textRotation	RichEditableText
top	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.	UIComponent
trackingLeft	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the left of each character. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.trackingLeft	RichEditableText
trackingRight	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The amount of tracking (manual kerning) to be applied to the right of each character. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.trackingRight	RichEditableText
typographicCase	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The type of typographic case used for this text. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.typographicCase	RichEditableText
unfocusedTextSelectionColor	Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The color of text when the component is enabled but does not have focus. For the Mobile theme, this is not supported.	RichEditableText
verticalAlign	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Vertical alignment or justification. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.verticalAlign. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.verticalAlign	RichEditableText
verticalCenter	Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component.	UIComponent
whiteSpaceCollapse	Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Collapses or preserves whitespace when importing text into a TextFlow. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse	RichEditableText
wordSpacing	Type: Object CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.5, AIR 2.0 Specifies the spacing between words to use during justification. For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.wordSpacing. For the Mobile theme, this is not supported. Related API Elements flashx.textLayout.formats.ITextLayoutFormat.wordSpacing	RichEditableText

Halo Theme Styles

Click for more information on styles

	Style		Description	Defined By
		themeColor	Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Theme color of a component.	UIComponent

Mobile Theme Styles

Click for more information on styles

Style Description Defined By

	Style	Description	Defined By
		leading	Type: Number Format: Length CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0 Additional vertical space between lines of text. For the Spark theme, this is not supported. See `lineHeight`. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported. Related API Elements spark.components.supportClasses.StyleableTextField.leading lineHeight	RichEditableText
		letterSpacing	Type: Number CSS Inheritance: Yes Theme: mobile Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0 The number of additional pixels to appear between each character. For the Spark theme, this is not supported. See `trackingLeft` and `trackingRight`. For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported. Related API Elements spark.components.supportClasses.StyleableTextField.letterSpacing trackingLeft trackingRight	RichEditableText

leading

Type: Number Format: Length CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0

Additional vertical space between lines of text.

For the Spark theme, this is not supported. See lineHeight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableStageText Style fontWeight and if using StyleableStageText, this is not supported.

Related API Elements

spark.components.supportClasses.StyleableTextField.leading
lineHeight

RichEditableText

letterSpacing

Type: Number CSS Inheritance: Yes Theme: mobile
Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10.1, AIR 2.0

The number of additional pixels to appear between each character.

For the Spark theme, this is not supported. See trackingLeft and trackingRight.

For the Mobile theme, if using StyleableTextField, see spark.components.supportClasses.StyleableTextField.letterSpacing and if using StyleableStageText, this is not supported.

Related API Elements

spark.components.supportClasses.StyleableTextField.letterSpacing
trackingLeft
trackingRight

RichEditableText

Effects

Click for more information on effects

	Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
focusInEffect	Triggering Event: focusIn Played when the component gains keyboard focus.	UIComponent
focusOutEffect	Triggering Event: focusOut Played when the component loses keyboard focus.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

Public Constants

	Constant		Defined By

Property Detail

clipAndEnableScrolling

property

clipAndEnableScrolling:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

If true, specifies to clip the children to the boundaries of the viewport. If false, the container children extend past the container boundaries, regardless of the size specification of the component.

The default value is false.

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

content

property

content:Object

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

This property is intended for use in MXML at compile time; to get or set rich text content at runtime, please use the textFlow property instead.

The content property is the default property for RichEditableText, so that you can write MXML such as

          <s:RichEditableText>Hello <s:span fontWeight="bold"/>World</s:span></s:RichEditableText>

and have the String and SpanElement that you specify as the content be used to create a TextFlow.

This property is typed as Object because you can set it to to a String, a FlowElement, or an Array of Strings and FlowElements. In the example above, you are specifying the content to be a 2-element Array whose first element is the String "Hello" and whose second element is a SpanElement with the text "World" in boldface.

No matter how you specify the content, it gets converted into a TextFlow, and when you get this property, you will get the resulting TextFlow.

Adobe recommends using textFlow property to get and set rich text content at runtime, because it is strongly typed as a TextFlow rather than as an Object. A TextFlow is the canonical representation for rich text content in the Text Layout Framework.

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

contentHeight

property

contentHeight:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The height of the text.

Due to the fact that the Text Layout Framework virtualizes TextLines for performance, this height will initially be an estimate if the component cannot display all of the text. If you scroll to the end of the text, all the TextLines will get composed and the contentHeight will be exact.

To scroll over the text vertically, vary the verticalScrollPosition between 0 and contentHeight - height.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get contentHeight():Number

contentWidth

property

contentWidth:Number [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The width of the text.

Due to the fact that the Text Layout Framework virtualizes TextLines for performance, this width will initially be an estimate if the component cannot display all of the text. If you scroll to the end of the text, all the TextLines will get composed and the contentWidth will be exact.

To scroll over the text horizontally, vary the horizontalScrollPosition between 0 and contentWidth - width.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get contentWidth():Number

displayAsPassword

property

displayAsPassword:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Specifies whether the text field is a password text field. If the value of this property is true, the text field is treated as a password text field and hides the input characters using asterisks instead of the actual characters. If false, the text field is not treated as a password text field. When password mode is enabled, the Cut and Copy commands and their corresponding keyboard shortcuts will not function. This security mechanism prevents an unscrupulous user from using the shortcuts to discover a password on an unattended computer.

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

editable

property

editable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A flag indicating whether the user is allowed to edit the text in this control.

If true, the mouse cursor will change to an i-beam when over the bounds of this control. If false, the mouse cursor will remain an arrow.

If this property is true, the selectable property is ignored.

The default value is true.

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

Related API Elements

spark.components.RichEditableText.selectable

enableIME

property

enableIME:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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

Implementation
public function get enableIME():Boolean

heightInLines

property

heightInLines:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The default height of the control, measured in lines.

The control's formatting styles, such as fontSize and lineHeight, are used to calculate the line height in pixels.

You would, for example, set this property to 5 if you want the height of the RichEditableText to be sufficient to display five lines of text.

If this property is NaN (the default), then the component's default height will be determined from the text to be displayed.

This property will be ignored if you specify an explicit height, a percent height, or both top and bottom constraints.

This property will also be ignored if the typicalText property is specified.

RichEditableText's measure() method uses widthInChars and heightInLines to determine the measuredWidth and measuredHeight. These are similar to the cols and rows of an HTML TextArea.

Since both widthInChars and heightInLines default to NaN, RichTextEditable "autosizes" by default: it starts out very small if it has no text, grows in width as you type, and grows in height when you press Enter to start a new line.

The default value is NaN.

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

Related API Elements

spark.components.RichEditableText.widthInChars

horizontalScrollPosition

property

horizontalScrollPosition:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The number of pixels by which the text is scrolled horizontally.

To scroll over the text horizontally, vary the horizontalScrollPosition between 0 and contentWidth - width.

The default value is 0.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

imeMode

property

imeMode:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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

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

The default value is null.

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

Related API Elements

flash.system.IMEConversionMode

maxChars

property

maxChars:int

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The maximum number of characters that the text field can contain, as entered by a user. A script can insert more text than maxChars allows; the maxChars property indicates only how much text a user can enter. If the value of this property is 0, a user can enter an unlimited amount of text.

The default value is 0.

Implementation
public function get maxChars():int
public function set maxChars(value:int):void

multiline

property

multiline:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Determines whether the user can enter multiline text.

If true, the Enter key starts a new paragraph. If false, the Enter key doesn't affect the text but causes the RichEditableText to dispatch an "enter" event. If you paste text into the RichEditableText with a multiline value of false, newlines are stripped out of the text.

The default value is true.

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

restrict

property

restrict:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Indicates the set of characters that a user can enter into the text field. If the value of the restrict property is null, you can enter any character. If the value of the restrict property is an empty string, you cannot enter any character. If the value of the restrict property is a string of characters, you can enter only characters in the string into the text field. The string is scanned from left to right. You can specify a range by using the hyphen (-) character. Only user interaction is restricted; a script can put any text into the text field. This property does not synchronize with the Embed font options in the Property inspector.

If the string begins with a caret (^) character, all characters are initially accepted and succeeding characters in the string are excluded from the set of accepted characters. If the string does not begin with a caret (^) character, no characters are initially accepted and succeeding characters in the string are included in the set of accepted characters.

The following example allows only uppercase characters, spaces, and numbers to be entered into a text field:

     my_txt.restrict = "A-Z 0-9";

The following example includes all characters, but excludes lowercase letters:

     my_txt.restrict = "^a-z";

You can use a backslash to enter a ^ or - verbatim. The accepted backslash sequences are \-, \^ or \\. The backslash must be an actual character in the string, so when specified in ActionScript, a double backslash must be used. For example, the following code includes only the dash (-) and caret (^):

     my_txt.restrict = "\\-\\^";

The ^ can be used anywhere in the string to toggle between including characters and excluding characters. The following code includes only uppercase letters, but excludes the uppercase letter Q:

     my_txt.restrict = "A-Z^Q";

You can use the \u escape sequence to construct restrict strings. The following code includes only the characters from ASCII 32 (space) to ASCII 126 (tilde).

     my_txt.restrict = "\u0020-\u007E";

The default value is null.

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

selectable

property

selectable:Boolean

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A flag indicating whether the content is selectable with the mouse, or with the keyboard when the control has the keyboard focus.

Making the text selectable lets you copy text from the control.

This property is ignored if the editable property is true.

The default value is true.

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

selectionActivePosition

property

selectionActivePosition:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A character position, relative to the beginning of the text String, specifying the end of the selection that moves when the selection is extended with the arrow keys.

The active position may be either the start or the end of the selection.

For example, if you drag-select from position 12 to position 8, then selectionAnchorPosition will be 12 and selectionActivePosition will be 8, and when you press Left-Arrow selectionActivePosition will become 7.

A value of -1 indicates "not set".

The default value is -1.

This property can be used as the source for data binding. When this property is modified, it dispatches the selectionChange event.

Implementation
public function get selectionActivePosition():int

Related API Elements

spark.components.RichEditableText.selectionAnchorPosition

selectionAnchorPosition

property

selectionAnchorPosition:int [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

A character position, relative to the beginning of the text String, specifying the end of the selection that stays fixed when the selection is extended with the arrow keys.

The anchor position may be either the start or the end of the selection.

A value of -1 indicates "not set".

The default value is -1.

This property can be used as the source for data binding. When this property is modified, it dispatches the selectionChange event.

Implementation
public function get selectionAnchorPosition():int

Related API Elements

spark.components.RichEditableText.selectionActivePosition

selectionHighlighting

property

selectionHighlighting:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Determines when the text selection is highlighted.

The allowed values are specified by the spark.components.TextSelectionHighlighting class. Possible values are TextSelectionHighlighting.WHEN_FOCUSED, TextSelectionHighlighting.WHEN_ACTIVE, and TextSelectionHighlighting.ALWAYS.

WHEN_FOCUSED shows the text selection only when the component has keyboard focus.

WHEN_ACTIVE shows the text selection whenever the component's window is active, even if the component doesn't have the keyboard focus.

ALWAYS shows the text selection, even if the component doesn't have the keyboard focus or if the component's window isn't the active window.

The default value is TextSelectionHighlighting.WHEN_FOCUSED.

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

Related API Elements

spark.components.TextSelectionHighlighting

showSystemCursor

property

showSystemCursor:Boolean [read-only]

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

True if the system cursor should always be shown when the mouse moves over the component. If false, the custom cursor will be shown.

Implementation
public function get showSystemCursor():Boolean

text

property

text:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The text String displayed by this component.

Setting this property affects the textFlow property and vice versa.

If you set the text to a String such as "Hello World" and get the textFlow, it will be a TextFlow containing a single ParagraphElement with a single SpanElement.

If you set the text to null, it will be set to the default value which is an empty string.

If the text contains explicit line breaks -- CR ("\r"), LF ("\n"), or CR+LF ("\r\n") -- then the content will be set to a TextFlow which contains multiple paragraphs, each with one span.

If you set the textFlow and get the text, the text in each paragraph will be separated by a single LF ("\n").

Setting this property also affects the properties specifying the control's scroll position and the text selection. It resets the horizontalScrollPosition and verticalScrollPosition to 0. Starting with Flex 4.6, the selectionAnchorPosition and selectionActivePosition are preserved. Previously, the selectionAnchorPosition and selectionActivePosition were set to -1 to clear the selection.

The default value is "".

This property can be used as the source for data binding. When this property is modified, it dispatches the change event.

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

Related API Elements

spark.components.RichEditableText.textFlow
spark.components.RichEditableText.horizontalScrollPosition
spark.components.RichEditableText.verticalScrollPosition
spark.components.RichEditableText.selectionAnchorPosition
spark.components.RichEditableText.selectionActivePosition

textFlow

property

textFlow:flashx.textLayout.elements:TextFlow

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10, AIR 2.5

The TextFlow representing the rich text displayed by this component.

A TextFlow is the most important class in the Text Layout Framework (TLF). It is the root of a tree of FlowElements representing rich text content.

You normally create a TextFlow from TLF markup using the TextFlowUtil.importFromString() or TextFlowUtil.importFromXML() methods. Alternately, you can use TLF's TextConverter class (which can import a subset of HTML) or build a TextFlow using methods like addChild() on TextFlow.

Setting this property affects the text property and vice versa.

If you set the textFlow and get the text, the text in each paragraph will be separated by a single LF ("\n").

If you set the text to a String such as "Hello World" and get the textFlow, it will be a TextFlow containing a single ParagraphElement with a single SpanElement.

If the text contains explicit line breaks -- CR ("\r"), LF ("\n"), or CR+LF ("\r\n") -- then the content will be set to a TextFlow which contains multiple paragraphs, each with one span.

Setting this property also affects the properties specifying the control's scroll position and the text selection. It resets the horizontalScrollPosition and verticalScrollPosition to 0, and it sets the selectionAnchorPosition and selectionActivePosition to -1 to clear the selection.

To turn a TextFlow object into TLF markup, use the TextFlowUtil.export() markup.

A single TextFlow cannot be shared by multiple instances of RichEditableText. To display the same text in a second instance, you must create a second TextFlow, either by using TextFlowUtil.export() and TextFlowUtil.importFromXML() or by using the deepCopy() method on TextFlow.

Implementation
public function get textFlow():flashx.textLayout.elements:TextFlow
public function set textFlow(value:flashx.textLayout.elements:TextFlow):void

Related API Elements

spark.utils.TextFlowUtil.importFromString()
spark.utils.TextFlowUtil.importFromXML()
spark.components.RichEditableText.text

typicalText

property

typicalText:String

Language Version:

ActionScript 3.0

Product Version:

Flex 4.5

Runtime Versions:

Flash Player 10.2, AIR 2.0

Text that is used to determine the default width and height of the control, without actually being displayed.

This property will be ignored if you specify an explicit width, a percent width, or both left and right constraints.

Use of this property causes the widthInChars and heightInLines properties to be ignored.

The default value is null.

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

Related API Elements

spark.primitives.heightInLines
spark.primitives.widthInChars

verticalScrollPosition

property

verticalScrollPosition:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The number of pixels by which the text is scrolled vertically.

To scroll over the text vertically, vary the verticalScrollPosition between 0 and contentHeight - height.

The default value is 0.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

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

widthInChars

property

widthInChars:Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

The default width of the control, measured in em units.

An em is a unit of typographic measurement equal to the point size. It is not necessarily exactly the width of the "M" character, but in many fonts the "M" is about one em wide. The control's fontSize style is used, to calculate the em unit in pixels.

You would, for example, set this property to 20 if you want the width of the RichEditableText to be sufficient to display about 20 characters of text.

If this property is NaN (the default), then the component's default width will be determined from the text to be displayed.

This property will be ignored if you specify an explicit width, a percent width, or both left and right constraints.

This property will also be ignored if the typicalText property is specified.

RichEditableText's measure() method uses widthInChars and heightInLines to determine the measuredWidth and measuredHeight. These are similar to the cols and rows of an HTML TextArea.

The default value is NaN.

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

Related API Elements

spark.primitives.heightInLines

Constructor Detail

RichEditableText

()

Constructor

public function RichEditableText()

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Constructor.

Method Detail

appendText

()

method

public function appendText(text:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Appends the specified text to the end of the RichEditableText, 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.

getFormatOfRange

()

method

 public function getFormatOfRange(requestedFormats:Vector.<String> = null, anchorPosition:int = -1, activePosition:int = -1):flashx.textLayout.formats:TextLayoutFormat

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Returns a TextLayoutFormat object specifying the computed formats for the specified range of characters.

If a format is not consistently set across the entire range, its value will be undefined.

You can specify a Vector of Strings containing the names of the formats that you care about; if you don't, all formats will be computed.

If you don't specify a range, the selected range is used.

Parameters

	`requestedFormats:Vector.<String>` (default = `null`) — A Vector of Strings specifying the names of the requested formats, or `null` to request all formats.

	`anchorPosition:int` (default = `-1`) — A character position specifying the fixed end of the selection.

	`activePosition:int` (default = `-1`) — A character position specifying the movable end of the selection.

Returns

flashx.textLayout.formats:TextLayoutFormat — A TextLayoutFormat object.

getHorizontalScrollPositionDelta

()

method

public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.

Parameters

navigationUnit:uint — The amount to scroll. The value must be one of the following spark.core.NavigationUnit constants:

LEFT
RIGHT
PAGE_LEFT
PAGE_RIGHT
HOME
END

To scroll by a single column, use LEFT or RIGHT. To scroll to the first or last column, use HOME or END.

Returns

Number — The number of pixels to add to horizontalScrollPosition.

getVerticalScrollPositionDelta

()

method

public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.

Parameters

navigationUnit:uint — The amount to scroll. The value of unit must be one of the following spark.core.NavigationUnit constants:

UP
DOWN
PAGE_UP
PAGE_DOWN
HOME
END

To scroll by a single row use UP or DOWN. To scroll to the first or last row, use HOME or END.

Returns

Number — The number of pixels to add to verticalScrollPosition.

insertText

()

method

public function insertText(text:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Inserts the specified text into the RichEditableText 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.

scrollToRange

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Scrolls so that the text range is visible in the container.

Parameters

	`anchorPosition:int` — The end of the selection that is changed when you extend the selection. It can be either the start or the end of the selection, expressed as an offset from the start of the text flow.

	`activePosition:int` — The stable end of the selection when you extend the selection. It can be either the start or the end of the selection.

selectAll

()

method

public function selectAll():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Selects all of the text. This does not include the final paragraph terminator.

selectRange

()

method

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

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Selects a specified range of characters.

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

Parameters

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

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

setFormatOfRange

()

method

 public function setFormatOfRange(format:flashx.textLayout.formats:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Applies the specified formats to each element in the specified range that correspond to the given format. It applies the character formats to the text in the specified range (no change is made if the specified range is a single point). It applies the paragraph formats to any paragraphs at least partially within the range (or a single paragraph if the range is a single point). It applies the container formats to the container.

The supported formats are those in TextLayoutFormat. A value of undefined does not get applied. If you don't specify a range, the selected range is used.

The following example sets the fontSize and color of the selection:

          var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
          textLayoutFormat.fontSize = 12;
          textLayoutFormat.color = 0xFF0000;
          myRET.setFormatOfRange(textLayoutFormat);

If you use the results of getFormatOfRange() to specify the format, note that every format in the TextLayoutFormat has a computed value, which will be applied to each element that corresponds to the given format.

If you would like to specify a format to be applied to all the text it would be better to use setStyle(format, value) on the component itself.

The following example sets the fontSize and color of all the text:

          myRET.setStyle("fontSize", 12);
          myRET.setStyle("color", 0xFF0000);

Parameters

	`format:flashx.textLayout.formats:TextLayoutFormat` — The TextLayoutFormat to apply to the selection.

	`anchorPosition:int` (default = `-1`) — A character position, relative to the beginning of the text String, specifying the end of the selection that stays fixed when the selection is extended with the arrow keys.

	`activePosition:int` (default = `-1`) — A character position, relative to the beginning of the text String, specifying the end of the selection that moves when the selection is extended with the arrow keys.

styleChanged

()

method

override public function styleChanged(styleProp:String):void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

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

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

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

Parameters

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

stylesInitialized

()

method

override public function stylesInitialized():void

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Flex calls the stylesInitialized() method when the styles for a component are first initialized.

This is an advanced method that you might override when creating a subclass of UIComponent. Flex guarantees that your component's styles are fully initialized before the first time your component's measure and updateDisplayList methods are called. For most components, that is sufficient. But if you need early access to your style values, you can override the stylesInitialized() function to access style properties as soon as they are initialized the first time.

Event Detail

change

Event

Event Object Type: spark.events.TextOperationEvent
property TextOperationEvent.type = spark.events.TextOperationEvent.CHANGE

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched after a user editing operation is complete.

The TextOperationEvent.CHANGE constant defines the value of the type property of the event object for a change event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`operation`	The FlowOperation object describing the editing operation being performed on the text by the user.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

changing

Event

Event Object Type: spark.events.TextOperationEvent
property TextOperationEvent.type = spark.events.TextOperationEvent.CHANGING

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched before a user editing operation occurs. You can alter the operation, or cancel the event to prevent the operation from being processed.

The TextOperationEvent.CHANGING constant defines the value of the type property of the event object for a changing event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	true
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`operation`	The FlowOperation object describing the editing operation being performed on the text by the user.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

enter

Event

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.ENTER

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Dispatched when the user presses the Enter key, if the multiline property is false.

The FlexEvent.ENTER constant defines the value of the type property of the event object for a enter event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

selectionChange

Event

Event Object Type: mx.events.FlexEvent
property FlexEvent.type = mx.events.FlexEvent.SELECTION_CHANGE

Language Version:

ActionScript 3.0

Product Version:

Flex 4

Runtime Versions:

Flash Player 10, AIR 1.5

Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason.

The FlexEvent.SELECTION_CHANGE constant defines the value of the type property of the event object for a selectionChange event.

The properties of the event object have the following values:

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

Examples How to use this example

RichEditableTextExample.mxml

<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Spark RichEditableText primitive. -->
<s:Application name="RichEditableTextExample"
        xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">

    <fx:Script>
        <![CDATA[
            import flashx.textLayout.conversion.TextConverter;
        ]]>
    </fx:Script>

    <fx:Declarations>
        <fx:XML id="extTxtFlow" source="externalTextFlow.xml" />
    </fx:Declarations>

    <s:Panel title="RichText textFlow test"
            width="90%" height="90%"
            horizontalCenter="0" verticalCenter="0">
        <s:Scroller width="100%" height="100%">
            <s:VGroup paddingLeft="20" paddingRight="20" paddingTop="20" paddingBottom="20">
                <s:RichEditableText id="richTxt1" textAlign="justify" percentWidth="100">
                    <s:textFlow>
                        <s:TextFlow>
                            <s:p fontSize="24">Inline TextFlow</s:p>
                            <s:p>1) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus aliquet tristique libero, vel mattis massa pellentesque nec. Maecenas non nulla nibh, et egestas ligula. Etiam massa mauris, elementum gravida rhoncus sit amet, blandit eu lacus. Proin nisi felis, accumsan at interdum eu, mattis at velit. Nulla at ipsum risus. Nullam non justo vel lacus vulputate mollis id quis libero.</s:p>
                            <s:p>2) Cras posuere posuere sem, eu congue orci mattis quis. Morbi vitae est ut purus vestibulum iaculis malesuada quis metus. Donec feugiat sapien quis turpis porttitor vel mattis libero viverra. Sed nisl justo, fringilla eget ultrices ut, venenatis quis magna. Nulla feugiat egestas mattis. Phasellus sed dignissim justo. Etiam malesuada bibendum urna, id dapibus nulla posuere eu.</s:p>
                            <s:p>3) Curabitur pulvinar tellus venenatis ipsum tempus lobortis. Vestibulum eros velit, bibendum at aliquet ut, placerat sed mauris.</s:p>
                        </s:TextFlow>
                    </s:textFlow>
                </s:RichEditableText>

                <s:RichEditableText id="richTxt2" textAlign="justify" width="100%"
                        textFlow="{TextConverter.importToFlow(extTxtFlow, TextConverter.TEXT_LAYOUT_FORMAT)}" />
            </s:VGroup>
        </s:Scroller>
    </s:Panel>

</s:Application>

externalTextFlow.xml

<?xml version="1.0" encoding="UTF-8"?>
<!-- externalTextFlow.xml -->
<TextFlow xmlns="http://ns.adobe.com/textLayout/2008">
    <p fontSize="24">External TextFlow</p>
    <p>1) Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus aliquet tristique libero, vel mattis massa pellentesque nec. Maecenas non nulla nibh, et egestas ligula. Etiam massa mauris, elementum gravida rhoncus sit amet, blandit eu lacus. Proin nisi felis, accumsan at interdum eu, mattis at velit. Nulla at ipsum risus. Nullam non justo vel lacus vulputate mollis id quis libero.</p>
    <p>2) Cras posuere posuere sem, eu congue orci mattis quis. Morbi vitae est ut purus vestibulum iaculis malesuada quis metus. Donec feugiat sapien quis turpis porttitor vel mattis libero viverra. Sed nisl justo, fringilla eget ultrices ut, venenatis quis magna. Nulla feugiat egestas mattis. Phasellus sed dignissim justo. Etiam malesuada bibendum urna, id dapibus nulla posuere eu.</p>
    <p>3) Curabitur pulvinar tellus venenatis ipsum tempus lobortis. Vestibulum eros velit, bibendum at aliquet ut, placerat sed mauris.</p>
</TextFlow>

Legal Notices | Online Privacy Policy

RichEditableText - AS3 Flex

Classes x

clipAndEnableScrolling

content

contentHeight

contentWidth

displayAsPassword

editable

enableIME

heightInLines

horizontalScrollPosition

imeMode

maxChars

multiline

restrict

selectable

selectionActivePosition

selectionAnchorPosition

selectionHighlighting

showSystemCursor

text

textFlow

typicalText

verticalScrollPosition

widthInChars

RichEditableText

appendText

getFormatOfRange

getHorizontalScrollPositionDelta

getVerticalScrollPositionDelta

insertText

scrollToRange

selectAll

selectRange

setFormatOfRange

styleChanged

stylesInitialized

change

changing

enter

selectionChange