mx.charts

# Legend - AS3 Flex

Package | mx.charts
Class | public class Legend
Inheritance | Legend UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object
Implements | IContainer

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The Legend control adds a legend to your charts, where the legend displays the label for each data series in the chart and a key showing the chart element for the series.

You can initialize a Legend control by binding a chart control identifier to the Legend control's `dataProvider` property, or you can define an Array of LegendItem objects.

MXML Syntax Show MXML Syntax
Hide MXML Syntax

The `<mx:Legend>` tag inherits all the properties of its parent classes and adds the following properties:

          <mx:Legend
            Properties
            autoLayout="true|false"
            clipContent="true|false"
            creationIndex="undefined"
            creationPolicy="auto|all|queued|none"
            dataProvider="No default"
            direction="horizontal|vertical"
            horizontalScrollPosition="0"
            legendItemClass="No default"
            verticalScrollPosition="0"

            Styles
            backgroundAlpha="1.0"
            backgroundAttachment="scroll"
            backgroundColor="undefined"
            backgroundDisabledColor="undefined"
            backgroundImage="undefined"
            backgroundSize="auto"
            barColor="undefined"
            borderColor="0xAAB3B3"
            borderSides="left top right bottom"
            borderSkin="mx.skins.halo.HaloBorder"
            borderStyle="inset|none|solid|outset"
            borderThickness="1"
            color="0x0B333C"
            cornerRadius="0"
            disabledColor="0xAAB3B3"
            disbledOverlayAlpha="undefined"
            dropShadowColor="0x000000"
            dropShadowEnabled="false"
            fontAntiAliasType="advanced"
            fontfamily="Verdana"
            fontGridFitType="pixel"
            fontSharpness="0""
            fontSize="10"
            fontStyle="normal"
            fontThickness="0"
            fontWeight="normal"
            horizontalAlign="left|center|right"
            horizontalGap="8"
            labelPlacement="right|left|top|bottom"
            markerHeight="15"
            markerWidth="10"
            paddingBottom="0"
            paddingLeft="0"
            paddingRight="0"
            paddingTop="0"
            shadowDirection="center"
            shadowDistance="2"
            stroke="IStroke; no default"
            textAlign="left"
            textDecoration="none|underline"
            textIndent="0"
            verticalAlign="top|middle|bottom"
            verticalGap="6"

            Events
            childAdd="No default"
            childIndexChange="No default"
            childRemove="No default"
            dataChange="No default"
            itemClick="Event; no default"
            itemMouseDown="Event; no default"
            itemMouseOut="Event; no default"
            itemMouseOver="Event; no default"
            itemMouseUp="Event; no default"
          />

View the examples

More examples

Formatting Legend controls
Setting the direction of legends
Formatting the legend markers
Adding a Legend control to your chart
Creating a custom Legend control

Learn more

Using Legend controls

Related API Elements

mx.charts.LegendItem

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | accessibilityDescription : String A convenience accessor for the description property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityEnabled : Boolean A convenience accessor for the silent property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance. | InteractiveObject
|  | accessibilityName : String A convenience accessor for the name property in this UIComponent's accessibilityProperties object. | UIComponent
|  | accessibilityProperties : AccessibilityProperties The current accessibility options for this display object. | DisplayObject
|  | accessibilityShortcut : String A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object. | UIComponent
|  | activeEffects : Array [read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances. | UIComponent
|  | alpha : Number Indicates the alpha transparency value of the object specified. | DisplayObject
|  | autoLayout : Boolean If true, measurement and layout are done when the position or size of a child is changed. | Legend
|  | automationDelegate : Object The delegate object that handles the automation-related functionality. | UIComponent
|  | automationEnabled : Boolean [read-only] True if this component is enabled for automation, false otherwise. | UIComponent
|  | automationName : String Name that can be used as an identifier for this object. | UIComponent
|  | automationOwner : DisplayObjectContainer [read-only] The owner of this component for automation purposes. | UIComponent
|  | automationParent : DisplayObjectContainer [read-only] The parent of this component for automation purposes. | UIComponent
|  | automationTabularData : Object [read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data. | UIComponent
|  | automationValue : Array [read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application. | UIComponent
|  | automationVisible : Boolean [read-only] True if this component is visible for automation, false otherwise. | UIComponent
|  | baseline : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | UIComponent
|  | blendMode : String A value from the BlendMode class that specifies which blend mode to use. | DisplayObject
|  | blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background. | DisplayObject
|  | borderMetrics : EdgeMetrics [read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom. | Legend
|  | bottom : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | buttonMode : Boolean Specifies the button mode of this sprite. | Sprite
|  | cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object. | DisplayObject
|  | cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true. | DisplayObject
|  | cacheHeuristic : Boolean [write-only] Used by Flex to suggest bitmap caching for the object. | UIComponent
|  | cachePolicy : String Specifies the bitmap caching policy for this object. | UIComponent
|  | childDescriptors : Array Array of UIComponentDescriptor objects produced by the MXML compiler. | Legend
|  | 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. | Legend
|  | 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. | Legend
|  | contentMouseY : Number [override] [read-only] Returns the y position of the mouse, in the content coordinate system. | Legend
|  | contextMenu : NativeMenu Specifies the context menu associated with this object. | InteractiveObject
|  | creatingContentPane : Boolean Containers use an internal content pane to control scrolling. | Legend
|  | creationIndex : int Deprecated: Deprecated Specifies the order to instantiate and draw the children of the container. | Legend
|  | creationPolicy : String The child creation policy for this MX Container. | Legend
|  | 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. | Legend
|  | dataProvider : Object Set of data to be used in the Legend. | Legend
|  | deferredContentCreated : Boolean [read-only] IDeferredContentOwner equivalent of processedDescriptors | Legend
|  | depth : Number Determines the order in which items inside of containers are rendered. | UIComponent
|  | descriptor : UIComponentDescriptor Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance. | UIComponent
|  | designLayer : DesignLayer Specifies the optional DesignLayer instance associated with this visual element. | UIComponent
|  | direction : String Determines how children are placed in the container. | Legend
|  | 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 displayed by a component's error tip when a component is monitored by a Validator and validation fails. | UIComponent
|  | explicitHeight : Number Number that specifies the explicit height of the component, in pixels, in the component's coordinates. | UIComponent
|  | explicitMaxHeight : Number The maximum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMaxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | explicitMinWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | explicitWidth : Number Number that specifies the explicit width of the component, in pixels, in the component's coordinates. | UIComponent
|  | filters : Array An indexed array that contains each filter object currently associated with the display object. | DisplayObject
|  | flexContextMenu : IFlexContextMenu The context menu for this UIComponent. | UIComponent
|  | focusEnabled : Boolean Indicates whether the component can receive focus when tabbed to. | UIComponent
|  | focusManager : IFocusManager Gets the FocusManager that controls focus for this component and its peers. | UIComponent
|  | focusPane : Sprite The focus pane associated with this object. | UIComponent
|  | focusRect : Object Specifies whether this object displays a focus rectangle. | InteractiveObject
|  | graphics : Graphics [read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur. | Sprite
|  | hasFocusableChildren : Boolean A flag that indicates whether child objects can receive focus. | UIComponent
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | UIComponent
|  | height : Number [override] Number that specifies the height of the component, in pixels, in the parent's coordinates. | UIComponent
|  | hitArea : Sprite Designates another sprite to serve as the hit area for a sprite. | Sprite
|  | horizontalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | horizontalScrollPosition : Number The current position of the horizontal scroll bar. | Legend
|  | 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
|  | is3D : Boolean [read-only] Contains true when the element is in 3D. | UIComponent
|  | isDocument : Boolean [read-only] Contains true if this UIComponent instance is a document object. | UIComponent
|  | isPopUp : Boolean Set to true by the PopUpManager to indicate that component has been popped up. | UIComponent
|  | layoutMatrix3D : Matrix3D [write-only] The transform matrix that is used to calculate a component's layout relative to its siblings. | UIComponent
|  | left : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | legendItemClass : Class The class used to instantiate LegendItem objects. | Legend
|  | loaderInfo : LoaderInfo [read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs. | DisplayObject
|  | maintainProjectionCenter : Boolean When true, the component keeps its projection matrix centered on the middle of its bounding box. | UIComponent
|  | mask : DisplayObject The calling display object is masked by the specified mask object. | DisplayObject
|  | 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. | Legend
|  | maxVerticalScrollPosition : Number [read-only] The largest possible value for the verticalScrollPosition property. | Legend
|  | maxWidth : Number The maximum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | measuredHeight : Number The default height of the component, in pixels. | UIComponent
|  | measuredMinHeight : Number The default minimum height of the component, in pixels. | UIComponent
|  | measuredMinWidth : Number The default minimum width of the component, in pixels. | UIComponent
|  | measuredWidth : Number The default width of the component, in pixels. | UIComponent
|  | metaData : Object Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject
|  | minHeight : Number The minimum recommended height of the component to be considered by the parent during layout. | UIComponent
|  | minWidth : Number The minimum recommended width of the component to be considered by the parent during layout. | UIComponent
|  | moduleFactory : IFlexModuleFactory A module factory is used as context for using embedded fonts and for finding the style manager that controls the styles for this component. | UIComponent
|  | mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer
|  | mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject
|  | mouseFocusEnabled : Boolean Whether you can receive focus when clicked on. | UIComponent
|  | mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject
|  | name : String Indicates the instance name of the DisplayObject. | DisplayObject
|  | needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus. | InteractiveObject
|  | nestLevel : int Depth of this object in the containment hierarchy. | UIComponent
|  | nonInheritingStyles : Object The beginning of this component's chain of non-inheriting styles. | UIComponent
|  | numAutomationChildren : int [read-only] The number of automation children this container has. | UIComponent
|  | numChildren : int [override] [read-only] Number of child components in this container. | Legend
|  | numElements : int [read-only] The number of visual elements in this container. | Legend
|  | opaqueBackground : Object Specifies whether the display object is opaque with a certain background color. | DisplayObject
|  | owner : DisplayObjectContainer The owner of this IVisualElement object. | UIComponent
|  | parent : DisplayObjectContainer [override] [read-only] The parent container or component for this component. | UIComponent
|  | parentApplication : Object [read-only] A reference to the Application object that contains this UIComponent instance. | UIComponent
|  | parentDocument : Object [read-only] A reference to the parent document object for this UIComponent. | UIComponent
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | UIComponent
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | UIComponent
|  | postLayoutTransformOffsets : mx.geom:TransformOffsets Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout. | UIComponent
|  | processedDescriptors : Boolean Set to true after immediate or deferred child creation, depending on which one happens. | UIComponent
|  | rawChildren : IChildList [read-only] A container typically contains child components, which can be enumerated using the Container.getChildAt() method and Container.numChildren property. | Legend
|  | 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
|  | right : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | root : DisplayObject [read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject
|  | rotation : Number [override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent
|  | rotationX : Number [override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationY : Number [override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | rotationZ : Number [override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent
|  | scale9Grid : Rectangle The current scaling grid that is in effect. | DisplayObject
|  | scaleX : Number [override] Number that specifies the horizontal scaling factor. | UIComponent
|  | scaleY : Number [override] Number that specifies the vertical scaling factor. | UIComponent
|  | scaleZ : Number [override] Number that specifies the scaling factor along the z axis. | UIComponent
|  | screen : Rectangle [read-only] Returns an object that contains the size and position of the base drawing surface for this object. | UIComponent
|  | scrollRect : Rectangle The scroll rectangle bounds of the display object. | DisplayObject
|  | showInAutomationHierarchy : Boolean A flag that determines if an automation object shows in the automation hierarchy. | UIComponent
|  | softKeyboard : String Controls the appearance of the soft keyboard. | InteractiveObject
|  | softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject
|  | soundTransform : flash.media:SoundTransform Controls sound within this sprite. | Sprite
|  | stage : Stage [read-only] The Stage of the display object. | DisplayObject
|  | states : Array The view states that are defined for this component. | UIComponent
|  | styleDeclaration : CSSStyleDeclaration Storage for the inline inheriting styles on this object. | UIComponent
|  | styleManager : IStyleManager2 [read-only] Returns the StyleManager instance used by this component. | UIComponent
|  | styleName : Object The class style used by this component. | UIComponent
|  | styleParent : IAdvancedStyleClient A component's parent is used to evaluate descendant selectors. | UIComponent
|  | systemManager : ISystemManager Returns the SystemManager object used by this component. | UIComponent
|  | tabChildren : Boolean Determines whether the children of the object are tab enabled. | DisplayObjectContainer
|  | tabEnabled : Boolean Specifies whether this object is in the tab order. | InteractiveObject
|  | tabFocusEnabled : Boolean A flag that indicates whether this object can receive focus via the TAB key This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor. | UIComponent
|  | tabIndex : int Specifies the tab ordering of objects in a SWF file. | InteractiveObject
|  | textSnapshot : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer
|  | toolTip : String Text to display in the ToolTip. | UIComponent
|  | top : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | transform : flash.geom:Transform [override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | UIComponent
|  | transformX : Number Sets the x coordinate for the transform center of the component. | UIComponent
|  | transformY : Number Sets the y coordinate for the transform center of the component. | UIComponent
|  | transformZ : Number Sets the z coordinate for the transform center of the component. | UIComponent
|  | transitions : Array An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs. | UIComponent
|  | tweeningProperties : Array Array of properties that are currently being tweened on this object. | UIComponent
|  | uid : String A unique identifier for the object. | UIComponent
|  | updateCompletePendingFlag : Boolean A flag that determines if an object has been through all three phases of layout validation (provided that any were required). | UIComponent
|  | useHandCursor : Boolean A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true. | Sprite
|  | validationSubField : String Used by a validator to associate a subfield with this component. | UIComponent
|  | verticalCenter : Object For components, this layout constraint property is a facade on top of the similarly-named style. | UIComponent
|  | verticalScrollPosition : Number The current position of the vertical scroll bar. | Legend
|  | viewMetrics : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Legend
|  | viewMetricsAndPadding : EdgeMetrics [read-only] Returns an object that has four properties: left, top, right, and bottom. | Legend
|  | visible : Boolean [override] Whether or not the display object is visible. | UIComponent
|  | width : Number [override] Number that specifies the width of the component, in pixels, in the parent's coordinates. | UIComponent
|  | x : Number [override] Number that specifies the component's horizontal position, in pixels, within its parent container. | UIComponent
|  | y : Number [override] Number that specifies the component's vertical position, in pixels, within its parent container. | UIComponent
|  | z : Number [override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container. | UIComponent

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

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

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | Legend() Constructor. | Legend
|  | addChild(child:DisplayObject):DisplayObject [override] Adds a child DisplayObject to this Container. | Legend
|  | addChildAt(child:DisplayObject, index:int):DisplayObject [override] Adds a child DisplayObject to this Container. | Legend
|  | addElement(element:IVisualElement):IVisualElement Adds a visual element to this container. | Legend
|  | addElementAt(element:IVisualElement, index:int):IVisualElement Adds a visual element to this container. | Legend
|  | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event. | EventDispatcher
|  | addStyleClient(styleClient:IAdvancedStyleClient):void Adds a non-visual style client to this component instance. | UIComponent
|  | 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. | Legend
|  | contentToLocal(point:Point):Point [override] Converts a Point object from content to local coordinates. | Legend
|  | createAutomationIDPart(child:IAutomationObject):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object Returns a set of properties that identify the child within this container. | UIComponent
|  | createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this container. | Legend
|  | createComponentsFromDescriptors(recurse:Boolean = true):void Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one. | Legend
|  | createDeferredContent():void Performs the equivalent action of calling the createComponentsFromDescriptors(true) method for containers that implement the IDeferredContentOwner interface to support deferred instantiation. | Legend
|  | createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Creates an id reference to this IUIComponent object on its parent document object. | UIComponent
|  | deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void Deletes the id reference to this IUIComponent object on its parent document object. | UIComponent
|  | determineTextFormatFromStyles():mx.core:UITextFormat Returns a UITextFormat object corresponding to the text styles for this UIComponent. | UIComponent
|  | dispatchEvent(event:Event):Boolean [override] Dispatches an event into the event flow. | UIComponent
|  | drawFocus(isFocused:Boolean):void Shows or hides the focus indicator around this component. | UIComponent
|  | drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void Programmatically draws a rectangle into this skin's Graphics object. | UIComponent
|  | effectFinished(effectInst:IEffectInstance):void Called by the effect instance when it stops playing on the component. | UIComponent
|  | effectStarted(effectInst:IEffectInstance):void Called by the effect instance when it starts playing on the component. | UIComponent
|  | endEffectsStarted():void Ends all currently playing effects on the component. | UIComponent
|  | executeBindings(recurse:Boolean = false):void [override] Executes all the data bindings on this Container. | Legend
|  | executeChildBindings(recurse:Boolean):void Executes the bindings into this Container's child UIComponent objects. | Legend
|  | finishPrint(obj:Object, target:IFlexDisplayObject):void Called after printing is complete. | UIComponent
|  | getAutomationChildAt(index:int):IAutomationObject Provides the automation object at the specified index. | UIComponent
|  | getAutomationChildren():Array Provides the automation object list . | UIComponent
|  | getBounds(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object. | DisplayObject
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | UIComponent
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | UIComponent
|  | getChildAt(index:int):DisplayObject [override] Gets the nth child component object. | Legend
|  | getChildByName(name:String):DisplayObject [override] Returns the child whose name property is the specified String. | Legend
|  | getChildIndex(child:DisplayObject):int [override] Gets the zero-based index of a specific child. | Legend
|  | getChildren():Array Returns an Array of DisplayObject objects consisting of the content children of the container. | Legend
|  | 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
|  | getElementAt(index:int):IVisualElement Returns the visual element at the specified index. | Legend
|  | getElementIndex(element:IVisualElement):int Returns the index position of a visual element. | Legend
|  | 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
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | UIComponent
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | UIComponent
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | UIComponent
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | UIComponent
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | UIComponent
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | UIComponent
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | UIComponent
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | UIComponent
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | UIComponent
|  | getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | UIComponent
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | UIComponent
|  | getRect(targetCoordinateSpace:DisplayObject):Rectangle Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes. | DisplayObject
|  | getRepeaterItem(whichRepeater:int = -1):Object Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated. | UIComponent
|  | getStyle(styleProp:String):* Gets a style property that has been set anywhere in this component's style lookup chain. | UIComponent
|  | globalToContent(point:Point):Point [override] Converts a Point object from global to content coordinates. | Legend
|  | globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates. | DisplayObject
|  | globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates. | DisplayObject
|  | hasCSSState():Boolean Returns true if currentCSSState is not null. | UIComponent
|  | hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event. | EventDispatcher
|  | hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined. | Object
|  | hasState(stateName:String):Boolean Determines whether the specified state has been defined on this UIComponent. | UIComponent
|  | hitTestObject(obj:DisplayObject):Boolean Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object. | DisplayObject
|  | hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters. | DisplayObject
|  | horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient. | UIComponent
|  | initialize():void Initializes the internal structure of this component. | UIComponent
|  | initializeRepeaterArrays(parent:IRepeaterClient):void Initializes various properties which keep track of repeated instances of this component. | UIComponent
|  | invalidateDisplayList():void Marks a component so that its updateDisplayList() method gets called during a later screen update. | UIComponent
|  | invalidateLayering():void Called by a component's items to indicate that their depth property has changed. | UIComponent
|  | invalidateLayoutDirection():void An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. | UIComponent
|  | invalidateProperties():void Marks a component so that its commitProperties() method gets called during a later screen update. | UIComponent
|  | invalidateSize():void Marks a component so that its measure() method gets called during a later screen update. | UIComponent
|  | isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter. | Object
|  | local3DToGlobal(point3d:Vector3D):Point Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject
|  | localToContent(point:Point):Point [override] Converts a Point object from local to content coordinates. | Legend
|  | localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates. | DisplayObject
|  | matchesCSSState(cssState:String):Boolean Returns true if cssState matches currentCSSState. | UIComponent
|  | matchesCSSType(cssType:String):Boolean Determines whether this instance is the same as, or is a subclass of, the given type. | UIComponent
|  | measureHTMLText(htmlText:String):flash.text:TextLineMetrics Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | measureText(text:String):flash.text:TextLineMetrics Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent. | UIComponent
|  | move(x:Number, y:Number):void Moves the component to a specified position within its parent. | UIComponent
|  | notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void Propagates style changes to the children. | UIComponent
|  | owns(child:DisplayObject):Boolean Returns true if the chain of owner properties points from child to this UIComponent. | UIComponent
|  | parentChanged(p:DisplayObjectContainer):void Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent
|  | prepareToPrint(target:IFlexDisplayObject):Object Prepares an IFlexDisplayObject for printing. | UIComponent
|  | propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable. | Object
|  | regenerateStyleCache(recursive:Boolean):void Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well. | UIComponent
|  | registerEffects(effects:Array):void For each effect event, registers the EffectManager as one of the event listeners. | UIComponent
|  | removeAllChildren():void Removes all children from the child list of this container. | Legend
|  | removeAllElements():void Removes all visual elements from the container. | Legend
|  | removeChild(child:DisplayObject):DisplayObject [override] Removes a child DisplayObject from the child list of this Container. | Legend
|  | removeChildAt(index:int):DisplayObject [override] Removes a child DisplayObject from the child list of this Container at the specified index. | Legend
|  | removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer
|  | removeElement(element:IVisualElement):IVisualElement Removes the specified visual element from the child list of this container. | Legend
|  | removeElementAt(index:int):IVisualElement Removes a visual element from the specified index position in the container. | Legend
|  | removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object. | EventDispatcher
|  | removeStyleClient(styleClient:IAdvancedStyleClient):void Removes a non-visual style client from this component instance. | UIComponent
|  | replayAutomatableEvent(event:Event):Boolean Replays the specified event. | UIComponent
|  | requestSoftKeyboard():Boolean Raises a virtual keyboard. | InteractiveObject
|  | resolveAutomationIDPart(criteria:Object):Array Resolves a child by using the id provided. | UIComponent
|  | resumeBackgroundProcessing():void [static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing(). | UIComponent
|  | setActualSize(w:Number, h:Number):void Sizes the object. | UIComponent
|  | setChildIndex(child:DisplayObject, newIndex:int):void [override] Sets the index of a particular child. | Legend
|  | 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
|  | setElementIndex(element:IVisualElement, index:int):void Changes the position of an existing visual element in the visual container. | Legend
|  | setFocus():void Sets the focus to this component. | UIComponent
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | UIComponent
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | UIComponent
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | UIComponent
|  | setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations. | Object
|  | setStyle(styleProp:String, newValue:*):void Sets a style property on this component instance. | UIComponent
|  | setVisible(value:Boolean, noEvent:Boolean = false):void Called when the visible property changes. | UIComponent
|  | startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite. | Sprite
|  | startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device. | Sprite
|  | stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer
|  | stopDrag():void Ends the startDrag() method. | Sprite
|  | stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite
|  | styleChanged(styleProp:String):void 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
|  | swapElements(element1:IVisualElement, element2:IVisualElement):void Swaps the index of the two specified visual elements. | Legend
|  | swapElementsAt(index1:int, index2:int):void Swaps the visual elements at the two specified index positions in the container. | Legend
|  | toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions. | Object
|  | toString():String [override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application. | FlexSprite
|  | transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIComponent
|  | transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates. | UIComponent
|  | validateDisplayList():void Validates the position and size of children and draws other visuals. | UIComponent
|  | validateNow():void Validate and update the properties and layout of this object and redraw it, if necessary. | UIComponent
|  | validateProperties():void Used by layout logic to validate the properties of a component by calling the commitProperties() method. | UIComponent
|  | validateSize(recursive:Boolean = false):void Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements. | UIComponent
|  | validationResultHandler(event:ValidationResultEvent):void Handles both the valid and invalid events from a validator assigned to this component. | UIComponent
|  | valueOf():Object Returns the primitive value of the specified object. | Object
|  | verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient. | UIComponent
|  | willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | EventDispatcher

Protected Methods
Hide Inherited Protected Methods
Show Inherited Protected Methods

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

Events
Click for more information on events
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | activate | [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher
|  | add | Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent
|  | added | Dispatched when a display object is added to the display list. | DisplayObject
|  | addedToStage | Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject
|  | childAdd | Dispatched after a child has been added to a legend. | Legend
|  | childIndexChange | Dispatched after the index (among the legend children) of a legend child changes. | Legend
|  | childRemove | Dispatched before a child of a legend is removed. | Legend
|  | 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. | Legend
|  | deactivate | [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher
|  | doubleClick | Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject
|  | dragComplete | Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent
|  | dragDrop | Dispatched by the drop target when the user releases the mouse over it. | UIComponent
|  | dragEnter | Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent
|  | dragExit | Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent
|  | dragOver | Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent
|  | dragStart | Dispatched by the drag initiator when starting a drag operation. | UIComponent
|  | effectEnd | Dispatched after an effect ends. | UIComponent
|  | effectStart | Dispatched just before an effect starts. | UIComponent
|  | effectStop | Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent
|  | enterFrame | [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject
|  | enterState | Dispatched after the component has entered a view state. | UIComponent
|  | exitFrame | [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject
|  | exitState | Dispatched just before the component exits a view state. | UIComponent
|  | frameConstructed | [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject
|  | gestureDirectionalTap | Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject
|  | gestureLongPress | Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gesturePan | Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureRotate | Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureSwipe | Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureTap | Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | gestureZoom | Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | hide | Dispatched when an object's state changes from visible to invisible. | UIComponent
|  | imeStartComposition | This event is dispatched to any client app that supports inline input with an IME | InteractiveObject
|  | initialize | Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent
|  | invalid | Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent
|  | itemClick | Dispatched when the user clicks on a LegendItem in the Legend control. | Legend
|  | itemMouseDown | Dispatched when the user presses the mouse button while over a LegendItem in the Legend control. | Legend
|  | itemMouseOut | Dispatched when the user moves the mouse off of a LegendItem in the Legend. | Legend
|  | itemMouseOver | Dispatched when the user moves the mouse over a LegendItem in the Legend control. | Legend
|  | itemMouseUp | Dispatched when the user releases the mouse button while over a LegendItem in the Legend. | Legend
|  | keyDown | Dispatched when the user presses a key. | InteractiveObject
|  | keyFocusChange | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject
|  | keyUp | Dispatched when the user releases a key. | InteractiveObject
|  | middleClick | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | middleMouseDown | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject
|  | middleMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseDownOutside | Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent
|  | mouseFocusChange | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject
|  | mouseMove | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject
|  | mouseOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | mouseOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | mouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | mouseWheel | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject
|  | mouseWheelOutside | Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent
|  | move | Dispatched when the object has moved. | UIComponent
|  | nativeDragComplete | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject
|  | nativeDragDrop | Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject
|  | nativeDragEnter | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject
|  | nativeDragExit | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject
|  | nativeDragOver | Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject
|  | nativeDragStart | Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | nativeDragUpdate | Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject
|  | paste | Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject
|  | preinitialize | Dispatched at the beginning of the component initialization sequence. | UIComponent
|  | proximityBegin | Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject
|  | proximityEnd | Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject
|  | proximityMove | Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject
|  | proximityOut | Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityOver | Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOut | Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject
|  | proximityRollOver | Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject
|  | releaseOutside | Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject
|  | remove | Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent
|  | removed | Dispatched when a display object is about to be removed from the display list. | DisplayObject
|  | removedFromStage | Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject
|  | render | [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject
|  | resize | Dispatched when the component is resized. | UIComponent
|  | rightClick | Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject
|  | rightMouseDown | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rightMouseUp | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject
|  | rollOut | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject
|  | rollOver | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject
|  | selectAll | Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject
|  | show | Dispatched when an object's state changes from invisible to visible. | UIComponent
|  | softKeyboardActivate | Dispatched immediately after the soft keyboard is raised. | InteractiveObject
|  | softKeyboardActivating | Dispatched immediately before the soft keyboard is raised. | InteractiveObject
|  | softKeyboardDeactivate | Dispatched immediately after the soft keyboard is lowered. | InteractiveObject
|  | stateChangeComplete | Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent
|  | stateChangeInterrupted | Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent
|  | tabChildrenChange | Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject
|  | tabEnabledChange | Dispatched when the object's tabEnabled flag changes. | InteractiveObject
|  | tabIndexChange | Dispatched when the value of the object's tabIndex property changes. | InteractiveObject
|  | textInput | Dispatched when a user enters one or more characters of text. | InteractiveObject
|  | toolTipCreate | Dispatched by the component when it is time to create a ToolTip. | UIComponent
|  | toolTipEnd | Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent
|  | toolTipHide | Dispatched by the component when its ToolTip is about to be hidden. | UIComponent
|  | toolTipShow | Dispatched by the component when its ToolTip is about to be shown. | UIComponent
|  | toolTipShown | Dispatched by the component when its ToolTip has been shown. | UIComponent
|  | toolTipStart | Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent
|  | touchBegin | Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchEnd | Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchInteractionEnd | A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStart | A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent
|  | touchInteractionStarting | A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent
|  | touchMove | Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject
|  | touchOut | Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOut | Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchRollOver | Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | touchTap | Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject
|  | updateComplete | Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent
|  | valid | Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent
|  | valueCommit | Dispatched when values are changed programmatically or by user interaction. | UIComponent

Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
Click for more information on styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | backgroundAttachment | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 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"`). The default value is`"scroll"`. | Legend
|  | baseline | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent
|  | borderSkin | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The border skin class of the component. The default value in all components that do not explicitly set their own default for the Halo theme is `mx.skins.halo.HaloBorder` and for the Spark theme is `mx.skins.spark.BorderSkin`. The Panel container has a default value of `mx.skins.halo.PanelSkin` for the Halo theme and `mx.skins.spark.BorderSkin` for the Spark theme. To determine the default value for a component, see the default.css file. | Legend
|  | borderStyle | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Bounding box style. The possible values are `"none"`, `"solid"`, `"inset"`, and `"outset"`. The default value depends on the component class; if not overridden for the class, the default value is `"inset"`. The default value for most Containers is `"none"`. The `"inset"` and `"outset"` values are only valid with the halo theme. | Legend
|  | bottom | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent
|  | color | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label. The default value is`0x0B333C`. | Legend
|  | disabledColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled. The default value is`0xAAB3B3`. | Legend
|  | disabledOverlayAlpha | Type: Number CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The alpha value for the overlay that is placed on top of the container when it is disabled. | Legend
|  | errorColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent
|  | fontAntiAliasType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `antiAliasType` property of internal TextFields. The possible values are `"normal"` (`flash.text.AntiAliasType.NORMAL`) and `"advanced"` (`flash.text.AntiAliasType.ADVANCED`).

The default value is `"advanced"`, which enables advanced anti-aliasing if you are using an embedded advanced anti-aliasing font. Set to `"normal"` to disable advanced anti-aliasing.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is`"advanced"`.

Related API Elements

flash.text.TextField
flash.text.AntiAliasType
Legend
|  | fontFamily | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is`"Verdana"`. | Legend
|  | fontGridFitType | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `gridFitType` property of internal TextFields that represent text in Flex controls. The possible values are `"none"` (`flash.text.GridFitType.NONE`), `"pixel"` (`flash.text.GridFitType.PIXEL`), and `"subpixel"` (`flash.text.GridFitType.SUBPIXEL`).

This property only applies when you are using an embedded advanced anti-aliasing font and the `fontAntiAliasType` property is set to `"advanced"`.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is`"pixel"`.

Related API Elements

flash.text.TextField
flash.text.GridFitType
Legend
|  | fontSharpness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `sharpness` property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded advanced anti-aliasing font and the `fontAntiAliasType` property is set to `"advanced"`.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is`0`.

Related API Elements

flash.text.TextField
Legend
|  | fontSize | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. | Legend
|  | fontStyle | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font. Recognized values are `"normal"` and `"italic"`. The default value is`"normal"`. | Legend
|  | fontThickness | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the `thickness` property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded advanced anti-aliasing font and the `fontAntiAliasType` property is set to `"advanced"`.

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is`0`.

Related API Elements

flash.text.TextField
Legend
|  | fontWeight | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface. Recognized values are `"normal"` and `"bold"`. For Button controls, the default is `"bold"`. The default value is`"normal"`. | Legend
|  | horizontalAlign | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Horizontal alignment of each child inside its tile cell. Possible values are `"left"`, `"center"`, and `"right"`. If the value is `"left"`, the left edge of each child is at the left edge of its cell. If the value is `"center"`, each child is centered horizontally within its cell. If the value is `"right"`, the right edge of each child is at the right edge of its cell. The default value is`"left"`. | Legend
|  | horizontalCenter | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | horizontalGap | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between children in the horizontal direction. The default value depends on the component class; if not overriden for the class, the default value is 8. | Legend
|  | interactionMode | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent
|  | kerning | Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled (`true`) or disabled (`false`). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded advanced anti-aliasing fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is`false`. | Legend
|  | labelPlacement | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the label placement of the legend element. Valid values are `"top"`, `"bottom"`, `"right"`, and `"left"`. | Legend
|  | layoutDirection | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent
|  | left | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent
|  | letterSpacing | Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is`0`. | Legend
|  | locale | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The locale of the text displayed by this component. FTE and TLF use this locale to map Unicode characters to font glyphs and to find fallback fonts.

Note: This style only applies when an MX component specifies UIFTETextField as its `textFieldClass`.

The default value is`"en"`.
Legend
|  | markerHeight | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the height of the legend element. | Legend
|  | markerWidth | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the width of the legend element. | Legend
|  | paddingBottom | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the legend's bottom border and the bottom of its content area. The default value is`0`. | Legend
|  | paddingLeft | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the control's left border and the left edge of its content area. The default value is`2`. | Legend
|  | paddingRight | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the control's right border and the right edge of its content area. The default value is`0`. | Legend
|  | paddingTop | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the legend's top border and the top of its content area. The default value is`0`. | Legend
|  | right | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent
|  | showErrorSkin | Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent
|  | showErrorTip | Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent
|  | stroke | Type: Object CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the line stroke for the legend element. | Legend
|  | textAlign | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container. Possible values are `"left"`, `"right"`, or `"center"`. The default value for most controls is `left`. For the Button, LinkButton, and AccordionHeader components, the default value is `"center"`. For these components, this property is only recognized when the `labelPlacement` property is set to `"left"` or `"right"`. If `labelPlacement` is set to `"top"` or `"bottom"`, the text and any icon are centered. | Legend
|  | textDecoration | Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined. Possible values are `"none"` and `"underline"`. The default value is`"none"`. | Legend
|  | textFieldClass | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The class implementing IUITextField that is used by this component to render text. It can be set to either the mx.core.UITextField class (to use the classic TextField class built into Flash Player) or the mx.core.UIFTETextField class (to use the Text Layout Framework to get improved text rendering, including bidirectional layout). The default value is`mx.core.UITextField`. | Legend
|  | textIndent | Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. The default value is`0`. | Legend
|  | top | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent
|  | verticalAlign | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Vertical alignment of each child inside its tile cell. Possible values are `"top"`, `"middle"`, and `"bottom"`. If the value is `"top"`, the top edge of each child is at the top edge of its cell. If the value is `"middle"`, each child is centered vertically within its cell. If the value is `"bottom"`, the bottom edge of each child is at the bottom edge of its cell. The default value is`"top"`. | Legend
|  | verticalCenter | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent
|  | verticalGap | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between children in the vertical direction. The default value depends on the component class; if not overriden for the class, the default value is 6. | Legend

Spark Theme Styles
Click for more information on styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | accentColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Accent color used by component skins. The default button skin uses this color to tint the background. Slider track highlighting uses this color. The default value is`#0099FF`. | Legend
|  | backgroundAlpha | Type: Number CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. Valid values range from 0.0 to 1.0. For most controls, the default value is 1.0, but for ToolTip controls, the default value is 0.95 and for Alert controls, the default value is 0.9. The default value is`1.0`. | Legend
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Background color of a component. You can have both a `backgroundColor` and a `backgroundImage` set. Some components do not have a background. The DataGrid control ignores this style. The default value is `undefined`, which means it is not set. If both this style and the `backgroundImage` style are `undefined`, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's `fillAlphas` property to 1, as the following example shows:

          <mx:Container backgroundColor="0x66CC66"/>
              <mx:ControlName ... fillAlphas="[1,1]"/>
          </mx:Container>

Legend
|  | borderAlpha | Type: Number CSS Inheritance: No Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Alpha of the border. The default value is`1`. | Legend
|  | borderColor | Type: uint Format: Color CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the border. The default value depends on the component class; if not overridden for the class, the default value is `0xB7BABC` for the Halo theme and `0x696969` for the Spark theme. | Legend
|  | borderVisible | Type: Boolean CSS Inheritance: No Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Visibility of the border. The default value is`true`. | Legend
|  | chromeColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The main color for a component. | UIComponent
|  | contentBackgroundAlpha | Type: Number CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The alpha of the content background for this component. | Legend
|  | contentBackgroundColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of the content area of the component. The default value is`0xFFFFFF`. | Legend
|  | cornerRadius | Type: Number Format: Length CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Radius of component corners. The default value depends on the component class; if not overridden for the class, the default value is 0. The default value for ApplicationControlBar is 5. | Legend
|  | dropShadowVisible | Type: Boolean CSS Inheritance: No Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Boolean property that specifies whether the component has a visible drop shadow. The default value is `false`.

Note: For drop shadows to appear on containers, set `contentBackgroundColor` property. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

Legend
|  | focusColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of focus ring when the component is in focus The default value is`0x70B2EE`. | Legend
|  | symbolColor | Type: uint Format: Color CSS Inheritance: Yes Theme: spark Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 Color of any symbol of a component. Examples include the check mark of a CheckBox or the arrow of a ScrollBar button. The default value is`0x000000`. | Legend

Halo Theme Styles
Click for more information on styles
Hide Inherited Styles
Show Inherited Styles

| Style | Description | Defined By
--- | --- | --- | ---
|  | backgroundAlpha | Type: Number CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alpha level of the color defined by the `backgroundColor` property, of the image or SWF file defined by the `backgroundImage` style. Valid values range from 0.0 to 1.0. For most controls, the default value is 1.0, but for ToolTip controls, the default value is 0.95 and for Alert controls, the default value is 0.9. The default value is`1.0`. | Legend
|  | backgroundColor | Type: uint Format: Color CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Background color of a component. You can have both a `backgroundColor` and a `backgroundImage` set. Some components do not have a background. The DataGrid control ignores this style. The default value is `undefined`, which means it is not set. If both this style and the `backgroundImage` style are `undefined`, the component has a transparent background.

For the Application container, this style specifies the background color while the application loads, and a background gradient while it is running. Flex calculates the gradient pattern between a color slightly darker than the specified color, and a color slightly lighter than the specified color.

The default skins of most Flex controls are partially transparent. As a result, the background color of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's `fillAlphas` property to 1, as the following example shows:

          <mx:Container backgroundColor="0x66CC66"/>
              <mx:ControlName ... fillAlphas="[1,1]"/>
          </mx:Container>

Legend
|  | backgroundDisabledColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Background color of the component when it is disabled. The global default value is `undefined`. The default value for List controls is `0xDDDDDD` (light gray). If a container is disabled, the background is dimmed, and the degree of dimming is controlled by the `disabledOverlayAlpha` style. | Legend
|  | backgroundImage | Type: Object Format: File CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Background image of a component. This can be an absolute or relative URL or class. You can set either the `backgroundColor` or the `backgroundImage`. The background image is displayed on top of the background color. The default value is `undefined`, meaning "not set". If this style and the `backgroundColor` style are undefined, the component has a transparent background.

The default skins of most Flex controls are partially transparent. As a result, the background image of a container partially "bleeds through" to controls that are in that container. You can avoid this by setting the alpha values of the control's `fillAlphas` property to 1, as the following example shows:

      <mx:Container backgroundColor="0x66CC66"/>
          <mx:ControlName ... fillAlphas="[1,1]"/>
      </mx:Container>

Legend
|  | backgroundSize | Type: String CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Scales the image specified by `backgroundImage` to different percentage sizes. A value of `"100%"` stretches the image to fit the entire component. To specify a percentage value, you must include the percent sign (%). The default for the Application container is `100%`. The default value for all other containers is `auto`, which maintains the original size of the image. | Legend
|  | barColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines the color of a ProgressBar. A ProgressBar is filled with a vertical gradient between this color and a brighter color computed from it. This style has no effect on other components, but can be set on a container to control the appearance of all progress bars found within. The default value is `undefined`, which means it is not set. In this case, the `themeColor` style property is used. | Legend
|  | borderColor | Type: uint Format: Color CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the border. The default value depends on the component class; if not overridden for the class, the default value is `0xB7BABC` for the Halo theme and `0x696969` for the Spark theme. | Legend
|  | borderSides | Type: String CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Bounding box sides. A space-delimited String that specifies the sides of the border to show. The String can contain `"left"`, `"top"`, `"right"`, and `"bottom"` in any order. The default value is `"left top right bottom"`, which shows all four sides. This style is only used when borderStyle is `"solid"`. | Legend
|  | borderThickness | Type: Number Format: Length CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Bounding box thickness. Only used when `borderStyle` is set to `"solid"`. The default value is`1`. | Legend
|  | cornerRadius | Type: Number Format: Length CSS Inheritance: No Theme: halo, spark Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Radius of component corners. The default value depends on the component class; if not overridden for the class, the default value is 0. The default value for ApplicationControlBar is 5. | Legend
|  | dropShadowColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the drop shadow. The default value is`0x000000`. | Legend
|  | dropShadowEnabled | Type: Boolean CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Boolean property that specifies whether the component has a visible drop shadow. This style is used with `borderStyle="solid"`. The default value is `false`.

Note: For drop shadows to appear on containers, set `backgroundColor` or `backgroundImage` properties. Otherwise, the shadow appears behind the container because the default background of a container is transparent.

Legend
|  | shadowDirection | Type: String CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Direction of the drop shadow. Possible values are `"left"`, `"center"`, and `"right"`. The default value is`"center"`. | Legend
|  | shadowDistance | Type: Number Format: Length CSS Inheritance: No Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Distance of the drop shadow. If the property is set to a negative value, the shadow appears above the component. The default value is`2`. | Legend
|  | themeColor | Type: uint Format: Color CSS Inheritance: Yes Theme: halo Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Theme color of a component. | UIComponent

Effects
Click for more information on effects
Hide Inherited Effects
Show Inherited Effects

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

Property Detail

### actualCreationPolicy

property

`protected var actualCreationPolicy:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The creation policy of this container.

### autoLayout

property

`autoLayout:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

If `true`, measurement and layout are done when the position or size of a child is changed. If `false`, measurement and layout are done only once, when children are added to or removed from the container.

When using the Move effect, the layout around the component that is moving does not readjust to fit that the Move effect animates. Setting a container's `autoLayout` property to `true` has no effect on this behavior.

The Zoom effect does not work when the `autoLayout` property is `false`.

The `autoLayout` property does not apply to Accordion or ViewStack containers.

The default value is `true.`

Implementation
`public function get autoLayout():Boolean`
`public function set autoLayout(value:Boolean):void`

### borderMetrics

property

`borderMetrics:EdgeMetrics` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an EdgeMetrics object that has four properties: `left`, `top`, `right`, and `bottom`. The value of each property is equal to the thickness of one side of the border, expressed in pixels.

Unlike `viewMetrics`, this property is not overridden by subclasses of Container.

Implementation
`public function get borderMetrics():EdgeMetrics`

### childDescriptors

property

`childDescriptors:Array`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Array of UIComponentDescriptor objects produced by the MXML compiler.

Each UIComponentDescriptor object contains the information specified in one child MXML tag of the container's MXML tag. The order of the UIComponentDescriptor objects in the Array is the same as the order of the child tags. During initialization, the child descriptors are used to create the container's child UIComponent objects and its Repeater objects, and to give them the initial property values, event handlers, effects, and so on, that were specified in MXML.

Implementation
`public function get childDescriptors():Array`
`public function set childDescriptors(value:Array):void`

Related API Elements

mx.core.UIComponentDescriptor

### clipContent

property

`clipContent:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container. If `false`, the children of this container remain visible when they are moved or sized outside the borders of this container. If `true`, the children of this container are clipped.

If `clipContent` is `false`, then scrolling is disabled for this container and scrollbars will not appear. If `clipContent` is true, then scrollbars will usually appear when the container's children extend outside the border of the container. For additional control over the appearance of scrollbars, see `horizontalScrollPolicy` and `verticalScrollPolicy`.

The default value is `true.`

Implementation
`public function get clipContent():Boolean`
`public function set clipContent(value:Boolean):void`

### contentMouseX

property

`contentMouseX:Number` [read-only] [override]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the x position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.

Implementation
`override public function get contentMouseX():Number`

### contentMouseY

property

`contentMouseY:Number` [read-only] [override]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the y position of the mouse, in the content coordinate system. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component.

Implementation
`override public function get contentMouseY():Number`

### creatingContentPane

property

`creatingContentPane:Boolean`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Containers use an internal content pane to control scrolling. The `creatingContentPane` is `true` while the container is creating the content pane so that some events can be ignored or blocked.

Implementation
`public function get creatingContentPane():Boolean`
`public function set creatingContentPane(value:Boolean):void`

### creationIndex

property

`creationIndex:int`
Deprecated: Deprecated

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Specifies the order to instantiate and draw the children of the container.

This property can only be used when the `creationPolicy` property is set to `ContainerCreationPolicy.QUEUED`. Otherwise, it is ignored.

The default value is `-1.`

Implementation
`public function get creationIndex():int`
`public function set creationIndex(value:int):void`

### creationPolicy

property

`creationPolicy:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The child creation policy for this MX Container. ActionScript values can be `ContainerCreationPolicy.AUTO`, `ContainerCreationPolicy.ALL`, or `ContainerCreationPolicy.NONE`. MXML values can be `auto`, `all`, or `none`.

If no `creationPolicy` is specified for a container, that container inherits its parent's `creationPolicy`. If no `creationPolicy` is specified for the Application, it defaults to `ContainerCreationPolicy.AUTO`.

A `creationPolicy` of `ContainerCreationPolicy.AUTO` means that the container delays creating some or all descendants until they are needed, a process which is known as deferred instantiation. This policy produces the best startup time because fewer UIComponents are created initially. However, this introduces navigation delays when a user navigates to other parts of the application for the first time. Navigator containers such as Accordion, TabNavigator, and ViewStack implement the `ContainerCreationPolicy.AUTO` policy by creating all their children immediately, but wait to create the deeper descendants of a child until it becomes the selected child of the navigator container.

A `creationPolicy` of `ContainerCreationPolicy.ALL` means that the navigator containers immediately create deeper descendants for each child, rather than waiting until that child is selected. For single-view containers such as a VBox container, there is no difference between the `ContainerCreationPolicy.AUTO` and `ContainerCreationPolicy.ALL` policies.

A `creationPolicy` of `ContainerCreationPolicy.NONE` means that the container creates none of its children. In that case, it is the responsibility of the MXML author to create the children by calling the `createComponentsFromDescriptors()` method.

The default value is `ContainerCreationPolicy.AUTO.`

Implementation
`public function get creationPolicy():String`
`public function set creationPolicy(value:String):void`

### data

property

`data:Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The `data` property lets you pass a value to the component when you use it in an item renderer or item editor. You typically use data binding to bind a field of the `data` property to a property of this component.

You do not set this property in MXML.

The default value is `null.`

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

Implementation
`public function get data():Object`
`public function set data(value:Object):void`

Related API Elements

mx.core.IDataRenderer

### dataProvider

property

`dataProvider:Object`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Set of data to be used in the Legend.

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

Implementation
`public function get dataProvider():Object`
`public function set dataProvider(value:Object):void`

### deferredContentCreated

property

`deferredContentCreated:Boolean` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

IDeferredContentOwner equivalent of processedDescriptors

Implementation
`public function get deferredContentCreated():Boolean`

Related API Elements

UIComponent.processedDescriptors

### direction

property

`direction:String`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Determines how children are placed in the container. Possible MXML values are `"horizontal"` and `"vertical"`. In ActionScript, you can set the direction using the values TileDirection.HORIZONTAL or TileDirection.VERTICAL. The default value is `"horizontal"`. (If the container is a Legend container, which is a subclass of Tile, the default value is `"vertical"`.)

The first child is always placed at the upper-left of the Tile container. If the `direction` is `"horizontal"`, the children are placed left-to-right in the topmost row, and then left-to-right in the second row, and so on. If the value is `"vertical"`, the children are placed top-to-bottom in the leftmost column, and then top-to-bottom in the second column, and so on.

The default value is `"horizontal".`

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

Implementation
`public function get direction():String`
`public function set direction(value:String):void`

Related API Elements

TileDirection

### horizontalScrollPosition

property

`horizontalScrollPosition:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The current position of the horizontal scroll bar. This is equal to the distance in pixels between the left edge of the scrollable surface and the leftmost piece of the surface that is currently visible.

The default value is `0.`

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

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

### legendItemClass

property

`public var legendItemClass:Class`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The class used to instantiate LegendItem objects. When a legend's content is derived from the chart or data, it instantiates one instance of `legendItemClass` for each item described by the `dataProvider`. If you want custom behavior in your legend items, you can assign a subclass of LegendItem to this property to have the Legend create instances of their derived type instead.

### maxHorizontalScrollPosition

property

`maxHorizontalScrollPosition:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The largest possible value for the `horizontalScrollPosition` property. Defaults to 0 if the horizontal scrollbar is not present.

Implementation
`public function get maxHorizontalScrollPosition():Number`

### maxVerticalScrollPosition

property

`maxVerticalScrollPosition:Number` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The largest possible value for the `verticalScrollPosition` property. Defaults to 0 if the vertical scrollbar is not present.

Implementation
`public function get maxVerticalScrollPosition():Number`

### numChildren

property

`numChildren:int` [read-only] [override]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Number of child components in this container.

The number of children is initially equal to the number of children declared in MXML. At runtime, new children may be added by calling `addChild()` or `addChildAt()`, and existing children may be removed by calling `removeChild()`, `removeChildAt()`, or `removeAllChildren()`.

Implementation
`override public function get numChildren():int`

### numElements

property

`numElements:int` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

The number of visual elements in this container. Visual elements include classes that implement the IVisualElement interface, such as subclasses of UIComponent and GraphicElement.

Implementation
`public function get numElements():int`

### rawChildren

property

`rawChildren:IChildList` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

A container typically contains child components, which can be enumerated using the `Container.getChildAt()` method and `Container.numChildren` property. In addition, the container may contain style elements and skins, such as the border and background. Flash Player and AIR do not draw any distinction between child components and skins. They are all accessible using the player's `getChildAt()` method and `numChildren` property. However, the Container class overrides the `getChildAt()` method and `numChildren` property (and several other methods) to create the illusion that the container's children are the only child components.

If you need to access all of the children of the container (both the content children and the skins), then use the methods and properties on the `rawChildren` property instead of the regular Container methods. For example, use the `Container.rawChildren.getChildAt())` method. However, if a container creates a ContentPane Sprite object for its children, the `rawChildren` property value only counts the ContentPane, not the container's children. It is not always possible to determine when a container will have a ContentPane.

Note:If you call the `addChild` or `addChildAt` method of the `rawChildren` object, set `tabFocusEnabled = false` on the component that you have added. Doing so prevents users from tabbing to the visual-only component that you have added.

Implementation
`public function get rawChildren():IChildList`

### verticalScrollPosition

property

`verticalScrollPosition:Number`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

The current position of the vertical scroll bar. This is equal to the distance in pixels between the top edge of the scrollable surface and the topmost piece of the surface that is currently visible.

The default value is `0.`

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

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

### viewMetrics

property

`viewMetrics:EdgeMetrics` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an object that has four properties: `left`, `top`, `right`, and `bottom`. The value of each property equals the thickness of the chrome (visual elements) around the edge of the container.

The chrome includes the border thickness. If the `horizontalScrollPolicy` or `verticalScrollPolicy` property value is `ScrollPolicy.ON`, the chrome also includes the thickness of the corresponding scroll bar. If a scroll policy is `ScrollPolicy.AUTO`, the chrome measurement does not include the scroll bar thickness, even if a scroll bar is displayed.

Subclasses of Container should override this method, so that they include other chrome to be taken into account when positioning the Container's children. For example, the `viewMetrics` property for the Panel class should return an object whose `top` property includes the thickness of the Panel container's title bar.

Implementation
`public function get viewMetrics():EdgeMetrics`

### viewMetricsAndPadding

property

`viewMetricsAndPadding:EdgeMetrics` [read-only]

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an object that has four properties: `left`, `top`, `right`, and `bottom`. The value of each property is equal to the thickness of the chrome (visual elements) around the edge of the container plus the thickness of the object's margins.

The chrome includes the border thickness. If the `horizontalScrollPolicy` or `verticalScrollPolicy` property value is `ScrollPolicy.ON`, the chrome also includes the thickness of the corresponding scroll bar. If a scroll policy is `ScrollPolicy.AUTO`, the chrome measurement does not include the scroll bar thickness, even if a scroll bar is displayed.

Implementation
`public function get viewMetricsAndPadding():EdgeMetrics`
Constructor Detail

### Legend

()
Constructor

`public function Legend()`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Constructor.

Method Detail

### addChild

()
method

`override public function addChild(child:DisplayObject):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Adds a child DisplayObject to this Container. The child is added after other existing children, so that the first child added has index 0, the next has index 1, an so on.

Note: While the `child` argument to the method is specified as of type DisplayObject, the argument must implement the IUIComponent interface to be added as a child of a container. All Flex components implement this interface.

Children are layered from back to front. In other words, if children overlap, the one with index 0 is farthest to the back, and the one with index `numChildren - 1` is frontmost. This means the newly added children are layered in front of existing children.

Parameters

| `child:DisplayObject` — The DisplayObject to add as a child of this Container. It must implement the IUIComponent interface.

Returns

| `DisplayObject` — The added child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of the added component.

Related API Elements

mx.core.IUIComponent

### addChildAt

()
method

`override public function addChildAt(child:DisplayObject, index:int):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Adds a child DisplayObject to this Container. The child is added at the index specified.

Note: While the `child` argument to the method is specified as of type DisplayObject, the argument must implement the IUIComponent interface to be added as a child of a container. All Flex components implement this interface.

Children are layered from back to front. In other words, if children overlap, the one with index 0 is farthest to the back, and the one with index `numChildren - 1` is frontmost. This means the newly added children are layered in front of existing children.

When you add a new child at an index that is already occupied by an old child, it doesn't replace the old child; instead the old child and the ones after it "slide over" and have their index incremented by one. For example, suppose a Container contains the children (A, B, C) and you add D at index 1. Then the container will contain (A, D, B, C). If you want to replace an old child, you must first remove it before adding the new one.

Parameters

| `child:DisplayObject` — The DisplayObject to add as a child of this Container. It must implement the IUIComponent interface.
| `index:int` — The index to add the child at.

Returns

| `DisplayObject` — The added child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of the added component.

Related API Elements

mx.core.IUIComponent

### addElement

()
method

`public function addElement(element:IVisualElement):IVisualElement`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Adds a visual element to this container. The element is added after all other elements and appears top of all other elements. To add a visual element to a specific index position, use the `addElementAt()` method.

If you add a visual element that already has a different container as a parent, the element is removed from the other container.

Parameters

| `element:IVisualElement` — The visual element to add as a child of this container.

Returns

| `IVisualElement` — The element that was added.

### addElementAt

()
method

`public function addElementAt(element:IVisualElement, index:int):IVisualElement`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Adds a visual element to this container. The element is added at the index position specified. An index of 0 represents the first element in the display list.

If you add a visual element that already has a different container as a parent, the element is removed from the other container.

Parameters

| `element:IVisualElement` — The element to add as a child of this visual container.
| `index:int` — The index position to which the element is added. If you specify a currently occupied index position, the child that exists at that position and all higher positions are moved up one position in the child list.

Returns

| `IVisualElement` — The element that was added.

### attachOverlay

()
method

`override protected function attachOverlay():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Used internally by the Dissolve Effect to add the overlay to the chrome of a container.

### contentToGlobal

()
method

`override public function contentToGlobal(point:Point):Point`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a `Point` object from content coordinates to global coordinates. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning. Global coordinates specify a pixel position relative to the upper-left corner of the stage, that is, the outermost edge of the application.

Parameters

| `point:Point` — A Point object that specifies the x and y coordinates in the content coordinate system as properties.

Returns

| `Point` — A Point object with coordinates relative to the Stage.

### contentToLocal

()
method

`override public function contentToLocal(point:Point):Point`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a `Point` object from content to local coordinates. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning. Local coordinates specify a pixel position relative to the upper left corner of the component.

Parameters

| `point:Point` — A Point object that specifies the x and y coordinates in the content coordinate system as properties.

Returns

| `Point` — Point A Point object with coordinates relative to the local coordinate system.

### createBorder

()
method

`protected function createBorder():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Creates the container's border skin if it is needed and does not already exist.

### createComponentFromDescriptor

()
method

`public function createComponentFromDescriptor(descriptor:ComponentDescriptor, recurse:Boolean):IFlexDisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this container.

This method instantiates the new object but does not add it to the display list, so the object does not appear on the screen by default. To add the new object to the display list, call the `validateNow()` method on the container after calling the `createComponentFromDescriptor()` method, as the following example shows:

              myVBox.createComponentFromDescriptor(myVBox.childDescriptors[0],false);
              myVBox.validateNow();

Alternatively, you can call the `createComponentsFromDescriptors()` method on the container to create all components at one time. You are not required to call the `validateNow()` method after calling the `createComponentsFromDescriptors()` method.

Parameters

| `descriptor:ComponentDescriptor` — The UIComponentDescriptor for the component to be created. This argument is either a UIComponentDescriptor object or the index of one of the container's children (an integer between 0 and n-1, where n is the total number of children of this container).
| `recurse:Boolean` — If `false`, create this component but none of its children. If `true`, after creating the component, Flex calls the `createComponentsFromDescriptors()` method to create all or some of its children, based on the value of the component's `creationPolicy` property.

Returns

| `IFlexDisplayObject` — The component that is created.

Related API Elements

mx.core.UIComponentDescriptor

### createComponentsFromDescriptors

()
method

`public function createComponentsFromDescriptors(recurse:Boolean = true):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Iterate through the Array of `childDescriptors`, and call the `createComponentFromDescriptor()` method for each one.

If the value of the container's `creationPolicy` property is `ContainerCreationPolicy.ALL`, then this method is called automatically during the initialization sequence.

If the value of the container's `creationPolicy` is `ContainerCreationPolicy.AUTO`, then this method is called automatically when the container's children are about to become visible.

If the value of the container's `creationPolicy` property is `ContainerCreationPolicy.NONE`, then you should call this function when you want to create this container's children.

Parameters

| `recurse:Boolean` (default = `true`)`` — If `true`, recursively create components.

### createDeferredContent

()
method

`public function createDeferredContent():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Performs the equivalent action of calling the `createComponentsFromDescriptors(true)` method for containers that implement the IDeferredContentOwner interface to support deferred instantiation.

Related API Elements

createComponentsFromDescriptors()

### executeBindings

()
method

`override public function executeBindings(recurse:Boolean = false):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Executes all the data bindings on this Container. Flex calls this method automatically once a Container has been created to cause any data bindings that have destinations inside of it to execute. Workaround for MXML container/bindings problem (177074): override Container.executeBindings() to prefer descriptor.document over parentDocument in the call to BindingManager.executeBindings(). This should always provide the correct behavior for instances created by descriptor, and will provide the original behavior for procedurally-created instances. (The bug may or may not appear in the latter case.) A more complete fix, guaranteeing correct behavior in both non-DI and reparented-component scenarios, is anticipated for updater 1.

Parameters

| `recurse:Boolean` (default = `false`)`` — If `false`, then only execute the bindings on this Container. If `true`, then also execute the bindings on this container's children, grandchildren, great-grandchildren, and so on.

### executeChildBindings

()
method

`public function executeChildBindings(recurse:Boolean):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Executes the bindings into this Container's child UIComponent objects. Flex calls this method automatically once a Container has been created.

Parameters

| `recurse:Boolean` — If `false`, then only execute the bindings on the immediate children of this Container. If `true`, then also execute the bindings on this container's grandchildren, great-grandchildren, and so on.

### getChildAt

()
method

`override public function getChildAt(index:int):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Gets the nth child component object.

The children returned from this method include children that are declared in MXML and children that are added using the `addChild()` or `addChildAt()` method.

Parameters

| `index:int` — Number from 0 to (numChildren - 1).

Returns

| `DisplayObject` — Reference to the child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of a specific Flex control, such as ComboBox or TextArea.

### getChildByName

()
method

`override public function getChildByName(name:String):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns the child whose `name` property is the specified String.

Parameters

| `name:String` — The identifier of the child.

Returns

| `DisplayObject` — The DisplayObject representing the child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of a specific Flex control, such as ComboBox or TextArea. Throws a run-time error if the child of the specified name does not exist.

### getChildIndex

()
method

`override public function getChildIndex(child:DisplayObject):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Gets the zero-based index of a specific child.

The first child of the container (i.e.: the first child tag that appears in the MXML declaration) has an index of 0, the second child has an index of 1, and so on. The indexes of a container's children determine the order in which they get laid out. For example, in a VBox the child with index 0 is at the top, the child with index 1 is below it, etc.

If you add a child by calling the `addChild()` method, the new child's index is equal to the largest index among existing children plus one. You can insert a child at a specified index by using the `addChildAt()` method; in that case the indices of the child previously at that index, and the children at higher indices, all have their index increased by 1 so that all indices fall in the range from 0 to `(numChildren - 1)`.

If you remove a child by calling `removeChild()` or `removeChildAt()` method, then the indices of the remaining children are adjusted so that all indices fall in the range from 0 to `(numChildren - 1)`.

If `myView.getChildIndex(myChild)` returns 5, then `myView.getChildAt(5)` returns myChild.

The index of a child may be changed by calling the `setChildIndex()` method.

Parameters

| `child:DisplayObject` — Reference to child whose index to get.

Returns

| `int` — Number between 0 and (numChildren - 1).

### getChildren

()
method

`public function getChildren():Array`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Returns an Array of DisplayObject objects consisting of the content children of the container. This array does not include the DisplayObjects that implement the container's display elements, such as its border and the background image.

Returns

| `Array` — Array of DisplayObject objects consisting of the content children of the container.

Related API Elements

rawChildren

### getElementAt

()
method

`public function getElementAt(index:int):IVisualElement`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the visual element at the specified index.

Parameters

| `index:int` — The index of the element to retrieve.

Returns

| `IVisualElement` — The element at the specified index.

### getElementIndex

()
method

`public function getElementIndex(element:IVisualElement):int`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Returns the index position of a visual element.

Parameters

| `element:IVisualElement` — The visual element.

Returns

| `int` — The index position of the element in the container.

### globalToContent

()
method

`override public function globalToContent(point:Point):Point`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a `Point` object from global to content coordinates. Global coordinates specify a pixel position relative to the upper-left corner of the stage, that is, the outermost edge of the application. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning.

Parameters

| `point:Point` — A Point object that specifies the x and y coordinates in the global (Stage) coordinate system as properties.

Returns

| `Point` — Point A Point object with coordinates relative to the component.

### layoutChrome

()
method

`protected function layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Respond to size changes by setting the positions and sizes of this container's borders. This is an advanced method that you might override when creating a subclass of Container.

Flex calls the `layoutChrome()` method when the container is added to a parent container using the `addChild()` method, and when the container's `invalidateDisplayList()` method is called.

The `Container.layoutChrome()` method is called regardless of the value of the `autoLayout` property.

The `Container.layoutChrome()` method sets the position and size of the Container container's border. In every subclass of Container, the subclass's `layoutChrome()` method should call the `super.layoutChrome()` method, so that the border is positioned properly.

Parameters

| `unscaledWidth:Number` — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleX` property of the component.
| `unscaledHeight:Number` — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleY` property of the component.

### localToContent

()
method

`override public function localToContent(point:Point):Point`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Converts a `Point` object from local to content coordinates. Local coordinates specify a pixel position relative to the upper left corner of the component. Content coordinates specify a pixel position relative to the upper left corner of the component's content, and include all of the component's content area, including any regions that are currently clipped and must be accessed by scrolling the component. You use the content coordinate system to set and get the positions of children of a container that uses absolute positioning.

Parameters

| `point:Point` — A Point object that specifies the x and y coordinates in the local coordinate system as properties.

Returns

| `Point` — Point A Point object with coordinates relative to the content coordinate system.

### removeAllChildren

()
method

`public function removeAllChildren():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes all children from the child list of this container.

### removeAllElements

()
method

`public function removeAllElements():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Removes all visual elements from the container.

### removeChild

()
method

`override public function removeChild(child:DisplayObject):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes a child DisplayObject from the child list of this Container. The removed child will have its `parent` property set to null. The child will still exist unless explicitly destroyed. If you add it to another container, it will retain its last known state.

Parameters

| `child:DisplayObject` — The DisplayObject to remove.

Returns

| `DisplayObject` — The removed child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of the removed component.

### removeChildAt

()
method

`override public function removeChildAt(index:int):DisplayObject`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Removes a child DisplayObject from the child list of this Container at the specified index. The removed child will have its `parent` property set to null. The child will still exist unless explicitly destroyed. If you add it to another container, it will retain its last known state.

Parameters

| `index:int` — The child index of the DisplayObject to remove.

Returns

| `DisplayObject` — The removed child as an object of type DisplayObject. You typically cast the return value to UIComponent, or to the type of the removed component.

### removeElement

()
method

`public function removeElement(element:IVisualElement):IVisualElement`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Removes the specified visual element from the child list of this container. The index positions of any elements above the element in this visual container are decreased by 1.

Parameters

| `element:IVisualElement` — The element to be removed from the container.

Returns

| `IVisualElement` — The element removed.

### removeElementAt

()
method

`public function removeElementAt(index:int):IVisualElement`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Removes a visual element from the specified index position in the container. The index positions of any elements above the element in this visual container are decreased by 1.

Parameters

| `index:int` — The index of the element to remove.

Returns

| `IVisualElement` — The element removed.

### scrollChildren

()
method

`protected function scrollChildren():void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties. Content that doesn't appear in the viewable area gets clipped. This method should be overridden by subclasses that have scrollable chrome in the content area.

### setChildIndex

()
method

`override public function setChildIndex(child:DisplayObject, newIndex:int):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Sets the index of a particular child. See the `getChildIndex()` method for a description of the child's index.

Parameters

| `child:DisplayObject` — Reference to child whose index to set.
| `newIndex:int` — Number that indicates the new index. Must be an integer between 0 and (numChildren - 1).

### setElementIndex

()
method

`public function setElementIndex(element:IVisualElement, index:int):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Changes the position of an existing visual element in the visual container.

When you call the `setElementIndex()` method and specify an index position that is already occupied, the only positions that change are those in between the elements's former and new position. All others stay the same.

If a visual element is moved to an index lower than its current index, the index of all elements in between increases by 1. If an element is moved to an index higher than its current index, the index of all elements in between decreases by 1.

Parameters

| `element:IVisualElement` — The element for which you want to change the index number.
| `index:int` — The resulting index number for the element.

### swapElements

()
method

`public function swapElements(element1:IVisualElement, element2:IVisualElement):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Swaps the index of the two specified visual elements. All other elements remain in the same index position.

Parameters

| `element1:IVisualElement` — The first visual element.
| `element2:IVisualElement` — The second visual element.

### swapElementsAt

()
method

`public function swapElementsAt(index1:int, index2:int):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 4

Runtime Versions: | Flash Player 10, AIR 1.5

Swaps the visual elements at the two specified index positions in the container. All other visual elements remain in the same index position.

Parameters

| `index1:int` — The index of the first element.
| `index2:int` — The index of the second element.

### updateDisplayList

()
method

`override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Respond to size changes by setting the positions and sizes of this container's children.

See the `UIComponent.updateDisplayList()` method for more information about the `updateDisplayList()` method.

The `Container.updateDisplayList()` method sets the position and size of the Container container's border. In every subclass of Container, the subclass's `updateDisplayList()` method should call the `super.updateDisplayList()` method, so that the border is positioned properly.

Parameters

| `unscaledWidth:Number` — Specifies the width of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleX` property of the component.
| `unscaledHeight:Number` — Specifies the height of the component, in pixels, in the component's coordinates, regardless of the value of the `scaleY` property of the component.

Related API Elements

mx.core.UIComponent
Event Detail

### childAdd

Event

Event Object Type: `mx.events.ChildExistenceChangedEvent`
property ChildExistenceChangedEvent.type = `mx.events.ChildExistenceChangedEvent.CHILD_ADD`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched after a child has been added to a legend.

The childAdd event is dispatched when the `addChild()` or `addChildAt()` method is called. When a container is first created, the `addChild()` method is automatically called for each child component declared in the MXML file. The `addChildAt()` method is automatically called whenever a Repeater object adds or removes child objects. The application developer may also manually call these methods to add new children.

At the time when this event is sent, the child object has been initialized, but its width and height have not yet been calculated, and the child has not been drawn on the screen. If you want to be notified when the child has been fully initialized and rendered, then register as a listener for the child's `creationComplete` event.

The `ChildExistenceChangedEvent.CHILD_ADD` constant defines the value of the `type` property of the event object for a `childAdd` event.

The properties of the event object have the following values:

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

### childIndexChange

Event

Event Object Type: `mx.events.IndexChangedEvent`
property IndexChangedEvent.type = `mx.events.IndexChangedEvent.CHILD_INDEX_CHANGE`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched after the index (among the legend children) of a legend child changes. This event is only dispatched for the child specified as the argument to the `setChildIndex()` method; it is not dispatched for any other child whose index changes as a side effect of the call to the `setChildIndex()` method.

The child's index is changed when the `setChildIndex()` method is called.

The IndexChangedEvent.CHILD_INDEX_CHANGE constant defines the value of the `type` property of the event object for a childIndexChange event, which indicates that a component's index among a container's children has changed.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`inputType` | Indicates whether this event was caused by a mouse or keyboard interaction.
`newIndex` | The zero-based index of the child after the change.
`oldIndex` | The zero-based index of the child before the change.
`relatedObject` | Contains a reference to the child object whose index changed.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`TriggerEvent` | null
`Type` | IndexChangedEvent.CHILD_INDEX_CHANGE

### childRemove

Event

Event Object Type: `mx.events.ChildExistenceChangedEvent`
property ChildExistenceChangedEvent.type = `mx.events.ChildExistenceChangedEvent.CHILD_REMOVE`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched before a child of a legend is removed.

This event is delivered when any of the following methods is called: `removeChild()`, `removeChildAt()`, or `removeAllChildren()`.

The `ChildExistenceChangedEvent.CHILD_REMOVE` constant defines the value of the `type` property of the event object for a `childRemove` event.

The properties of the event object have the following values:

Property | Value
--- | ---
`bubbles` | false
`cancelable` | false
`currentTarget` | The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`relatedObject` | Contains a reference to the child object that is about to be removed.
`target` | The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.

### dataChange

Event

Event Object Type: `mx.events.FlexEvent`
property FlexEvent.type = `mx.events.FlexEvent.DATA_CHANGE`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the `data` property changes.

When a legend is used as a renderer in a List or other components, the `data` property is used pass to the legend the data to display.

The `FlexEvent.DATA_CHANGE` constant defines the value of the `type` property of the event object for a `dataChange` event.

The properties of the event object have the following values:

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

### itemClick

Event

Event Object Type: `mx.charts.events.LegendMouseEvent`
property LegendMouseEvent.type = `mx.charts.events.LegendMouseEvent.ITEM_CLICK`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the user clicks on a LegendItem in the Legend control.

Event type constant; indicates that the user clicked the mouse button over a legend item.

### itemMouseDown

Event

Event Object Type: `mx.charts.events.LegendMouseEvent`
property LegendMouseEvent.type = `mx.charts.events.LegendMouseEvent.ITEM_MOUSE_DOWN`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the user presses the mouse button while over a LegendItem in the Legend control.

Event type constant; indicates that the user clicked the mouse button over a legend item.

### itemMouseOut

Event

Event Object Type: `mx.charts.events.LegendMouseEvent`
property LegendMouseEvent.type = `mx.charts.events.LegendMouseEvent.ITEM_MOUSE_OUT`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the user moves the mouse off of a LegendItem in the Legend.

Event type constant; indicates that the user rolled the mouse pointer away from a legend item.

### itemMouseOver

Event

Event Object Type: `mx.charts.events.LegendMouseEvent`
property LegendMouseEvent.type = `mx.charts.events.LegendMouseEvent.ITEM_MOUSE_OVER`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the user moves the mouse over a LegendItem in the Legend control.

Event type constant; indicates that the user rolled the mouse pointer over a legend item.

### itemMouseUp

Event

Event Object Type: `mx.charts.events.LegendMouseEvent`
property LegendMouseEvent.type = `mx.charts.events.LegendMouseEvent.ITEM_MOUSE_UP`

Language Version: | ActionScript 3.0

Product Version: | Flex 3

Runtime Versions: | Flash Player 9, AIR 1.1

Dispatched when the user releases the mouse button while over a LegendItem in the Legend.

Event type constant; indicates that the user released the mouse button while over a legend item.
Examples How to use this example
PlotChartExample.mxml
Copy

    <?xml version="1.0"?>
    <!-- Simple example to demonstrate the PlotChart control. -->
    <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
        xmlns:s="library://ns.adobe.com/flex/spark"
        xmlns:mx="library://ns.adobe.com/flex/mx">
        <fx:Script>
            <![CDATA[
            import mx.collections.ArrayCollection;

            [Bindable]
            private var expensesAC:ArrayCollection = new ArrayCollection( [
                { Month: "Jan", Profit: 2000, Expenses: 1500, Amount: 450 },
                { Month: "Feb", Profit: 1000, Expenses: 200, Amount: 600 },
                { Month: "Mar", Profit: 1500, Expenses: 500, Amount: 300 } ]);
            ]]>
        </fx:Script>

        <fx:Declarations>
            <!-- Define custom colors for use as plot point fills. -->
            <mx:SolidColor id="sc1" color="blue" alpha=".3"/>
            <mx:SolidColor id="sc2" color="red" alpha=".3"/>
            <mx:SolidColor id="sc3" color="green" alpha=".3"/>

            <!-- Define custom Strokes. -->
            <mx:SolidColorStroke id="s1" color="blue" weight="1"/>
            <mx:SolidColorStroke id="s2" color="red" weight="1"/>
            <mx:SolidColorStroke id="s3" color="green" weight="1"/>
        </fx:Declarations>

        <mx:Panel title="PlotChart Control Example" height="100%" width="100%">
            <mx:PlotChart id="plot"
                height="100%"
                width="100%"
                paddingLeft="5"
                paddingRight="5"
                showDataTips="true"
                dataProvider="{expensesAC}"
            >
                <mx:series>
                    <mx:PlotSeries
                        xField="Expenses"
                        yField="Profit"
                        displayName="Plot 1"
                        fill="{sc1}"
                        stroke="{s1}"
                    />
                    <mx:PlotSeries
                        xField="Amount"
                        yField="Expenses"
                        displayName="Plot 2"
                        fill="{sc2}"
                        stroke="{s2}"
                    />
                    <mx:PlotSeries
                        xField="Profit"
                        yField="Amount"
                        displayName="Plot 3"
                        fill="{sc3}"
                        stroke="{s3}"
                    />
                </mx:series>
            </mx:PlotChart>
            <mx:Legend dataProvider="{plot}"/>
        </mx:Panel>
    </s:Application>

© 2015 Adobe Systems Incorporated. All rights reserved.
Mon Apr 10 2017, 12:28 PM -07:00