Packagemx.core
Classpublic class Container
InheritanceContainer Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite
ImplementsIContainer, IDataRenderer, IFocusManagerContainer, IListItemRenderer, IRawChildrenContainer
SubclassesAccordion, Box, Canvas, HFlowBox, LayoutContainer, Panel, Tile, ViewStack

The Container class is an abstract base class for components that controls the layout characteristics of child components. You do not create an instance of Container in an application. Instead, you create an instance of one of Container's subclasses, such as Canvas or HBox.

The Container class contains the logic for scrolling, clipping, and dynamic instantiation. It contains methods for adding and removing children. It also contains the getChildAt() method, and the logic for drawing the background and borders of containers.

MXML Syntaxexpanded Hide MXML Syntax
Flex Framework containers inherit the following attributes from the Container class:

  <mx:tagname
    Properties
    autoLayout="true|false"
    clipContent="true|false"
    creationIndex="undefined"
    creationPolicy="auto|all|queued|none"
    defaultButton="No default"
    horizontalLineScrollSize="5"
    horizontalPageScrollSize="0"
    horizontalScrollBar="null"
    horizontalScrollPolicy="auto|on|off"
    horizontalScrollPosition="0"
    icon="undefined"
    label=""
    verticalLineScrollSize="5"
    verticalPageScrollSize="0"
    verticalScrollBar="null"
    verticalScrollPolicy="auto|on|off"
    verticalScrollPosition="0"
 
    Styles
    backgroundAlpha="1.0"
    backgroundAttachment="scroll"
    backgroundColor="undefined"
    backgroundDisabledColor="undefined"
    backgroundImage="undefined"
    backgroundSize="auto" 
        For the Application container only, backgroundSize="100%"
    barColor="undefined"
    borderColor="0xAAB3B3"
    borderSides="left top right bottom"
    borderSkin="mx.skins.halo.HaloBorder"
    borderStyle="inset"
    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"
    horizontalScrollBarStyleName="undefined"
    paddingBottom="0"
    paddingLeft="0"
    paddingRight="0"
    paddingTop="0"
    shadowDirection="center"
    shadowDistance="2"
    textAlign="left"
    textDecoration="none|underline"
    textIndent="0"
    verticalScrollBarStyleName="undefined"
 
    Events
    childAdd="No default"
    childIndexChange="No default"
    childRemove="No default"
    dataChange="No default"
    scroll="No default"
    >
      ...
      child tags
      ...
  </mx:tagname>
  


Public Properties
 PropertyDefined by
 InheritedactiveEffects : Array
The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
  autoLayout : Boolean
If true, measurement and layout are done when the position or size of a child is changed.
Container
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationTabularData : Object
An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : Array
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
 InheritedbaselinePosition : Number
The y-coordinate of the baseline of the first line of text of the component.
UIComponent
  borderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
Container
 InheritedcacheHeuristic : Boolean
Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
  childDescriptors : Array
[read-only] Array of UIComponentDescriptor objects produced by the MXML compiler.
Container
 InheritedclassName : String
The name of this instance's class, such as "Button".
UIComponent
  clipContent : Boolean
Whether to apply a clip mask if the positions and/or sizes of this container's children extend outside the borders of this container.
Container
  contentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
Container
  contentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
Container
  creatingContentPane : Boolean
Containers use an internal content pane to control scrolling.
Container
  creationIndex : int
Specifies the order to instantiate and draw the children of the container.
Container
  creationPolicy : String
The child creation policy for this Container.
Container
 InheritedcurrentLooperData : Object
When using this component as the child of a DataLooper element, this holds the current element's corresponding looping data.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
  data : Object
The data property lets you pass a value to the component when you use it in an item renderer or item editor.
Container
  defaultButton : IFlexDisplayObject
The Button control designated as the default button for the container.
Container
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritederrorString : String
The text that will be displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
 InheritedglobalX : Number
UIComponent
 InheritedglobalY : Number
UIComponent
 Inheritedheight : Number
Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
  horizontalLineScrollSize : Number
Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.
Container
  horizontalPageScrollSize : Number
Number of pixels to move when the track in the horizontal scroll bar is pressed.
Container
  horizontalScrollBar : ScrollBar
The horizontal scrollbar used in this container.
Container
  horizontalScrollPolicy : String
Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed.
Container
  horizontalScrollPosition : Number
The current position of the horizontal scroll bar.
Container
  icon : Class
The Class of the icon displayed by some navigator containers to represent this Container.
Container
 Inheritedid : String
ID of the component.
UIComponent
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : Boolean
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIComponent
 InheritedinstanceIndex : int
The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 InheritedisDocument : Boolean
Determines whether this UIComponent instance is a document object, that is, whether it is at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
  label : String
The text displayed by some navigator containers to represent this Container.
Container
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, in the component's coordinates.
UIComponent
  maxHorizontalScrollPosition : Number
[read-only] The largest possible value for the horizontalScrollPosition property.
Container
  maxVerticalScrollPosition : Number
[read-only] The largest possible value for the verticalScrollPosition property.
Container
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedmiscHolder : Object
A utility holder for any various properties
UIComponent
 InheritedmoduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
UIComponent
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 Inheritedmove_enableProtection : Boolean = false
UIComponent
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednumAutomationChildren : int
The number of automation children this container has.
UIComponent
  numChildren : int
[read-only] Number of child components in this container.
Container
 Inheritedowner : DisplayObjectContainer
The owner of this UIComponent.
UIComponent
 Inheritedparent : DisplayObjectContainer
The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedprocessedDescriptors : 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.
Container
 Inheritedrepeater : IRepeater
A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : Array
An Array containing the indices of the items in the data provider of the Repeaters in the parent document that produced this UIComponent.
UIComponent
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 InheritedscaleX : Number
Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
Number that specifies the vertical scaling factor.
UIComponent
 Inheritedscreen : Rectangle
Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedsetActualSize_enableProtection : Boolean = false
UIComponent
 InheritedsetVisible_enableProtection : Boolean = true
UIComponent
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleClassOverridesInline : Boolean = true
Specifies if class-specific styles (as defined by the styleName property) override inline styles.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
  verticalLineScrollSize : Number
Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.
Container
  verticalPageScrollSize : Number
Number of pixels to scroll when the track in the vertical scroll bar is pressed.
Container
  verticalScrollBar : ScrollBar
The vertical scrollbar used in this container.
Container
  verticalScrollPolicy : String
Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed.
Container
  verticalScrollPosition : Number
The current position of the vertical scroll bar.
Container
  viewMetrics : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
  viewMetricsAndPadding : EdgeMetrics
[read-only] Returns an object that has four properties: left, top, right, and bottom.
Container
 Inheritedvisible : Boolean
Controls the visibility of this UIComponent.
UIComponent
 Inheritedvisible_unprotected : Boolean
If setVisible_enableProtection is enabled, this allows access to determine what the pseudo-state is -- that is, what's been requested, regardless of any prevention of default behavior.
UIComponent
 Inheritedwidth : Number
Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 Inheritedx : Number
Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 InheritedxmlDescriptor : XML
For certain dynamically created elements, this represents the XML node used to create that element.
UIComponent
 Inheritedy : Number
Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
Protected Properties
 PropertyDefined by
  actualCreationPolicy : String
The creation policy of this container.
Container
 InheritedunscaledHeight : Number
A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : Number
A convenience method for determining the unscaled width of the component All of a component's drawing and child layout should be done within a bounding rectangle of this width, which is also passed as an argument to updateDisplayList().
UIComponent
Public Methods
 MethodDefined by
  
Constructor.
Container
  
addChild(child:DisplayObject):DisplayObject
Adds a child DisplayObject to this Container.
Container
  
addChildAt(child:DisplayObject, index:int):DisplayObject
Adds a child DisplayObject to this Container.
Container
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
  
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
Container
  
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
Container
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
  
Given a single UIComponentDescriptor, create the corresponding component and add the component as a child of this Container.
Container
  
createComponentsFromDescriptors(recurse:Boolean = true):void
Iterate through the Array of childDescriptors, and call the createComponentFromDescriptor() method for each one.
Container
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically draws a rectangle into this skin's Graphics object.
UIComponent
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
  
executeBindings(recurse:Boolean = false):void
Executes all the data bindings on this Container.
Container
  
executeChildBindings(recurse:Boolean):void
Executes the bindings into this Container's child UIComponent objects.
Container
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
  
getChildAt(index:int):DisplayObject
Gets the nth child component object.
Container
  
getChildByName(name:String):DisplayObject
Returns the child whose name property is the specified String.
Container
  
