Packagespark.components
Classpublic class RichEditableText
InheritanceRichEditableText Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IViewport, IFocusManagerComponent, IIMESupport

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

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, which is new with Flex 4, makes use of the new 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 -- as part of its pay-only-for-what-you-need philosophy. 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 slowest and heaviest, but offers most of what TLF can do. You should 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 in the Player.

The most important differences to understand are:

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 RichEditableText to display by setting its textFlow property to a TextFlow instance. Please 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, simply set the text property to 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 simply put TLF markup tags inside the RichEditableText tag, as in

  <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, grows in width up to maxWidth as you type, and grows in height when you press Enter to start a new line.

The widthInChars and heightInChars properties provide a convenient way to specify the width and height in a way that scales with the font size. Of course, 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 it 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".

Also 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, and editing.

Default MXML Propertycontent

View the examples

See also

spark.components.Label
spark.components.RichText


Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
 InheritedclassName : 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
 Inheritedconstructor : 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
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : 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
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : 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
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddropTarget : 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
 Inheritedenabled : 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
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus This is similar to the tabChildren property used by Flash Player. This is usually false because most components either receive focus themselves or delegate focus to a single internal sub-component and appear as if the component has received focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] True if the element has 3D Matrix.
UIComponent
 Inheritedheight : 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
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
  horizontalScrollPosition : Number
The number of pixels by which the text is scrolled horizontally.
RichEditableText
 Inheritedid : String
ID of the component.
UIComponent
  imeMode : String
Specifies the IME (input method editor) mode.
RichEditableText
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] True, when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
UIComponent
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component will keep its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : 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
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
  multiline : Boolean
Determines whether the user can enter multiline text.
RichEditableText
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only]
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : 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
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 Inheritedroot : 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
 Inheritedrotation : Number
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollRect : 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
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
[read-only] A component's parent is used to evalate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : 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
 InheritedtabIndex : 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
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
UIComponent
  verticalScrollPosition : Number
The number of pixels by which the text is scrolled vertically.
RichEditableText
 Inheritedvisible : Boolean
[override]
UIComponent
 Inheritedwidth : 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
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIComponent
Protected Properties
 PropertyDefined By
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties
UIComponent
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : 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
 MethodDefined By
  
Constructor.
RichEditableText
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
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
  
Appends the specified text to the end of the RichEditableText, as if you had clicked at the end and typed.
RichEditableText
 Inherited
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
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation ID that identify the child within this container.
UIComponent
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
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
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
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 formats for the specified range of characters.
RichEditableText
  
Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.
RichEditableText
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
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
 Inherited
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
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
  
Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.
RichEditableText
 Inherited
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
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
 Inherited
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
 Inherited
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
  
Inserts the specified text into the RichEditableText as if you had typed it.
RichEditableText
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
 Inherited
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Determins whether the current state of this component matches a CSS pseudo-selector.
UIComponent
 Inherited
Determines whether this component is assignable to the given CSS type.
UIComponent
 Inherited
Measures the specified HTML text, which may 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
 Inherited
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
Moves the component to a specified position within its parent.
UIComponent
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
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
 Inherited
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIComponent
 Inherited
Resolves a child by using the id provided.
UIComponent
 Inherited
