Packagespark.components
Classpublic class RichEditableText
InheritanceRichEditableText Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
Implements IFocusManagerComponent, IIMESupport, mx.core.ISystemCursorClient, IViewport, IEditableText

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

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

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

The most important differences between UITextField and RichEditableText are:

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

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

      <s:RichEditableText>Hello <s:span fontWeight="bold">World!</s:span></s:RichEditableText>
      
In this case, the MXML compiler sets the content property, causing a TextFlow to be automatically created from the FlowElements that you specify.

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

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

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

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

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

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

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

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

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

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

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

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

MXML SyntaxexpandedHide MXML Syntax

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

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

Default MXML Propertycontent

See also

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


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 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
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 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
  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
 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
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
  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 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
 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
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains 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
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  horizontalScrollPosition : Number
The number of pixels by which the text is scrolled horizontally.
RichEditableText
 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] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
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
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
  maxChars : int
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 embedded fonts and for finding the style manager that controls the styles for this component.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
  multiline : Boolean
Determines whether the user can enter multiline text.
RichEditableText
 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
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
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
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 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
RichEditableText
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 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]
UIComponent
 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
  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
  showSystemCursor : Boolean
[read-only] True if the system cursor should always be shown when the mouse moves over the component.
RichEditableText
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 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
  text : String
The text String displayed by this component.
RichEditableText
  textFlow : TextFlow
The TextFlow representing the rich text displayed by this component.
RichEditableText
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 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
  typicalText : String
Text that is used to determine the default width and height of the control, without actually being displayed.
RichEditableText
 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
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
  verticalScrollPosition : Number
The number of pixels by which the text is scrolled vertically.
RichEditableText
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
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]
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 non-visual style client to this component instance.
UIComponent
  
appendText(text:String):void
Appends the specified text to the end of the RichEditableText, as if you had clicked at the end and typed.
RichEditableText
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
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 IDs 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
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
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
Programmatically 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
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 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
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
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
  
getFormatOfRange(requestedFormats:Vector.<String> = null, anchorPosition:int = -1, activePosition:int = -1):TextLayoutFormat
Returns a TextLayoutFormat object specifying the computed formats for the specified range of characters.
RichEditableText
  
getHorizontalScrollPositionDelta(navigationUnit:uint):Number
Returns the amount to add to the viewport's current horizontalScrollPosition to scroll by the requested scrolling unit.
RichEditableText
 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
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
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
  
getVerticalScrollPositionDelta(navigationUnit:uint):Number
Returns the amount to add to the viewport's current verticalScrollPosition to scroll by the requested scrolling unit.
RichEditableText
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
  
insertText(text:String):void
Inserts the specified text into the RichEditableText as if you had typed it.
RichEditableText
 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
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
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
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
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
RichEditableText
  
selectAll():void
Selects all of the text.
RichEditableText
  
selectRange(anchorPosition:int, activePosition:int):void
Selects a specified range of characters.
RichEditableText
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 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
setFocus():void
Sets the focus to this component.
UIComponent
  
setFormatOfRange(format:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void
Applies the specified formats to each element in the specified range that correspond to the given format.
RichEditableText
 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 of the element.
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
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 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
  
styleChanged(styleProp:String):void
[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
toString():String
[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, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 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
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined By
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
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
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
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
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
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
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
measure():void
Calculates the default size, and optionally the default minimum size, of the component.
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
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
  Dispatched after a user editing operation is complete.RichEditableText
  Dispatched before a user editing operation occurs.RichEditableText
 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 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
 InheritedDispatched after the component has entered a view state.UIComponent
 InheritedDispatched just before the component exits a view state.UIComponent
 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 from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 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 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 the component is resized.UIComponent
  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 after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to 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
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.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 the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.alignmentBaseline
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: 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.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.baselineShift.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.baselineShift
RichEditableText
  
blockProgression
Type: String CSS Inheritance: yes
Specifies a vertical or horizontal progression of line placement.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.blockProgression
RichEditableText
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
  
breakOpportunity
Type: String CSS Inheritance: yes
Controls where lines are allowed to break when breaking wrapping text into multiple lines.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.breakOpportunity
RichEditableText
  
cffHinting
Type: String CSS Inheritance: yes
The type of CFF hinting used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.cffHinting.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.cffHinting
RichEditableText
  
clearFloats
Type: String CSS Inheritance: yes
Controls how text wraps around a float.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.clearFloats.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.clearFloats
RichEditableText
  
color
Type: uint Format: Color CSS Inheritance: yes
Color of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.color.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style color.

The default value is 0x000000.

See also

flashx.textLayout.formats.ITextLayoutFormat.color
spark.components.supportClasses.StyleableTextField.color
RichEditableText
  
columnCount
Type: Object CSS Inheritance: no
Number of text columns.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnCount.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.columnCount
RichEditableText
  
columnGap
Type: Number Format: Length CSS Inheritance: no
Amount of gutter space, in pixels, to leave between the columns.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnGap.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.columnGap
RichEditableText
  
columnWidth
Type: Object CSS Inheritance: no
Column width in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.columnWidth.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.columnWidth
RichEditableText
  
digitCase
Type: String CSS Inheritance: yes
The type of digit case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitCase.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.digitCase
RichEditableText
  
digitWidth
Type: String CSS Inheritance: yes
Type of digit width used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.digitWidth.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.digitWidth
RichEditableText
  
direction
Type: String CSS Inheritance: yes
Specifies the default bidirectional embedding level of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.direction.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.direction
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.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.dominantBaseline
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.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.firstBaselineOffset
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.

For the Mobile theme, this is not supported.

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.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontFamily.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontFamily.

The default value for the Spark theme is Arial. The default value for the Mobile theme is _sans.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontFamily
spark.components.supportClasses.StyleableTextField.fontFamily
RichEditableText
  
fontLookup
Type: String CSS Inheritance: yes
Font lookup to use.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontLookup

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontLookup
RichEditableText
  
fontSize
Type: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontSize

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontSize

The default value for the Spark theme is 12. The default value for the Mobile theme is 24.

See also

flashx.textLayout.formats.ITextLayoutFormat.fontSize
spark.components.supportClasses.StyleableTextField.fontSize
RichEditableText
  
fontStyle
Type: String CSS Inheritance: yes
Determines whether the text is italic font.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontStyle

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontStyle

See also

flashx.textLayout.formats.ITextLayoutFormat.fontStyle
spark.components.supportClasses.StyleableTextField.fontStyle
RichEditableText
  
fontWeight
Type: String CSS Inheritance: yes
Determines whether the text is boldface.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.fontWeight

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style fontWeight

See also

flashx.textLayout.formats.ITextLayoutFormat.fontWeight
spark.components.supportClasses.StyleableTextField.fontWeight
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.

For the Mobile theme, this is not supported.

RichEditableText
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
  
justificationRule
Type: String CSS Inheritance: yes
Rule used to justify text in a paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationRule

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.justificationRule
RichEditableText
  
justificationStyle
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.justificationStyle

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.justificationStyle
RichEditableText
  
kerning
Type: String CSS Inheritance: yes
The style used for justification of the paragraph.

Kerning is enabled by default for Spark components, but is disabled by default for MX components. Spark components interpret default as auto, while MX components interpret default as false.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.kerning

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.kerning
RichEditableText
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
  
leading
Type: Number Format: Length CSS Inheritance: yes Theme: mobile
Additional vertical space between lines of text.

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

For the Mobile theme, see spark.components.supportClasses.StyleableTextField.leading.

See also

RichEditableText
  
leadingModel
Type: String CSS Inheritance: yes
Specifies the leading model, which is a combination of leading basis and leading direction.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.leadingModel.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.leadingModel
RichEditableText
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
  
letterSpacing
Type: Number CSS Inheritance: yes Theme: mobile
The number of additional pixels to appear between each character.

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

For the Mobile theme, see spark.components.supportClasses.StyleableTextField.letterSpacing.

See also

RichEditableText
  
ligatureLevel
Type: String CSS Inheritance: yes
Controls which of the ligatures that are defined in the font may be used in the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.ligatureLevel
RichEditableText
  
lineBreak
Type: String CSS Inheritance: no
Controls word wrapping within the container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.blockProgression.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.lineBreak
RichEditableText
  
lineHeight
Type: Object CSS Inheritance: yes
Leading controls for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineHeight.

For the Mobile theme, this is not supported. See leading.

See also

flashx.textLayout.formats.ITextLayoutFormat.lineHeight
leading
RichEditableText
  
lineThrough
Type: Boolean CSS Inheritance: yes
If true, applies strikethrough, a line drawn through the middle of the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.lineThrough

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.lineThrough
RichEditableText
  
listAutoPadding
Type: Number Format: length CSS Inheritance: yes
This specifies an auto indent for the start edge of lists when the padding value of the list on that side is auto.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.listAutoPadding
RichEditableText
  
listStylePosition
Type: String CSS Inheritance: yes
This controls the placement of a list item marker relative to the list item.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStylePosition.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.listStylePosition
RichEditableText
  
listStyleType
Type: String CSS Inheritance: yes
This controls the appearance of items in a list.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.listStyleType.

For the Mobile theme, this is not supported.

See also

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

The default value is undefined. This property inherits its value from an ancestor; if still undefined, it inherits from the global locale style. During the application initialization, if the global locale style is undefined, then the default value is set to "en".

When using the Spark formatters and globalization classes, you can set this style on the root application to the value of the LocaleID.DEFAULT constant. Those classes will then use the client operating system's international preferences.

RichEditableText
  
paddingBottom
Type: Number Format: Length CSS Inheritance: no
Bottom inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingBottom.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paddingBottom
RichEditableText
  
paddingLeft
Type: Number Format: Length CSS Inheritance: no
Left inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingLeft.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paddingLeft
RichEditableText
  
paddingRight
Type: Number Format: Length CSS Inheritance: no
Right inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paddingRight
RichEditableText
  
paddingTop
Type: Number Format: Length CSS Inheritance: no
Top inset, in pixels.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paddingRight.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paddingRight
RichEditableText
  
paragraphEndIndent
Type: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's end edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphEndIndent
RichEditableText
  
paragraphSpaceAfter
Type: Number Format: length CSS Inheritance: yes
The amount of space to leave after the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceAfter
RichEditableText
  
paragraphSpaceBefore
Type: Number Format: length CSS Inheritance: yes
The amount of space to leave before the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphSpaceBefore
RichEditableText
  
paragraphStartIndent
Type: Number Format: length CSS Inheritance: yes
The amount to indent the paragraph's start edge.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.paragraphStartIndent
RichEditableText
  
renderingMode
Type: String CSS Inheritance: yes
The rendering mode used for this text which applies only to embedded fonts.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.renderingMode

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.renderingMode
RichEditableText
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error border or skin when this component is invalid.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it.
UIComponent
  
tabStops
Type: String CSS Inheritance: yes
Specifies the tab stops associated with the paragraph.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.tabStops.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.tabStops
RichEditableText
  
textAlign
Type: String CSS Inheritance: yes
Alignment of text within a container.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlign

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textAlign

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlign
spark.components.supportClasses.StyleableTextField.textAlign
RichEditableText
  
textAlignLast
Type: String CSS Inheritance: yes
Alignment of the last line in the paragraph relative to the container in justified text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlignLast

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlignLast
RichEditableText
  
textAlpha
Type: Number CSS Inheritance: yes
Alpha (transparency) value for the text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textAlpha

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textAlpha
RichEditableText
  
textDecoration
Type: String CSS Inheritance: yes
Determines whether the text is underlined.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textDecoration

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textDecoration

See also

flashx.textLayout.formats.ITextLayoutFormat.textDecoration
spark.components.supportClasses.StyleableTextField.textDecoration
RichEditableText
  
textIndent
Type: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container. .

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textIndent.

For the Mobile theme, see spark.components.supportClasses.StyleableTextField Style textIndent.

See also

flashx.textLayout.formats.ITextLayoutFormat.textIndent
spark.components.supportClasses.StyleableTextField.textIndent
RichEditableText
  
textJustify
Type: String CSS Inheritance: yes
Specifies options for justifying text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textJustify

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textJustify
RichEditableText
  
textRotation
Type: String CSS Inheritance: yes
Determines the number of degrees to rotate this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.textRotation.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.textRotation
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 component to the top edge of its parent container's content area.
UIComponent
  
trackingLeft
Type: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the left of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingLeft

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.trackingLeft
RichEditableText
  
trackingRight
Type: Object CSS Inheritance: yes
The amount of tracking (manual kerning) to be applied to the right of each character.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.trackingRight

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.trackingRight
RichEditableText
  
typographicCase
Type: String CSS Inheritance: yes
The type of typographic case used for this text.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.typographicCase

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.typographicCase
RichEditableText
  
unfocusedTextSelectionColor
Type: uint Format: Color CSS Inheritance: yes
The color of text when the component is enabled but does not have focus.

For the Mobile theme, this is not supported.

RichEditableText
  
verticalAlign
Type: String CSS Inheritance: no
Vertical alignment or justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.verticalAlign.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.verticalAlign
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.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.whiteSpaceCollapse
RichEditableText
  
wordSpacing
Type: Object CSS Inheritance: yes
Specifies the spacing between words to use during justification.

For the Spark theme, see flashx.textLayout.formats.ITextLayoutFormat.wordSpacing.

For the Mobile theme, this is not supported.

See also

flashx.textLayout.formats.ITextLayoutFormat.wordSpacing
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.


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.


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


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.

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

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

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

The default value is NaN.


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

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.


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

flash.system.IMEConversionMode
maxCharsproperty 
maxChars:int

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

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. If you paste text into the RichEditableText with a multiline value of false, newlines are stripped out of the text.

The default value is true.


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

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

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.


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.


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

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

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

The default value is TextSelectionHighlighting.WHEN_FOCUSED.


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

See also

showSystemCursorproperty 
showSystemCursor:Boolean  [read-only]

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

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


Implementation
    public function get showSystemCursor():Boolean
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 you set the text to null, it will be set to the default value which is an empty string.

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

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

Setting this property also affects the properties specifying the control's scroll position and the text selection. It resets the horizontalScrollPosition and verticalScrollPosition to 0, 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.


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

See also

textFlowproperty 
textFlow:TextFlow

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10, AIR 2.5

The TextFlow representing the rich text displayed by this component.

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

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

Setting this property affects the text property and vice versa.

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

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

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

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

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

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


Implementation
    public function get textFlow():TextFlow
    public function set textFlow(value:TextFlow):void

See also

typicalTextproperty 
typicalText:String

Language Version : ActionScript 3.0
Product Version : Flex 4.5
Runtime Versions : Flash Player 10.2, AIR 2.0

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

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

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

The default value is null.


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

See also

spark.primitives.heightInLines
spark.primitives.widthInChars
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.


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.

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

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

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

The default value is NaN.


Implementation
    public function get 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):TextLayoutFormat

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

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

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

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

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

Parameters

requestedFormats:Vector.<String> (default = null) — A Vector of Strings specifying the names of the requested formats, or null to request all formats.
 
anchorPosition:int (default = -1) — A character position specifying the fixed end of the selection.
 
activePosition:int (default = -1) — A character position specifying the movable end of the selection.

Returns
TextLayoutFormat — A TextLayoutFormat object.
getHorizontalScrollPositionDelta()method 
public function getHorizontalScrollPositionDelta(navigationUnit:uint):Number

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

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

Parameters

navigationUnit:uint — The amount to scroll. The value must be one of the following spark.core.NavigationUnit constants:
  • LEFT
  • RIGHT
  • PAGE_LEFT
  • PAGE_RIGHT
  • HOME
  • END
To scroll by a single column, use LEFT or RIGHT. To scroll to the first or last column, use HOME or END.

Returns
Number — The number of pixels to add to horizontalScrollPosition.
getVerticalScrollPositionDelta()method 
public function getVerticalScrollPositionDelta(navigationUnit:uint):Number

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

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

Parameters

navigationUnit:uint — The amount to scroll. The value of unit must be one of the following spark.core.NavigationUnit constants:
  • UP
  • DOWN
  • PAGE_UP
  • PAGE_DOWN
  • HOME
  • END
To scroll by a single row use UP or DOWN. To scroll to the first or last row, use HOME or END.

Returns
Number — The number of pixels to add to verticalScrollPosition.
insertText()method 
public function insertText(text:String):void

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

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

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

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

Parameters

text:String — The text to be inserted.

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

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

Parameters

anchorPosition:int
 
activePosition:int

selectAll()method 
public function selectAll():void

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

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

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

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

Selects a specified range of characters.

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

Parameters

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

setFormatOfRange()method 
public function setFormatOfRange(format:TextLayoutFormat, anchorPosition:int = -1, activePosition:int = -1):void

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

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

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

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

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

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

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

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

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

Parameters

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

styleChanged()method 
override public function styleChanged(styleProp:String):void

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

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

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

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

Parameters

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

stylesInitialized()method 
override public function stylesInitialized():void

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

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

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

Event Detail
change Event
Event Object Type: spark.events.TextOperationEvent
TextOperationEvent.type property = 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
TextOperationEvent.type property = 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
FlexEvent.type property = 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
FlexEvent.type property = 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.