getChildIndex(child:DisplayObject):int
Gets the zero-based index of a specific child.
Container
  
getChildren():Array
Returns an Array of DisplayObject objects consisting of the content children of the container.
Container
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
getDescendantByName(name:String):DisplayObject
Searches all children for the first child named with the passed value; returns that child, or null if not found.
UIComponent
 Inherited
getDescendantsByName(name:String):Array
Searches all children for all children named with the passed value; returns an array with those children, or an empty array if none found.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
MOVED OVER FROM SDK 3.2 UIComponent - Allows for popped-up alerts to be displayed correctly - NGR MOVED 11-20-08
UIComponent
  
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
Container
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
  
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
Container
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which may contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
 Inherited
move_unprotected(x:Number, y:Number):void
Same as move, but cannot be prevented via the protection_move event.
UIComponent
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
  
Removes all children from the child list of this container.
Container
  
removeChild(child:DisplayObject):DisplayObject
Removes a child DisplayObject from the child list of this Container.
Container
  
removeChildAt(index:int):DisplayObject
Removes a child DisplayObject from the child list of this Container at the specified index.
Container
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setActualSize_unprotected(w:Number, h:Number):void
Same as setActualSize, but is not cancelable via the protection_size event.
UIComponent
  
setChildIndex(child:DisplayObject, newIndex:int):void
Sets the index of a particular child.
Container
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
setVisible_unprotected(value:Boolean, noEvent:Boolean = false):void
Same as setVisible, but cannot be prevented.
UIComponent
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
validateNow():void
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined by
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
  
Used internally by the Dissolve Effect to add the overlay to the chrome of a container.
Container
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
Processes the properties set on the component.
UIComponent
  
createBorder():void
Creates the container's border skin if it is needed and does not already exist.
Container
 Inherited
Create child objects of the component.
UIComponent
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
  
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's borders.
Container
 Inherited
measure():void
Calculates the default size, and optionally the default minimum size, of the component.
UIComponent
 Inherited
This method is called when a UIComponent is constructed, and again whenever the ResourceManager dispatches a "change" Event to indicate that the localized resources have changed in some way.
UIComponent
  
