Packagemx.flash
Classpublic dynamic class UIMovieClip
InheritanceUIMovieClip Inheritance MovieClip Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IDeferredInstantiationUIComponent, IToolTipManagerClient, IStateClient, IFocusManagerComponent, IConstraintClient, IAutomationObject
Subclasses ContainerMovieClip

Components created in Adobe Flash CS3 Professional for use in Flex are subclasses of the mx.flash.UIMovieClip class. The UIMovieClip class implements the interfaces necessary for a Flash component to be used like a normal Flex component. Therefore, a subclass of UIMovieClip can be used as a child of a Flex container or as a skin, and it can respond to events, define view states and transitions, and work with effects in the same way as can any Flex component.

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

  1. Install the Adobe Flash Workflow Integration Kit.
  2. Create symbols for your dynamic assets in the FLA file.
  3. Run Commands > Make Flex Component to convert your symbol to a subclass of the UIMovieClip class, and to configure the Flash CS3 publishing settings for use with Flex.
  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.



Public Properties
 PropertyDefined By
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
  automationDelegate : Object
The delegate object that handles the automation-related functionality.
UIMovieClip
  automationName : String
Name that can be used as an identifier for this object.
UIMovieClip
  automationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIMovieClip
  automationValue : Array
[read-only] This value generally corresponds to the rendered appearance of the object and should be usable for correlating the identifier with the object as it appears visually within the application.
UIMovieClip
  baseline : *
The vertical distance in pixels from the top edge of the content area to the component's baseline position.
UIMovieClip
  baselinePosition : 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
  bottom : *
The vertical distance, in pixels, from the lower edge of the component to the lower edge of its content area.
UIMovieClip
  boundingBoxName : 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 Player or Adobe AIR caches an internal bitmap representation of the display object.
DisplayObject
  cacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIMovieClip
  cachePolicy : 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
 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
 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
  currentState : String
The current state of this component.
UIMovieClip
  descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIMovieClip
  document : 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
  explicitHeight : Number
The explicitly specified height for the component, in pixels, as the component's coordinates.
UIMovieClip
  explicitMaxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
UIMovieClip
  explicitMaxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
UIMovieClip
  explicitMinHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
UIMovieClip
  explicitMinWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
UIMovieClip
  explicitWidth : 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
  focusEnabled : Boolean
A flag that indicates whether the component can receive focus when selected.
UIMovieClip
  focusPane : 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
  height : Number
The height of this object, in pixels.
UIMovieClip
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
  horizontalCenter : *
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIMovieClip
  id : String
ID of the component.
UIMovieClip
  includeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIMovieClip
  isPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIMovieClip
  left : *
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
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
  maxHeight : Number
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
UIMovieClip
  maxWidth : Number
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
UIMovieClip
  measuredHeight : Number
[read-only] The measured height of this object.
UIMovieClip
  measuredMinHeight : Number
The default minimum height of the component, in pixels.
UIMovieClip
  measuredMinWidth : Number
The default minimum width of the component, in pixels.
UIMovieClip
  measuredWidth : Number
[read-only] The measured width of this object.
UIMovieClip
  minHeight : Number
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
UIMovieClip
  minWidth : Number
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
UIMovieClip
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse messages.
InteractiveObject
  mouseFocusEnabled : 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 position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
  numAutomationChildren : 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
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
  owner : DisplayObjectContainer
Typically the parent container of this component.
UIMovieClip
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
  parentDocument : Object
[read-only] The document containing this component.
UIMovieClip
  percentHeight : Number
Number that specifies the height of a component as a percentage of its parent's size.
UIMovieClip
  percentWidth : Number
Number that specifies the width of a component as a percentage of its parent's size.
UIMovieClip
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
  right : *
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
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point.
DisplayObject
 InheritedscaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 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
  showInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIMovieClip
 InheritedsoundTransform : SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
  systemManager : 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
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
  toolTip : String
Text to display in the ToolTip.
UIMovieClip
  top : *
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.
MovieClip
 Inheritedtransform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
  tweeningProperties : Array
