The delegate object that handles the automation-related functionality.

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

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.

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

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.

See also

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.

See also

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

See also

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

See also

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

See also

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

See also

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

See also

A flag that indicates whether the component can receive focus when selected.

As an optimization, if a child component in your component implements the IFocusManagerComponent interface, and you never want it to receive focus, you can set focusEnabled to false before calling addChild() on the child component.

This will cause the FocusManager to ignore this component and not monitor it for changes to the tabEnabled, tabChildren, and mouseFocusEnabled properties. This also means you cannot change this value after addChild() and expect the FocusManager to notice.

Note: It does not mean that you cannot give this object focus programmatically in your setFocus() method; it just tells the FocusManager to ignore this IFocusManagerComponent component in the Tab and mouse searches.

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.

See also

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 Bindable 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).

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

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 Bindable event.

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

See also

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

See also

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.

See also

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

See also

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.

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 Bindable event.

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.

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 Bindable event.

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 Bindable event.

The width of this object, in pixels.

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

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

The main function that watches our size and progesses through transitions.

Parameters

Executes the data bindings into this UIComponent object. Workaround for MXML container/bindings problem (177074): override Container.executeBindings() to prefer descriptor.document over parentDocument in the call to BindingManager.executeBindings(). This should always provide the correct behavior for instances created by descriptor, and will provide the original behavior for procedurally-created instances. (The bug may or may not appear in the latter case.) A more complete fix, guaranteeing correct behavior in both non-DI and reparented-component scenarios, is anticipated for updater 1.

Parameters

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

Returns the specified constraint value.

Parameters

A convenience method for determining whether to use the explicit or measured height

A convenience method for determining whether to use the explicit or measured width

Initialize the object.

See also

Moves this object to the specified x and y coordinates.

Parameters

Notify our parent that our size has changed.

Returns true if the chain of owner properties points from child to this UIComponent.

Parameters

Called by Flex when a UIComponent object is added to or removed from a parent. Developers typically never need to call this method.

Parameters

For each effect event, register the EffectManager as one of the event listeners.

Parameters

Replays the specified event. A component author should probably call super.replayAutomatableEvent in case default replay behavior has been defined in a superclass.

Parameters

Resolves a child by using the id provided. The id is a set of properties as provided by the createAutomationIDPart() method.

Parameters

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

Sets the specified constraint value.

Parameters

Called by the FocusManager when the component receives focus. The component may in turn set focus to an internal component.

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

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.

The properties of the event object have the following values:

Dispatched when the component has finished its construction. For Flash-based components, this is the same time as the initialize event.

The properties of the event object have the following values:

Dispatched after the view state has changed.

The properties of the event object have the following values:

Dispatched after the currentState property changes, but before the view state changes.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

See also

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

See also

Dispatched when an object's state changes from visible to invisible.

The properties of the event object have the following values:

Dispatched when the component has finished its construction and has all initialization properties set.

The properties of the event object have the following values:

Dispatched from a component opened using the PopUpManager when the user clicks outside it.

The properties of the event object have the following values:

Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.

The properties of the event object have the following values:

Dispatched when the object has moved.

You can move the component by setting the x or y properties, by calling the move() method, by setting one of the following properties either on the component or on other components such that the LayoutManager needs to change the x or y properties of the component:

• minWidth
• minHeight
• maxWidth
• maxHeight
• explicitWidth
• explicitHeight

When you call the move() method, the move event is dispatched before the method returns. In all other situations, the move event is not dispatched until after the property changes.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

Dispatched when the component is resized.

You can resize the component by setting the width or height property, by calling the setActualSize() method, or by setting one of the following properties either on the component or on other components such that the LayoutManager needs to change the width or height properties of the component:

• minWidth
• minHeight
• maxWidth
• maxHeight
• explicitWidth
• explicitHeight

The resize event is not dispatched until after the property changes.

The properties of the event object have the following values:

Dispatched when an object's state changes from invisible to visible.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values:

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.

The properties of the event object have the following values: