mx.controls.RichTextEditor (Flex 3.4)

Package	mx.controls
Class	public class RichTextEditor
Inheritance	RichTextEditor Panel Container UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object

The RichTextEditor control lets users enter and format text. The text characteristics that users can vary include the font family, color, size, and style, and other properties such as text alignment, bullets and URL links. The control consists of a Panel control with two direct children:

A Text Area control where users can enter text.
A Container with format controls that let a user specify the text characteristics. The format controls affect text being typed or selected text.

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: _sans _serif _typewriter Arial Courier Courier New Geneva Georgia Helvetica Times New Roman Times Verdana (default)
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 `size` attribute of the <font> tag.
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: left (default) center right justify
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 `defaultLinkProtocol` property; users can append the rest of the link to this text, or replace it.

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

MXML Syntax expanded

Hide MXML Syntax

The <mx:RichTextEditor> tag inherits all the members of its parent and adds the following members:

   <RichTextEditor
     Properties
     defaultLinkProtocol="http://"
     htmlText=""
     showControlBar="true | false"
     showToolTips="false | true"
     text=""
       
     Events
     change
   />

View the examples

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	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
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	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 [override] [read-only] Returns the x position of the mouse, in the content coordinate system.	Container
		contentMouseY : Number [override] [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 [override] Specifies whether the UIComponent object receives doubleClick events.	UIComponent
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		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 The maximum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		flexContextMenu : IFlexContextMenu The context menu for this UIComponent.	UIComponent
		focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to.	UIComponent
		focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers.	UIComponent
		focusPane : Sprite The focus pane associated with this object.	UIComponent
		focusRect : Object Specifies whether this object displays a focus rectangle.	InteractiveObject
		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 [override] 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 The maximum recommended height of the component to be considered by the parent during layout.	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 The maximum recommended width of the component to be considered by the parent during layout.	UIComponent
		measuredHeight : Number The default height of the component, in pixels.	UIComponent
		measuredMinHeight : Number The default minimum height of the component, in pixels.	UIComponent
		measuredMinWidth : Number The default minimum width of the component, in pixels.	UIComponent
		measuredWidth : Number The default width of the component, in pixels.	UIComponent
		minHeight : Number The minimum recommended height of the component to be considered by the parent during layout.	UIComponent
		minWidth : Number The minimum recommended width of the component to be considered by the parent during layout.	UIComponent
		moduleFactory : IFlexModuleFactory 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 [override] [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 [override] [read-only] The parent container or component for this component.	UIComponent
		parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance.	UIComponent
		parentDocument : Object [read-only] A reference to the parent document object for this UIComponent.	UIComponent
		percentHeight : Number 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
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : Number Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Number that specifies the horizontal scaling factor.	UIComponent
		scaleY : Number [override] Number that specifies the vertical scaling factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		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 : mx.controls.textClasses: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 : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		states : Array The view states that are defined for this component.	UIComponent
		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 : flash.text: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 : flash.geom: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 [override] Controls the visibility of this UIComponent.	UIComponent
		width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates.	UIComponent
		x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container.	UIComponent
		y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Protected Properties

Hide Inherited Protected Properties

Show Inherited Protected Properties

	Property		Defined By
		actualCreationPolicy : String The creation policy of this container.	Container
		closeButtonStyleFilters : Object [read-only] The set of styles to pass from the Panel to the close button.	Panel
		controlBar : IUIComponent A reference to this Panel container's control bar, if any.	Panel
		resourceManager : IResourceManager [read-only] A reference to the object which manages all of the application's localized resources.	UIComponent
		statusTextField : mx.core:IUITextField The UITextField sub-control that displays the status.	Panel
		titleBar : UIComponent The TitleBar sub-control that displays the Panel container's title bar.	Panel
		titleTextField : mx.core:IUITextField The UITextField sub-control that displays the title.	Panel
		unscaledHeight : Number [read-only] A convenience method for determining the unscaled height of the component.	UIComponent
		unscaledWidth : Number [read-only] A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().	UIComponent

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		addChild(child:DisplayObject):DisplayObject [override] Adds a child DisplayObject to this Container.	Container
		addChildAt(child:DisplayObject, index:int):DisplayObject [override] Adds a child DisplayObject to this Container.	Container
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	EventDispatcher
		areInaccessibleObjectsUnderPoint(point:Point):Boolean Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.	DisplayObjectContainer
		callLater(method:Function, args:Array = null):void Queues a function to be called later.	UIComponent
		clearStyle(styleProp:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		contentToGlobal(point:Point):Point [override] Converts a Point object from content coordinates to global coordinates.	Container
		contentToLocal(point:Point):Point [override] Converts a Point object from content to local coordinates.	Container
		createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container.	UIComponent
		createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.	Container
		createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.	Container
		createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object.	UIComponent
		deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object.	UIComponent
		determineTextFormatFromStyles():mx.core:UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent.	UIComponent
		dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow.	UIComponent
		drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component.	UIComponent
		drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programatically draws a rectangle into this skin's Graphics object.	UIComponent
		effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component.	UIComponent
		effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component.	UIComponent
		endEffectsStarted():void Ends all currently playing effects on the component.	UIComponent
		executeBindings(recurse:Boolean = false):void [override] Executes all the data bindings on this Container.	Container
		executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects.	Container
		finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete.	UIComponent
		getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index.	UIComponent
		getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.	DisplayObject
		getChildAt(index:int):DisplayObject [override] Gets the nth child component object.	Container
		getChildByName(name:String):DisplayObject [override] Returns the child whose name property is the specified String.	Container
		getChildIndex(child:DisplayObject):int [override] Gets the zero-based index of a specific child.	Container
		getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container.	Container
		getClassStyleDeclarations():Array Finds the type selectors for this UIComponent instance.	UIComponent
		getConstraintValue(constraintName:String):* Returns a layout constraint value, which is the same as getting the constraint style for this component.	UIComponent
		getExplicitOrMeasuredHeight():Number A convenience method for determining whether to use the explicit or measured height	UIComponent
		getExplicitOrMeasuredWidth():Number A convenience method for determining whether to use the explicit or measured width	UIComponent
		getFocus():InteractiveObject Gets the object that currently has focus.	UIComponent
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.	DisplayObject
		getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.	UIComponent
		getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain.	UIComponent
		globalToContent(point:Point):Point [override] Converts a Point object from global to content coordinates.	Container
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.	DisplayObject
		hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.	DisplayObject
		horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.	UIComponent
		initialize():void Initializes the internal structure of this component.	UIComponent
		initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component.	UIComponent
		invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update.	UIComponent
		invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update.	UIComponent
		invalidateSize():void Marks a component so that its measure() method gets called during a later screen update.	UIComponent
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.	DisplayObject
		localToContent(point:Point):Point [override] Converts a Point object from local to content coordinates.	Container
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		measureHTMLText(htmlText:String):flash.text:TextLineMetrics Measures the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		measureText(text:String):flash.text:TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.	UIComponent
		move(x:Number, y:Number):void Moves the component to a specified position within its parent.	UIComponent
		notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children.	UIComponent
		owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent.	UIComponent
		parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent.	UIComponent
		prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.	UIComponent
		registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners.	UIComponent
		removeAllChildren():void Removes all children from the child list of this container.	Container
		removeChild(child:DisplayObject):DisplayObject [override] Removes a child DisplayObject from the child list of this Container.	Container
		removeChildAt(index:int):DisplayObject [override] Removes a child DisplayObject from the child list of this Container at the specified index.	Container
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		replayAutomatableEvent(event:Event):Boolean Replays the specified event.	UIComponent
		resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided.	UIComponent
		resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().	UIComponent
		setActualSize(w:Number, h:Number):void Sizes the object.	UIComponent
		setChildIndex(child:DisplayObject, newIndex:int):void [override] Sets the index of a particular child.	Container
		setConstraintValue(constraintName:String, value:*):void Sets a layout constraint value, which is the same as setting the constraint style for this component.	UIComponent
		setCurrentState(stateName:String, playTransition:Boolean = true):void Set the current state.	UIComponent
		setFocus():void Sets the focus to this component.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance.	UIComponent
		setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes.	UIComponent
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		stopDrag():void Ends the startDrag() method.	Sprite
		styleChanged(styleProp:String):void Detects changes to style properties.	UIComponent
		stylesInitialized():void Flex calls the stylesInitialized() method when the styles for a component are first initialized.	UIComponent
		suspendBackgroundProcessing():void [static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.	UIComponent
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		swapChildrenAt(index1:int, index2:int):void Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.	DisplayObjectContainer
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.	FlexSprite
		validateDisplayList():void Validates the position and size of children and draws other visuals.	UIComponent
		validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary.	UIComponent
		validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method.	UIComponent
		validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.	UIComponent
		validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.	UIComponent
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		adjustFocusRect(obj:DisplayObject = null):void Adjust the focus rectangle.	UIComponent
		attachOverlay():void [override] Used internally by the Dissolve Effect to add the overlay to the chrome of a container.	Container
		childrenCreated():void Performs any final processing after child objects are created.	UIComponent
		commitProperties():void Processes the properties set on the component.	UIComponent
		createBorder():void Creates the container's border skin if it is needed and does not already exist.	Container
		createChildren():void Create child objects of the component.	UIComponent
		createInFontContext(classObj:Class):Object Creates a new object using a context based on the embedded font being used.	UIComponent
		createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object Creates the object using a given moduleFactory.	UIComponent
		focusInHandler(event:FocusEvent):void The event handler called when a UIComponent object gets focus.	UIComponent
		focusOutHandler(event:FocusEvent):void The event handler called when a UIComponent object loses focus.	UIComponent
		getHeaderHeight():Number Returns the height of the header.	Panel
		initializationComplete():void Finalizes the initialization of this component.	UIComponent
		initializeAccessibility():void Initializes this component's accessibility code.	UIComponent
		isOurFocus(target:DisplayObject):Boolean Typically overridden by components containing UITextField objects, where the UITextField object gets focus.	UIComponent
		keyDownHandler(event:KeyboardEvent):void The event handler called for a keyDown event.	UIComponent
		keyUpHandler(event:KeyboardEvent):void The event handler called for a keyUp event.	UIComponent
		layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void Respond to size changes by setting the positions and sizes of this container's borders.	Container
		measure():void [override] Calculates the default mininum and maximum sizes of the Panel container.	Panel
		resourcesChanged():void This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.	UIComponent
		scrollChildren():void Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.	Container
		startDragging(event:MouseEvent):void Called when the user starts dragging a Panel that has been popped up by the PopUpManager.	Panel
		stopDragging():void Called when the user stops dragging a Panel that has been popped up by the PopUpManager.	Panel
		updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override] Respond to size changes by setting the positions and sizes of this container's children.	Container

Events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
add	Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.	UIComponent
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.	DisplayObject
change	Dispatched when the user changes the contents or format of the text in the TextArea control.	RichTextEditor
childAdd	Dispatched after a child has been added to a container.	Container
childIndexChange	Dispatched after the index (among the container children) of a container child changes.	Container
childRemove	Dispatched before a child of a container is removed.	Container
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
creationComplete	Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.	UIComponent
currentStateChange	Dispatched after the view state has changed.	UIComponent
currentStateChanging	Dispatched after the currentState property changes, but before the view state changes.	UIComponent
cut	Dispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
dataChange	Dispatched when the data property changes.	Container
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.	InteractiveObject
dragComplete	Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.	UIComponent
dragDrop	Dispatched by the drop target when the user releases the mouse over it.	UIComponent
dragEnter	Dispatched by a component when the user moves the mouse over the component during a drag operation.	UIComponent
dragExit	Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.	UIComponent
dragOver	Dispatched by a component when the user moves the mouse while over the component during a drag operation.	UIComponent
dragStart	Dispatched by the drag initiator when starting a drag operation.	UIComponent
effectEnd	Dispatched after an effect ends.	UIComponent
effectStart	Dispatched just before an effect starts.	UIComponent
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
enterState	Dispatched after the component has returned to the root view state.	UIComponent
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
exitState	Dispatched before the component exits from the root view state.	UIComponent
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
hide	Dispatched when an object's state changes from visible to invisible.	UIComponent
initialize	Dispatched when the component has finished its construction and has all initialization properties set.	UIComponent
invalid	Dispatched when a component is monitored by a Validator and the validation failed.	UIComponent
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDownOutside	Dispatched from a component opened using the PopUpManager when the user clicks outside it.	UIComponent
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
mouseWheelOutside	Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.	UIComponent
move	Dispatched when the object has moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().	InteractiveObject
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
preinitialize	Dispatched at the beginning of the component initialization sequence.	UIComponent
remove	Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.	UIComponent
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.	DisplayObject
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched when the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
rollOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
scroll	Dispatched when the user manually scrolls the container.	Container
selectAll	Dispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.	InteractiveObject
show	Dispatched when an object's state changes from invisible to visible.	UIComponent
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
toolTipCreate	Dispatched by the component when it is time to create a ToolTip.	UIComponent
toolTipEnd	Dispatched by the component when its ToolTip has been hidden and will be discarded soon.	UIComponent
toolTipHide	Dispatched by the component when its ToolTip is about to be hidden.	UIComponent
toolTipShow	Dispatched by the component when its ToolTip is about to be shown.	UIComponent
toolTipShown	Dispatched by the component when its ToolTip has been shown.	UIComponent
toolTipStart	Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.	UIComponent
updateComplete	Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).	UIComponent
valid	Dispatched when a component is monitored by a Validator and the validation succeeded.	UIComponent
valueCommit	Dispatched when values are changed programmatically or by user interaction.	UIComponent

Styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
backgroundAlpha	Type: Number CSS Inheritance: no Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style.	Container
backgroundAttachment	Type: String CSS Inheritance: no If a background image is specified, this style specifies whether it is fixed with regard to the viewport (`"fixed"`) or scrolls along with the content (`"scroll"`).	Container
backgroundColor	Type: uint Format: Color CSS Inheritance: no Background color of a component.	Container
backgroundDisabledColor	Type: uint Format: Color CSS Inheritance: yes Background color of the component when it is disabled.	Container
backgroundImage	Type: Object Format: File CSS Inheritance: no Background image of a component.	Container
backgroundSize	Type: String CSS Inheritance: no Scales the image specified by `backgroundImage` to different percentage sizes.	Container
barColor	Type: uint Format: Color CSS Inheritance: yes Determines the color of a ProgressBar.	Container
baseline	Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position.	UIComponent
borderAlpha	Type: Number CSS Inheritance: no Alpha of the title bar, control bar and sides of the Panel.	Panel
borderColor	Type: uint Format: Color CSS Inheritance: no Color of the border.	Container
borderSides	Type: String CSS Inheritance: no Bounding box sides.	Container
borderSkin	Type: Class CSS Inheritance: no The border skin class of the component.	Container
borderStyle	Type: String CSS Inheritance: no Bounding box style.	Container
borderThickness	Type: Number Format: Length CSS Inheritance: no Bounding box thickness.	Container
borderThicknessBottom	Type: Number Format: Length CSS Inheritance: no Thickness of the bottom border of the Panel control.	Panel
borderThicknessLeft	Type: Number Format: Length CSS Inheritance: no Thickness of the left border of the Panel.	Panel
borderThicknessRight	Type: Number Format: Length CSS Inheritance: no Thickness of the right border of the Panel.	Panel
borderThicknessTop	Type: Number Format: Length CSS Inheritance: no Thickness of the top border of the Panel.	Panel
bottom	Type: String CSS Inheritance: no The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.	UIComponent
color	Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label.	Container
controlBarStyleName	Type: String CSS Inheritance: no Name of the CSS style declaration that specifies styles to apply to any control bar child subcontrol.	Panel
cornerRadius	Type: Number Format: Length CSS Inheritance: no Radius of corners of the window frame.	Panel
disabledColor	Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled.	Container
disabledOverlayAlpha	Type: Number CSS Inheritance: no The alpha value for the overlay that is placed on top of the container when it is disabled.	Container
dropShadowColor	Type: uint Format: Color CSS Inheritance: yes Color of the drop shadow.	Container
dropShadowEnabled	Type: Boolean CSS Inheritance: no Boolean property that controls the visibility of the Panel container's drop shadow.	Panel
errorColor	Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails.	UIComponent
fontAntiAliasType	Type: String CSS Inheritance: yes Sets the `antiAliasType` property of internal TextFields.	Container
fontFamily	Type: String CSS Inheritance: yes Name of the font to use.	Container
fontGridFitType	Type: String CSS Inheritance: yes Sets the `gridFitType` property of internal TextFields that represent text in Flex controls.	Container
fontSharpness	Type: Number CSS Inheritance: yes Sets the `sharpness` property of internal TextFields that represent text in Flex controls.	Container
fontSize	Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels.	Container
fontStyle	Type: String CSS Inheritance: yes Determines whether the text is italic font.	Container
fontThickness	Type: Number CSS Inheritance: yes Sets the `thickness` property of internal TextFields that represent text in Flex controls.	Container
fontWeight	Type: String CSS Inheritance: yes Determines whether the text is boldface.	Container
footerColors	Type: Array Format: Color CSS Inheritance: yes Array of two colors used to draw the footer (area for the ControlBar container) background.	Panel
headerColors	Type: Array Format: Color CSS Inheritance: yes Array of two colors used to draw the header.	Panel
headerHeight	Type: Number Format: Length CSS Inheritance: no Height of the header.	Panel
highlightAlphas	Type: Array CSS Inheritance: no Alphas used for the highlight fill of the header.	Panel
horizontalAlign	Type: String CSS Inheritance: no Horizontal alignment of children in the container.	Panel
horizontalCenter	Type: 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
horizontalGap	Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the horizontal direction.	Panel
horizontalScrollBarStyleName	Type: String CSS Inheritance: no The name of the horizontal scrollbar style.	Container
kerning	Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`).	Container
left	Type: String CSS Inheritance: no The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.	UIComponent
letterSpacing	Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character.	Container
modalTransparency	Type: Number CSS Inheritance: yes Modality of components launched by the PopUp Manager is simulated by creating a large translucent overlay underneath the component.	Panel
modalTransparencyBlur	Type: Number CSS Inheritance: yes The blur applied to the application while a modal window is open.	Panel
modalTransparencyColor	Type: uint Format: Color CSS Inheritance: yes Color of the modal overlay layer.	Panel
modalTransparencyDuration	Type: Number Format: Time CSS Inheritance: yes Duration, in milliseconds, of the modal transparency effect that plays when a modal window opens or closes.	Panel
paddingBottom	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's lower border and its content area.	Panel
paddingLeft	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area.	Container
paddingRight	Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area.	Container
paddingTop	Type: Number Format: Length CSS Inheritance: no Number of pixels between the container's top border and its content area.	Panel
right	Type: String CSS Inheritance: no The horizontal distance in pixels from the right edge of the component to the right edge of its content area.	UIComponent
roundedBottomCorners	Type: Boolean CSS Inheritance: no Flag to enable rounding for the bottom two corners of the container.	Panel
shadowDirection	Type: String CSS Inheritance: no Direction of drop shadow.	Panel
shadowDistance	Type: Number Format: Length CSS Inheritance: no Distance of drop shadow.	Panel
statusStyleName	Type: String CSS Inheritance: no Style declaration name for the status in the title bar.	Panel
textAlign	Type: String CSS Inheritance: yes Alignment of text within a container.	Container
textAreaStyleName	Type: String CSS Inheritance: no Name of the CSS Style declaration to use for the styles for the TextArea. By default, the TextArea uses the the RichTextEditor's inheritable styles.	RichTextEditor
textDecoration	Type: String CSS Inheritance: yes Determines whether the text is underlined.	Container
textIndent	Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels.	Container
themeColor	Type: uint Format: Color CSS Inheritance: yes Theme color of a component.	UIComponent
titleBackgroundSkin	Type: Class CSS Inheritance: no The title background skin.	Panel
titleStyleName	Type: String CSS Inheritance: no Style declaration name for the text in the title bar.	Panel
top	Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.	UIComponent
verticalAlign	Type: String CSS Inheritance: no Vertical alignment of children in the container.	Panel
verticalCenter	Type: 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
verticalGap	Type: Number Format: Length CSS Inheritance: no Number of pixels between children in the vertical direction.	Panel
verticalScrollBarStyleName	Type: String CSS Inheritance: no The name of the vertical scrollbar style.	Container

Effects

Hide Inherited Effects

Show Inherited Effects

	Description	Defined By
addedEffect	Triggering Event: added Played when the component is added as a child to a Container.	UIComponent
creationCompleteEffect	Triggering Event: creationComplete Played when the component is created.	UIComponent
hideEffect	Triggering Event: hide Played when the component becomes invisible.	UIComponent
mouseDownEffect	Triggering Event: mouseDown Played when the user presses the mouse button while over the component.	UIComponent
mouseUpEffect	Triggering Event: mouseUp Played when the user releases the mouse button while over the component.	UIComponent
moveEffect	Triggering Event: move Played when the component is moved.	UIComponent
removedEffect	Triggering Event: removed Played when the component is removed from a Container.	UIComponent
resizeEffect	Triggering Event: resize Played when the component is resized.	UIComponent
resizeEndEffect	Triggering Event: resizeEnd Specifies the effect to play after a Resize effect finishes playing. To disable the default Dissolve effect, so that the children are hidden instantaneously, set the value of the resizeEndEffect property to "none".	Panel
resizeStartEffect	Triggering Event: resizeStart Specifies the effect to play before a Resize effect begins playing. To disable the default Dissolve effect, so that the children are hidden instantaneously, set the value of the resizeStartEffect property to "none".	Panel
rollOutEffect	Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component.	UIComponent
rollOverEffect	Triggering Event: rollOver Played when the user rolls the mouse over the component.	UIComponent
showEffect	Triggering Event: show Played when the component becomes visible.	UIComponent

Public Constants

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		DEFAULT_MAX_HEIGHT : Number = 10000 [static] The default value for the maxHeight property.	UIComponent
		DEFAULT_MAX_WIDTH : Number = 10000 [static] The default value for the maxWidth property.	UIComponent
		DEFAULT_MEASURED_HEIGHT : Number = 22 [static] The default value for the measuredHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static] The default value for the measuredMinHeight property.	UIComponent
		DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static] The default value for the measuredMinWidth property.	UIComponent
		DEFAULT_MEASURED_WIDTH : Number = 160 [static] The default value for the measuredWidth property.	UIComponent

Property Detail

alignToolTip

property

public var alignToolTip:String

The ToolTip that appears when the user hovers over the text alignment buttons. All the buttons share the same ToolTip. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Align".

boldToolTip

property

public var boldToolTip:String

The ToolTip that appears when the user hovers over the text bold button. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Bold".

bulletToolTip

property

public var bulletToolTip:String

The ToolTip that appears when the user hovers over the bulleted list button. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Bullet".

colorPickerToolTip

property

public var colorPickerToolTip:String

The ToolTip that appears when the user hovers over the ColorPicker control. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Color".

defaultLinkProtocol

property

public var defaultLinkProtocol:String

The default protocol string to use at the start of link text. This string appears in the LinkTextInput subcontrol, so users do not have to type the protocol identifier when entering link text.

The default value is "http://".

fontFamilyToolTip

property

public var fontFamilyToolTip:String

The ToolTip that appears when the user hovers over the font drop-down list. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Font Family".

fontSizeToolTip

property

public var fontSizeToolTip:String

The ToolTip that appears when the user hovers over the font size drop-down list. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Font Size".

htmlText

property

public var htmlText:String

Text containing HTML markup that displays in the RichTextEditor control's TextArea subcontrol. You cannot set this property and the text property simultaneously. If you set one property, it replaces any value set using the other property. You can get both properties; the htmlText property always returns a String containing HTML markup that represents the current text formatting. For more information on using this property, see the TextArea documentation.

The default value is "".

See also

mx.controls.TextArea

italicToolTip

property

public var italicToolTip:String

The ToolTip that appears when the user hovers over the text italic button. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Italic".

linkToolTip

property

public var linkToolTip:String

The ToolTip that appears when the user hovers over the link text input field. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Link".

selection

property

selection:mx.controls.textClasses:TextRange [read-only]

A TextRange object containing the selected text in the TextArea subcontrol.

Implementation
public function get selection():mx.controls.textClasses:TextRange

See also

mx.controls.textClasses.TextRange

showControlBar

property

public var showControlBar:Boolean

Specifies whether to display the control bar that contains the text formatting controls.

The default value is true.

showToolTips

property

public var showToolTips:Boolean

Specifies whether to display tooltips for the text formatting controls.

The default value is false.

text

property

public var text:String

Plain text without markup that displays in the RichTextEditor control's TextArea subcontrol. You cannot set this property and the htmlText property simultaneously. If you set one property, it replaces any value set using the other property. You can get both properties; the text property always returns a plain text String with no formatting information. For more information on using this property, see the TextArea documentation.

The default value is "".

See also

mx.controls.TextArea

underlineToolTip

property

public var underlineToolTip:String

The ToolTip that appears when the user hovers over the text underline button. To view ToolTips, you must also set the showToolTips property of the RichTextEditor control to true.

The default value is "Underline".

Event Detail

change

Event

Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CHANGE

Dispatched when the user changes the contents or format of the text in the TextArea control. This event is not dispatched if you change the TextArea contents by resetting the text or htmlText property.

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

This event has the following properties:

Property	Value
`bubbles`	`true`
`cancelable`	`false`; there is no default behavior to cancel.
`currentTarget`	The object that is actively processing the Event object with an event listener.
`target`	The object that has had its value modified. The `target` is not always the object in the display list that registered the event listener. Use the `currentTarget` property to access the object in the display list that is currently processing the event.

Examples How to use this example

RichTextEditorExample.mxml

<?xml version="1.0" ?>
<!-- Simple example to demonstrate the RichTextEditor control. -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml" 
    horizontalAlign="center" verticalAlign="middle">

    <mx:RichTextEditor id="rte" title="RichTextEditor" height="75%" text="Enter text into the RichTextEditor control, then click a button to display your text as plain text, or as HTML-formatted text."/>

    <mx:TextArea id="rteText" width="80%" height="25%"/>

    <mx:HBox>
        <mx:Button label="Show Plain Text" click="rteText.text=rte.text;"/>
        <mx:Button label="Show HTML Markup" click="rteText.text=rte.htmlText;"/>
    </mx:HBox>

</mx:Application>

Adobe® Flex™ 3.4 Language Reference Language Reference only	All Packages \| All Classes \| Language Elements \| Index \| Appendixes \| Conventions \| Frames No Frames
RichTextEditor	Properties \| Methods \| Events \| Styles \| Effects \| Constants \| Examples