Used by EffectManager.
UIMovieClip
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls over a sprite in which the buttonMode property is set to true.
Sprite
  verticalCenter : *
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIMovieClip
 Inheritedvisible : Boolean
Whether or not the display object is visible.
DisplayObject
  width : Number
The width of this object, in pixels.
UIMovieClip
 Inheritedx : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
 Inheritedy : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of the parent DisplayObjectContainer.
DisplayObject
Protected Properties
 PropertyDefined By
  bounds : Rectangle
[read-only] The unscaled bounds of the content.
UIMovieClip
  initialized : 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.
UIMovieClip
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 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
  
Returns a set of properties that identify the child within this container.
UIMovieClip
  
Creates an id reference to this IUIComponent object on its parent document object.
UIMovieClip
  
Deletes the id reference to this IUIComponent object on its parent document object.
UIMovieClip
 Inherited
Dispatches an event into the event flow.
EventDispatcher
  
drawFocus(isFocused:Boolean):void
Called by the FocusManager when the component receives focus.
UIMovieClip
  
executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object.
UIMovieClip
  
Provides the automation object at the specified index.
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
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
  
getConstraintValue(constraintName:String):*
Returns the specified constraint value.
UIMovieClip
  
A convenience method for determining whether to use the explicit or measured height
UIMovieClip
  
A convenience method for determining whether to use the explicit or measured 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
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
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 display object to see if it overlaps or intersects with 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
  
Initialize the object.
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 the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
  
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
  
owns(displayObject:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIMovieClip
  
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
  
For each effect event, register the EffectManager as one of the event listeners.
UIMovieClip
 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
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
  
Replays the specified event.
UIMovieClip
  
Resolves a child by using the id provided.
UIMovieClip
  
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
  
setConstraintValue(constraintName:String, value:*):void
Sets the specified constraint value.
UIMovieClip
  
Called by the FocusManager when the component receives focus.
UIMovieClip
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
  
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
Stops the playhead in the movie clip.
MovieClip
 Inherited
Ends the startDrag() method.
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
 Inherited
Returns the string representation of the specified object.
Object
 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
  
The main function that watches our size and progesses through transitions.
UIMovieClip
  
Recursively finds all children that have tabEnabled=true and adds them to the focusableObjects array.
UIMovieClip
  
Called when focus is entering any of our children.
UIMovieClip
  
Notify our parent that our size has changed.
UIMovieClip
Events
 Event Summary Defined By
 Inherited Dispatched when Flash Player or an AIR application gains operating system focus and becomes active.EventDispatcher
  
add
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method.UIMovieClip
 Inherited Dispatched when a display object is added to the display list.DisplayObject
 Inherited Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 Inherited Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when the user selects the context menu associated with this interactive object in an AIR application.InteractiveObject
   Dispatched when the component has finished its construction.UIMovieClip
   Dispatched after the view state has changed.UIMovieClip
   Dispatched after the currentState property changes, but before the view state changes.UIMovieClip
 Inherited Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive.EventDispatcher
 Inherited Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
   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.UIMovieClip
   Dispatched by the drop target when the user releases the mouse over it.UIMovieClip
   Dispatched by a component when the user moves the mouse over the component during a drag operation.UIMovieClip
   Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIMovieClip
   Dispatched by a component when the user moves the mouse while over the component during a drag operation.UIMovieClip
 Inherited Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited Dispatched after a display object gains focus.InteractiveObject
 Inherited Dispatched after a display object loses focus.InteractiveObject
   Dispatched when an object's state changes from visible to invisible.UIMovieClip
   Dispatched when the component has finished its construction and has all initialization properties set.UIMovieClip
 Inherited Dispatched when the user presses a key.InteractiveObject
 Inherited Dispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 Inherited Dispatched when the user releases a key.InteractiveObject
 Inherited Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 Inherited Dispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
   Dispatched from a component opened using the PopUpManager when the user clicks outside it.UIMovieClip
 Inherited Dispatched when the user atte