automationDelegate:Object| Language Version: | ActionScript 3.0 |
| 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:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
True if this component is enabled for automation, false
otherwise.
Implementation public function get automationEnabled():BooleanautomationName:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Name that can be used as an identifier for this object.
Implementation public function get automationName():String public function set automationName(value:String):voidautomationOwner:DisplayObjectContainer [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The owner of this component for automation purposes.
Implementation public function get automationOwner():DisplayObjectContainerautomationParent:DisplayObjectContainer [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The parent of this component for automation purposes.
Implementation public function get automationParent():DisplayObjectContainerautomationTabularData:Object [read-only]
| Language Version: | ActionScript 3.0 |
| 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:Array [read-only]
| Language Version: | ActionScript 3.0 |
| 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:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
True if this component is visible for automation, false
otherwise.
Implementation public function get automationVisible():BooleanautoUpdateCurrentState:Boolean| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 3.0 |
| 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:Object| Language Version: | ActionScript 3.0 |
| 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:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The y-coordinate of the baseline
of the first line of text of the component.
Implementation public function get baselinePosition():Numberbottom:Object| Language Version: | ActionScript 3.0 |
| 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):voidpublic var boundingBoxName:String = "boundingBox"| Language Version: | ActionScript 3.0 |
| 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:Rectangle [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The unscaled bounds of the content.
Implementation protected function get bounds():RectanglecacheHeuristic:Boolean [write-only]
| Language Version: | ActionScript 3.0 |
| 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:String [read-only]
| Language Version: | ActionScript 3.0 |
| 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.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.
Implementation public function get cachePolicy():StringcurrentState:String| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:UIComponentDescriptor| Language Version: | ActionScript 3.0 |
| 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):voidSee also
designLayer:DesignLayer| Language Version: | ActionScript 3.0 |
| 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:Object| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
explicitMaxHeight:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
explicitMaxWidth:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
explicitMinHeight:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
explicitMinWidth:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
explicitWidth:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
focusEnabled:Boolean| Language Version: | ActionScript 3.0 |
| 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:Sprite| Language Version: | ActionScript 3.0 |
| 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):voidSee also
hasFocusableChildren:Boolean| Language Version: | ActionScript 4.0 |
| 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:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Contians true if the element has 3D Matrix.
Use hasLayoutMatrix3D instead of calling and examining the
return value of getLayoutMatrix3D() becasue that method returns a valid
matrix even when the element is in 2D.
Implementation public function get hasLayoutMatrix3D():Booleanheight:Number[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The height of this object, in pixels.
Implementation override public function get height():Number override public function set height(value:Number):voidhorizontalCenter:Object| Language Version: | ActionScript 3.0 |
| 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:String| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 3.0 |
| 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):voidprotected var initialized:Boolean = false| Language Version: | ActionScript 3.0 |
| 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:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Set to true by the PopUpManager to indicate
that component has been popped up.
Implementation public function get isPopUp():Boolean public function set isPopUp(value:Boolean):voidleft:Object| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
maxWidth:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
measuredHeight:Number [read-only]
| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:Number [read-only]
| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
minWidth:Number| Language Version: | ActionScript 3.0 |
| 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):voidSee also
moduleFactory:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| 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:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| 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:int [read-only]
| Language Version: | ActionScript 3.0 |
| 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:DisplayObjectContainer| Language Version: | ActionScript 3.0 |
| 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:Object [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The document containing this component.
Implementation public function get parentDocument():ObjectpercentHeight:Number| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:mx.geom:TransformOffsets| Language Version: | ActionScript 3.0 |
| 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:Object| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 3.0 |
| 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:ISystemManager| Language Version: | ActionScript 3.0 |
| 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:Boolean| Language Version: | ActionScript 4.0 |
| 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:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Text to display in the ToolTip.
The default value is null.
Implementation public function get toolTip():String public function set toolTip(value:String):voidtop:Object| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:Number| Language Version: | ActionScript 3.0 |
| 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:Array| Language Version: | ActionScript 3.0 |
| 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:Object| Language Version: | ActionScript 3.0 |
| 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:Boolean[override]
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:Number[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The width of this object, in pixels.
Implementation override public function get width():Number override public function set width(value:Number):voidx:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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:Number[override]
| Language Version: | ActionScript 3.0 |
| 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):voidpublic function UIMovieClip()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
protected function autoUpdateCurrentStateEnterFrameHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This enter frame handler watches our currentLabel for changes so that it
can be reflected in the currentState.
Parameters
protected function autoUpdateMeasuredSizeEnterFrameHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This enter frame handler watches the flash object's size to see if
it has changed. If it's chagned, we will notify our flex parent of
the change. This size change may also cause the flash component
to rescale if it's been explicitly sized so it fits within the
correct bounds.
Parameters
public function createAutomationIDPart(child:IAutomationObject):Object| Language Version: | ActionScript 3.0 |
| 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
Returns | Object — Sets of properties describing the child which can
later be used to resolve the component.
|
public function createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object| Language Version: | ActionScript 3.0 |
| 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
Returns | Object — Sets of properties describing the child which can
later be used to resolve the component.
|
public function createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| 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
public function deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| 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
public function drawFocus(isFocused:Boolean):void| Language Version: | ActionScript 3.0 |
| 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.
|
protected function enterFrameHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| 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
public function executeBindings(recurse:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Executes the data bindings into this UIComponent object.
Parameters
| recurse:Boolean (default = false) |
protected function findFocusCandidates(obj:DisplayObjectContainer):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Recursively finds all children that have tabEnabled=true and adds them
to the focusableObjects array.
Parameters
protected function focusInHandler(event:FocusEvent):void| Language Version: | ActionScript 3.0 |
| 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
public function getAutomationChildAt(index:int):IAutomationObject| Language Version: | ActionScript 3.0 |
| 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
|
Returns public function getAutomationChildren():Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Provides the automation object list . This list
does not include any children that are composites.
Returns public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getConstraintValue(constraintName:String):*| Language Version: | ActionScript 3.0 |
| 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.
|
Returns | * — The constraint value, or null if it is not defined.
|
public function getExplicitOrMeasuredHeight():Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience method for determining whether to use the
explicit or measured height
Returns | Number — A Number which is explicitHeight if defined
or measuredHeight if not.
|
public function getExplicitOrMeasuredWidth():Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience method for determining whether to use the
explicit or measured width
Returns | Number — A Number which is explicitWidth if defined
or measuredWidth if not.
|
public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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) |
Returns public function getLayoutMatrix():Matrix| Language Version: | ActionScript 3.0 |
| 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.
Returns | Matrix — The layout transform Matrix for this element.
Don't directly modify the return value but call setLayoutMatrix instead.
|
public function getLayoutMatrix3D():Matrix3D| Language Version: | ActionScript 3.0 |
| 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.
Returns | Matrix3D — The layout transform Matrix3D for this element.
Don't directly modify the return value but call setLayoutMatrix instead.
|
public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's maximum height.
Parameters
| postLayoutTransform:Boolean (default = true) |
Returns public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the element's maximum width.
Parameters
| postLayoutTransform:Boolean (default = true) |
Returns public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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.
Bounding box is in element's parent
coordinate space and is calculated from the element's minimum size and
layout transform matrix.
|
Returns public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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.
Bounding box is in element's parent
coordinate space and is calculated from the element's minimum size and
layout transform matrix.
|
Returns public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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.
Bounding box is in element's parent
coordinate space and is calculated from the element's preferred size and
layout transform matrix.
|
Returns | 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.
|
public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| 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.
Bounding box is in element's parent
coordinate space and is calculated from the element's preferred size and
layout transform matrix.
|
Returns | 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.
|
public function initialize():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initialize the object.
See also
protected function invalidateParentSizeAndDisplayList():void
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true).
public function move(x:Number, y:Number):void| Language Version: | ActionScript 3.0 |
| 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.
|
protected function notifySizeChanged():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Notify our parent that our size has changed.
public function owns(displayObject:DisplayObject):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true if the chain of owner properties
points from child to this UIComponent.
Parameters
Returns | Boolean — true if the child is parented or owned by this UIComponent.
|
public function parentChanged(p:DisplayObjectContainer):void| Language Version: | ActionScript 3.0 |
| 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
public function registerEffects(effects:Array):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
For each effect event, register the EffectManager
as one of the event listeners.
Parameters
| effects:Array — An Array of strings of effect names.
|
public function replayAutomatableEvent(event:Event):Boolean| Language Version: | ActionScript 3.0 |
| 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.
|
Returns | Boolean — true if a replay was successful.
|
public function resolveAutomationIDPart(criteria:Object):Array| Language Version: | ActionScript 3.0 |
| 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.
|
Returns | Array — Array of children that matched the criteria
or null if no children could not be resolved.
|
public function setActualSize(newWidth:Number, newHeight:Number):void| Language Version: | ActionScript 3.0 |
| 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.
|
public function setConstraintValue(constraintName:String, value:*):void| Language Version: | ActionScript 3.0 |
| 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.
|
public function setFocus():void| Language Version: | ActionScript 3.0 |
| 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.
public function setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Sets the coordinates that the element uses to draw on screen.
Parameters
| x:Number — When postLayoutTransform is true,
the element is positioned in such a way that the top-left corner of its bounding box is (x, y).
Bounding box is in element's parent coordinate space and is calculated
from the element's layout size, layout position and layout transform matrix.
Note that calls to the setLayoutBoundSize() method can affect the layout position, so
call setLayoutBoundPosition() after calling setLayoutBoundSize().
|
| |
| y:Number |
| |
| postLayoutTransform:Boolean (default = true) |
public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void| Language Version: | ActionScript 3.0 |
| 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) |
public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void| Language Version: | ActionScript 3.0 |
| 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 invalidateLayout so that a subsequent layout pass is not
triggered.
Parameters
| value:Matrix — The matrix.
|
| |
| invalidateLayout:Boolean — true to cause theparetn container
to re-layout its children.You typically pass true
to invalidateLayout.
|
public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void| Language Version: | ActionScript 3.0 |
| 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 invalidateLayout so that a subsequent layout pass is not
triggered.
Parameters
| value:Matrix3D — The matrix.
|
| |
| invalidateLayout:Boolean — true to cause theparetn container
to re-layout its children.You typically pass true
to invalidateLayout.
|
public function setVisible(value:Boolean, noEvent:Boolean = false):void| Language Version: | ActionScript 3.0 |
| 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.
|
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 |
| 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 new values for the scale of the transform
|
| |
| 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) |
public function transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void| Language Version: | ActionScript 3.0 |
| 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 |
protected function transitionEnterFrameHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This enter frame handler progresses through transitions.
Parameters
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.ADD| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.CREATION_COMPLETE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.StateChangeEventproperty StateChangeEvent.type = mx.events.StateChangeEvent.CURRENT_STATE_CHANGE| Language Version: | ActionScript 3.0 |
| 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 the
type 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 |
Event Object Type: mx.events.StateChangeEventproperty StateChangeEvent.type = mx.events.StateChangeEvent.CURRENT_STATE_CHANGING| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched after the currentState property changes,
but before the view state changes.
The StateChangeEvent.CURRENT_STATE_CHANGING constant defines the
value of the
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 |
Event Object Type: mx.events.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_COMPLETE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_DROP| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_ENTER| Language Version: | ActionScript 3.0 |
| 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.
The
DragEvent.DRAG_ENTER constant defines the value of the
type property of the event object for a
dragEnter event.
The properties of the event object have the following values:
| Property | Value |
|---|
action | The action that caused the event, which is always
DragManager.MOVE. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the
data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
See also
Event Object Type: mx.events.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_EXIT| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_OVER| Language Version: | ActionScript 3.0 |
| 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.
The
DragEvent.DRAG_OVER constant defines the value of the
type property of the event object for a
dragOver event.
The properties of the event object have the following values:
| Property | Value |
|---|
action | The action that caused the event:
DragManager.COPY, DragManager.LINK,
DragManager.MOVE, or DragManager.NONE. |
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
dragInitiator | The component that initiated the drag. |
dragSource | The DragSource object containing the
data being dragged. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
See also
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.HIDE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an object's state changes from visible to invisible.
The
FlexEvent.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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.INITIALIZE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the component has finished its construction
and has all initialization properties set.
The
FlexEvent.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. |
Event Object Type: mx.events.FlexMouseEventproperty FlexMouseEvent.type = mx.events.FlexMouseEvent.MOUSE_DOWN_OUTSIDE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched from a component opened using the PopUpManager
when the user clicks outside it.
The
FlexMouseEvent.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. |
Event Object Type: mx.events.FlexMouseEventproperty FlexMouseEvent.type = mx.events.FlexMouseEvent.MOUSE_WHEEL_OUTSIDE| Language Version: | ActionScript 3.0 |
| 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.
The
FlexMouseEvent.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. |
Event Object Type: mx.events.MoveEventproperty MoveEvent.type = mx.events.MoveEvent.MOVE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.PREINITIALIZE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.REMOVE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ResizeEventproperty ResizeEvent.type = mx.events.ResizeEvent.RESIZE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.SHOW| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an object's state changes from invisible to visible.
The
FlexEvent.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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_CREATE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_END| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_HIDE| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_SHOW| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_SHOWN| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
Event Object Type: mx.events.ToolTipEventproperty ToolTipEvent.type = mx.events.ToolTipEvent.TOOL_TIP_START| Language Version: | ActionScript 3.0 |
| 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.
The
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. |
MovieClip 
Hide Inherited Public Properties
Show Inherited Public Properties
