| Appendixes | Conventions | Frames
| Package | mx.controls |
| Class | public class RichTextEditor |
| Inheritance | RichTextEditor  Panel Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
The RichTextEditor has a default height and width of 300 by 325 pixels
and a default minimum height and width of 200 by 220 pixels.
If you put a RichTextEditor control in a DividedBox control, make sure that
the DividedBox control is large enough to contain the RichTextEditor control
at its minimum dimensions.
Also, you can explicitly set the RichTextEditor control's minHeight or
minWidth property to NaN to let the DividedBox container
reduce the control's dimensions to 0.
The following table describes the subcontrols that you can access and modify:
| Control Type | ID | Description |
|---|---|---|
| TextArea | textArea | Area where the user can enter text. |
| Container | toolbar | The container for the formatting controls; puts the controls in a single horizontal row, if they fit, or multiple rows, otherwise. |
| ComboBox | fontFamilyCombo | Specifies the text font family. The ComboBox dataProvider is an Array of Strings with the following values:
|
| ComboBox | fontSizeCombo | Specifies the font size. The ComboBox dataProvider is an Array of Strings with the following values:
8, 9, 10 (default), 11, 12, 14, 16, 18, 20, 24, 26, 28, 36, 48, 72.
Note:This specification is the actual pixel value for the font size. These sizes are not equivalent to the
relative font sizes specified in HTML using the |
| HBox | toolBar2 | Contains the font characteristic buttons. |
| Button | boldButton | When toggled to selected="true", sets the font to bold. |
| Button | italicButton | When toggled to selected="true", sets the font to italic. |
| Button | underlineButton | When toggled to selected="true", sets the font to underlined. |
| ColorPicker | colorPicker | Specifies the color of the text. |
| ToggleButtonBar | alignButtons | Specifies the text alignment. The control's data provider consists of an Array Of objects, with the object action field specifying the justification type. The available actions are as follows:
|
| Button | bulletButton | When toggled to selected="true", sets the current line, or the selected line, to a list item, preceded by a bullet. |
| TextInput | linkTextInput | This field is enabled only when text is selected.
When the user enters a URL in this field and presses the Enter key, Flex inserts
the equivalent of an HTML <a href="user_text"
target="blank"></a> tag in the TextArea subcontrol
at around the currently selected text.
Flex initially fills this control with the text specified by the
|
To access one of the subcontrols, you can use syntax similar to the following:
myRTE.toolBar2.setStyle("backgroundColor", 0xCC6633);
The RichTextEditor control has the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | 325 pixels wide by 300 pixels high |
| Minimum size | 220 pixels wide by 200 pixels high |
| Maximum size | 10000 by 10000 pixels |
Hide MXML Syntax
The <mx:RichTextEditor> tag inherits all the members of its parent and adds the following members:
Show MXML Syntax
<RichTextEditor
Properties
defaultLinkProtocol="http://"
htmlText=""
showControlBar="true | false"
showToolTips="false | true"
text=""
Events
change
/>
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| alignToolTip : String
The ToolTip that appears when the user hovers over the text alignment buttons.
| RichTextEditor | ||
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| autoLayout : Boolean
If true, measurement and layout are done
when the position or size of a child is changed.
| Container | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
[read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
| UIComponent | |
| automationValue : Array
[read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
[read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| boldToolTip : String
The ToolTip that appears when the user hovers over the text bold button.
| RichTextEditor | ||
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom.
| Container | |
| bulletToolTip : String
The ToolTip that appears when the user hovers over the bulleted list button.
| RichTextEditor | ||
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
| cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| childDescriptors : Array
[read-only]
Array of UIComponentDescriptor objects produced by the MXML compiler.
| Container | |
| className : String
[read-only]
The name of this instance's class, such as "Button".
| UIComponent | |
| clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes
of this container's children extend outside the borders of
this container.
| Container | |
| colorPickerToolTip : String
The ToolTip that appears when the user hovers over the ColorPicker control.
| RichTextEditor | ||
| constraintColumns : Array
An Array of ConstraintColumn instances that partition this container.
| Panel | |
| constraintRows : Array
An Array of ConstraintRow instances that partition this container.
| Panel | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| Container | |
| contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| Container | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
| Container | |
| creationIndex : int
Specifies the order to instantiate and draw the children
of the container.
| Container | |
| creationPolicy : String
The child creation policy for this Container.
| Container | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The data property lets you pass a value
to the component when you use it in an item renderer or item editor.
| Container | |
| defaultButton : IFlexDisplayObject
The Button control designated as the default button
for the container.
| Container | |
| defaultLinkProtocol : String
The default protocol string to use at the start of link text.
| RichTextEditor | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
| UIComponent | |
| dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| fontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
| Panel | |
| fontFamilyToolTip : String
The ToolTip that appears when the user hovers over the font drop-down list.
| RichTextEditor | ||
| fontSizeToolTip : String
The ToolTip that appears when the user hovers over the font size drop-down list.
| RichTextEditor | ||
| graphics : Graphics
[read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| horizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow
button in the horizontal scroll bar is pressed.
| Container | |
| horizontalPageScrollSize : Number
Number of pixels to move when the track in the
horizontal scroll bar is pressed.
| Container | |
| horizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
| Container | |
| horizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| horizontalScrollPosition : Number
The current position of the horizontal scroll bar.
| Container | |
| htmlText : String
Text containing HTML markup that displays in the RichTextEditor
control's TextArea subcontrol.
| RichTextEditor | ||
| icon : Class
The Class of the icon displayed by some navigator
containers to represent this Container.
| Container | |
| id : String
ID of the component.
| UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up.
| UIComponent | |
| italicToolTip : String
The ToolTip that appears when the user hovers over the text italic button.
| RichTextEditor | ||
| label : String
The text displayed by some navigator containers to represent
this Container.
| Container | |
| layout : String
Specifies the layout mechanism used for this container.
| Panel | |
| linkToolTip : String
The ToolTip that appears when the user hovers over the link text input field.
| RichTextEditor | ||
| loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
[read-only]
The largest possible value for the
horizontalScrollPosition property.
| Container | |
| maxVerticalScrollPosition : Number
[read-only]
The largest possible value for the
verticalScrollPosition property.
| Container | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | |
| numChildren : int
[read-only]
Number of child components in this container.
| Container | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rawChildren : IChildList
[read-only]
A container typically contains child components, which can be enumerated
using the Container.getChildAt() method and
Container.numChildren property.
| Container | |
| repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| selection : TextRange
[read-only]
A TextRange object containing the selected text in the TextArea subcontrol.
| RichTextEditor | ||
| showControlBar : Boolean
Specifies whether to display the control bar that contains the text
formatting controls.
| RichTextEditor | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| showToolTips : Boolean
Specifies whether to display tooltips for the text formatting controls.
| RichTextEditor | ||
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| status : String
Text in the status area of the title bar.
| Panel | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
| text : String
Plain text without markup that displays in the RichTextEditor control's TextArea subcontrol.
| RichTextEditor | ||
| textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| title : String
Title or caption displayed in the title bar.
| Panel | |
| titleIcon : Class
The icon displayed in the title bar.
| Panel | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| underlineToolTip : String
The ToolTip that appears when the user hovers over the text underline button.
| RichTextEditor | ||
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| verticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow
button in the vertical scroll bar is pressed,
or when you scroll by using the mouse wheel.
| Container | |
| verticalPageScrollSize : Number
Number of pixels to scroll when the track
in the vertical scroll bar is pressed.
| Container | |
| verticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
| Container | |
| verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present,
always absent, or automatically added when needed.
| Container | |
| verticalScrollPosition : Number
The current position of the vertical scroll bar.
| Container | |
| viewMetrics : EdgeMetrics
[read-only]
Returns an object that has four properties: left,
top, right, and bottom.
| Container | |
| viewMetricsAndPadding : EdgeMetrics
[read-only]
Returns an object that has four properties: left,
top, right, and bottom.
| Container | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |