Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.flash 
ContainerMovieClip 
Packagemx.flash
Classpublic dynamic class ContainerMovieClip
InheritanceContainerMovieClip Inheritance UIMovieClip Inheritance MovieClip Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IVisualElementContainer

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Container components created in Adobe Flash Professional for use in Flex are subclasses of the mx.flash.ContainerMovieClip class. You can use a subclass of ContainerMovieClip as a Flex container, it can hold children, and it can respond to events, define view states and transitions, and work with effects in the same way as can any Flex component.

A Flash container can only have a single Flex IUIComponent child. However, this child can be a Flex container which allows you to add additional children.

If your Flash container modifies the visual characteristics of the Flex components contained in it, such as changing the alpha property, you must embed the fonts used by the Flex components. This is the same requirement that you have when using the Dissolve, Fade, and Rotate effects with Flex components.

The following procedure describes the basic process for creating a Flex component in Flash Professional:

  1. Install the Adobe Flash Workflow Integration Kit.
  2. Create symbols for your dynamic assets in the FLA file.
  3. Run Commands > Make Flex Container to convert your symbol to a subclass of the ContainerMovieClip class, to configure the Flash Professional publishing settings for use with Flex, and add a new symbol named FlexContentHolder to the Library. This symbol defines the content area of the container in which you can place child Flex components..
  4. Publish your FLA file as a SWC file.
  5. Reference the class name of your symbols in your Flex application as you would any class.
  6. Include the SWC file in your library-path when you compile your Flex application.

For more information, see the documentation that ships with the Flex/Flash Integration Kit at http://www.adobe.com/go/flex3_cs3_swfkit.

Default MXML Propertycontent



Public Properties
 PropertyDefined By
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIMovieClip
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIMovieClip
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIMovieClip
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIMovieClip
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIMovieClip
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIMovieClip
 InheritedautomationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIMovieClip
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIMovieClip
 InheritedautoUpdateCurrentState : Boolean
Whether we should actively watch changes to the label of the flash object.
UIMovieClip
 InheritedautoUpdateMeasuredSize : Boolean
Whether we should actively watch changes to the size of the flash object.
UIMovieClip
 Inheritedbaseline : Object
The vertical distance in pixels from the top edge of the content area to the component's baseline position.
UIMovieClip
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIMovieClip
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 Inheritedbottom : Object
The vertical distance, in pixels, from the lower edge of the component to the lower edge of its content area.
UIMovieClip
 InheritedboundingBoxName : String = "boundingBox"
Name of the object to use as the bounding box.
UIMovieClip
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 InheritedAIR-only cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIMovieClip
 InheritedcachePolicy : String
[read-only] Specifies the bitmap caching policy for this object.
UIMovieClip
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
  content : IUIComponent
The Flex content to display inside this container.
ContainerMovieClip
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheritedcurrentFrame : int
[read-only] Specifies the number of the frame in which the playhead is located in the timeline of the MovieClip instance.
MovieClip
 InheritedcurrentFrameLabel : String
[read-only] The label at the current frame in the timeline of the MovieClip instance.
MovieClip
 InheritedcurrentLabel : String
[read-only] The current label in which the playhead is located in the timeline of the MovieClip instance.
MovieClip
 InheritedcurrentLabels : Array
[read-only] Returns an array of FrameLabel objects from the current scene.
MovieClip
 InheritedcurrentScene : Scene
[read-only] The current scene in which the playhead is located in the timeline of the MovieClip instance.
MovieClip
 InheritedcurrentState : String
The current state of this component.
UIMovieClip
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIMovieClip
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIMovieClip
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIMovieClip
 Inheriteddocument : Object
A reference to the document object associated with this component.
UIMovieClip
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
A Boolean value that indicates whether a movie clip is enabled.
MovieClip
 InheritedexplicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedexplicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedexplicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedexplicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedexplicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedexplicitWidth : Number
The explicitly specified width for the component, in pixels, as the component's coordinates.
UIMovieClip
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusEnabled : Boolean
A flag that indicates whether the component can receive focus when selected.
UIMovieClip
 InheritedfocusPane : Sprite
A single Sprite object that is shared among components and used as an overlay for drawing focus.
UIMovieClip
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 InheritedframesLoaded : int
[read-only] The number of frames that are loaded from a streaming SWF file.
MovieClip
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIMovieClip
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contians true if the element has 3D Matrix.
UIMovieClip
 Inheritedheight : Number
[override] The height of this object, in pixels.
UIMovieClip
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIMovieClip
 Inheritedid : String
ID of the component.
UIMovieClip
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIMovieClip
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIMovieClip
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIMovieClip
 InheritedlayoutDirection : String
Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit).
UIMovieClip
 Inheritedleft : Object
The horizontal distance, in pixels, from the left edge of the component's content area to the left edge of the component.
UIMovieClip
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedmaintainProjectionCenter : Boolean
When true, the component will keep its projection matrix centered on the middle of its bounding box.
UIMovieClip
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedmaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedmeasuredHeight : Number
[read-only] The measured height of this object.
UIMovieClip
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIMovieClip
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIMovieClip
 InheritedmeasuredWidth : Number
[read-only] The measured width of this object.
UIMovieClip
 InheritedminHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedminWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedmoduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
UIMovieClip
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
[read-only] A flag that indicates whether the component can receive focus when selected with the mouse.
UIMovieClip
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIMovieClip
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
  numElements : int
[read-only] Returns 1 if there is a viewport, 0 otherwise.
ContainerMovieClip
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedowner : DisplayObjectContainer
Typically the parent container of this component.
UIMovieClip
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
 InheritedparentDocument : Object
[read-only] The document containing this component.
UIMovieClip
 InheritedpercentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIMovieClip
 InheritedpercentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIMovieClip
 InheritedpostLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the component's transform in a way that is invisible to the component's parent's layout.
UIMovieClip
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedright : Object
The horizontal distance, in pixels, from the right edge of the component to the right edge of its content area.
UIMovieClip
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
UIMovieClip
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIMovieClip
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIMovieClip
 InheritedrotationZ : Number
[override] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIMovieClip
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
  scaleContentWhenResized : Boolean
Whether the scale of the container due to sizing affects the scale of the flex content.
ContainerMovieClip
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIMovieClip
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIMovieClip
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIMovieClip
 Inheritedscenes : Array
[read-only] An array of Scene objects, each listing the name, the number of frames, and the frame labels for a scene in the MovieClip instance.
MovieClip
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIMovieClip
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedsystemManager : ISystemManager
A reference to the SystemManager object for this component.
UIMovieClip
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabFocusEnabled : Boolean
A flag that indicates whether child objects can receive focus This is similar to the tabEnabled property used by the Flash Player. This is usually true for components that handle keyboard input, but some components in controlbars have them set to false because they should not steal focus from another component like an editor.
UIMovieClip
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIMovieClip
 Inheritedtop : Object
The vertical distance, in pixels, from the top edge of the control's content area to the top edge of the component.
UIMovieClip
 InheritedtotalFrames : int
[read-only] The total number of frames in the MovieClip instance.
MovieClip
 InheritedtrackAsMenu : Boolean
Indicates whether other display objects that are SimpleButton or MovieClip objects can receive mouse release events or other user input release events.
MovieClip
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIMovieClip
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIMovieClip
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIMovieClip
 InheritedtweeningProperties : Array
Used by EffectManager.
UIMovieClip
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedverticalCenter : Object
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIMovieClip
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIMovieClip
 Inheritedwidth : Number
[override] The width of this object, in pixels.
UIMovieClip
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIMovieClip
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIMovieClip
 Inheritedz : Number
[override] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
UIMovieClip
Protected Properties
 PropertyDefined By
 Inheritedbounds : Rectangle
[read-only] The unscaled bounds of the content.
UIMovieClip
 Inheritedinitialized : Boolean = false
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
UIMovieClip
Public Methods
 MethodDefined By
  
Constructor
ContainerMovieClip
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
  
Adds a visual element to this container.
ContainerMovieClip
  
Adds a visual element to this container.
ContainerMovieClip
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Returns a set of properties that identify the child within this container.
UIMovieClip
 Inherited
Returns a set of properties that identify the child within this container.
UIMovieClip
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIMovieClip
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIMovieClip
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Called by the FocusManager when the component receives focus.
UIMovieClip
 Inherited
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
UIMovieClip
 Inherited
Provides the automation object at the specified index.
UIMovieClip
 Inherited
Provides the automation object list .
UIMovieClip
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIMovieClip
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIMovieClip
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
getConstraintValue(constraintName:String):*
Returns the specified constraint value.
UIMovieClip
  
Returns the viewport if there is a viewport and the index passed in is 0.
ContainerMovieClip
  
Returns the 0 if the element passed in is the viewport.
ContainerMovieClip
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIMovieClip
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIMovieClip
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIMovieClip
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIMovieClip
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIMovieClip
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIMovieClip
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIMovieClip
 Inherited
Returns the layout transform Matrix3D for this element.
UIMovieClip
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIMovieClip
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIMovieClip
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIMovieClip
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIMovieClip
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIMovieClip
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIMovieClip
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
gotoAndPlay(frame:Object, scene:String = null):void
Starts playing the SWF file at the specified frame.
MovieClip
 Inherited
gotoAndStop(frame:Object, scene:String = null):void
Brings the playhead to the specified frame of the movie clip and stops it there.
MovieClip
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
Initialize the object.
UIMovieClip
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIMovieClip
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Moves this object to the specified x and y coordinates.
UIMovieClip
 Inherited
Sends the playhead to the next frame and stops it.
MovieClip
 Inherited
Moves the playhead to the next scene of the MovieClip instance.
MovieClip
 Inherited
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIMovieClip
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIMovieClip
 Inherited
Moves the playhead in the timeline of the movie clip.
MovieClip
 Inherited
Sends the playhead to the previous frame and stops it.
MovieClip
 Inherited
Moves the playhead to the previous scene of the MovieClip instance.
MovieClip
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
For each effect event, register the EffectManager as one of the event listeners.
UIMovieClip
  
Removes all visual elements from the container.
ContainerMovieClip
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
  
Removes the specified visual element from the child list of this container.
ContainerMovieClip
  
Removes a visual element from the specified index position in the container.
ContainerMovieClip
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIMovieClip
 Inherited
Resolves a child by using the id provided.
UIMovieClip
 Inherited
setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
UIMovieClip
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets the specified constraint value.
UIMovieClip
  
Changes the position of an existing visual element in the visual container.
ContainerMovieClip
 Inherited
Called by the FocusManager when the component receives focus.
UIMovieClip
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIMovieClip
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIMovieClip
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIMovieClip
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIMovieClip
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIMovieClip
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Stops the playhead in the movie clip.
MovieClip
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
  
Swaps the index of the two specified visual elements.
ContainerMovieClip
  
swapElementsAt(index1:int, index2:int):void
Swaps the visual elements at the two specified index positions in the container.
ContainerMovieClip
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space.
UIMovieClip
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIMovieClip
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
  
Any time a display object gets added, let's see if this is a child that belongs to use and needs to be initialized.
ContainerMovieClip
 Inherited
This enter frame handler watches our currentLabel for changes so that it can be reflected in the currentState.
UIMovieClip
 Inherited
This enter frame handler watches the flash object's size to see if it has changed.
UIMovieClip
 Inherited
This enter frame handler is used when our width, height, x, or y value changes.
UIMovieClip
 Inherited
Recursively finds all children that have tabEnabled=true and adds them to the focusableObjects array.
UIMovieClip
 Inherited
Called when focus is entering any of our children.
UIMovieClip
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIMovieClip
 Inherited
Notify our parent that our size has changed.
UIMovieClip
  
Any time a display object gets removed, let's see if this child is the contentHolder.
ContainerMovieClip
 Inherited
This enter frame handler progresses through transitions.
UIMovieClip
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIMovieClip
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the component has finished its construction.UIMovieClip
 InheritedDispatched after the view state has changed.UIMovieClip
 InheritedDispatched after the currentState property changes, but before the view state changes.UIMovieClip
 InheritedDispatched when the user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 InheritedDispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop.UIMovieClip
 InheritedDispatched by the drop target when the user releases the mouse over it.UIMovieClip
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIMovieClip
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIMovieClip
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIMovieClip
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when an object's state changes from visible to invisible.UIMovieClip
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIMovieClip
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIMovieClip
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIMovieClip
 InheritedDispatched when the object has moved.UIMovieClip
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched at the beginning of the component initialization sequence.UIMovieClip
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method.UIMovieClip
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIMovieClip
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIMovieClip
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched by the component when it is time to create a ToolTip.UIMovieClip
 InheritedDispatched by the component when its ToolTip has been hidden and will be discarded soon.UIMovieClip
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIMovieClip
 InheritedDispatched by the component when its ToolTip is about to be shown.UIMovieClip
 InheritedDispatched by the component when its ToolTip has been shown.UIMovieClip
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIMovieClip
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
Property Detail