[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
  
Selects all of the text.
RichEditableText
  
selectRange(anchorPosition:int, activePosition:int):void
Selects a specified range of characters.
RichEditableText
 Inherited
Sizes the object.
UIComponent
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
Sets the focus to this component.
UIComponent
  
setFormatOfRange(format:flashx.textLayout.formats:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void
Applies the specified format to the specified range.
RichEditableText
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size to the specified dimensions.
UIComponent
 Inherited
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
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but doesn't trigger a layout pass.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
  
[override] Detects changes to style properties.
RichEditableText
  
[override] Flex calls the stylesInitialized() method when the styles for a component are first initialized.
RichEditableText
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
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
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null):void
UIComponent
 Inherited
transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
FIXME (chaase) : FLEXDOCS-1031
UIComponent
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
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
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Adjust the focus rectangle.
UIComponent
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
 Inherited
Create child objects of the component.
UIComponent
 Inherited
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
The event handler called for a keyUp event.
UIComponent
 Inherited
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
UIComponent
 Inherited
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
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
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
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Draws the object and/or sizes and positions its children.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched 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
  Dispatched after a user editing operation is complete.RichEditableText
  Dispatched before a user editing operation occurs.RichEditableText
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched 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
 InheritedDispatched 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
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
  Dispatched when the user presses the Enter key, if the multiline property is false.RichEditableText
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched just before the component exits a view state.UIComponent
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched 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
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched 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
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched 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
  Dispached after the selectionAnchorPosition and/or selectionActivePosition properties have changed for any reason.RichEditableText
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
  
alignmentBaseline
Type: String CSS Inheritance: yes
Specifies the baseline to which the dominant baseline aligns. For example, if you set dominantBaseline to ASCENT, setting alignmentBaseline to DESCENT aligns the top of the text with the DESCENT baseline, or below the line. The largest element in the line generally determines the baselines.

baselines

Legal values are flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flash.text.engine.TextBaseline.USE_DOMINANT_BASELINE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of USE_DOMINANT_BASELINE.

RichEditableText
  
backgroundAlpha
Type: Number CSS Inheritance: no
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
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
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
UIComponent
 InheritedType: String CSS Inheritance: no
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
Amount to shift the baseline from the dominantBaseline value. Units are in pixels, or a percentage of fontSize (in which case, enter a string value, like 140%). Positive values shift the line up for horizontal text (right for vertical) and negative values shift it down for horizontal (left for vertical).

Legal values are flashx.textLayout.formats.BaselineShift.SUPERSCRIPT, flashx.textLayout.formats.BaselineShift.SUBSCRIPT, flashx.textLayout.formats.FormatValue.INHERIT.

Legal values as a number are from -1000 to 1000.

Legal values as a percent are numbers from -1000 to 1000.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.0.

RichEditableText
  
blockProgression
Type: String CSS Inheritance: yes
Specifies a vertical or horizontal progression of line placement. Lines are either placed top-to-bottom (BlockProgression.TB, used for horizontal text) or right-to-left (BlockProgression.RL, used for vertical text).

Legal values are flashx.textLayout.formats.BlockProgression.RL, flashx.textLayout.formats.BlockProgression.TB, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of TB.

RichEditableText
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
  
breakOpportunity
Type: String CSS Inheritance: yes
Controls where lines are allowed to break when breaking wrapping text into multiple lines. Set to BreakOpportunity.AUTO to break text normally. Set to BreakOpportunity.NONE to not break the text unless the text would overrun the measure and there are no other places to break the line. Set to BreakOpportunity.ANY to allow the line to break anywhere, rather than just between words. Set to BreakOpportunity.ALL to have each typographic cluster put on a separate line (useful for text on a path).

Legal values are flash.text.engine.BreakOpportunity.ALL, flash.text.engine.BreakOpportunity.ANY, flash.text.engine.BreakOpportunity.AUTO, flash.text.engine.BreakOpportunity.NONE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

RichEditableText
  
cffHinting
Type: String CSS Inheritance: yes
The type of CFF hinting used for this text. CFF hinting determines whether the Flash runtime forces strong horizontal stems to fit to a sub pixel grid or not. This property applies only if the renderingMode property is set to RenderingMode.CFF, and the font is embedded (fontLookup property is set to FontLookup.EMBEDDED_CFF). At small screen sizes, hinting produces a clear, legible text for human readers.

Legal values are flash.text.engine.CFFHinting.NONE, flash.text.engine.CFFHinting.HORIZONTAL_STEM, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of HORIZONTAL_STEM.

RichEditableText
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text. A hexadecimal number that specifies three 8-bit RGB (red, green, blue) values; for example, 0xFF0000 is red and 0x00FF00 is green.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
columnCount
Type: Object CSS Inheritance: no
Number of text columns (adopts default value if undefined during cascade). The column number overrides the other column settings. Value is an integer, or FormatValue.AUTO if unspecified. If columnCount is not specified,columnWidth is used to create as many columns as can fit in the container.

Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT and from ints from 1 to 50.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of AUTO.

RichEditableText
  
columnGap
Type: Number Format: Length CSS Inheritance: no
Specifies the amount of gutter space, in pixels, to leave between the columns (adopts default value if undefined during cascade). Value is a Number

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 20.

RichEditableText
  
columnWidth
Type: Object CSS Inheritance: no
Column width in pixels (adopts default value if undefined during cascade). If you specify the width of the columns, but not the count, TextLayout will create as many columns of that width as possible, given the container width and columnGap settings. Any remainder space is left after the last column. Value is a Number.

Legal values as a string are flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT and numbers from 0 to 8000.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of AUTO.

RichEditableText
  
digitCase
Type: String CSS Inheritance: yes
The type of digit case used for this text. Setting the value to DigitCase.OLD_STYLE approximates lowercase letterforms with varying ascenders and descenders. The figures are proportionally spaced. This style is only available in selected typefaces, most commonly in a supplemental or expert font. The DigitCase.LINING setting has all-cap height and is typically monospaced to line up in charts.

digitCase

Legal values are flash.text.engine.DigitCase.DEFAULT, flash.text.engine.DigitCase.LINING, flash.text.engine.DigitCase.OLD_STYLE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

RichEditableText
  
digitWidth
Type: String CSS Inheritance: yes
Type of digit width used for this text. This can be DigitWidth.PROPORTIONAL, which looks best for individual numbers, or DigitWidth.TABULAR, which works best for numbers in tables, charts, and vertical rows.

digitWidth

Legal values are flash.text.engine.DigitWidth.DEFAULT, flash.text.engine.DigitWidth.PROPORTIONAL, flash.text.engine.DigitWidth.TABULAR, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

RichEditableText
  
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text in the text block. Left-to-right reading order, as in Latin-style scripts, or right-to-left reading order, as in Arabic or Hebrew. This property also affects column direction when it is applied at the container level. Columns can be either left-to-right or right-to-left, just like text. Below are some examples:

direction

Legal values are flashx.textLayout.formats.Direction.LTR, flashx.textLayout.formats.Direction.RTL, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of LTR.

RichEditableText
  
dominantBaseline
Type: String CSS Inheritance: yes
Specifies which element baseline snaps to the alignmentBaseline to determine the vertical position of the element on the line. A value of TextBaseline.AUTO selects the dominant baseline based on the locale property of the parent paragraph. For Japanese and Chinese, the selected baseline value is TextBaseline.IDEOGRAPHIC_CENTER; for all others it is TextBaseline.ROMAN. These baseline choices are determined by the choice of font and the font size.

baselines

Legal values are flashx.textLayout.formats.FormatValue.AUTO, flash.text.engine.TextBaseline.ROMAN, flash.text.engine.TextBaseline.ASCENT, flash.text.engine.TextBaseline.DESCENT, flash.text.engine.TextBaseline.IDEOGRAPHIC_TOP, flash.text.engine.TextBaseline.IDEOGRAPHIC_CENTER, flash.text.engine.TextBaseline.IDEOGRAPHIC_BOTTOM, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

RichEditableText
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
  
firstBaselineOffset
Type: Object CSS Inheritance: yes
Specifies the baseline position of the first line in the container. Which baseline this property refers to depends on the container-level locale. For Japanese and Chinese, it is TextBaseline.IDEOGRAPHIC_BOTTOM; for all others it is TextBaseline.ROMAN. The offset from the top inset (or right inset if blockProgression is RL) of the container to the baseline of the first line can be either BaselineOffset.ASCENT, meaning equal to the ascent of the line, BaselineOffset.LINE_HEIGHT, meaning equal to the height of that first line, or any fixed-value number to specify an absolute distance. BaselineOffset.AUTO aligns the ascent of the line with the container top inset.

firstBaselineOffset1firstBaselineOffset2firstBaselineOffset3firstBaselineOffset4

Legal values as a string are flashx.textLayout.formats.BaselineOffset.AUTO, flashx.textLayout.formats.BaselineOffset.ASCENT, flashx.textLayout.formats.BaselineOffset.LINE_HEIGHT, flashx.textLayout.formats.FormatValue.INHERIT and numbers from 0 to 1000.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

RichEditableText
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
  
focusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled and has focus.
RichEditableText
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
fontFamily
Type: String CSS Inheritance: yes
The name of the font to use, or a comma-separated list of font names. The Flash runtime renders the element with the first available font in the list. For example Arial, Helvetica, _sans causes the player to search for Arial, then Helvetica if Arial is not found, then _sans if neither is found.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of Times New Roman.

RichEditableText
  
fontLookup
Type: String CSS Inheritance: yes
Font lookup to use. Specifying FontLookup.DEVICE uses the fonts installed on the system that is running the SWF file. Device fonts result in a smaller movie size, but text is not always rendered the same across different systems and platforms. Specifying FontLookup.EMBEDDED_CFF uses font outlines embedded in the published SWF file. Embedded fonts increase the size of the SWF file (sometimes dramatically), but text is consistently displayed in the chosen font.

Legal values are flash.text.engine.FontLookup.DEVICE, flash.text.engine.FontLookup.EMBEDDED_CFF, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEVICE.

RichEditableText
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
The size of the text in pixels.

Legal values are numbers from 1 to 720 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 12.

RichEditableText
  
fontStyle
Type: String CSS Inheritance: yes
Style of text. May be FontPosture.NORMAL, for use in plain text, or FontPosture.ITALIC for italic. This property applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontPosture.NORMAL, flash.text.engine.FontPosture.ITALIC, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL.

RichEditableText
  
fontWeight
Type: String CSS Inheritance: yes
Weight of text. May be FontWeight.NORMAL for use in plain text, or FontWeight.BOLD. Applies only to device fonts (fontLookup property is set to flash.text.engine.FontLookup.DEVICE).

Legal values are flash.text.engine.FontWeight.NORMAL, flash.text.engine.FontWeight.BOLD, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NORMAL.

RichEditableText
 InheritedType: String CSS Inheritance: no
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
The color of text when the component is disabled.
RichEditableText
  
justificationRule
Type: String CSS Inheritance: yes
Rule used to justify text in a paragraph. Default value is FormatValue.AUTO, which justifies text based on the paragraph's locale property. For all languages except Japanese and Chinese, FormatValue.AUTO becomes JustificationRule.SPACE, which adds extra space to the space characters. For Japanese and Chinese, FormatValue.AUTO becomes JustficationRule.EAST_ASIAN. In part, justification changes the spacing of punctuation. In Roman text the comma and Japanese periods take a full character's width but in East Asian text only half of a character's width. Also, in the East Asian text the spacing between sequential punctuation marks becomes tighter, obeying traditional East Asian typographic conventions. Note, too, in the example below the leading that is applied to the second line of the paragraphs. In the East Asian version, the last two lines push left. In the Roman version, the second and following lines push left.

justificationRule

Legal values are flashx.textLayout.formats.JustificationRule.EAST_ASIAN, flashx.textLayout.formats.JustificationRule.SPACE, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

RichEditableText
  
justificationStyle
Type: String CSS Inheritance: yes
The style used for justification of the paragraph. Used only in conjunction with a justificationRule setting of JustificationRule.EAST_ASIAN. Default value of FormatValue.AUTO is resolved to JustificationStyle.PUSH_IN_KINSOKU for all locales. The constants defined by the JustificationStyle class specify options for handling kinsoku characters, which are Japanese characters that cannot appear at either the beginning or end of a line. If you want looser text, specify JustificationStyle.PUSH-OUT-ONLY. If you want behavior that is like what you get with the justificationRule of JustificationRule.SPACE, use JustificationStyle.PRIORITIZE-LEAST-ADJUSTMENT.

Legal values are flash.text.engine.JustificationStyle.PRIORITIZE_LEAST_ADJUSTMENT, flash.text.engine.JustificationStyle.PUSH_IN_KINSOKU, flash.text.engine.JustificationStyle.PUSH_OUT_ONLY, flashx.textLayout.formats.FormatValue.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of flashx.textLayout.formats.FormatValue.AUTO.

RichEditableText
  
kerning
Type: String CSS Inheritance: yes
Kerning adjusts the pixels between certain character pairs to improve readability. Kerning is supported for all fonts with kerning tables.

Legal values are flash.text.engine.Kerning.ON, flash.text.engine.Kerning.OFF, flash.text.engine.Kerning.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

RichEditableText
  
leadingModel
Type: String CSS Inheritance: yes
Specifies the leading model, which is a combination of leading basis and leading direction. Leading basis is the baseline to which the lineHeight property refers. Leading direction determines whether the lineHeight property refers to the distance of a line's baseline from that of the line before it or the line after it. The default value of FormatValue.AUTO is resolved based on the paragraph's locale property. For Japanese and Chinese, it is LeadingModel.IDEOGRAPHIC_TOP_DOWN and for all others it is LeadingModel.ROMAN_UP.

leadingBasis1leadingBasis2leadingBasis3leadingDirection1leadingDirection2leadingDirection3

Legal values are flashx.textLayout.formats.LeadingModel.ROMAN_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_TOP_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_CENTER_UP, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_TOP_DOWN, flashx.textLayout.formats.LeadingModel.IDEOGRAPHIC_CENTER_DOWN, flashx.textLayout.formats.LeadingModel.ASCENT_DESCENT_UP, flashx.textLayout.formats.LeadingModel.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

RichEditableText
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
  
ligatureLevel
Type: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text. The ligatures that appear for each of these settings is dependent on the font. A ligature occurs where two or more letter-forms are joined as a single glyph. Ligatures usually replace consecutive characters sharing common components, such as the letter pairs 'fi', 'fl', or 'ae'. They are used with both Latin and Non-Latin character sets. The ligatures enabled by the values of the LigatureLevel class - MINIMUM, COMMON, UNCOMMON, and EXOTIC - are additive. Each value enables a new set of ligatures, but also includes those of the previous types.

Note: When working with Arabic or Syriac fonts, ligatureLevel must be set to MINIMUM or above.

ligatureLevel

Legal values are flash.text.engine.LigatureLevel.MINIMUM, flash.text.engine.LigatureLevel.COMMON, flash.text.engine.LigatureLevel.UNCOMMON, flash.text.engine.LigatureLevel.EXOTIC, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of COMMON.

RichEditableText
  
lineBreak
Type: String CSS Inheritance: yes
Controls word wrapping within the container (adopts default value if undefined during cascade). Text in the container may be set to fit the width of the container (LineBreak.TO_FIT), or can be set to break only at explicit return or line feed characters (LineBreak.EXPLICIT).

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

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of TO_FIT.

RichEditableText
  
lineHeight
Type: Object CSS Inheritance: yes
Leading controls for the text. The distance from the baseline of the previous or the next line (based on LeadingModel) to the baseline of the current line is equal to the maximum amount of the leading applied to any character in the line. This is either a number or a percent. If specifying a percent, enter a string value, like 140%.

lineHeight1lineHeight2

Legal values as a number are from -720 to 720.

Legal values as a percent are numbers from -1000% to 1000%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 120%.

RichEditableText
  
lineThrough
Type: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.

Legal values are true, false and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of false.

RichEditableText
  
locale
Type: String CSS Inheritance: yes
The locale of the text. Controls case transformations and shaping. Standard locale identifiers as described in Unicode Technical Standard #35 are used. For example en, en_US and en-US are all English, ja is Japanese.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of en.

RichEditableText
  
paddingBottom
Type: Number Format: Length CSS Inheritance: no
Botttom inset in pixels (adopts default value if undefined during cascade). Space between the bottom edge of the container and the text. Value is a Number.

With horizontal text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the bottom of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

RichEditableText
  
paddingLeft
Type: Number Format: Length CSS Inheritance: no
Left inset in pixels (adopts default value if undefined during cascade). Space between the left edge of the container and the text. Value is a Number.

With vertical text, in scrollable containers with multiple columns, the first and following columns will show the padding as blank space at the end of the container, but for the last column, if the text doesn't all fit, you may have to scroll in order to see the padding.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

RichEditableText
  
paddingRight
Type: Number Format: Length CSS Inheritance: no
Right inset in pixels (adopts default value if undefined during cascade). Space between the right edge of the container and the text. Value is a Number.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

RichEditableText
  
paddingTop
Type: Number Format: Length CSS Inheritance: no
Top inset in pixels (adopts default value if undefined during cascade). Space between the top edge of the container and the text. Value is a Number.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of 0.

RichEditableText
  
paragraphEndIndent
Type: Number Format: length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the paragraph's end edge. Refers to the right edge in left-to-right text and the left edge in right-to-left text.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
paragraphSpaceAfter
Type: Number Format: length CSS Inheritance: yes
A Number that specifies the amount of space, in pixels, to leave after the paragraph. Collapses in tandem with paragraphSpaceBefore.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
paragraphSpaceBefore
Type: Number Format: length CSS Inheritance: yes
A Number that specifies the amount of space, in pixels, to leave before the paragraph. Collapses in tandem with paragraphSpaceAfter.

Legal values are numbers from 0 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
paragraphStartIndent
Type: Number Format: length CSS Inheritance: yes
RichEditableText
  
renderingMode
Type: String CSS Inheritance: yes
The rendering mode used for this text. Applies only to embedded fonts (fontLookup property is set to FontLookup.EMBEDDED_CFF).

Legal values are flash.text.engine.RenderingMode.NORMAL, flash.text.engine.RenderingMode.CFF, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of CFF.

RichEditableText
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
  
tabStops
Type: String CSS Inheritance: yes
Specifies the tab stops associated with the paragraph. Setters can take an array of flashx.textLayout.formats.TabStopFormat, a condensed string representation, undefined, or FormatValue.INHERIT. The condensed string representation is always converted into an array of flashx.textLayout.formats.TabStopFormat.

The string-based format is a list of tab stops, where each tab stop is delimited by one or more spaces.

A tab stop takes the following form: <alignment type><alignment position>|<alignment token>.

The alignment type is a single character, and can be S, E, C, or D (or lower-case equivalents). S or s for start, E or e for end, C or c for center, D or d for decimal. The alignment type is optional, and if its not specified will default to S.

The alignment position is a Number, and is specified according to FXG spec for Numbers (decimal or scientific notation). The alignment position is required.

The vertical bar is used to separate the alignment position from the alignment token, and should only be present if the alignment token is present.

The alignment token is optional if the alignment type is D, and should not be present if the alignment type is anything other than D. The alignment token may be any sequence of characters terminated by the space that ends the tab stop (for the last tab stop, the terminating space is optional; end of alignment token is implied). A space may be part of the alignment token if it is escaped with a backslash (\ ). A backslash may be part of the alignment token if it is escaped with another backslash (\\). If the alignment type is D, and the alignment token is not specified, it will take on the default value of null.

If no tab stops are specified, a tab action defaults to the end of the line.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of null.

RichEditableText
  
textAlign
Type: String CSS Inheritance: yes
Alignment of lines in the paragraph relative to the container. TextAlign.LEFT aligns lines along the left edge of the container. TextAlign.RIGHT aligns on the right edge. TextAlign.CENTER positions the line equidistant from the left and right edges. TextAlign.JUSTIFY spreads the lines out so they fill the space. TextAlign.START is equivalent to setting left in left-to-right text, or right in right-to-left text. TextAlign.END is equivalent to setting right in left-to-right text, or left in right-to-left text.

Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START.

RichEditableText
  
textAlignLast
Type: String CSS Inheritance: yes
Alignment of the last (or only) line in the paragraph relative to the container in justified text. If textAlign is set to TextAlign.JUSTIFY, textAlignLast specifies how the last line (or only line, if this is a one line block) is aligned. Values are similar to textAlign.

Legal values are flashx.textLayout.formats.TextAlign.LEFT, flashx.textLayout.formats.TextAlign.RIGHT, flashx.textLayout.formats.TextAlign.CENTER, flashx.textLayout.formats.TextAlign.JUSTIFY, flashx.textLayout.formats.TextAlign.START, flashx.textLayout.formats.TextAlign.END, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of START.

RichEditableText
  
textAlpha
Type: Number CSS Inheritance: yes
Alpha (transparency) value for the text. A value of 0 is fully transparent, and a value of 1 is fully opaque. Display objects with textAlpha set to 0 are active, even though they are invisible.

Legal values are numbers from 0 to 1 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 1.

RichEditableText
  
textDecoration
Type: String CSS Inheritance: yes
Decoration on text. Use to apply underlining; default is none.

Legal values are flashx.textLayout.formats.TextDecoration.NONE, flashx.textLayout.formats.TextDecoration.UNDERLINE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of NONE.

RichEditableText
  
textIndent
Type: Number Format: Length CSS Inheritance: yes
A Number that specifies, in pixels, the amount to indent the first line of the paragraph. A negative indent will push the line into the margin, and possibly out of the container.

Legal values are numbers from -1000 to 1000 and flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
textJustify
Type: String CSS Inheritance: yes
Specifies options for justifying text. Default value is TextJustify.INTER_WORD, meaning that extra space is added to the space characters. TextJustify.DISTRIBUTE adds extra space to space characters and between individual letters. Used only in conjunction with a justificationRule value of JustificationRule.SPACE.

Legal values are flashx.textLayout.formats.TextJustify.INTER_WORD, flashx.textLayout.formats.TextJustify.DISTRIBUTE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of INTER_WORD.

RichEditableText
  
textRotation
Type: String CSS Inheritance: yes
Determines the number of degrees to rotate this text.

Legal values are flash.text.engine.TextRotation.ROTATE_0, flash.text.engine.TextRotation.ROTATE_180, flash.text.engine.TextRotation.ROTATE_270, flash.text.engine.TextRotation.ROTATE_90, flash.text.engine.TextRotation.AUTO, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of AUTO.

RichEditableText
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
  
trackingLeft
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the left of each character. If kerning is enabled, the trackingLeft value is added to the values in the kerning table for the font. If kerning is disabled, the trackingLeft value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are numbers from -100% to 100%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
trackingRight
Type: Object CSS Inheritance: yes
Number in pixels (or percent of fontSize, like 120%) indicating the amount of tracking (manual kerning) to be applied to the right of each character. If kerning is enabled, the trackingRight value is added to the values in the kerning table for the font. If kerning is disabled, the trackingRight value is used as a manual kerning value. Supports both positive and negative values.

Legal values as a number are from -100 to 100.

Legal values as a percent are numbers from -100% to 100%.

Legal values include flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of 0.

RichEditableText
  
typographicCase
Type: String CSS Inheritance: yes
The type of typographic case used for this text. Here are some examples:

typographicCase

Legal values are flashx.textLayout.formats.TLFTypographicCase.DEFAULT, flashx.textLayout.formats.TLFTypographicCase.CAPS_TO_SMALL_CAPS, flashx.textLayout.formats.TLFTypographicCase.UPPERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE, flashx.textLayout.formats.TLFTypographicCase.LOWERCASE_TO_SMALL_CAPS, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of DEFAULT.

RichEditableText
  
unfocusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled but does not have focus.
RichEditableText
  
verticalAlign
Type: String CSS Inheritance: no
Vertical alignment or justification (adopts default value if undefined during cascade). Determines how TextFlow elements align within the container.

Legal values are flashx.textLayout.formats.VerticalAlign.TOP, flashx.textLayout.formats.VerticalAlign.MIDDLE, flashx.textLayout.formats.VerticalAlign.BOTTOM, flashx.textLayout.formats.VerticalAlign.JUSTIFY, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will have a value of TOP.

RichEditableText
 InheritedType: String CSS Inheritance: no
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
Collapses or preserves whitespace when importing text into a TextFlow. WhiteSpaceCollapse.PRESERVE retains all whitespace characters. WhiteSpaceCollapse.COLLAPSE removes newlines, tabs, and leading or trailing spaces within a block of imported text. Line break tags () and Unicode line separator characters are retained.

Legal values are flashx.textLayout.formats.WhiteSpaceCollapse.PRESERVE, flashx.textLayout.formats.WhiteSpaceCollapse.COLLAPSE, flashx.textLayout.formats.FormatValue.INHERIT.

Default value is undefined indicating not set.

If undefined during the cascade this property will inherit its value from an ancestor. If no ancestor has set this property, it will have a value of COLLAPSE.

RichEditableText
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
clipAndEnableScrollingproperty
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
contentproperty 
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
contentHeightproperty 
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
contentWidthproperty 
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
displayAsPasswordproperty 
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
editableproperty 
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

See also

enableIMEproperty 
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
heightInLinesproperty 
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.

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

See also

horizontalScrollPositionproperty 
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
imeModeproperty 
imeMode:String

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

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

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

The default value is null.



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

See also

maxCharsproperty 
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
multilineproperty 
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.

The default value is true.



Implementation
    public function get multiline():Boolean
    public function set multiline(value:Boolean):void
restrictproperty 
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.

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
selectableproperty 
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
selectionActivePositionproperty 
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 propertyChange event.



Implementation
    public function get selectionActivePosition():int

See also

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

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 propertyChange event.



Implementation
    public function get selectionAnchorPosition():int

See also

selectionHighlightingproperty 
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 means show the text selection only when the component has keyboard focus.

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

ALWAYS means show 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

See also

mx.components.TextSelectionHighlighting
textproperty 
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 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, and it sets the selectionAnchorPosition and selectionActivePosition 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 propertyChange event.



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

See also

textFlowproperty 
textFlow:flashx.textLayout.elements:TextFlow

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

See also

verticalScrollPositionproperty 
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
widthInCharsproperty 
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.

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 samll 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 widthInChars():Number
    public function set widthInChars(value:Number):void

See also

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 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 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
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 of unit must be one of the following spark.core.NavigationUnit constants: LEFT, RIGHT, PAGE_LEFT, PAGE_RIGHT, HOME, or 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, or 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.

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 format to the specified range.

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

For example, calling

      var textLayoutFormat:TextLayoutFormat = new TextLayoutFormat();
      textLayoutFormat.fontSize = 12;
      textLayoutFormat.color = 0xFF0000;
      setFormatOfRange(textLayoutFormat);
      
will set the fontSize and color of the selection.

Parameters

format:flashx.textLayout.formats:TextLayoutFormat
 
anchorPosition:int (default = -1)
 
activePosition:int (default = -1)

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 will be 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe 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:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe 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.
operationThe FlowOperation object describing the editing operation being performed on the text by the user.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
targetThe 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/halo">

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