Package | mx.flash |
Class | public dynamic class UIMovieClip |
Inheritance | UIMovieClip ![]() ![]() ![]() ![]() ![]() ![]() ![]() |
Implements | IDeferredInstantiationUIComponent, IToolTipManagerClient, IStateClient, IFocusManagerComponent, IConstraintClient, IAutomationObject |
Subclasses | ContainerMovieClip |
The following procedure describes the basic process for creating a Flex component in Flash CS3:
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.
Property | Defined By | ||
---|---|---|---|
![]() | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
![]() | alpha : 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 | ||
![]() | blendMode : 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 | ||
![]() | buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
![]() | cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIMovieClip | ||
cachePolicy : String
[read-only]
Specifies the bitmap caching policy for this object.
| UIMovieClip | ||
![]() | constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
![]() | contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
![]() | currentFrame : int
[read-only]
Specifies the number of the frame in which the playhead is located in the timeline of
the MovieClip instance.
| MovieClip | |
![]() | currentLabel : String
[read-only]
The current label in which the playhead is located in the timeline of the MovieClip instance.
| MovieClip | |
![]() | currentLabels : Array
[read-only]
Returns an array of FrameLabel objects from the current scene.
| MovieClip | |
![]() | currentScene : 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 | ||
![]() | doubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
| InteractiveObject | |
![]() | dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
![]() | enabled : Boolean
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 | ||
![]() | filters : 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 | ||
![]() | focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
![]() | framesLoaded : int
[read-only]
The number of frames that are loaded from a streaming SWF file.
| MovieClip | |
![]() | graphics : 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 | ||
![]() | hitArea : 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 | ||
![]() | loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
![]() | mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
maxHeight : Number
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 | ||
![]() | mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
![]() | mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
mouseFocusEnabled : Boolean
[read-only]
A flag that indicates whether the component can receive focus
when selected with the mouse.
| UIMovieClip | ||
![]() | mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
![]() | name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIMovieClip | ||
![]() | numChildren : int
[read-only]
Returns the number of children of this object.
| DisplayObjectContainer | |
![]() | opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
owner : DisplayObjectContainer
Typically the parent container of this component.
| UIMovieClip | ||
![]() | parent : 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 | ||
![]() | prototype : 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 | ||
![]() | root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
![]() | rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
![]() | scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
![]() | scaleX : Number
Indicates the horizontal scale (percentage) of the object as applied from the registration point.
| DisplayObject | |
![]() | scaleY : Number
Indicates the vertical scale (percentage) of an object as applied from the registration point of the object.
| DisplayObject | |
![]() | scenes : 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 | |
![]() | scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIMovieClip | ||
![]() | soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
![]() | stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
systemManager : ISystemManager
A reference to the SystemManager object for this component.
| UIMovieClip | ||
![]() | tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
![]() | tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
![]() | tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
![]() | textSnapshot : 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 | ||
![]() | totalFrames : int
[read-only]
The total number of frames in the MovieClip instance.
| MovieClip | |
![]() | trackAsMenu : Boolean
Indicates whether other display objects that are SimpleButton or MovieClip objects can receive
mouse release events.
| MovieClip | |
![]() | transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
tweeningProperties : Array
Used by EffectManager.
| UIMovieClip | ||
![]() | useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
verticalCenter : *
The vertical distance in pixels from the center of the component's content area
to the center of the component.
| UIMovieClip | ||
![]() | visible : Boolean
Whether or not the display object is visible.
| DisplayObject | |
width : Number
The width of this object, in pixels.
| UIMovieClip | ||
![]() | x : Number
Indicates the x coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer.
| DisplayObject | |
![]() | y : Number
Indicates the y coordinate of the DisplayObject instance relative to the local coordinates of
the parent DisplayObjectContainer.
| DisplayObject |
Property | Defined 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 |
Method | Defined By | ||
---|---|---|---|
Constructor.
| UIMovieClip | ||
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
Adds a child DisplayObject instance to this DisplayObjectContainer
instance.
| DisplayObjectContainer | |
![]() |
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 | |
![]() |
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 | |
![]() |
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 | ||
![]() |
Dispatches an event into the event flow.
| EventDispatcher | |
Called by the FocusManager when the component receives focus.
| UIMovieClip | ||
Executes the data bindings into this UIComponent object.
| UIMovieClip | ||
Provides the automation object at the specified index.
| UIMovieClip | ||
![]() |
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object.
| DisplayObject | |
![]() |
Returns the child display object instance that exists at the specified index.
| DisplayObjectContainer | |
![]() |
Returns the child display object that exists with the specified name.
| DisplayObjectContainer | |
![]() |
Returns the index position of a child DisplayObject instance.
| DisplayObjectContainer | |
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 | ||
![]() |
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
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 | |
![]() |
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates.
| DisplayObject | |
![]() |
Starts playing the SWF file at the specified frame.
| MovieClip | |
![]() |
Brings the playhead to the specified frame of the movie clip and stops it there.
| MovieClip | |
![]() |
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event.
| EventDispatcher | |
![]() |
Indicates whether an object has a specified property defined.
| Object | |
![]() |
Evaluates the display object to see if it overlaps or intersects with the
obj display object.
| DisplayObject | |
![]() |
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 | ||
![]() |
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter.
| Object | |
![]() |
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 | ||
![]() |
Sends the playhead to the next frame and stops it.
| MovieClip | |
![]() |
Moves the playhead to the next scene of the MovieClip instance.
| MovieClip | |
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 | ||
![]() |
Moves the playhead in the timeline of the movie clip.
| MovieClip | |
![]() |
Sends the playhead to the previous frame and stops it.
| MovieClip | |
![]() |
Moves the playhead to the previous scene of the MovieClip instance.
| MovieClip | |
![]() |
Indicates whether the specified property exists and is enumerable.
| Object | |
For each effect event, register the EffectManager
as one of the event listeners.
| UIMovieClip | ||
![]() |
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
| DisplayObjectContainer | |
![]() |
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer.
| DisplayObjectContainer | |
![]() |
Removes a listener from the EventDispatcher object.
| EventDispatcher | |
Replays the specified event.
| UIMovieClip | ||
Resolves a child by using the id provided.
| UIMovieClip | ||
Sets the actual size of this object.
| UIMovieClip | ||
![]() |
Changes the position of an existing child in the display object container.
| DisplayObjectContainer | |
Sets the specified constraint value.
| UIMovieClip | ||
Called by the FocusManager when the component receives focus.
| UIMovieClip | ||
![]() |
Sets the availability of a dynamic property for loop operations.
| Object | |
Called when the visible property changes.
| UIMovieClip | ||
![]() |
Lets the user drag the specified sprite.
| Sprite | |
![]() |
Stops the playhead in the movie clip.
| MovieClip | |
![]() |
Ends the startDrag() method.
| Sprite | |
![]() |
Swaps the z-order (front-to-back order) of the two specified child objects.
| DisplayObjectContainer | |
![]() |
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list.
| DisplayObjectContainer | |
![]() |
Returns the string representation of the specified object.
| Object | |
![]() |
Returns the primitive value of the specified object.
| Object | |
![]() |
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher |
Method | Defined 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 |
Event | Summary | Defined By | ||
---|---|---|---|---|
![]() | Dispatched when Flash Player or an AIR application gains operating system focus and becomes active. | EventDispatcher | ||
Dispatched when the component is added to a container as a content child by using the addChild() or addChildAt() method. | UIMovieClip | |||
![]() | Dispatched when a display object is added to the display list. | DisplayObject | ||
![]() | 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 | ||
![]() | Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
![]() | 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 | |||
![]() | Dispatched when Flash Player or an AIR application loses operating system focus and is becoming inactive. | EventDispatcher | ||
![]() | 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 | |||
![]() | Dispatched when the playhead is entering a new frame. | DisplayObject | ||
![]() | Dispatched after a display object gains focus. | InteractiveObject | ||
![]() | 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 | |||
![]() | Dispatched when the user presses a key. | InteractiveObject | ||
![]() | Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
![]() | Dispatched when the user releases a key. | InteractiveObject | ||
![]() | Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | 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 | |||
![]() | Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
![]() | Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIMovieClip | |||
Dispatched when the object has moved. | UIMovieClip | |||
![]() | Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
![]() | Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
![]() | Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
![]() | Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
![]() | Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
![]() | Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
![]() | Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
Dispatched at the beginning of the component initialization sequence. | UIMovieClip | |||
Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() method. | UIMovieClip | |||
![]() | Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
![]() | Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
![]() | Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
Dispatched when the component is resized. | UIMovieClip | |||
![]() | Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
![]() | Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
![]() | Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
Dispatched when an object's state changes from invisible to visible. | UIMovieClip | |||
![]() | Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
![]() | Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
![]() | Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
Dispatched by the component when it is time to create a ToolTip. | UIMovieClip | |||
Dispatched by the component when its ToolTip has been hidden and will be discarded soon. | UIMovieClip | |||
Dispatched by the component when its ToolTip is about to be hidden. | UIMovieClip | |||
Dispatched by the component when its ToolTip is about to be shown. | UIMovieClip | |||
Dispatched by the component when its ToolTip has been shown. | UIMovieClip | |||
Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIMovieClip |
automationDelegate | property |
automationDelegate:Object
[read-write] The delegate object that handles the automation-related functionality.
public function get automationDelegate():Object
public function set automationDelegate(value:Object):void
automationName | property |
automationName:String
[read-write]
Name that can be used as an identifier for this object.
public function get automationName():String
public function set automationName(value:String):void
automationTabularData | property |
automationTabularData:Object
[read-only]
An implementation of the IAutomationTabularData
interface, which
can be used to retrieve the data.
public function get automationTabularData():Object
automationValue | property |
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.
public function get automationValue():Array
baseline | property |
baseline:*
[read-write] The vertical distance in pixels from the top edge of the content area to the component's baseline position. If this property is set, the baseline of the component is anchored to the top edge of its content area; when its container is resized, the two edges maintain their separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get baseline():*
public function set baseline(value:any):void
baselinePosition | property |
baselinePosition:Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
public function get baselinePosition():Number
bottom | property |
bottom:*
[read-write] The vertical distance, in pixels, from the lower edge of the component to the lower edge of its content area. If this property is set, the lower edge of the component is anchored to the bottom edge of its content area; when its container is resized, the two edges maintain their separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get bottom():*
public function set bottom(value:any):void
boundingBoxName | property |
public var boundingBoxName:String = "boundingBox"
Name of the object to use as the bounding box.
The bounding box is an object that is used by Flex to determine the size of the component. The actual content can be larger or smaller than the bounding box, but Flex uses the size of the bounding box when laying out the component. This object is optional. If omitted, the actual content size of the component is used instead.
The default value is "boundingBox"
.
bounds | property |
bounds:Rectangle
[read-only] The unscaled bounds of the content.
protected function get bounds():Rectangle
cacheHeuristic | property |
cacheHeuristic:Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
If cachePolicy
is UIComponentCachePolicy.AUTO
,
then cacheHeuristic
is used to control the object's cacheAsBitmap
property.
public function set cacheHeuristic(value:Boolean):void
cachePolicy | property |
cachePolicy:String
[read-only]
Specifies the bitmap caching policy for this object.
Possible values in MXML are "on"
,
"off"
and
"auto"
(default).
Possible values in ActionScript are UIComponentCachePolicy.ON
,
UIComponentCachePolicy.OFF
and
UIComponentCachePolicy.AUTO
(default).
UIComponentCachePolicy.ON
means that
the object is always cached as a bitmap.UIComponentCachePolicy.OFF
means that
the object is never cached as a bitmap.UIComponentCachePolicy.AUTO
means that
the framework uses heuristics to decide whether the object should
be cached as a bitmap. The default value is UIComponentCachePolicy.AUTO
.
public function get cachePolicy():String
currentState | property |
currentState:String
[read-write]
The current state of this component. For UIMovieClip, the value of the
currentState
property is the current frame label.
public function get currentState():String
public function set currentState(value:String):void
descriptor | property |
descriptor:UIComponentDescriptor
[read-write]
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor()
method to create this
UIComponent instance. If this UIComponent instance
was not created from a descriptor, this property is null.
public function get descriptor():UIComponentDescriptor
public function set descriptor(value:UIComponentDescriptor):void
See also
document | property |
document:Object
[read-write] A reference to the document object associated with this component. A document object is an Object at the top of the hierarchy of a Flex application, MXML component, or ActionScript component.
public function get document():Object
public function set document(value:Object):void
explicitHeight | property |
explicitHeight:Number
[read-write]
The explicitly specified height for the component,
in pixels, as the component's coordinates.
If no height is explicitly specified, the value is NaN
.
public function get explicitHeight():Number
public function set explicitHeight(value:Number):void
See also
explicitMaxHeight | property |
explicitMaxHeight:Number
[read-write] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
public function get explicitMaxHeight():Number
public function set explicitMaxHeight(value:Number):void
See also
explicitMaxWidth | property |
explicitMaxWidth:Number
[read-write] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
public function get explicitMaxWidth():Number
public function set explicitMaxWidth(value:Number):void
See also
explicitMinHeight | property |
explicitMinHeight:Number
[read-write] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
public function get explicitMinHeight():Number
public function set explicitMinHeight(value:Number):void
See also
explicitMinWidth | property |
explicitMinWidth:Number
[read-write] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
public function get explicitMinWidth():Number
public function set explicitMinWidth(value:Number):void
See also
explicitWidth | property |
explicitWidth:Number
[read-write]
The explicitly specified width for the component,
in pixels, as the component's coordinates.
If no width is explicitly specified, the value is NaN
.
public function get explicitWidth():Number
public function set explicitWidth(value:Number):void
See also
focusEnabled | property |
focusEnabled:Boolean
[read-write] A flag that indicates whether the component can receive focus when selected.
As an optimization, if a child component in your component
implements the IFocusManagerComponent interface, and you
never want it to receive focus,
you can set focusEnabled
to false
before calling addChild()
on the child component.
This will cause the FocusManager to ignore this component
and not monitor it for changes to the tabEnabled
,
tabChildren
, and mouseFocusEnabled
properties.
This also means you cannot change this value after
addChild()
and expect the FocusManager to notice.
Note: It does not mean that you cannot give this object focus
programmatically in your setFocus()
method;
it just tells the FocusManager to ignore this IFocusManagerComponent
component in the Tab and mouse searches.
public function get focusEnabled():Boolean
public function set focusEnabled(value:Boolean):void
focusPane | property |
focusPane:Sprite
[read-write] A single Sprite object that is shared among components and used as an overlay for drawing focus. Components share this object if their parent is a focused component, not if the component implements the IFocusManagerComponent interface.
public function get focusPane():Sprite
public function set focusPane(value:Sprite):void
See also
height | property |
public var height:Number
The height of this object, in pixels.
horizontalCenter | property |
horizontalCenter:*
[read-write] The horizontal distance in pixels from the center of the component's content area to the center of the component. If this property is set, the center of the component will be anchored to the center of its content area; when its container is resized, the two centers maintain their horizontal separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get horizontalCenter():*
public function set horizontalCenter(value:any):void
id | property |
id:String
[read-write] ID of the component. This value becomes the instance name of the object and should not contain any white space or special characters. Each component throughout an application should have a unique id.
If your application is going to be tested by third party tools, give each component a meaningful id. Testing tools use ids to represent the control in their scripts and having a meaningful name can make scripts more readable. For example, set the value of a button to submit_button rather than b1 or button1.
public function get id():String
public function set id(value:String):void
includeInLayout | property |
includeInLayout:Boolean
[read-write]
Specifies whether this component is included in the layout of the
parent container.
If true
, the object is included in its parent container's
layout. If false
, the object is positioned by its parent
container as per its layout rules, but it is ignored for the purpose of
computing the position of the next child.
The default value is true
.
public function get includeInLayout():Boolean
public function set includeInLayout(value:Boolean):void
initialized | property |
protected var 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).
isPopUp | property |
isPopUp:Boolean
[read-write]
Set to true
by the PopUpManager to indicate
that component has been popped up.
public function get isPopUp():Boolean
public function set isPopUp(value:Boolean):void
left | property |
left:*
[read-write] The horizontal distance, in pixels, from the left edge of the component's content area to the left edge of the component. If this property is set, the left edge of the component is anchored to the left edge of its content area; when its container is resized, the two edges maintain their separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get left():*
public function set left(value:any):void
maxHeight | property |
maxHeight:Number
[read-write] Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
public function get maxHeight():Number
public function set maxHeight(value:Number):void
See also
maxWidth | property |
maxWidth:Number
[read-write] Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
public function get maxWidth():Number
public function set maxWidth(value:Number):void
See also
measuredHeight | property |
measuredHeight:Number
[read-only] The measured height of this object.
This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a measure()
method will be called at an appropriate time,
giving you an opportunity to compute a measuredHeight
.
public function get measuredHeight():Number
measuredMinHeight | property |
measuredMinHeight:Number
[read-write]
The default minimum height of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinHeight():Number
public function set measuredMinHeight(value:Number):void
measuredMinWidth | property |
measuredMinWidth:Number
[read-write]
The default minimum width of the component, in pixels.
This value is set by the measure()
method.
public function get measuredMinWidth():Number
public function set measuredMinWidth(value:Number):void
measuredWidth | property |
measuredWidth:Number
[read-only] The measured width of this object.
This is typically hard-coded for graphical skins
because this number is simply the number of pixels in the graphic.
For code skins, it can also be hard-coded
if you expect to be drawn at a certain size.
If your size can change based on properties, you may want
to also be an ILayoutManagerClient so a measure()
method will be called at an appropriate time,
giving you an opportunity to compute a measuredHeight
.
public function get measuredWidth():Number
minHeight | property |
minHeight:Number
[read-write] Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
public function get minHeight():Number
public function set minHeight(value:Number):void
See also
minWidth | property |
minWidth:Number
[read-write] Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
public function get minWidth():Number
public function set minWidth(value:Number):void
See also
mouseFocusEnabled | property |
mouseFocusEnabled:Boolean
[read-only]
A flag that indicates whether the component can receive focus
when selected with the mouse.
If false
, focus will be transferred to
the first parent that is mouseFocusEnabled
.
public function get mouseFocusEnabled():Boolean
numAutomationChildren | property |
numAutomationChildren:int
[read-only]
The number of automation children this container has. This sum should not include any composite children, though it does include those children not significant within the automation hierarchy.
public function get numAutomationChildren():int
owner | property |
owner:DisplayObjectContainer
[read-write] Typically the parent container of this component. However, if this is a popup component, the owner is the component that popped it up. For example, the owner of a dropdown list of a ComboBox control is the ComboBox control itself. This property is not managed by Flex, but by each component. Therefore, if you popup a component, you should set this property accordingly.
public function get owner():DisplayObjectContainer
public function set owner(value:DisplayObjectContainer):void
parentDocument | property |
parentDocument:Object
[read-only] The document containing this component.
public function get parentDocument():Object
percentHeight | property |
percentHeight:Number
[read-write] Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.
public function get percentHeight():Number
public function set percentHeight(value:Number):void
percentWidth | property |
percentWidth:Number
[read-write] Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.
public function get percentWidth():Number
public function set percentWidth(value:Number):void
right | property |
right:*
[read-write] The horizontal distance, in pixels, from the right edge of the component to the right edge of its content area. If this property is set, the right edge of the component is anchored to the right edge of its content area; when its container is resized, the two edges maintain their separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get right():*
public function set right(value:any):void
showInAutomationHierarchy | property |
showInAutomationHierarchy:Boolean
[read-write]
A flag that determines if an automation object shows in the automation hierarchy. Children of containers that are not visible in the hierarchy appear as children of the next highest visible parent. Typically containers used for layout, such as boxes and Canvas, do not appear in the hierarchy.
Some controls force their children to appear
in the hierarchy when appropriate.
For example a List will always force item renderers,
including boxes, to appear in the hierarchy.
Implementers must support setting this property
to true
.
public function get showInAutomationHierarchy():Boolean
public function set showInAutomationHierarchy(value:Boolean):void
systemManager | property |
systemManager:ISystemManager
[read-write] A reference to the SystemManager object for this component.
public function get systemManager():ISystemManager
public function set systemManager(value:ISystemManager):void
toolTip | property |
toolTip:String
[read-write] Text to display in the ToolTip.
The default value is null
.
public function get toolTip():String
public function set toolTip(value:String):void
top | property |
top:*
[read-write] The vertical distance, in pixels, from the top edge of the control's content area to the top edge of the component. If this property is set, the top edge of the component is anchored to the top edge of its content area; when its container is resized, the two edges maintain their separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get top():*
public function set top(value:any):void
tweeningProperties | property |
tweeningProperties:Array
[read-write] Used by EffectManager. Returns non-null if a component is not using the EffectManager to execute a Tween.
public function get tweeningProperties():Array
public function set tweeningProperties(value:Array):void
verticalCenter | property |
verticalCenter:*
[read-write] The vertical distance in pixels from the center of the component's content area to the center of the component. If this property is set, the center of the component is anchored to the center of its content area; when its container is resized, the two centers maintain their vertical separation.
This property only has an effect when used on a component in a Canvas container,
or when used on a component in a Panel or Application container
that has the layout property set to absolute
.
The default value is undefined
, which means it is not set.
This property can be used as the source for data binding.
public function get verticalCenter():*
public function set verticalCenter(value:any):void
width | property |
public var width:Number
The width of this object, in pixels.
UIMovieClip | () | Constructor |
public function UIMovieClip()
Constructor.
createAutomationIDPart | () | method |
public function createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.
Parameters
child:IAutomationObject — Child for which to provide the id.
|
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
createReferenceOnParentDocument | () | method |
public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id
reference to this IUIComponent object
on its parent document object.
This function can create multidimensional references
such as b[2][4] for objects inside one or more repeaters.
If the indices are null, it creates a simple non-Array reference.
Parameters
parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.
|
deleteReferenceOnParentDocument | () | method |
public function deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id
reference to this IUIComponent object
on its parent document object.
This function can delete from multidimensional references
such as b[2][4] for objects inside one or more Repeaters.
If the indices are null, it deletes the simple non-Array reference.
Parameters
parentDocument:IFlexDisplayObject — The parent of this IUIComponent object.
|
drawFocus | () | method |
public function drawFocus(isFocused:Boolean):void
Called by the FocusManager when the component receives focus. The component should draw or hide a graphic that indicates that the component has focus.
Parameters
isFocused:Boolean — If true , draw the focus indicator,
otherwise hide it.
|
enterFrameHandler | () | method |
protected function enterFrameHandler(event:Event):void
The main function that watches our size and progesses through transitions.
Parameters
event:Event |
executeBindings | () | method |
public function executeBindings(recurse:Boolean = false):void
Executes the data bindings into this UIComponent object. 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 ) — Recursively execute bindings for children of this component.
|
findFocusCandidates | () | method |
protected function findFocusCandidates(obj:DisplayObjectContainer):void
Recursively finds all children that have tabEnabled=true and adds them to the focusableObjects array.
Parameters
obj:DisplayObjectContainer |
focusInHandler | () | method |
protected function focusInHandler(event:FocusEvent):void
Called when focus is entering any of our children. Make sure our focus event handlers are called so we can take control from the Flex focus manager.
Parameters
event:FocusEvent |
getAutomationChildAt | () | method |
public function getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. This list should not include any children that are composites.
Parameters
index:int — The index of the child to return
|
IAutomationObject — The child at the specified index.
|
getConstraintValue | () | method |
public function getConstraintValue(constraintName:String):*
Returns the specified constraint value.
Parameters
constraintName:String — name of the constraint value. Constraint parameters are
"baseline ", "bottom ", "horizontalCenter ",
"left ", "right ", "top ", and
"verticalCenter ".
For more information about these parameters, see the Canvas and Panel containers and Styles Metadata AnchorStyles. |
* — The constraint value, or null if it is not defined.
|
getExplicitOrMeasuredHeight | () | method |
public function getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the explicit or measured height
ReturnsNumber — A Number which is explicitHeight if defined
or measuredHeight if not.
|
getExplicitOrMeasuredWidth | () | method |
public function getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the explicit or measured width
ReturnsNumber — A Number which is explicitWidth if defined
or measuredWidth if not.
|
initialize | () | method |
move | () | method |
public function move(x:Number, y:Number):void
Moves this object to the specified x and y coordinates.
Parameters
x:Number — The new x-position for this object.
|
|
y:Number — The new y-position for this object.
|
notifySizeChanged | () | method |
protected function notifySizeChanged():void
Notify our parent that our size has changed.
owns | () | method |
public function owns(displayObject:DisplayObject):Boolean
Returns true
if the chain of owner
properties
points from child
to this UIComponent.
Parameters
displayObject:DisplayObject — A UIComponent.
|
Boolean —
true if the child is parented or owned by this UIComponent.
|
parentChanged | () | method |
public function parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. Developers typically never need to call this method.
Parameters
p:DisplayObjectContainer — The parent of this UIComponent object.
|
registerEffects | () | method |
public function registerEffects(effects:Array):void
For each effect event, register the EffectManager as one of the event listeners.
Parameters
effects:Array — An Array of strings of effect names.
|
replayAutomatableEvent | () | method |
public function replayAutomatableEvent(event:Event):Boolean
Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.
Parameters
event:Event — The event to replay.
|
Boolean —
true if a replay was successful.
|
resolveAutomationIDPart | () | method |
public function resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. The id is a set
of properties as provided by the createAutomationIDPart()
method.
Parameters
criteria:Object — Set of properties describing the child.
The criteria can contain regular expression values
resulting in multiple children being matched.
|
Array — Array of children that matched the criteria
or null if no children could not be resolved.
|
setActualSize | () | method |
public function setActualSize(newWidth:Number, newHeight:Number):void
Sets the actual size of this object.
This method is mainly for use in implementing the
updateDisplayList()
method, which is where
you compute this object's actual size based on
its explicit size, parent-relative (percent) size,
and measured size.
You then apply this actual size to the object
by calling setActualSize()
.
In other situations, you should be setting properties
such as width
, height
,
percentWidth
, or percentHeight
rather than calling this method.
Parameters
newWidth:Number — The new width for this object.
|
|
newHeight:Number — The new height for this object.
|
setConstraintValue | () | method |
public function setConstraintValue(constraintName:String, value:*):void
Sets the specified constraint value.
Parameters
constraintName:String — name of the constraint value. Constraint parameters are
"baseline ", "bottom ", "horizontalCenter ",
"left ", "right ", "top ", and
"verticalCenter ".
For more information about these parameters, see the Canvas and Panel containers and Styles Metadata AnchorStyles. |
|
value:* — The new value for the constraint.
|
setFocus | () | method |
public function setFocus():void
Called by the FocusManager when the component receives focus. The component may in turn set focus to an internal component.
setVisible | () | method |
public function setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible
property changes.
You should set the visible
property to show or hide
a component instead of calling this method directly.
Parameters
value:Boolean — The new value of the visible property.
Specify true to show the component, and false to hide it.
|
|
noEvent:Boolean (default = false ) — If true , do not dispatch an event.
If false , dispatch a show event when
the component becomes visible, and a hide event when
the component becomes invisible.
|
add | Event |
mx.events.FlexEvent
mx.events.FlexEvent.ADD
Dispatched when the component is added to a container as a content child
by using the addChild()
or addChildAt()
method.
If the component is added to the container as a noncontent child by
using the rawChildren.addChild()
or
rawChildren.addChildAt()
method, the event is not dispatched.
FlexEvent.ADD
constant defines the value of the
type
property of the event object for an add
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
creationComplete | Event |
mx.events.FlexEvent
mx.events.FlexEvent.CREATION_COMPLETE
Dispatched when the component has finished its construction.
For Flash-based components, this is the same time as the
initialize
event.
FlexEvent.CREATION_COMPLETE
constant defines the value of the
type
property of the event object for a creationComplete
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
currentStateChange | Event |
mx.events.StateChangeEvent
mx.events.StateChangeEvent.CURRENT_STATE_CHANGE
Dispatched after the view state has changed.
The StateChangeEvent.CURRENT_STATE_CHANGE constant defines the value of thetype
property of the event that is dispatched
when the view state has changed.
The value of this constant is "currentStateChange".
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
newState | The name of the view state that was entered. |
oldState | The name of the view state that was exited. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | StateChangeEvent.CURRENT_STATE_CHANGE |
currentStateChanging | Event |
mx.events.StateChangeEvent
mx.events.StateChangeEvent.CURRENT_STATE_CHANGING
Dispatched after the currentState
property changes,
but before the view state changes.
type
property of the event that is dispatched
when the view state is about to change.
The value of this constant is "currentStateChanging".
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
newState | The name of the view state that is being entered. |
oldState | The name of the view state that is being exited. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | StateChangeEvent.CURRENT_STATE_CHANGING |
dragComplete | Event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_COMPLETE
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.
You can use this event to perform any final cleanup of the drag-and-drop operation. For example, if you drag a List control item from one list to another, you can delete the List control item from the source if you no longer need it.
If you call Event.preventDefault()
in the event handler
for the dragComplete
event for
a Tree control when dragging data from one Tree control to another,
it prevents the drop.
DragEvent.DRAG_COMPLETE
constant defines the value of the
type
property of the event object for a dragComplete
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
dragDrop | Event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_DROP
Dispatched by the drop target when the user releases the mouse over it.
You use this event handler to add the drag data to the drop target.
If you call Event.preventDefault()
in the event handler
for the dragDrop
event for
a Tree control when dragging data from one Tree control to another,
it prevents the drop.
DragEvent.DRAG_DROP
constant defines the value of the
type
property of the event object for a dragDrop
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
dragEnter | Event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_ENTER
Dispatched by a component when the user moves the mouse over the component during a drag operation.
In order to be a valid drop target, you must define a handler for this event. In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.
If you want to accept the drag, you must call the
DragManager.acceptDragDrop()
method. If you don't
call acceptDragDrop()
, you will not get any of the
other drag events.
The value of the action
property is always
DragManager.MOVE
, even if you are doing a copy.
This is because the dragEnter
event occurs before
the control recognizes that the Control key is pressed to signal a copy.
The action
property of the event object for the
dragOver
event does contain a value that signifies the type of
drag operation.
You may change the type of drag action by calling the
DragManager.showFeedback()
method.
DragEvent.DRAG_ENTER
constant defines the value of the
type
property of the event object for a dragEnter
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event, which is always
DragManager.MOVE . |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
See also
dragExit | Event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_EXIT
Dispatched by the component when the user drags outside the component, but does not drop the data onto the target.
You use this event to restore the drop target to its normal appearance
if you modified its appearance as part of handling the
dragEnter
or dragOver
event.
DragEvent.DRAG_EXIT
constant defines the value of the
type
property of the event object for a dragExit
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
dragOver | Event |
mx.events.DragEvent
mx.events.DragEvent.DRAG_OVER
Dispatched by a component when the user moves the mouse while over the component during a drag operation.
In the handler, you can change the appearance of the drop target to provide visual feedback to the user that the component can accept the drag. For example, you could draw a border around the drop target, or give focus to the drop target.
You should handle this event to perform additional logic before allowing the drop, such as dropping data to various locations in the drop target, reading keyboard input to determine if the drag-and-drop action is a move or copy of the drag data, or providing different types of visual feedback based on the type of drag-and-drop action.
You may also change the type of drag action by changing the
DragManager.showFeedback()
method.
The default value of the action
property is
DragManager.MOVE
.
DragEvent.DRAG_OVER
constant defines the value of the
type
property of the event object for a dragOver
event.
The properties of the event object have the following values:
Property | Value |
---|---|
action | The action that caused the event:
DragManager.COPY , DragManager.LINK ,
DragManager.MOVE , or DragManager.NONE . |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
See also
hide | Event |
mx.events.FlexEvent
mx.events.FlexEvent.HIDE
Dispatched when an object's state changes from visible to invisible.
TheFlexEvent.HIDE
constant defines the value of the
type
property of the event object for a hide
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
initialize | Event |
mx.events.FlexEvent
mx.events.FlexEvent.INITIALIZE
Dispatched when the component has finished its construction and has all initialization properties set.
TheFlexEvent.INITIALIZE
constant defines the value of the
type
property of the event object for a initialize
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
mouseDownOutside | Event |
mx.events.FlexMouseEvent
mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE
Dispatched from a component opened using the PopUpManager when the user clicks outside it.
TheFlexMouseEvent.MOUSE_DOWN_OUTSIDE
constant defines the value of the
type
property of the event object for a mouseDownOutside
event.
The properties of the event object have the following values:
Property | Value |
---|---|
altKey | Indicates whether the Alt key is down
(true ) or not (false ). |
bubbles | false |
buttonDown | Indicates whether the main mouse button is down
(true ) or not (false ). |
cancelable | false |
ctrlKey | Indicates whether the Control key is down
(true ) or not (false ). |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget .
For PopUpManager events, the object is the pop-up window. |
delta | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0. |
localX | The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
localY | The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
relatedObject | A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located. |
shiftKey | Indicates whether the Shift key is down
(true ) or not (false ). |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event.
For PopUpManager events, the object is the pop-up window. |
mouseWheelOutside | Event |
mx.events.FlexMouseEvent
mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE
Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.
TheFlexMouseEvent.MOUSE_WHEEL_OUTSIDE
constant defines the value of the
type
property of the event object for a mouseWheelOutside
event.
The properties of the event object have the following values:
Property | Value |
---|---|
altKey | Indicates whether the Alt key is down
(true ) or not (false ). |
bubbles | false |
buttonDown | Indicates whether the main mouse button is down
(true ) or not (false ). |
cancelable | false |
ctrlKey | Indicates whether the Control key is down
(true ) or not (false ). |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget .
For PopUpManager events, the object is the pop-up window. |
delta | Indicates how many lines should be scrolled for each notch the user scrolls the mouse wheel. For PopUpManager events this value is 0. |
localX | The horizontal position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
localY | The vertical position at which the event occurred. For PopUpManager events, the value is relative to the pop-up control. |
relatedObject | A reference to a display list object that is related to the event. For PopUpManager events, the object is the container over which the mouse pointer is located. |
shiftKey | Indicates whether the Shift key is down
(true ) or not (false ). |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event.
For PopUpManager events, the object is the pop-up window. |
move | Event |
mx.events.MoveEvent
mx.events.MoveEvent.MOVE
Dispatched when the object has moved.
You can move the component by setting the x
or y
properties, by calling the move()
method, by setting one
of the following properties either on the component or on other
components such that the LayoutManager needs to change the
x
or y
properties of the component:
minWidth
minHeight
maxWidth
maxHeight
explicitWidth
explicitHeight
When you call the move()
method, the move
event is dispatched before the method returns.
In all other situations, the move
event is not dispatched
until after the property changes.
MoveEvent.MOVE
constant defines the value of the
type
property of the event object for a move
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
oldX | The previous x coordinate of the object, in pixels. |
oldY | The previous y coordinate of the object, in pixels. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
preinitialize | Event |
mx.events.FlexEvent
mx.events.FlexEvent.PREINITIALIZE
Dispatched at the beginning of the component initialization sequence.
The component is in a very raw state when this event is dispatched.
Many components, such as the Button control, create internal child
components to implement functionality; for example, the Button control
creates an internal UITextField component to represent its label text.
When Flex dispatches the preinitialize
event,
the children, including the internal children, of a component
have not yet been created.
FlexEvent.PREINITIALIZE
constant defines the value of the
type
property of the event object for a preinitialize
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
remove | Event |
mx.events.FlexEvent
mx.events.FlexEvent.REMOVE
Dispatched when the component is removed from a container as a content child
by using the removeChild()
or removeChildAt()
method.
If the component is removed from the container as a noncontent child by
using the rawChildren.removeChild()
or
rawChildren.removeChildAt()
method, the event is not dispatched.
FlexEvent.REMOVE
constant defines the value of the
type
property of the event object for an remove
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
resize | Event |
mx.events.ResizeEvent
mx.events.ResizeEvent.RESIZE
Dispatched when the component is resized.
You can resize the component by setting the width
or
height
property, by calling the setActualSize()
method, or by setting one of
the following properties either on the component or on other components
such that the LayoutManager needs to change the width
or
height
properties of the component:
minWidth
minHeight
maxWidth
maxHeight
explicitWidth
explicitHeight
The resize
event is not
dispatched until after the property changes.
ResizeEvent.RESIZE
constant defines the value of the
type
property of the event object for a resize
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
oldHeight | The previous height of the object, in pixels. |
oldWidth | The previous width of the object, in pixels. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
show | Event |
mx.events.FlexEvent
mx.events.FlexEvent.SHOW
Dispatched when an object's state changes from invisible to visible.
TheFlexEvent.SHOW
constant defines the value of the
type
property of the event object for a show
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
toolTipCreate | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_CREATE
Dispatched by the component when it is time to create a ToolTip.
If you create your own IToolTip object and place a reference
to it in the toolTip
property of the event object
that is passed to your toolTipCreate
handler,
the ToolTipManager displays your custom ToolTip.
Otherwise, the ToolTipManager creates an instance of
ToolTipManager.toolTipClass
to display.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_CREATE
constant defines the value of the
type
property of the event object for a toolTipCreate
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |
toolTipEnd | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_END
Dispatched by the component when its ToolTip has been hidden and will be discarded soon.
If you specify an effect using the
ToolTipManager.hideEffect
property,
this event is dispatched after the effect stops playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_END
constant defines the value of the
type
property of the event object for a toolTipEnd
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |
toolTipHide | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_HIDE
Dispatched by the component when its ToolTip is about to be hidden.
If you specify an effect using the
ToolTipManager.hideEffect
property,
this event is dispatched before the effect starts playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_HIDE
constant defines the value of the
type
property of the event object for a toolTipHide
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |
toolTipShow | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_SHOW
Dispatched by the component when its ToolTip is about to be shown.
If you specify an effect using the
ToolTipManager.showEffect
property,
this event is dispatched before the effect starts playing.
You can use this event to modify the ToolTip before it appears.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_SHOW
constant defines the value of the
type
property of the event object for a toolTipShow
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |
toolTipShown | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_SHOWN
Dispatched by the component when its ToolTip has been shown.
If you specify an effect using the
ToolTipManager.showEffect
property,
this event is dispatched after the effect stops playing.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_SHOWN
constant defines the value of the
type
property of the event object for a toolTipShown
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |
toolTipStart | Event |
mx.events.ToolTipEvent
mx.events.ToolTipEvent.TOOL_TIP_START
Dispatched by a component whose toolTip
property is set,
as soon as the user moves the mouse over it.
The sequence of ToolTip events is toolTipStart
,
toolTipCreate
, toolTipShow
,
toolTipShown
, toolTipHide
,
and toolTipEnd
.
ToolTipEvent.TOOL_TIP_START
constant defines the value of the
type
property of the event object for a toolTipStart
event.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
tooltip | The ToolTip object to which this event applies. |