content

property
content:IUIComponent

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

The Flex content to display inside this container.

Typically, to add a child to a container in ActionScript, you use the Container.addChild() or Container.addChildAt() method. However, to add a child to the ContainerMovieClip.content property of a Flash container, you do not use the addChild() or addChildAt() method. Instead, you assign the child directly to the content property.

The following example assigns a container to the ContainerMovieClip.content property.

      <mx:Application xmlns:mx="http://www.adobe.com/2006/mxml"
         xmlns:myComps="*">
         
         <mx:Script>
             <![CDATA[
                 import mx.containers.HBox;
                 import mx.controls.Image;
     
                 private function init():void {            
                     // Define the Image control.
                     var image1:Image = new Image();
                     image1.source = "../assets/logowithtext.jpg";
                     image1.percentWidth = 80;
                     image1.percentHeight = 80;
     
                     // Define the HBox container.
                     var hb1:HBox = new HBox();
                     hb1.percentWidth = 100;
                     hb1.percentHeight = 100;
                     hb1.setStyle('borderStyle', 'solid');
                     hb1.addChild(image1);
     
                     // Assign the HBox container to the 
                     // ContainerMovieClip.content property..
                     pFrame.content = hb1;
                 }
             ]]>
         </mx:Script>    
     
         <myComps:MyPictureFrameContainer id="pFrame" 
             initialize="init();"/>
     </mx:Application>



Implementation
    public function get content():IUIComponent
    public function set content(value:IUIComponent):void

numElements

property 
numElements:int  [read-only]

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

Returns 1 if there is a viewport, 0 otherwise.



Implementation
    public function get numElements():int

scaleContentWhenResized

property 
scaleContentWhenResized:Boolean

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

Whether the scale of the container due to sizing affects the scale of the flex content.

When Flash components are resized, they scale up or down to their new size. However, this means their children are also scaled up or down. By setting this flag to false, the children are inversely scaled when the container is resized.

Note: When the container is scaled direclty (through scaleX or scaleY), the content will also be scaled accordingly. This only affects scaling of the container due to sizing.

The default value is false.



Implementation
    public function get scaleContentWhenResized():Boolean
    public function set scaleContentWhenResized(value:Boolean):void
Constructor Detail

ContainerMovieClip

()Constructor
public function ContainerMovieClip()

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor

Method Detail

addedHandler

()method
protected function addedHandler(event:Event):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

Any time a display object gets added, let's see if this is a child that belongs to use and needs to be initialized. Also if it is the contentHolder, let's stuff the content down into it.

We only need this method if the child gets added after we've already been initialized.

Parameters

event:Event

addElement

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

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

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

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

Parameters

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

Returns
IVisualElement — The element that was added.

addElementAt

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

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

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

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

Parameters

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

Returns
IVisualElement — The element that was added.

getElementAt

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

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

Returns the viewport if there is a viewport and the index passed in is 0. Otherwise, it throws a RangeError.

Parameters

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

Returns
IVisualElement — The element at the specified index.

Throws
RangeError — If the index position does not exist in the child list.

getElementIndex

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

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

Returns the 0 if the element passed in is the viewport. Otherwise, it throws an ArgumentError.

Parameters

element:IVisualElement — The element to identify.

Returns
int — The index position of the element to identify.

Throws
ArgumentError — If the element is not a child of this object.

removeAllElements

()method 
public function removeAllElements():void

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

Removes all visual elements from the container.

removedHandler

()method 
protected function removedHandler(event:Event):void

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 9, AIR 1.1

Any time a display object gets removed, let's see if this child is the contentHolder. If it is, let's null out our reference to _contentHolder.

Parameters

event:Event

removeElement

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

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

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

Parameters

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

Returns
IVisualElement — The element removed.

removeElementAt

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

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

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

Parameters

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

Returns
IVisualElement — The element removed.

setElementIndex

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

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

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

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

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

Parameters

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

swapElements

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

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

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

Parameters

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

swapElementsAt

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

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

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

Parameters

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