Positions the container's content area relative to the viewable area based on the horizontalScrollPosition and verticalScrollPosition properties.
Container
  
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
Respond to size changes by setting the positions and sizes of this container's children.
Container
Events
 EventSummaryDefined by
 Inherited
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIComponent
   Dispatched after a child has been added to a container.Container
   Dispatched after the index (among the container children) of a container child changes.Container
   Dispatched before a child of a container is removed.Container
 Inherited Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 Inherited Dispatched after the view state has changed.UIComponent
 Inherited Dispatched after the currentState property changes, but before the view state changes.UIComponent
   Dispatched when the data property changes.Container
 Inherited 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
 Inherited Dispatched by the drop target when the user releases the mouse over it.UIComponent
 Inherited Dispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 Inherited Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 Inherited Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 Inherited Dispatched by the drag initiator when starting a drag operation.UIComponent
 Inherited Dispatched after an effect ends.UIComponent
 Inherited Dispatched just before an effect starts.UIComponent
 Inherited Dispatched after the component has returned to the root view state.UIComponent
 Inherited Dispatched before the component exits from the root view state.UIComponent
 Inherited Dispatched when an object's state changes from visible to invisible.UIComponent
 Inherited Dispatched when the component has finished its construction and has all initialization properties set.UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation failed.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 Inherited Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 Inherited Dispatched when the object has moved.UIComponent
 Inherited Dispatched at the beginning of the component initialization sequence.UIComponent
 Inherited Dispatched when the component is about to be hidden (visible = false); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be moved via move(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be shown (visible = true); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is about to be sized via setActualSize(); calling event.preventDefault() will stop the action from occuring.UIComponent
 Inherited Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIComponent
 Inherited Dispatched when the component is resized.UIComponent
   Dispatched when the user manually scrolls the container.Container
 Inherited Dispatched when an object's state changes from invisible to visible.UIComponent
 Inherited Dispatched by the component when it is time to create a ToolTip.UIComponent
 Inherited Dispatched by the component when its ToolTip has been hidden and will be discarded soon.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be hidden.UIComponent
 Inherited Dispatched by the component when its ToolTip is about to be shown.UIComponent
 Inherited Dispatched by the component when its ToolTip has been shown.UIComponent
 Inherited Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 Inherited Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 Inherited Dispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 Inherited Dispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 StyleDescriptionDefined by
  
backgroundAlpha
Type: Number   CSS Inheritance: no
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style. 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.
Container
  
backgroundAttachment
Type: String   CSS Inheritance: no
If a background image is specified, this style specifies whether it is fixed with regard to the viewport ("fixed") or scrolls along with the content ("scroll"). The default value is "scroll".
Container
  
backgroundColor
Type: uint   Format: Color   CSS Inheritance: no
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>

Container
  
backgroundDisabledColor
Type: uint   Format: Color   CSS Inheritance: yes
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.
Container
  
backgroundImage
Type: Object   Format: File   CSS Inheritance: no
Background image of a component. This can be an absolute or relative URL or class. You can either have both a backgroundColor and a backgroundImage set at the same time. 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>

Container
  
backgroundSize
Type: String   CSS Inheritance: no
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.
Container
  
barColor
Type: uint   Format: Color   CSS Inheritance: yes
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.
Container
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
  
borderColor
Type: uint   Format: Color   CSS Inheritance: no
Color of the border. The default value depends on the component class; if not overridden for the class, the default value is 0xB7BABC.
Container
  
borderSides
Type: String   CSS Inheritance: no
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".
Container
  
borderSkin
Type: Class   CSS Inheritance: no
The border skin class of the component. The mx.skins.halo.HaloBorder class is the default value for all components that do not explicitly set their own default. The Panel container has a default value of mx.skins.halo.PanelSkin. To determine the default value for a component, see the default.css file. The default value is mx.skins.halo.HaloBorder.
Container
  
borderStyle
Type: String   CSS Inheritance: no
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".
Container
  
borderThickness
Type: Number   Format: Length   CSS Inheritance: no
Bounding box thickness. Only used when borderStyle is set to "solid". The default value is 1.
Container
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the lower edge of the component to the lower edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color brightness of the component.
UIComponent
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.
Container
 Inherited Type: Number   CSS Inheritance: no
The color contrast of the component.
UIComponent
  
cornerRadius
Type: Number   Format: Length   CSS Inheritance: no
Radius of component corners. The default value depends on the component class; if not overriden for the class, the default value is 0. The default value for ApplicationControlBar is 5.
Container
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.
Container
  
disabledOverlayAlpha
Type: Number   CSS Inheritance: no
The alpha value for the overlay that is placed on top of the container when it is disabled.
Container
  
dropShadowColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of the drop shadow. The default value is 0x000000.
Container
  
dropShadowEnabled
Type: Boolean   CSS Inheritance: no
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.

Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
 Inherited Type: String   CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 Inherited Type: Class   CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 Inherited Type: Number   Format: Length   CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
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 for the font. Set to "normal" to disable the advanced anti-aliasing.

This style has no effect for system fonts.

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

The default value is "advanced".
Container
  
fontFamily
Type: String   CSS Inheritance: yes
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".
Container
  
fontGridFitType
Type: String   CSS Inheritance: yes
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 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".
Container
  
fontSharpness
Type: Number   CSS Inheritance: yes
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 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.
Container
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
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.
Container
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".
Container
  
fontThickness
Type: Number   CSS Inheritance: yes
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 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.
Container
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal.
Container
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
horizontalScrollBarStyleName
Type: String   CSS Inheritance: no
The name of the horizontal scrollbar style. The default value is undefined.
Container
 Inherited
hue
Type: Number   CSS Inheritance: no
The color hue of the component.
UIComponent
  
kerning
Type: Boolean   CSS Inheritance: yes
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 fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.
Container
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the left edge of the component's content area to the left edge of the component.
UIComponent
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.
Container
 Inherited Type: Number   CSS Inheritance: no
The opacity of the component.
UIComponent
  
paddingBottom
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's bottom border and the bottom of its content area. The default value is 0.
Container
  
paddingLeft
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.

The default value is 0.

The default value for a Button control is 10.

The default value for the ComboBox control is 5.

The default value for the Form container is 16.

The default value for the Tree control is 2.

Container
  
paddingRight
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.

The default value is 0.

The default value for a Button control is 10.

The default value for the ComboBox control is 5.

The default value for the Form container is 16.

Container
  
paddingTop
Type: Number   Format: Length   CSS Inheritance: no
Number of pixels between the container's top border and the top of its content area. The default value is 0.
Container
 Inherited Type: String   CSS Inheritance: no
The horizontal distance in pixels from the right edge of the component to the right edge of its content area.
UIComponent
 Inherited Type: Number   CSS Inheritance: no
The color saturation of the component.
UIComponent
  
shadowDirection
Type: String   CSS Inheritance: no
Direction of the drop shadow. Possible values are "left", "center", and "right". The default value is "center".
Container
  
shadowDistance
Type: Number   Format: Length   CSS Inheritance: no
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.
Container
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and 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.

Container
  
textDecoration
Type: String   CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".
Container
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.
Container
 Inherited Type: uint   Format: Color   CSS Inheritance: yes
Theme color of a component.
UIComponent
 Inherited
top
Type: String   CSS Inheritance: no
The vertical distance in pixels from the top edge of the control's content area to the top edge of the component.
UIComponent
 Inherited Type: String   CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
  
verticalScrollBarStyleName
Type: String   CSS Inheritance: no
The name of the vertical scrollbar style. The default value is undefined.
Container
Effects
 EffectDescriptionDefined by
 Inherited Triggering event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering event: hide
Played when the component becomes invisible.
UIComponent
 Inherited Triggering event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering event: move
Played when the component is moved.
UIComponent
 Inherited Triggering event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined by
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property detail
actualCreationPolicyproperty
protected var actualCreationPolicy:String

The creation policy of this container. This property is useful when the container inherits its creation policy from its parent container.

autoLayoutproperty 
autoLayout:Boolean  [read-write]

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
borderMetricsproperty 
borderMetrics:EdgeMetrics  [read-only]

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 overriden by subclasses of Container.

Implementation
    public function get borderMetrics():EdgeMetrics
childDescriptorsproperty 
childDescriptors:Array  [read-only]

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

See also

clipContentproperty 
clipContent:Boolean  [read-write]

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
contentMouseXproperty 
contentMouseX:Number  [read-only]

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
    public function get contentMouseX():Number
contentMouseYproperty 
contentMouseY:Number  [read-only]

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
    public function get contentMouseY():Number
creatingContentPaneproperty 
creatingContentPane:Boolean  [read-write]

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
creationIndexproperty 
creationIndex:int  [read-write]

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
creationPolicyproperty 
creationPolicy:String  [read-write]

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

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.QUEUED means that the container is added to a creation queue rather than being immediately instantiated and drawn. When the application processes the queued container, it creates the children of the container and then waits until the children have been created before advancing to the next container in the creation queue.

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.

Implementation
    public function get creationPolicy():String
    public function set creationPolicy(value:String):void
dataproperty 
data:Object  [read-write]

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.

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

See also

defaultButtonproperty 
defaultButton:IFlexDisplayObject  [read-write]

The Button control designated as the default button for the container. When controls in the container have focus, pressing the Enter key is the same as clicking this Button control.

The default value is null.

Implementation
    public function get defaultButton():IFlexDisplayObject
    public function set defaultButton(value:IFlexDisplayObject):void
horizontalLineScrollSizeproperty 
horizontalLineScrollSize:Number  [read-write]

Number of pixels to move when the left- or right-arrow button in the horizontal scroll bar is pressed.

The default value is 5.

This property can be used as the source for data binding.

Implementation
    public function get horizontalLineScrollSize():Number
    public function set horizontalLineScrollSize(value:Number):void
horizontalPageScrollSizeproperty 
horizontalPageScrollSize:Number  [read-write]

Number of pixels to move when the track in the horizontal scroll bar is pressed. A value of 0 means that the page size will be calculated to be a full screen.

The default value is 0.

This property can be used as the source for data binding.

Implementation
    public function get horizontalPageScrollSize():Number
    public function set horizontalPageScrollSize(value:Number):void
horizontalScrollBarproperty 
horizontalScrollBar:ScrollBar  [read-write]

The horizontal scrollbar used in this container. This property is null if no horizontal scroll bar is currently displayed. In general you do not access this property directly. Manipulation of the horizontalScrollPolicy and horizontalScrollPosition properties should provide sufficient control over the scroll bar.

Implementation
    public function get horizontalScrollBar():ScrollBar
    public function set horizontalScrollBar(value:ScrollBar):void
horizontalScrollPolicyproperty 
horizontalScrollPolicy:String  [read-write]

Specifies whether the horizontal scroll bar is always present, always absent, or automatically added when needed. ActionScript values can be ScrollPolicy.ON, ScrollPolicy.OFF, and ScrollPolicy.AUTO. MXML values can be "on", "off", and "auto".

Setting this property to ScrollPolicy.OFF also prevents the horizontalScrollPosition property from having an effect.

Note: This property does not apply to the ControlBar container.

If the horizontalScrollPolicy is ScrollPolicy.AUTO, the horizontal scroll bar appears when all of the following are true:

The default value is ScrollPolicy.AUTO.

This property can be used as the source for data binding.

Implementation
    public function get horizontalScrollPolicy():String
    public function set horizontalScrollPolicy(value:String):void
horizontalScrollPositionproperty 
horizontalScrollPosition:Number  [read-write]

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.

Implementation
    public function get horizontalScrollPosition():Number
    public function set horizontalScrollPosition(value:Number):void
iconproperty 
icon:Class  [read-write]

The Class of the icon displayed by some navigator containers to represent this Container.

For example, if this Container is a child of a TabNavigator, this icon appears in the corresponding tab. If this Container is a child of an Accordion, this icon appears in the corresponding header.

To embed the icon in the SWF file, use the @Embed() MXML compiler directive:

        icon="@Embed('filepath')"
      

The image can be a JPEG, GIF, PNG, SVG, or SWF file.

The default value is null.

This property can be used as the source for data binding.

Implementation
    public function get icon():Class
    public function set icon(value:Class):void
labelproperty 
label:String  [read-write]

The text displayed by some navigator containers to represent this Container.

For example, if this Container is a child of a TabNavigator, this string appears in the corresponding tab. If this Container is a child of an Accordion, this string appears in the corresponding header.

The default value is "".

This property can be used as the source for data binding.

Implementation
    public function get label():String
    public function set label(value:String):void
maxHorizontalScrollPositionproperty 
maxHorizontalScrollPosition:Number  [read-only]

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

Implementation
    public function get maxHorizontalScrollPosition():Number
maxVerticalScrollPositionproperty 
maxVerticalScrollPosition:Number  [read-only]

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

Implementation
    public function get maxVerticalScrollPosition():Number
numChildrenproperty 
numChildren:int  [read-only]

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
    public function get numChildren():int
rawChildrenproperty 
rawChildren:IChildList  [read-only]

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 addChildAtmethod of the rawChildren object, set tabEnabled = 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
verticalLineScrollSizeproperty 
verticalLineScrollSize:Number  [read-write]

Number of pixels to scroll when the up- or down-arrow button in the vertical scroll bar is pressed, or when you scroll by using the mouse wheel.

The default value is 5.

This property can be used as the source for data binding.

Implementation
    public function get verticalLineScrollSize():Number
    public function set verticalLineScrollSize(value:Number):void
verticalPageScrollSizeproperty 
verticalPageScrollSize:Number  [read-write]

Number of pixels to scroll when the track in the vertical scroll bar is pressed. A value of 0 means that the page size will be calculated to be a full screen.

The default value is 0.

This property can be used as the source for data binding.

Implementation
    public function get verticalPageScrollSize():Number
    public function set verticalPageScrollSize(value:Number):void
verticalScrollBarproperty 
verticalScrollBar:ScrollBar  [read-write]

The vertical scrollbar used in this container. This property is null if no vertical scroll bar is currently displayed. In general you do not access this property directly. Manipulation of the verticalScrollPolicy and verticalScrollPosition properties should provide sufficient control over the scroll bar.

Implementation
    public function get verticalScrollBar():ScrollBar
    public function set verticalScrollBar(value:ScrollBar):void
verticalScrollPolicyproperty 
verticalScrollPolicy:String  [read-write]

Specifies whether the vertical scroll bar is always present, always absent, or automatically added when needed. Possible values are ScrollPolicy.ON, ScrollPolicy.OFF, and ScrollPolicy.AUTO. MXML values can be "on", "off", and "auto".

Setting this property to ScrollPolicy.OFF also prevents the verticalScrollPosition property from having an effect.

Note: This property does not apply to the ControlBar container.

If the verticalScrollPolicy is ScrollPolicy.AUTO, the vertical scroll bar appears when all of the following are true:

The default value is ScrollPolicy.AUTO.

This property can be used as the source for data binding.

Implementation
    public function get verticalScrollPolicy():String
    public function set verticalScrollPolicy(value:String):void
verticalScrollPositionproperty 
verticalScrollPosition:Number  [read-write]

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.

Implementation
    public function get verticalScrollPosition():Number
    public function set verticalScrollPosition(value:Number):void
viewMetricsproperty 
viewMetrics:EdgeMetrics  [read-only]

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
viewMetricsAndPaddingproperty 
viewMetricsAndPadding:EdgeMetrics  [read-only]

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
Container()constructor
public function Container()

Constructor.

Method detail
addChild()method
public override function addChild(child:DisplayObject):DisplayObject

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.

See also

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

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.

See also

attachOverlay()method 
protected override function attachOverlay():void

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

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

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 
public override function contentToLocal(point:Point):Point

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

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

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

See also

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

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.
executeBindings()method 
public override function executeBindings(recurse:Boolean = false):void

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

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 
public override function getChildAt(index:int):DisplayObject

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 
public override function getChildByName(name:String):DisplayObject

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.
getChildIndex()method 
public override function getChildIndex(child:DisplayObject):int

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

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.

See also

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

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

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 
public override function localToContent(point:Point):Point

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

Removes all children from the child list of this container.

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

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 
public override function removeChildAt(index:int):DisplayObject

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.
scrollChildren()method 
protected function scrollChildren():void

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 
public override function setChildIndex(child:DisplayObject, newIndex:int):void

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).
updateDisplayList()method 
protected override function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void

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.

