UIMovieClip  - AS3 Flex

The delegate object that handles the automation-related functionality.

True if this component is enabled for automation, false otherwise.

Name that can be used as an identifier for this object.

The owner of this component for automation purposes.

The parent of this component for automation purposes.

An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.

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.

True if this component is visible for automation, false otherwise.

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.

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.

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.

The y-coordinate of the baseline of the first line of text of the component.

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.

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".

The unscaled bounds of the content.

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.

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.ON means that the object is always cached as a bitmap.
• A value of UIComponentCachePolicy.OFF means that the object is never cached as a bitmap.
• A value of UIComponentCachePolicy.AUTO means that the framework uses heuristics to decide whether the object should be cached as a bitmap.

The default value is UIComponentCachePolicy.AUTO.

The current state of this component. For UIMovieClip, the value of the currentState property is the current frame label.

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.

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.

Related API Elements

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.

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.

The explicitly specified height for the component, in pixels, as the component's coordinates. If no height is explicitly specified, the value is NaN.

Related API Elements

Number that specifies the maximum height of the component, in pixels, as the component's coordinates.

Related API Elements

Number that specifies the maximum width of the component, in pixels, as the component's coordinates.

Related API Elements

Number that specifies the minimum height of the component, in pixels, as the component's coordinates.

Related API Elements

Number that specifies the minimum width of the component, in pixels, as the component's coordinates.

Related API Elements

The explicitly specified width for the component, in pixels, as the component's coordinates. If no width is explicitly specified, the value is NaN.

Related API Elements

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.

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.

Related API Elements

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.

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.

The height of this object, in pixels.

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.

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.

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.

A flag that determines if an object has been through all three phases of layout: commitment, measurement, and layout (provided that any were required).

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.

Set to true by the PopUpManager to indicate that component has been popped up.

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.

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.

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.

Number that specifies the maximum height of the component, in pixels, as the component's coordinates.

Related API Elements

Number that specifies the maximum width of the component, in pixels, as the component's coordinates.

Related API Elements

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.

The default minimum height of the component, in pixels. This value is set by the measure() method.

The default minimum width of the component, in pixels. This value is set by the measure() method.

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.

Number that specifies the minimum height of the component, in pixels, as the component's coordinates.

Related API Elements

Number that specifies the minimum width of the component, in pixels, as the component's coordinates.

Related API Elements

A module factory is used as context for using embeded fonts and for finding the style manager that controls the styles for this component.

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.

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.

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.

The document containing this component.

Number that specifies the height of a component as a percentage of its parent's size. Allowed values are 0 to 100.

Number that specifies the width of a component as a percentage of its parent's size. Allowed values are 0 to 100.

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.

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.

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.

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.

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.

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.

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.

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.

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.

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.

A reference to the SystemManager object for this component.

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.

Text to display in the ToolTip.

The default value is null.

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.

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.

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.

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.

Used by EffectManager. Returns non-null if a component is not using the EffectManager to execute a Tween.

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.

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.

The width of this object, in pixels.

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.

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.

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.

Constructor.

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

Returns a set of properties that identify the child within this container. These values should not change during the lifespan of the application.

Parameters

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

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

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

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

Executes the data bindings into this UIComponent object.

Parameters

Recursively finds all children that have tabEnabled=true and adds them to the focusableObjects array.

Parameters

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

Provides the automation object at the specified index. This list should not include any children that are composites.

Parameters

Provides the automation object list . This list does not include any children that are composites.