| Package | mx.flash |
| Class | public dynamic class UIMovieClip |
| Inheritance | UIMovieClip  MovieClip Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDeferredInstantiationUIComponent, IToolTipManagerClient, IStateClient, IFocusManagerComponent, IConstraintClient, IAutomationObject, IVisualElement, ILayoutElement, IFlexModule |
| Subclasses | ContainerMovieClip |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The following procedure describes the basic process for creating a Flex component in Flash Professional:
- Install the Adobe Flash Component Kit for Flex.
- Create symbols for your dynamic assets in the FLA file.
- Run Commands > Make Flex Component to convert your symbol to a subclass of the UIMovieClip class, and to configure the Flash Professional publishing settings for use with Flex.
- Publish your FLA file as a SWC file.
- Reference the class name of your symbols in your Flex application as you would any class.
- Include the SWC file in your
library-pathwhen 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.
Hide Inherited Public Properties
Show Inherited Public Properties| Property | Defined By | ||
|---|---|---|---|
 | accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| 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 | ||
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIMovieClip | ||
| automationName : String
Name that can be used as an identifier for this object. | UIMovieClip | ||
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIMovieClip | ||
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | 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 | ||
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIMovieClip | ||
| autoUpdateCurrentState : Boolean
Whether we should actively watch changes to the label of the flash object. | UIMovieClip | ||
| autoUpdateMeasuredSize : Boolean
Whether we should actively watch changes to the size of the flash object. | UIMovieClip | ||
| baseline : Object
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 | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| bottom : Object
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 runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | 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 | |
| currentFrameLabel : String [read-only]
The label at the current frame 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 | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIMovieClip | ||
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIMovieClip | ||
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | 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 | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIMovieClip | ||
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIMovieClip | ||
| height : Number [override]
The height of this object, in pixels. | UIMovieClip | ||
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
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 | ||
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIMovieClip | ||
| isPlaying : Boolean [read-only]
Indicates whether this movie clip is curently playing. | MovieClip | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIMovieClip | ||
| layoutDirection : String
Specifies the desired layout direction for an element: one of LayoutDirection.LTR
(left to right), LayoutDirection.RTL (right to left), or null (inherit). | UIMovieClip | ||
| left : Object
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 | |
| maintainProjectionCenter : Boolean
When true, the component will keep its projection matrix centered on the
middle of its bounding box. | UIMovieClip | ||
| 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 | ||
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embeded fonts and for
finding the style manager that controls the styles for this
component. | UIMovieClip | ||
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean [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 or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| 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 | ||
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the component's transform in a way that is
invisible to the component's parent's layout. | UIMovieClip | ||
| prototype : Object [static]
A reference to the prototype object of a class or function object. | Object | |
| right : Object
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 [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIMovieClip | ||
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees,
from its original orientation relative to the 3D parent container. | UIMovieClip | ||
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees,
from its original orientation relative to the 3D parent container. | UIMovieClip | ||
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIMovieClip | ||
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIMovieClip | ||
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIMovieClip | ||
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIMovieClip | ||
| 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 | ||
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed. | InteractiveObject | |
| soundTransform : flash.media: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 | |
| tabFocusEnabled : Boolean
A flag that indicates whether child objects can receive focus
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIMovieClip | ||
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIMovieClip | ||
| top : Object
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 or other user input release events. | MovieClip | |
| transform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds. | DisplayObject | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIMovieClip | ||
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIMovieClip | ||
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIMovieClip | ||
| tweeningProperties : Array
Used by EffectManager. | UIMovieClip | ||
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| verticalCenter : Object
The vertical distance in pixels from the center of the component's content area
to the center of the component. | UIMovieClip | ||
| visible : Boolean [override]
Whether or not the display object is visible. | UIMovieClip | ||
| width : Number [override]
The width of this object, in pixels. | UIMovieClip | ||
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIMovieClip | ||
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIMovieClip | ||
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIMovieClip | ||
| 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 | ||
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 | ||
Provides the automation object list . | UIMovieClip | ||
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
Returns the x coordinate of the element's bounds at the specified element size. | UIMovieClip | ||
Returns the y coordinate of the element's bounds at the specified element size. | UIMovieClip | ||
|
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 the element's layout height. | UIMovieClip | ||
Returns the element's layout width. | UIMovieClip | ||
Returns the x coordinate that the element uses to draw on screen. | UIMovieClip | ||
Returns the y coordinate that the element uses to draw on screen. | UIMovieClip | ||
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIMovieClip | ||
Returns the layout transform Matrix3D for this element. | UIMovieClip | ||
Returns the element's maximum height. | UIMovieClip | ||
Returns the element's maximum width. | UIMovieClip | ||
Returns the element's minimum height. | UIMovieClip | ||
Returns the element's minimum 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 the element's preferred height. | UIMovieClip | ||
Returns the element's preferred width. | UIMovieClip | ||
|
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 | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional 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 bounding box of the display object to see if it overlaps or intersects with the
bounding box of 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 | ||
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIMovieClip | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
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 one or more child DisplayObject instances from the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
Replays the specified event. | UIMovieClip | ||
|
Raises a virtual keyboard. | InteractiveObject | |
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 coordinates that the element uses to draw on screen. | UIMovieClip | ||
Sets the layout size of the element. | UIMovieClip | ||
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIMovieClip | ||
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | 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 | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Stops the playhead in the movie clip. | MovieClip | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | 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 this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIMovieClip | ||
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIMovieClip | ||
|
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 | ||
|---|---|---|---|
This enter frame handler is used when our width, height, x, or y
value changes. | 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 | ||
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIMovieClip | ||
Notify our parent that our size has changed. | UIMovieClip | ||
This enter frame handler progresses through transitions. | UIMovieClip | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or 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 the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | 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 the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses 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 | |||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIMovieClip | |||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| 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 when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIMovieClip | |||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| 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 | ||
| [broadcast event] 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 the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIMovieClip | |||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| 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 when a user enters one or more characters of text. | 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 | |||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
automationDelegate | property |
automationDelegate:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The delegate object that handles the automation-related functionality.
Implementation
public function get automationDelegate():Object public function set automationDelegate(value:Object):voidautomationEnabled | property |
automationName | property |
automationOwner | property |
automationOwner:DisplayObjectContainer [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The owner of this component for automation purposes.
Implementation
public function get automationOwner():DisplayObjectContainerautomationParent | property |
automationParent:DisplayObjectContainer [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The parent of this component for automation purposes.
Implementation
public function get automationParent():DisplayObjectContainerautomationTabularData | property |
automationTabularData:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
Implementation
public function get automationTabularData():ObjectautomationValue | property |
automationValue:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get automationValue():ArrayautomationVisible | property |
autoUpdateCurrentState | property |
autoUpdateCurrentState:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether we should actively watch changes to the label of the flash object.
The Flex currentState property depends on this flash label.
If this is set to true, then every frame, the label of the flash
obejct will be quieried. If the label has changed, that will become the new
currentState for the Flex object.
Note: Setting this property to true may be expensive because
we now are asking the flash object for is current label every single frame.
The default value is false.
Implementation
public function get autoUpdateCurrentState():Boolean public function set autoUpdateCurrentState(value:Boolean):voidautoUpdateMeasuredSize | property |
autoUpdateMeasuredSize:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether we should actively watch changes to the size of the flash object.
If this is set to true, then every frame, the size of the flash
object will be determined. If the size has changed, then the flash object
will scale appropriately to fit its explicit bounds (or it will resize and
notify its parent if there is no explicit sizing).
Note: Setting this property to true may be expensive because
we now are asking the flash object its current size every single frame.
The default value is false.
Implementation
public function get autoUpdateMeasuredSize():Boolean public function set autoUpdateMeasuredSize(value:Boolean):voidbaseline | property |
baseline:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get baseline():Object public function set baseline(value:Object):voidbaselinePosition | property |
bottom | property |
bottom:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get bottom():Object public function set bottom(value:Object):voidboundingBoxName | property |
public var boundingBoxName:String = "boundingBox"| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 |
cacheHeuristic | property |
cacheHeuristic:Boolean [write-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function set cacheHeuristic(value:Boolean):voidcachePolicy | property |
cachePolicy:String [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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).
- A value of
UIComponentCachePolicy.ONmeans that the object is always cached as a bitmap. - A value of
UIComponentCachePolicy.OFFmeans that the object is never cached as a bitmap. - A value of
UIComponentCachePolicy.AUTOmeans that the framework uses heuristics to decide whether the object should be cached as a bitmap.
The default value is UIComponentCachePolicy.AUTO.
Implementation
public function get cachePolicy():StringcurrentState | property |
currentState:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The current state of this component. For UIMovieClip, the value of the
currentState property is the current frame label.
Implementation
public function get currentState():String public function set currentState(value:String):voiddepth | property |
depth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Determines the order in which items inside of containers
are rendered.
Spark containers order their items based on their
depth property, with the lowest depth in the back,
and the higher in the front.
Items with the same depth value appear in the order
they are added to the container.
Implementation
public function get depth():Number public function set depth(value:Number):voiddescriptor | property |
descriptor:UIComponentDescriptor| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get descriptor():UIComponentDescriptor public function set descriptor(value:UIComponentDescriptor):voidRelated API Elements
designLayer | property |
designLayer:DesignLayer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the optional DesignLayer instance associated with this visual element.
When a DesignLayer is assigned, a visual element must consider the visibility and alpha of its parent layer when ultimately committing its own effective visibility or alpha to its backing DisplayObject (if applicable).
A visual element must listen for layerPropertyChange
notifications from the associated layer parent. When the
effectiveAlpha or effectiveVisibility of the
layer changes, the element must then compute its own effective visibility
(or alpha) and apply it accordingly.
This property should not be set within MXML directly.
The designLayer property is not used for z-order control,
please see depth.
Implementation
public function get designLayer():DesignLayer public function set designLayer(value:DesignLayer):voiddocument | property |
document:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get document():Object public function set document(value:Object):voidexplicitHeight | property |
explicitHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly specified height for the component,
in pixels, as the component's coordinates.
If no height is explicitly specified, the value is NaN.
Implementation
public function get explicitHeight():Number public function set explicitHeight(value:Number):voidRelated API Elements
explicitMaxHeight | property |
explicitMaxHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMaxHeight():Number public function set explicitMaxHeight(value:Number):voidRelated API Elements
explicitMaxWidth | property |
explicitMaxWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMaxWidth():Number public function set explicitMaxWidth(value:Number):voidRelated API Elements
explicitMinHeight | property |
explicitMinHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMinHeight():Number public function set explicitMinHeight(value:Number):voidRelated API Elements
explicitMinWidth | property |
explicitMinWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation
public function get explicitMinWidth():Number public function set explicitMinWidth(value:Number):voidRelated API Elements
explicitWidth | property |
explicitWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The explicitly specified width for the component,
in pixels, as the component's coordinates.
If no width is explicitly specified, the value is NaN.
Implementation
public function get explicitWidth():Number public function set explicitWidth(value:Number):voidRelated API Elements
focusEnabled | property |
focusEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 tabFocusEnabled,
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.
Implementation
public function get focusEnabled():Boolean public function set focusEnabled(value:Boolean):voidfocusPane | property |
focusPane:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get focusPane():Sprite public function set focusPane(value:Sprite):voidRelated API Elements
hasFocusableChildren | property |
hasFocusableChildren:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether child objects can receive focus.
Note: This property is similar to the tabChildren property
used by Flash Player.
Use the hasFocusableChildren property with Flex applications.
Do not use the tabChildren property.
This property is usually false because most components
either receive focus themselves or delegate focus to a single
internal sub-component and appear as if the component has
received focus.
For example, a TextInput control contains a focusable
child RichEditableText control, but while the RichEditableText
sub-component actually receives focus, it appears as if the
TextInput has focus. TextInput sets hasFocusableChildren
to false because TextInput is considered the
component that has focus. Its internal structure is an
abstraction.
Usually only navigator components, such as TabNavigator and
Accordion, have this flag set to true because they
receive focus on Tab but focus goes to components in the child
containers on further Tabs.
The default value is false, except for the
spark.components.Scroller component.
For that component, the default value is true.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the hasFocusableChildrenChange event.
Implementation
public function get hasFocusableChildren():Boolean public function set hasFocusableChildren(value:Boolean):voidhasLayoutMatrix3D | property |
hasLayoutMatrix3D:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Contains true if the element has 3D Matrix.
Use hasLayoutMatrix3D instead of calling and examining the
return value of getLayoutMatrix3D() because that method returns a valid
matrix even when the element is in 2D.
Implementation
public function get hasLayoutMatrix3D():Booleanheight | property |
horizontalCenter | property |
horizontalCenter:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get horizontalCenter():Object public function set horizontalCenter(value:Object):voidid | property |
id:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get id():String public function set id(value:String):voidincludeInLayout | property |
includeInLayout:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get includeInLayout():Boolean public function set includeInLayout(value:Boolean):voidinitialized | property |
protected var initialized:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).
is3D | property |
is3D:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Contains true when the element is in 3D.
The element can be in 3D either because
it has 3D transform properties or it has 3D post layout transform offsets or both.
Implementation
public function get is3D():BooleanisPopUp | property |
layoutDirection | property |
layoutDirection:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies the desired layout direction for an element: one of LayoutDirection.LTR (left to right), LayoutDirection.RTL (right to left), or null (inherit). This property is typically backed by an inheriting style. If null, the layoutDirection style will be set to undefined. Classes like GraphicElement, which implement ILayoutDirectionElement but do not support styles, must additionally support a null value for this property which means the layoutDirection must be inherited from its parent.
Implementation
public function get layoutDirection():String public function set layoutDirection(value:String):voidleft | property |
left:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get left():Object public function set left(value:Object):voidmaintainProjectionCenter | property |
maintainProjectionCenter:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
When true, the component will keep its projection matrix centered on the middle of its bounding box. If no projection matrix is defined on the component, one will be added automatically.
Implementation
public function get maintainProjectionCenter():Boolean public function set maintainProjectionCenter(value:Boolean):voidmaxHeight | property |
maxHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum height of the component, in pixels, as the component's coordinates.
Implementation
public function get maxHeight():Number public function set maxHeight(value:Number):voidRelated API Elements
maxWidth | property |
maxWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the maximum width of the component, in pixels, as the component's coordinates.
Implementation
public function get maxWidth():Number public function set maxWidth(value:Number):voidRelated API Elements
measuredHeight | property |
measuredHeight:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get measuredHeight():NumbermeasuredMinHeight | property |
measuredMinHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default minimum height of the component, in pixels.
This value is set by the measure() method.
Implementation
public function get measuredMinHeight():Number public function set measuredMinHeight(value:Number):voidmeasuredMinWidth | property |
measuredMinWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default minimum width of the component, in pixels.
This value is set by the measure() method.
Implementation
public function get measuredMinWidth():Number public function set measuredMinWidth(value:Number):voidmeasuredWidth | property |
measuredWidth:Number [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get measuredWidth():NumberminHeight | property |
minHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum height of the component, in pixels, as the component's coordinates.
Implementation
public function get minHeight():Number public function set minHeight(value:Number):voidRelated API Elements
minWidth | property |
minWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the minimum width of the component, in pixels, as the component's coordinates.
Implementation
public function get minWidth():Number public function set minWidth(value:Number):voidRelated API Elements
moduleFactory | property |
moduleFactory:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.
Implementation
public function get moduleFactory():IFlexModuleFactory public function set moduleFactory(value:IFlexModuleFactory):voidmouseFocusEnabled | property |
mouseFocusEnabled:Boolean [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get mouseFocusEnabled():BooleannumAutomationChildren | property |
numAutomationChildren:int [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get numAutomationChildren():intowner | property |
owner:DisplayObjectContainer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get owner():DisplayObjectContainer public function set owner(value:DisplayObjectContainer):voidparentDocument | property |
percentHeight | property |
percentHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation
public function get percentHeight():Number public function set percentHeight(value:Number):voidpercentWidth | property |
percentWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.
Implementation
public function get percentWidth():Number public function set percentWidth(value:Number):voidpostLayoutTransformOffsets | property |
postLayoutTransformOffsets:mx.geom:TransformOffsets| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines a set of adjustments that can be applied to the component's transform in a way that is
invisible to the component's parent's layout. For example, if you want a layout to adjust
for a component that will be rotated 90 degrees, you set the component's rotation property.
If you want the layout to not adjust for the component being rotated, you set its postLayoutTransformOffsets.rotationZ
property.
Implementation
public function get postLayoutTransformOffsets():mx.geom:TransformOffsets public function set postLayoutTransformOffsets(value:mx.geom:TransformOffsets):voidright | property |
right:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get right():Object public function set right(value:Object):voidrotation | property |
rotation:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. Values from 0 to 180 represent
clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or
subtracted from 360 to obtain a value within the range. For example, the statement my_video.rotation = 450 is the
same as my_video.rotation = 90.
Implementation
override public function get rotation():Number override public function set rotation(value:Number):voidrotationX | property |
rotationX:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.
Implementation
override public function get rotationX():Number override public function set rotationX(value:Number):voidrotationY | property |
rotationY:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range. This property is ignored during calculation by any of Flex's 2D layouts.
Implementation
override public function get rotationY():Number override public function set rotationY(value:Number):voidrotationZ | property |
rotationZ:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. Values from 0 to 180 represent clockwise rotation; values from 0 to -180 represent counterclockwise rotation. Values outside this range are added to or subtracted from 360 to obtain a value within the range.
Implementation
override public function get rotationZ():Number override public function set rotationZ(value:Number):voidscaleX | property |
scaleX:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the horizontal scaling factor.
The default value is 1.0, which means that the object
is not scaled.
A scaleX of 2.0 means the object has been
magnified by a factor of 2, and a scaleX of 0.5
means the object has been reduced by a factor of 2.
A value of 0.0 is an invalid value.
Rather than setting it to 0.0, set it to a small value, or set
the visible property to false to hide the component.
The default value is 1.0.
Implementation
override public function get scaleX():Number override public function set scaleX(value:Number):voidscaleY | property |
scaleY:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the vertical scaling factor.
The default value is 1.0, which means that the object
is not scaled.
A scaleY of 2.0 means the object has been
magnified by a factor of 2, and a scaleY of 0.5
means the object has been reduced by a factor of 2.
A value of 0.0 is an invalid value.
Rather than setting it to 0.0, set it to a small value, or set
the visible property to false to hide the component.
The default value is 1.0.
Implementation
override public function get scaleY():Number override public function set scaleY(value:Number):voidscaleZ | property |
scaleZ:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 10, AIR 1.1 |
Number that specifies the scaling factor along the z axis.
A scaling along the z axis will not affect a typical component, which lies flat in the z=0 plane. components with children that have 3D transforms applied, or components with a non-zero transformZ, will be affected.
The default value is 1.0, which means that the object is not scaled.
This property is ignored during calculation by any of Flex's 2D layouts.
The default value is 1.0.
Implementation
override public function get scaleZ():Number override public function set scaleZ(value:Number):voidshowInAutomationHierarchy | property |
showInAutomationHierarchy:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get showInAutomationHierarchy():Boolean public function set showInAutomationHierarchy(value:Boolean):voidsystemManager | property |
systemManager:ISystemManager| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the SystemManager object for this component.
Implementation
public function get systemManager():ISystemManager public function set systemManager(value:ISystemManager):voidtabFocusEnabled | property |
tabFocusEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A flag that indicates whether child objects can receive focus
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the tabFocusEnabledChange event.
Implementation
public function get tabFocusEnabled():Boolean public function set tabFocusEnabled(value:Boolean):voidtoolTip | property |
top | property |
top:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get top():Object public function set top(value:Object):voidtransformX | property |
transformX:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the x coordinate for the transform center of the component.
When this component is the target of a Spark transform effect,
you can override this property by setting
the AnimateTransform.autoCenterTransform property.
If autoCenterTransform is false, the transform
center is determined by the transformX,
transformY, and transformZ properties
of the effect target.
If autoCenterTransform is true,
the effect occurs around the center of the target,
(width/2, height/2).
Setting this property on the Spark effect class overrides the setting on the target component.
Implementation
public function get transformX():Number public function set transformX(value:Number):voidtransformY | property |
transformY:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the y coordinate for the transform center of the component.
When this component is the target of a Spark transform effect,
you can override this property by setting
the AnimateTransform.autoCenterTransform property.
If autoCenterTransform is false, the transform
center is determined by the transformX,
transformY, and transformZ properties
of the effect target.
If autoCenterTransform is true,
the effect occurs around the center of the target,
(width/2, height/2).
Seeting this property on the Spark effect class overrides the setting on the target component.
Implementation
public function get transformY():Number public function set transformY(value:Number):voidtransformZ | property |
transformZ:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the z coordinate for the transform center of the component.
When this component is the target of a Spark transform effect,
you can override this property by setting
the AnimateTransform.autoCenterTransform property.
If autoCenterTransform is false, the transform
center is determined by the transformX,
transformY, and transformZ properties
of the effect target.
If autoCenterTransform is true,
the effect occurs around the center of the target,
(width/2, height/2).
Seeting this property on the Spark effect class overrides the setting on the target component.
Implementation
public function get transformZ():Number public function set transformZ(value:Number):voidtweeningProperties | property |
tweeningProperties:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used by EffectManager. Returns non-null if a component is not using the EffectManager to execute a Tween.
Implementation
public function get tweeningProperties():Array public function set tweeningProperties(value:Array):voidverticalCenter | property |
verticalCenter:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the propertyChange event.
Implementation
public function get verticalCenter():Object public function set verticalCenter(value:Object):voidvisible | property |
visible:Boolean[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Whether or not the display object is visible.
Display objects that are not visible are disabled.
For example, if visible=false for an InteractiveObject instance,
it cannot be clicked.
When setting to true, the object dispatches
a show event.
When setting to false, the object dispatches
a hide event.
In either case the children of the object does not emit a
show or hide event unless the object
has specifically written an implementation to do so.
Implementation
override public function get visible():Boolean override public function set visible(value:Boolean):voidwidth | property |
x | property |
x:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the component's horizontal position, in pixels, within its parent container.
Setting this property directly or calling move()
will have no effect -- or only a temporary effect -- if the
component is parented by a layout container such as HBox, Grid,
or Form, because the layout calculations of those containers
set the x position to the results of the calculation.
However, the x property must almost always be set
when the parent is a Canvas or other absolute-positioning
container because the default value is 0.
The default value is 0.
Implementation
override public function get x():Number override public function set x(value:Number):voidy | property |
y:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the component's vertical position, in pixels, within its parent container.
Setting this property directly or calling move()
will have no effect -- or only a temporary effect -- if the
component is parented by a layout container such as HBox, Grid,
or Form, because the layout calculations of those containers
set the x position to the results of the calculation.
However, the x property must almost always be set
when the parent is a Canvas or other absolute-positioning
container because the default value is 0.
The default value is 0.
Implementation
override public function get y():Number override public function set y(value:Number):voidz | property |
z:Number[override] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container. The z property is used for 3D coordinates, not screen or pixel coordinates.
When you set a z property for a display object to something other than the default
value of 0, a corresponding Matrix3D object is automatically created. for adjusting a
display object's position and orientation
in three dimensions. When working with the z-axis,
the existing behavior of x and y properties changes from screen or pixel coordinates to
positions relative to the 3D parent container.
For example, a child of the _root at position x = 100, y = 100, z = 200
is not drawn at pixel location (100,100). The child is drawn wherever the 3D projection
calculation puts it. The calculation is:
(x*cameraFocalLength/cameraRelativeZPosition, y*cameraFocalLength/cameraRelativeZPosition)
This property can be used as the source for data binding. When this property is modified, it dispatches the zChanged event.
Implementation
override public function get z():Number override public function set z(value:Number):voidUIMovieClip | () | Constructor |
public function UIMovieClip()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
createAutomationIDPart | () | method |
public function createAutomationIDPart(child:IAutomationObject):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
createAutomationIDPartWithRequiredProperties | () | method |
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
| |
properties:Array |
Object — Sets of properties describing the child which can
later be used to resolve the component.
|
createReferenceOnParentDocument | () | method |
public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This enter frame handler is used when our width, height, x, or y value changes. This is so the change can be delayed so that setting x and y at the same time only results in one change event.
Parameters
event:Event |
executeBindings | () | method |
public function executeBindings(recurse:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Executes the data bindings into this UIComponent object.
Parameters
recurse:Boolean (default = false) |
findFocusCandidates | () | method |
protected function findFocusCandidates(obj:DisplayObjectContainer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
getAutomationChildren | () | method |
getBoundsXAtSize | () | method |
public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the x coordinate of the element's bounds at the specified element size.
This method is typically used by layouts during a call to the
measure() method to predict what
the element position will be, if the element is resized to particular dimensions.
Parameters
width:Number — The element's bounds width, or NaN to use the preferred width.
| |
height:Number — The element's bounds height, or NaN to use the preferred height.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
x coordinate of the element's bounding box top-left corner.
The bounding box is in element's parent coordinate space and is calculated
from the specified bounds size, layout position and layout transform matrix.
|
Number — The x coordinate of the element's bounds at the specified element size.
|
getBoundsYAtSize | () | method |
public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the y coordinate of the element's bounds at the specified element size.
This method is typically used by layouts during a call to
the measure() to predict what
the element position will be, if the element is resized to particular dimensions.
Parameters
width:Number — The element's bounds width, or NaN to use the preferred width.
| |
height:Number — The element's bounds height, or NaN to use the preferred height.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the y coordinate of the element's bounding box top-left corner.
The bounding box is in element's parent coordinate space and is calculated
from the specified bounds size, layout position and layout transform matrix.
|
Number — The y coordinate of the element's bounds at the specified element size.
|
getConstraintValue | () | method |
public function getConstraintValue(constraintName:String):*| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
|
getLayoutBoundsHeight | () | method |
public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's layout height. This is the size that the element uses to draw on screen.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the element's bounding box width. The bounding box is in the element's parent
coordinate space and is calculated from the element's layout size and
layout transform matrix.
|
Number — The element's layout height.
|
getLayoutBoundsWidth | () | method |
public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's layout width. This is the size that the element uses to draw on screen.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the element's bounding box width. The bounding box is in element's parent
coordinate space and is calculated from the element's layout size and
layout transform matrix.
|
Number — The element's layout width.
|
getLayoutBoundsX | () | method |
public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the x coordinate that the element uses to draw on screen.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
x coordinate of the element's bounding box top-left corner.
The bounding box is in the element's parent coordinate space and is calculated
from the element's layout size, layout position and layout transform matrix.
|
Number — The x coordinate that the element uses to draw on screen.
|
getLayoutBoundsY | () | method |
public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the y coordinate that the element uses to draw on screen.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
y coordinate of the element's bounding box top-left corner.
The bounding box is in the element's parent coordinate space and is calculated
from the element's layout size, layout position, and layout transform matrix.
|
Number — The y coordinate that the element uses to draw on screen.
|
getLayoutMatrix | () | method |
public function getLayoutMatrix():Matrix| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
This matrix is typically defined by the
component's 2D properties such as x, y,
rotation, scaleX, scaleY,
transformX, and transformY.
Some components may have additional transform properties that
are applied on top of the layout matrix to determine the final,
computed matrix. For example UIComponent
defines the offsets property.
Matrix — The layout transform Matrix for this element.
Do not directly modify the return value; call the setLayoutMatrix() method instead.
|
getLayoutMatrix3D | () | method |
public function getLayoutMatrix3D():Matrix3D| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the layout transform Matrix3D for this element.
This matrix is typically defined by the
component's transform properties such as x, y,
z, rotationX, rotationY,
rotationZ, scaleX, scaleY,
scaleZ, transformX, and transformY.
Some components may have additional transform properties that
are applied on top of the layout matrix to determine the final,
computed matrix. For example UIComponent
defines the offsets property.
Matrix3D — The layout transform Matrix3D for this element.
Do not directly modify the return value but call the setLayoutMatrix() method instead.
|
getMaxBoundsHeight | () | method |
public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's maximum height.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the element's bounding box height. The bounding box is in the element's parent
coordinate space and is calculated from the element's maximum size and
layout transform matrix.
|
Number — The element's maximum height.
|
getMaxBoundsWidth | () | method |
public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's maximum width.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the method returns
the element's bounding box width. The bounding box is in the element's parent
coordinate space and is calculated from the element's maximum size and
layout transform matrix.
|
Number — The element's maximum width.
|
getMinBoundsHeight | () | method |
public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's minimum height.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true,
the method returns the element's bounding box height.
The bounding box is in the element's parent
coordinate space and is calculated from the element's minimum size and
layout transform matrix.
|
Number — The element's maximum height.
|
getMinBoundsWidth | () | method |
public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's minimum width.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true,
the method returns the element's bounding box width.
The bounding box is in the element's parent
coordinate space and is calculated from the element's minimum size and
layout transform matrix.
|
Number — The element's maximum width.
|
getPreferredBoundsHeight | () | method |
public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's preferred height.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true,
the method returns the element's bounding box height.
The bounding box is in the element's parent
coordinate space and is calculated from the element's preferred size and
layout transform matrix.
|
Number — Returns the element's preferred height. Preferred height is
usually based on the default element size and any explicit overrides.
For UIComponent this is the same value as returned by
the getExplicitOrMeasuredHeight() method.
|
getPreferredBoundsWidth | () | method |
public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's preferred width.
Parameters
postLayoutTransform:Boolean (default = true)postLayoutTransform is true,
the method returns the element's bounding box width.
The bounding box is in the element's parent
coordinate space and is calculated from the element's preferred size and
layout transform matrix.
|
Number — Returns the element's preferred width. Preferred width is
usually based on the default element size and any explicit overrides.
For UIComponent this is the same value as returned by
the getExplicitOrMeasuredWidth() method.
|
initialize | () | method |
public function initialize():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initialize the object.
Related API Elements
invalidateLayoutDirection | () | method |
public function invalidateLayoutDirection():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes. If they differ, this method is responsible for mirroring the element’s contents and for updating the element’s post-layout transform so that descendants inherit a mirrored coordinate system. IVisualElements typically implement mirroring by using postLayoutTransformOffsets to scale the X axis by -1 and to translate the x coordinate of the origin by the element's width. The net effect of this "mirror" transform is to reverse the direction in which the X axis increases without changing the element's location relative to its parent's origin.
invalidateParentSizeAndDisplayList | () | method |
protected function invalidateParentSizeAndDisplayList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
move | () | method |
public function move(x:Number, y:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Notify our parent that our size has changed.
owns | () | method |
public function owns(displayObject:DisplayObject):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 |
replayAutomatableEvent | () | method |
public function replayAutomatableEvent(event:Event):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the FocusManager when the component receives focus. The component may in turn set focus to an internal component.
setLayoutBoundsPosition | () | method |
public function setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the coordinates that the element uses to draw on screen.
Note that calls to the setLayoutBoundSize() method can affect the layout position, so
call setLayoutBoundPosition() after calling setLayoutBoundSize().
Parameters
x:Number — The x-coordinate of the top-left corner of the bounding box.
| |
y:Number — The y-coordinate of the top-left corner of the bounding box.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true,
the element is positioned in such a way that the top-left corner of its bounding box is (x, y).
The bounding box is in the element's parent coordinate space and is calculated
from the element's layout size, layout position and layout transform matrix.
|
setLayoutBoundsSize | () | method |
public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the layout size of the element. This is the size that the element uses to draw on screen.
If the width and/or height parameters are left unspecified (NaN),
Flex sets the element's layout size to its preferred width and/or preferred height.
Note that calls to the setLayoutBoundSize() method can affect the layout position, so
call setLayoutBoundPosition() after calling setLayoutBoundSize().
Parameters
width:Number — The element's layout width.
| |
height:Number — The element's layout height.
| |
postLayoutTransform:Boolean (default = true)postLayoutTransform is true, the specified sizes
are those of the element's bounding box.
The bounding box is in the element's parent coordinate space and is calculated
from the element's layout size, layout position, and layout transform matrix.
|
setLayoutMatrix | () | method |
public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
The matrix is typically defined by the
component's 2D properties such as x, y,
rotation, scaleX, scaleY,
transformX, and transformY.
Some components may have additional transform properties that
are applied on top of the layout matrix to determine the final,
computed matrix. For example UIComponent
defines the offsets.
Note that layout Matrix is factored in the getPreferredSize(),
getMinSize(), getMaxSize(), getLayoutSize()
methods when computed in parent coordinates
as well as in getLayoutPosition() in both parent and child coordinates.
Layouts that calculate the transform matrix explicitly typically call
this method and work with sizes in child coordinates.
Layouts calling this method pass false
to the invalidateLayout() method so that a subsequent layout pass is not
triggered.
Parameters
value:Matrix — The matrix.
| |
invalidateLayout:Boolean — true to cause the parent container
to re-layout its children. You typically pass true
to the invalidateLayout() method.
|
setLayoutMatrix3D | () | method |
public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
This matrix is typically defined by the
component's transform properties such as x, y,
z, rotationX, rotationY,
rotationZ, scaleX, scaleY,
scaleZ, transformX, and transformY.
Some components may have additional transform properties that
are applied on top of the layout matrix to determine the final,
computed matrix. For example UIComponent
defines the offsets property.
Note that layout Matrix3D is factored in the getPreferredSize(),
getMinSize(), getMaxSize(), getLayoutSize()
when computed in parent coordinates
as well as in getLayoutPosition() in both parent and child coordinates.
Layouts that calculate the transform matrix explicitly typically call
this method and work with sizes in child coordinates.
Layouts calling this method pass false
to the invalidateLayout() method so that a subsequent layout pass is not
triggered.
Parameters
value:Matrix3D — The matrix.
| |
invalidateLayout:Boolean — true to cause the parent container
to re-layout its children. You typically pass true
to the invalidateLayout() method.
|
setVisible | () | method |
public function setVisible(value:Boolean, noEvent:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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)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.
|
transformAround | () | method |
public function transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A utility method to update the rotation, scale, and translation of the transform while keeping a particular point, specified in the component's own coordinate space, fixed in the parent's coordinate space. This function will assign the rotation, scale, and translation values provided, then update the x/y/z properties as necessary to keep the transform center fixed.
Parameters
transformCenter:Vector3D — The point, in the component's own coordinates, to keep fixed relative to its parent.
| |
scale:Vector3D (default = null) | |
rotation:Vector3D (default = null) | |
translation:Vector3D (default = null) | |
postLayoutScale:Vector3D (default = null) | |
postLayoutRotation:Vector3D (default = null) | |
postLayoutTranslation:Vector3D (default = null) | |
invalidateLayout:Boolean (default = true) |
transformPointToParent | () | method |
public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. The pre-layout and post-layout result will be set on
the position and postLayoutPosition
parameters, if they are non-null.
Parameters
localPosition:Vector3D — The point to be transformed, specified in the
local coordinates of the object.
| |
position:Vector3D | |
postLayoutPosition:Vector3D |
transitionEnterFrameHandler | () | method |
add | Event |
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.ADD| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.
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.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.CREATION_COMPLETE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.StateChangeEventproperty StateChangeEvent.type =
mx.events.StateChangeEvent.CURRENT_STATE_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.StateChangeEventproperty StateChangeEvent.type =
mx.events.StateChangeEvent.CURRENT_STATE_CHANGING| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.DragEventproperty DragEvent.type =
mx.events.DragEvent.DRAG_COMPLETE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.DragEventproperty DragEvent.type =
mx.events.DragEvent.DRAG_DROP| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.DragEventproperty DragEvent.type =
mx.events.DragEvent.DRAG_ENTER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. |
Related API Elements
dragExit | Event |
mx.events.DragEventproperty DragEvent.type =
mx.events.DragEvent.DRAG_EXIT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.DragEventproperty DragEvent.type =
mx.events.DragEvent.DRAG_OVER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. |
Related API Elements
hide | Event |
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.HIDE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.INITIALIZE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.FlexMouseEventproperty FlexMouseEvent.type =
mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.FlexMouseEventproperty FlexMouseEvent.type =
mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.MoveEventproperty MoveEvent.type =
mx.events.MoveEvent.MOVE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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:
minWidthminHeightmaxWidthmaxHeightexplicitWidthexplicitHeight
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.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.PREINITIALIZE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.REMOVE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
This event will only be dispatched when there are one or more relevant listeners attached to the dispatching object.
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.ResizeEventproperty ResizeEvent.type =
mx.events.ResizeEvent.RESIZE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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:
minWidthminHeightmaxWidthmaxHeightexplicitWidthexplicitHeight
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.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.SHOW| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_CREATE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_END| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_HIDE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_SHOW| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_SHOWN| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.ToolTipEventproperty ToolTipEvent.type =
mx.events.ToolTipEvent.TOOL_TIP_START| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. |
Mon Nov 28 2011, 06:48 AM -08:00