See also

Event detail
childAddevent 
Event object type: mx.events.ChildExistenceChangedEvent
ChildExistenceChangedEvent.type property = mx.events.ChildExistenceChangedEvent.CHILD_ADD

Dispatched after a child has been added to a container.

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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
relatedObjectContains a reference to the child object that was created.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
childIndexChangeevent  
Event object type: mx.events.IndexChangedEvent
IndexChangedEvent.type property = mx.events.IndexChangedEvent.CHILD_INDEX_CHANGE

Dispatched after the index (among the container children) of a container 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
inputTypeIndicates whether this event was caused by a mouse or keyboard interaction.
newIndexThe zero-based index of the child after the change.
oldIndexThe zero-based index of the child before the change.
relatedObjectContains a reference to the child object whose index changed.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
TriggerEventnull
TypeIndexChangedEvent.CHILD_INDEX_CHANGE
childRemoveevent  
Event object type: mx.events.ChildExistenceChangedEvent
ChildExistenceChangedEvent.type property = mx.events.ChildExistenceChangedEvent.CHILD_REMOVE

Dispatched before a child of a container 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
relatedObjectContains a reference to the child object that is about to be removed.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
dataChangeevent  
Event object type: mx.events.FlexEvent
FlexEvent.type property = mx.events.FlexEvent.DATA_CHANGE

Dispatched when the data property changes.

When a container is used as a renderer in a List or other components, the data property is used pass to the container 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:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.
scrollevent  
Event object type: mx.events.ScrollEvent
ScrollEvent.type property = mx.events.ScrollEvent.SCROLL

Dispatched when the user manually scrolls the container.

The event is dispatched when the scroll position is changed using either the mouse (e.g. clicking on the scrollbar's "down" button) or the keyboard (e.g., clicking on the down-arrow key). However, this event is not dispatched if the scroll position is changed programatically (e.g., setting the value of the horizontalScrollPosition property). The viewChanged event is delivered whenever the scroll position is changed, either manually or programatically.

At the time when this event is dispatched, the scrollbar has been updated to the new position, but the container's child objects have not been shifted to reflect the new scroll position.

The ScrollEvent.SCROLL constant defines the value of the type property of the event object for a scroll event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe Object that defines the event listener that handles the event. For example, if you use myButton.addEventListener() to register an event listener, myButton is the value of the currentTarget.
deltaContains the change in scroll position, expressed in pixels. A positive value indicates the scroll was down or to the right. A negative value indicates the scroll was up or to the left.
directionContains the scroll direction, either ScrollEventDirection.HORIZONTAL or ScrollEventDirection.VERTICAL.
positionContains the new scroll position.
targetThe Object that dispatched the event; it is not always the Object listening for the event. Use the currentTarget property to always access the Object listening for the event.