accessibilityDescription:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object.
The getter simply returns accessibilityProperties.description,
or "" if accessibilityProperties is null.
The setter first checks whether accessibilityProperties is null,
and if it is, sets it to a new AccessibilityProperties instance.
Then it sets accessibilityProperties.description.
Implementation public function get accessibilityDescription():String public function set accessibilityDescription(value:String):voidaccessibilityEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object.
Note that accessibilityEnabled has the opposite sense from silent;
accessibilityEnabled is true
when silent is false.
The getter simply returns accessibilityProperties.silent,
or true if accessibilityProperties is null.
The setter first checks whether accessibilityProperties is null,
and if it is, sets it to a new AccessibilityProperties instance.
Then it sets accessibilityProperties.silent.
Implementation public function get accessibilityEnabled():Boolean public function set accessibilityEnabled(value:Boolean):voidaccessibilityName:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object.
The getter simply returns accessibilityProperties.name,
or "" if accessibilityProperties is null.
The setter first checks whether accessibilityProperties is null,
and if it is, sets it to a new AccessibilityProperties instance.
Then it sets accessibilityProperties.name.
Implementation public function get accessibilityName():String public function set accessibilityName(value:String):voidaccessibilityShortcut:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object.
The getter simply returns accessibilityProperties.shortcut,
or "" if accessibilityProperties is null.
The setter first checks whether accessibilityProperties is null,
and if it is, sets it to a new AccessibilityProperties instance.
Then it sets accessibilityProperties.shortcut.
Implementation public function get accessibilityShortcut():String public function set accessibilityShortcut(value:String):voidactiveEffects:Array [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
Implementation public function get activeEffects():ArrayautomationDelegate: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():Booleanbaseline:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The vertical distance in pixels from the anchor target to
the control's baseline position.
By default the anchor target is the top edge of the container's
content area. In layouts with advanced constraints, the target can be
a constraint row.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format:
"anchorTargetName:value". For example, "row1:10".
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.
This property is used to implement
the baseline constraint style.
It is also used to align the label of a FormItem
with the controls in the FormItem.
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 bottom edge of the component to the
anchor target's bottom edge.
By default the anchor target is the container's content area. In layouts
with advanced constraints, the target can be a constraint row.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format:
"anchorTargetName:value". For example, "row1:10".
Implementation public function get bottom():Object public function set bottom(value:Object):voidcacheHeuristic: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| 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():String public function set cachePolicy(value:String):voidclassName:String [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The name of this instance's class, such as "Button".
This string does not include the package name.
If you need the package name as well, call the
getQualifiedClassName() method in the flash.utils package.
It returns a string such as "mx.controls::Button".
Implementation public function get className():StringcontentMouseX:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the x position of the mouse, in the content coordinate system.
Content coordinates specify a pixel position relative to the upper left
corner of the component's content, and include all of the component's
content area, including any regions that are currently clipped and must
be accessed by scrolling the component.
Implementation public function get contentMouseX():NumbercontentMouseY:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the y position of the mouse, in the content coordinate system.
Content coordinates specify a pixel position relative to the upper left
corner of the component's content, and include all of the component's
content area, including any regions that are currently clipped and must
be accessed by scrolling the component.
Implementation public function get contentMouseY():NumbercurrentCSSState:String [read-only]
The state to be used when matching CSS pseudo-selectors. By default
this is the currentState.
Implementation protected function get currentCSSState():StringcurrentState:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The current view state of the component.
Set to "" or null to reset
the component back to its base state.
When you use this property to set a component's state,
Flex applies any transition you have defined.
You can also use the setCurrentState() method to set the
current state; this method can optionally change states without
applying a transition.
This property can be used as the source for data binding. When this property is modified, it dispatches the currentStateChange event.
Implementation public function get currentState():String public function set currentState(value:String):voidSee also
cursorManager:ICursorManager [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the CursorManager that controls the cursor for this component
and its peers.
Each top-level window has its own instance of a CursorManager;
To make sure you're talking to the right one, use this method.
Implementation public function get cursorManager():ICursorManagerdepth: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 UIComponent.
A document object is an Object at the top of the hierarchy of a
Flex application, MXML component, or AS component.
Implementation public function get document():Object public function set document(value:Object):voiddoubleClickEnabled:Boolean[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Specifies whether the UIComponent object receives doubleClick events.
The default value is false, which means that the UIComponent object
does not receive doubleClick events.
The mouseEnabled property must also be set to true,
its default value, for the object to receive doubleClick events.
The default value is false.
Implementation override public function get doubleClickEnabled():Boolean override public function set doubleClickEnabled(value:Boolean):voidenabled:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether the component can accept user interaction. After setting the enabled
property to false, some components still respond to mouse interactions such
as mouseOver. As a result, to fully disable UIComponents,
you should also set the value of the mouseEnabled property to false.
If you set the enabled property to false
for a container, Flex dims the color of the container and of all
of its children, and blocks user input to the container
and to all of its children.
This property can be used as the source for data binding. When this property is modified, it dispatches the enabledChanged event.
Implementation public function get enabled():Boolean public function set enabled(value:Boolean):voiderrorString:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
You can use the errorString property to show a
validation error for a component, without actually using a validator class.
When you write a String value to the errorString property,
Flex draws a red border around the component to indicate the validation error,
and the String appears in a tooltip as the validation error message when you move
the mouse over the component, just as if a validator detected a validation error.
To clear the validation error, write an empty String, "",
to the errorString property.
Note that writing a value to the errorString property
does not trigger the valid or invalid events; it only changes the border
color and displays the validation error message.
This property can be used as the source for data binding. When this property is modified, it dispatches the errorStringChanged event.
Implementation public function get errorString():String public function set errorString(value:String):voidexplicitHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitHeight with respect to its parent
is affected by the scaleY property.
Setting the height property also sets this property to
the specified height value.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitHeightChanged event.
Implementation public function get explicitHeight():Number public function set explicitHeight(value:Number):voidexplicitMaxHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum recommended height of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels.
Application developers typically do not set the explicitMaxHeight property. Instead, they
set the value of the maxHeight property, which sets the explicitMaxHeight property. The
value of maxHeight does not change.
At layout time, if maxHeight was explicitly set by the application developer, then
the value of explicitMaxHeight is used. Otherwise, the default value for maxHeight
is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxHeight with respect to its parent
is affected by the scaleY property.
Some components have no theoretical limit to their height.
In those cases their maxHeight is set to
UIComponent.DEFAULT_MAX_HEIGHT.
The default value is NaN.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMaxHeightChanged event.
Implementation public function get explicitMaxHeight():Number public function set explicitMaxHeight(value:Number):voidexplicitMaxWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum recommended width of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels.
Application developers typically do not set the explicitMaxWidth property. Instead, they
set the value of the maxWidth property, which sets the explicitMaxWidth property. The
value of maxWidth does not change.
At layout time, if maxWidth was explicitly set by the application developer, then
the value of explicitMaxWidth is used. Otherwise, the default value for maxWidth
is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxWidth with respect to its parent
is affected by the scaleX property.
Some components have no theoretical limit to their width.
In those cases their maxWidth is set to
UIComponent.DEFAULT_MAX_WIDTH.
The default value is NaN.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMaxWidthChanged event.
Implementation public function get explicitMaxWidth():Number public function set explicitMaxWidth(value:Number):voidexplicitMinHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum recommended height of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels.
Application developers typically do not set the explicitMinHeight property. Instead, they
set the value of the minHeight property, which sets the explicitMinHeight property. The
value of minHeight does not change.
At layout time, if minHeight was explicitly set by the application developer, then
the value of explicitMinHeight is used. Otherwise, the value of measuredMinHeight
is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight with respect to its parent
is affected by the scaleY property.
The default value is NaN.
This property can be used as the source for data binding. When this property is modified, it dispatches the explictMinHeightChanged event.
Implementation public function get explicitMinHeight():Number public function set explicitMinHeight(value:Number):voidexplicitMinWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum recommended width of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels.
Application developers typically do not set the explicitMinWidth property. Instead, they
set the value of the minWidth property, which sets the explicitMinWidth property. The
value of minWidth does not change.
At layout time, if minWidth was explicitly set by the application developer, then
the value of explicitMinWidth is used. Otherwise, the value of measuredMinWidth
is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth with respect to its parent
is affected by the scaleX property.
The default value is NaN.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMinWidthChanged event.
Implementation public function get explicitMinWidth():Number public function set explicitMinWidth(value:Number):voidexplicitWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true explicitWidth with respect to its parent
is affected by the scaleX property.
Setting the width property also sets this property to
the specified width value.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitWidthChanged event.
Implementation public function get explicitWidth():Number public function set explicitWidth(value:Number):voidflexContextMenu:IFlexContextMenu| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The context menu for this UIComponent.
The default value is null.
Implementation public function get flexContextMenu():IFlexContextMenu public function set flexContextMenu(value:IFlexContextMenu):voidfocusEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Indicates whether the component can receive focus when tabbed to.
You can set focusEnabled to false
when a UIComponent is used as a subcomponent of another component
so that the outer component becomes the focusable entity.
If this property is false, focus is transferred to
the first parent that has focusEnable
set to true.
The default value is true, except for the
spark.components.Scroller component.
For that component, the default value is false.
Implementation public function get focusEnabled():Boolean public function set focusEnabled(value:Boolean):voidSee also
focusManager:IFocusManager| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the FocusManager that controls focus for this component
and its peers.
Each popup has its own focus loop and therefore its own instance
of a FocusManager.
To make sure you're talking to the right one, use this method.
Implementation public function get focusManager():IFocusManager public function set focusManager(value:IFocusManager):voidfocusPane:Sprite| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The focus pane associated with this object.
An object has a focus pane when one of its children has focus.
Implementation public function get focusPane():Sprite public function set focusPane(value:Sprite):voidhasComplexLayoutMatrix:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns true if the UIComponent has any non-translation (x,y) transform properties.
Implementation protected function get hasComplexLayoutMatrix():BooleanhasFocusableChildren: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.
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):voidSee also
hasLayoutMatrix3D: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 |
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
The default value is 0, but this property contains the actual component
height after Flex completes sizing the components in your application.
Note: You can specify a percentage value in the MXML
height attribute, such as height="100%",
but you cannot use a percentage value for the height
property in ActionScript;
use the percentHeight property instead.
Setting this property causes a resize event to be dispatched.
See the resize event for details on when
this event is dispatched.
If the component's scaleY property is not 100,
the height of the component from its internal coordinates
do not match.
Thus a 100 pixel high component with a scaleY
of 200 takes 100 pixels in the parent, but
internally thinks it is 50 pixels high.
This property can be used as the source for data binding. When this property is modified, it dispatches the heightChanged event.
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 to the
center of the anchor target's content area.
The default anchor target is the container itself.
In layouts with advanced constraints, the anchor target can be a constraint column.
Then the content area is the space between the preceding column
(or container side) and the target column.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format
"constraintColumnId:value". For example, "col1:10".
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 and is sized and positioned by its parent container as per its layout rules.
If false, the object size and position are not affected by its parent container's
layout.
The default value is true.
This property can be used as the source for data binding. When this property is modified, it dispatches the includeInLayoutChanged event.
Implementation public function get includeInLayout():Boolean public function set includeInLayout(value:Boolean):voidinheritingStyles:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The beginning of this component's chain of inheriting styles.
The getStyle() method simply accesses
inheritingStyles[styleName] to search the entire
prototype-linked chain.
This object is set up by initProtoChain().
Developers typically never need to access this property directly.
Implementation public function get inheritingStyles():Object public function set inheritingStyles(value:Object):voidinitialized:Boolean| 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).
Implementation public function get initialized():Boolean public function set initialized(value:Boolean):voidinstanceIndex:int [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of a repeated component.
If the component is not within a Repeater, the value is -1.
Implementation public function get instanceIndex():intinstanceIndices:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array containing the indices required to reference
this UIComponent object from its parent document.
The Array is empty unless this UIComponent object is within one or more Repeaters.
The first element corresponds to the outermost Repeater.
For example, if the id is "b" and instanceIndices is [2,4],
you would reference it on the parent document as b[2][4].
Implementation public function get instanceIndices():Array public function set instanceIndices(value:Array):voidis3D: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():BooleanisDocument:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Contains true if this UIComponent instance is a document object.
That means it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
Implementation public function get isDocument():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):voidlayoutMatrix3D:Matrix3D [write-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The transform matrix that is used to calculate a component's layout
relative to its siblings. This matrix is defined by the component's
3D properties (which include the 2D properties such as x,
y, rotation, scaleX,
scaleY, transformX, and
transformY, as well as rotationX,
rotationY, scaleZ, z, and
transformZ.
Most components do not have any 3D transform properties set on them.
This layout matrix is combined with the values of the
postLayoutTransformOffsets property to determine the
component's final, computed matrix.
Implementation public function set layoutMatrix3D(value:Matrix3D):voidSee also
left: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 to the
anchor target's left edge.
By default the anchor target is the container's content area. In layouts
with advanced constraints, the target can be a constraint column.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format
"anchorTargetName:value". For example, "col1:10".
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 keeps its projection matrix centered on the
middle of its bounding box. If no projection matrix is defined on the
component, one is 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 |
The maximum recommended height of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels. The default value of this property is
set by the component developer.
The component developer uses this property to set an upper limit on the
height of the component.
If the application developer overrides the default value of maxHeight,
the new value is stored in explicitMaxHeight. The default value of maxHeight
does not change. As a result, at layout time, if
maxHeight was explicitly set by the application developer, then the value of
explicitMaxHeight is used for the component's maximum recommended height.
If maxHeight is not set explicitly by the user, then the default value is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxHeight with respect to its parent
is affected by the scaleY property.
Some components have no theoretical limit to their height.
In those cases their maxHeight is set to
UIComponent.DEFAULT_MAX_HEIGHT.
The default value is 10000.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMaxHeightChanged event.
Implementation public function get maxHeight():Number public function set maxHeight(value:Number):voidmaxWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The maximum recommended width of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels. The default value of this property is
set by the component developer.
The component developer uses this property to set an upper limit on the
width of the component.
If the application developer overrides the default value of maxWidth,
the new value is stored in explicitMaxWidth. The default value of maxWidth
does not change. As a result, at layout time, if
maxWidth was explicitly set by the application developer, then the value of
explicitMaxWidth is used for the component's maximum recommended width.
If maxWidth is not set explicitly by the user, then the default value is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true maxWidth with respect to its parent
is affected by the scaleX property.
Some components have no theoretical limit to their width.
In those cases their maxWidth is set to
UIComponent.DEFAULT_MAX_WIDTH.
The default value is 10000.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMaxWidthChanged event.
Implementation public function get maxWidth():Number public function set maxWidth(value:Number):voidmeasuredHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default height of the component, in pixels.
This value is set by the measure() method.
Implementation public function get measuredHeight():Number public function set measuredHeight(value:Number):voidmeasuredMinHeight: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| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default width of the component, in pixels.
This value is set by the measure() method.
Implementation public function get measuredWidth():Number public function set measuredWidth(value:Number):voidminHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum recommended height of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels. The default value depends on
the component's implementation.
If the application developer sets the value of minHeight,
the new value is stored in explicitMinHeight. The default value of minHeight
does not change. As a result, at layout time, if
minHeight was explicitly set by the application developer, then the value of
explicitMinHeight is used for the component's minimum recommended height.
If minHeight is not set explicitly by the application developer, then the value of
measuredMinHeight is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minHeight with respect to its parent
is affected by the scaleY property.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMinHeightChanged event.
Implementation public function get minHeight():Number public function set minHeight(value:Number):voidminWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The minimum recommended width of the component to be considered
by the parent during layout. This value is in the
component's coordinates, in pixels. The default value depends on
the component's implementation.
If the application developer sets the value of minWidth,
the new value is stored in explicitMinWidth. The default value of minWidth
does not change. As a result, at layout time, if
minWidth was explicitly set by the application developer, then the value of
explicitMinWidth is used for the component's minimum recommended width.
If minWidth is not set explicitly by the application developer, then the value of
measuredMinWidth is used.
This value is used by the container in calculating
the size and position of the component.
It is not used by the component itself in determining
its default size.
Thus this property may not have any effect if parented by
Container, or containers that don't factor in
this property.
Because the value is in component coordinates,
the true minWidth with respect to its parent
is affected by the scaleX property.
This property can be used as the source for data binding. When this property is modified, it dispatches the explicitMinWidthChanged event.
Implementation public function get minWidth():Number public function set minWidth(value:Number):voidmoduleFactory:IFlexModuleFactory| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A module factory is used as context for using embedded 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| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Whether you can receive focus when clicked on.
If false, focus is transferred to
the first parent that is mouseFocusEnable
set to true.
For example, you can set this property to false
on a Button control so that you can use the Tab key to move focus
to the control, but not have the control get focus when you click on it.
The default value is true.
Implementation public function get mouseFocusEnabled():Boolean public function set mouseFocusEnabled(value:Boolean):voidnestLevel:int| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Depth of this object in the containment hierarchy.
This number is used by the measurement and layout code.
The value is 0 if this component is not on the DisplayList.
Implementation public function get nestLevel():int public function set nestLevel(value:int):voidnonInheritingStyles:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The beginning of this component's chain of non-inheriting styles.
The getStyle() method simply accesses
nonInheritingStyles[styleName] to search the entire
prototype-linked chain.
This object is set up by initProtoChain().
Developers typically never need to access this property directly.
Implementation public function get nonInheritingStyles():Object public function set nonInheritingStyles(value:Object):voidnumAutomationChildren: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 |
The owner of this IVisualElement object.
By default, it is the parent of this IVisualElement object.
However, if this IVisualElement object is a child component that is
popped up by its parent, such as the drop-down list of a ComboBox control,
the owner is the component that popped up this IVisualElement object.
This property is not managed by Flex, but by each component.
Therefore, if you use the PopUpManger.createPopUp() or
PopUpManger.addPopUp() method to pop up a child component,
you should set the owner property of the child component
to the component that popped it up.
The default value is the value of the parent property.
Implementation public function get owner():DisplayObjectContainer public function set owner(value:DisplayObjectContainer):voidparent:DisplayObjectContainer [read-only] [override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The parent container or component for this component.
Only visual elements should have a parent property.
Non-visual items should use another property to reference
the object to which they belong.
By convention, non-visual objects use an owner
property to reference the object to which they belong.
Implementation override public function get parent():DisplayObjectContainerparentApplication:Object [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the Application object that contains this UIComponent
instance.
This Application object might exist in a SWFLoader control in another
Application, and so on, creating a chain of Application objects that
can be walked using parentApplication.
The parentApplication property of an Application is never itself;
it is either the Application into which it was loaded or null
(for the top-level Application).
Walking the application chain using the parentApplication
property is similar to walking the document chain using the
parentDocument property.
You can access the top-level application using the
application property of the Application class.
This property can be used as the source for data binding. When this property is modified, it dispatches the initialize event.
Implementation public function get parentApplication():ObjectparentDocument:Object [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the parent document object for this UIComponent.
A document object is a UIComponent at the top of the hierarchy
of a Flex application, MXML component, or AS component.
For the Application object, the parentDocument
property is null.
This property is useful in MXML scripts to go up a level
in the chain of document objects.
It can be used to walk this chain using
parentDocument.parentDocument, and so on.
It is typed as Object so that authors can access properties
and methods on ancestor document objects without casting.
This property can be used as the source for data binding. When this property is modified, it dispatches the initialize event.
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-100. The default value is NaN.
Setting the height or explicitHeight properties
resets this property to NaN.
This property returns a numeric value only if the property was
previously set; it does not reflect the exact size of the component
in percent.
This property is always set to NaN for the UITextField control.
This property can be used as the source for data binding. When this property is modified, it dispatches the resize event.
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-100. The default value is NaN.
Setting the width or explicitWidth properties
resets this property to NaN.
This property returns a numeric value only if the property was
previously set; it does not reflect the exact size of the component
in percent.
This property is always set to NaN for the UITextField control.
This property can be used as the source for data binding. When this property is modified, it dispatches the resize event.
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 object's
transform in a way that is invisible to its parent's layout.
For example, if you want a layout to adjust for an object
that is rotated 90 degrees, set the object's
rotation property. If you want the layout to not
adjust for the object being rotated,
set its postLayoutTransformOffsets.rotationZ property.
Implementation public function get postLayoutTransformOffsets():mx.geom:TransformOffsets public function set postLayoutTransformOffsets(value:mx.geom:TransformOffsets):voidprocessedDescriptors:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Set to true after immediate or deferred child creation,
depending on which one happens. For a Container object, it is set
to true at the end of
the createComponentsFromDescriptors() method,
meaning after the Container object creates its children from its child descriptors.
For example, if an Accordion container uses deferred instantiation,
the processedDescriptors property for the second pane of
the Accordion container does not become true until after
the user navigates to that pane and the pane creates its children.
But, if the Accordion had set the creationPolicy property
to "all", the processedDescriptors property
for its second pane is set to true during application startup.
For classes that are not containers, which do not have descriptors,
it is set to true after the createChildren()
method creates any internal component children.
Implementation public function get processedDescriptors():Boolean public function set processedDescriptors(value:Boolean):voidrepeater:IRepeater [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the Repeater object
in the parent document that produced this UIComponent.
Use this property, rather than the repeaters property,
when the UIComponent is created by a single Repeater object.
Use the repeaters property when this UIComponent is created
by nested Repeater objects.
The property is set to null when this UIComponent
is not created by a Repeater.
Implementation public function get repeater():IRepeaterrepeaterIndex:int [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index of the item in the data provider
of the Repeater that produced this UIComponent.
Use this property, rather than the repeaterIndices property,
when the UIComponent is created by a single Repeater object.
Use the repeaterIndices property when this UIComponent is created
by nested Repeater objects.
This property is set to -1 when this UIComponent is
not created by a Repeater.
Implementation public function get repeaterIndex():intrepeaterIndices:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
The Array is empty unless this UIComponent is within one or more Repeaters.
The first element in the Array corresponds to the outermost Repeater.
For example, if repeaterIndices is [2,4] it means that the
outer repeater used item dataProvider[2] and the inner repeater
used item dataProvider[4].
Note that this property differs from the instanceIndices property
if the startingIndex property of any of the Repeaters is not 0.
For example, even if a Repeater starts at dataProvider[4],
the document reference of the first repeated object is b[0], not b[4].
Implementation public function get repeaterIndices():Array public function set repeaterIndices(value:Array):voidrepeaters:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
The Array is empty unless this UIComponent is within
one or more Repeaters.
The first element corresponds to the outermost Repeater object.
Implementation public function get repeaters():Array public function set repeaters(value:Array):voidresourceManager:IResourceManager [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the object which manages
all of the application's localized resources.
This is a singleton instance which implements
the IResourceManager interface.
This property can be used as the source for data binding. When this property is modified, it dispatches the unused event.
Implementation protected function get resourceManager():IResourceManagerright: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
anchor target's right edge.
By default the anchor target is the container's content area. In layouts
with advanced constraints, the target can be a constraint column.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format
"anchorTargetName:value". For example, "col1:10".
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 9, AIR 1.1 |
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 9, AIR 1.1 |
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.
This property can be used as the source for data binding. When this property is modified, it dispatches the scaleXChanged event.
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.
This property can be used as the source for data binding. When this property is modified, it dispatches the scaleYChanged event.
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 9, AIR 1.1 |
Number that specifies the scaling factor along the z axis.
A scaling along the z axis does 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, is 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.
This property can be used as the source for data binding. When this property is modified, it dispatches the scaleZChanged event.
Implementation override public function get scaleZ():Number override public function set scaleZ(value:Number):voidscreen:Rectangle [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns an object that contains the size and position of the base
drawing surface for this object.
Implementation public function get screen():RectangleshowInAutomationHierarchy: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):voidstates:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The view states that are defined for this component.
You can specify the states property only on the root
of the application or on the root tag of an MXML component.
The compiler generates an error if you specify it on any other control.
Implementation public function get states():Array public function set states(value:Array):voidstyleDeclaration:CSSStyleDeclaration| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Storage for the inline inheriting styles on this object.
This CSSStyleDeclaration is created the first time that
the setStyle() method
is called on this component to set an inheriting style.
Developers typically never need to access this property directly.
Implementation public function get styleDeclaration():CSSStyleDeclaration public function set styleDeclaration(value:CSSStyleDeclaration):voidstyleManager:IStyleManager2 [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Returns the StyleManager instance used by this component.
Implementation public function get styleManager():IStyleManager2styleName:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The class style used by this component. This can be a String, CSSStyleDeclaration
or an IStyleClient.
If this is a String, it is the name of one or more whitespace delimited class
declarations in an <fx:Style> tag or CSS file. You do not include the period
in the styleName. For example, if you have a class style named ".bigText",
set the styleName property to "bigText" (no period).
If this is an IStyleClient (typically a UIComponent), all styles in the
styleName object are used by this component.
The default value is null.
Implementation public function get styleName():Object public function set styleName(value:Object):voidstyleParent:IAdvancedStyleClient [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A component's parent is used to evaluate descendant selectors. A parent
must also be an IAdvancedStyleClient to participate in advanced style
declarations.
Implementation public function get styleParent():IAdvancedStyleClientsystemManager:ISystemManager| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the SystemManager object used by 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 this object can receive focus
via the TAB key
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.
This property can be used as the source for data binding. When this property is modified, it dispatches the toolTipChanged event.
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 component to the
anchor target's top edge.
By default the anchor target is the container's content area. In layouts
with advanced constraints, the target can be a constraint row.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format
"anchorTargetName:value". For example, "row1:10".
Implementation public function get top():Object public function set top(value:Object):voidtransformX:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidSee also
transformY:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidSee also
transformZ:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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):voidSee also
transitions:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
Implementation public function get transitions():Array public function set transitions(value:Array):voidSee also
tweeningProperties:Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Array of properties that are currently being tweened on this object.
Used to alert the EffectManager that certain properties of this object
are being tweened, so that the EffectManger doesn't attempt to animate
the same properties.
Implementation public function get tweeningProperties():Array public function set tweeningProperties(value:Array):voiduid:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A unique identifier for the object.
Flex data-driven controls, including all controls that are
subclasses of List class, use a UID to track data provider items.
Flex can automatically create and manage UIDs.
However, there are circumstances when you must supply your own
uid property by implementing the IUID interface,
or when supplying your own uid property improves processing efficiency.
UIDs do not need to be universally unique for most uses in Flex.
One exception is for messages sent by data services.
Implementation public function get uid():String public function set uid(value:String):voidSee also
unscaledHeight:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience method for determining the unscaled height
of the component.
All of a component's drawing and child layout should be done
within a bounding rectangle of this height, which is also passed
as an argument to updateDisplayList().
Implementation protected function get unscaledHeight():NumberunscaledWidth:Number [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList().
Implementation protected function get unscaledWidth():NumberupdateCompletePendingFlag:Boolean| 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 validation (provided that any were required).
Implementation public function get updateCompletePendingFlag():Boolean public function set updateCompletePendingFlag(value:Boolean):voidvalidationSubField:String| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used by a validator to associate a subfield with this component.
Implementation public function get validationSubField():String public function set validationSubField(value:String):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 to the
center of the anchor target's content area.
The default anchor target is the container itself.
In layouts with advanced constraints, the anchor target can be a constraint row.
Then the content area is the space between the preceding row
(or container side) and the target row.
Setting the property to a number or to a numerical string like "10"
specifies use of the default anchor target.
To specify an anchor target, set the property value to a string in the format
"constraintColumnId:value". For example, "row1:10".
Implementation public function get verticalCenter():Object public function set verticalCenter(value:Object):voidvisible:Boolean[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
This property can be used as the source for data binding. When this property is modified, it dispatches the show event.
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 |
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
The default value is 0, but this property contains the actual component
width after Flex completes sizing the components in your application.
Note: You can specify a percentage value in the MXML
width attribute, such as width="100%",
but you cannot use a percentage value in the width
property in ActionScript.
Use the percentWidth property instead.
Setting this property causes a resize event to
be dispatched.
See the resize event for details on when
this event is dispatched.
If the component's scaleX property is not 1.0,
the width of the component from its internal coordinates
do not match.
Thus a 100 pixel wide component with a scaleX
of 2 takes 100 pixels in the parent, but
internally thinks it is 50 pixels wide.
This property can be used as the source for data binding. When this property is modified, it dispatches the widthChanged event.
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()
has 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.
This property can be used as the source for data binding. When this property is modified, it dispatches the xChanged event.
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()
has 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.
This property can be used as the source for data binding. When this property is modified, it dispatches the yChanged event.
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 UIComponent()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
protected function adjustFocusRect(obj:DisplayObject = null):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adjust the focus rectangle.
Parameters
| obj:DisplayObject (default = null) |
protected function applyComputedMatrix():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform.
protected function attachOverlay():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This is an internal method used by the Flex framework
to support the Dissolve effect.
You do not have to call it or override it.
public function callLater(method:Function, args:Array = null):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Queues a function to be called later.
Before each update of the screen, Flash Player or AIR calls
the set of functions that are scheduled for the update.
Sometimes, a function should be called in the next update
to allow the rest of the code scheduled for the current
update to be executed.
Some features, like effects, can cause queued functions to be
delayed until the feature completes.
Parameters
| method:Function — Reference to a method to be executed later.
|
| |
| args:Array (default = null) |
protected function canSkipMeasurement():Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the call to the measure() method can be skipped.
Returns | Boolean — Returns true when the measureSizes() method can skip the call to
the measure() method. For example this is usually true when both explicitWidth and
explicitHeight are set. For paths, this is true when the bounds of the path
have not changed.
|
protected function childrenCreated():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Performs any final processing after child objects are created.
This is an advanced method that you might override
when creating a subclass of UIComponent.
public function clearStyle(styleProp:String):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Deletes a style property from this component instance.
This does not necessarily cause the getStyle() method
to return undefined.
Parameters
| styleProp:String — The name of the style property.
|
protected function commitProperties():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Processes the properties set on the component.
This is an advanced method that you might override
when creating a subclass of UIComponent.
You do not call this method directly.
Flex calls the commitProperties() method when you
use the addChild() method to add a component to a container,
or when you call the invalidateProperties() method of the component.
Calls to the commitProperties() method occur before calls to the
measure() method. This lets you set property values that might
be used by the measure() method.
Some components have properties that affect the number or kinds
of child objects that they need to create, or have properties that
interact with each other, such as the horizontalScrollPolicy
and horizontalScrollPosition properties.
It is often best at startup time to process all of these
properties at one time to avoid duplicating work.
See also
public function contentToGlobal(point:Point):Point| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a Point object from content coordinates to global coordinates.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Global coordinates specify a pixel position relative to the upper-left corner
of the stage, that is, the outermost edge of the application.
Parameters
| point:Point — A Point object that
specifies the x and y coordinates in the content coordinate system
as properties.
|
Returns | Point — A Point object with coordinates relative to the Stage.
|
See also
public function contentToLocal(point:Point):Point| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a Point object from content to local coordinates.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Local coordinates specify a pixel position relative to the
upper left corner of the component.
Parameters
| point:Point — A Point object that specifies the x and y
coordinates in the content coordinate system as properties.
|
Returns | Point — Point A Point object with coordinates relative to the
local coordinate system.
|
See also
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.
|
protected function createChildren():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Create child objects of the component.
This is an advanced method that you might override
when creating a subclass of UIComponent.
A component that creates other components or objects within it is called a composite component.
For example, the Flex ComboBox control is actually made up of a TextInput control
to define the text area of the ComboBox, and a Button control to define the ComboBox arrow.
Components implement the createChildren() method to create child
objects (such as other components) within the component.
From within an override of the createChildren() method,
you call the addChild() method to add each child object.
You do not call this method directly. Flex calls the
createChildren() method in response to the call to
the addChild() method to add the component to its parent.
See also
protected function createInFontContext(classObj:Class):Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates a new object using a context
based on the embedded font being used.
This method is used to solve a problem
with access to fonts embedded in an application SWF
when the framework is loaded as an RSL
(the RSL has its own SWF context).
Embedded fonts can only be accessed from the SWF file context
in which they were created.
By using the context of the application SWF,
the RSL can create objects in the application SWF context
that has access to the application's embedded fonts.
Call this method only after the font styles
for this object are set.
Parameters
| classObj:Class — The class to create.
|
Returns | Object — The instance of the class created in the context
of the SWF owning the embedded font.
If this object is not using an embedded font,
the class is created in the context of this object.
|
protected function createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates the object using a given moduleFactory.
If the moduleFactory is null or the object
cannot be created using the module factory,
then fall back to creating the object using a systemManager.
Parameters
| moduleFactory:IFlexModuleFactory — The moduleFactory to create the class in;
can be null.
|
| |
| className:String — The name of the class to create.
|
Returns | Object — The object created in the context of the moduleFactory.
|
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 determineTextFormatFromStyles():mx.core:UITextFormat| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a UITextFormat object corresponding to the text styles
for this UIComponent.
Returnsoverride public function dispatchEvent(event:Event):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatches an event into the event flow.
The event target is the EventDispatcher object upon which
the dispatchEvent() method is called.
Parameters
| event:Event — The Event object that is dispatched into the event flow.
If the event is being redispatched, a clone of the event is created automatically.
After an event is dispatched, its target property cannot be changed,
so you must create a new copy of the event for redispatching to work.
|
Returns | Boolean — A value of true if the event was successfully dispatched.
A value of false indicates failure or that
the preventDefault() method was called on the event.
|
protected function dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Helper method for dispatching a PropertyChangeEvent
when a property is updated.
Parameters
| prop:String — Name of the property that changed.
|
| |
| oldValue:* — Old value of the property.
|
| |
| value:* — New value of the property.
|
public function drawFocus(isFocused:Boolean):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Shows or hides the focus indicator around this component.
UIComponent implements this by creating an instance of the class
specified by the focusSkin style and positioning it
appropriately.
Parameters
| isFocused:Boolean — Determines if the focus indicator should be displayed. Set to
true to display the focus indicator. Set to false to hide it.
|
public function drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Programmatically draws a rectangle into this skin's Graphics object.
The rectangle can have rounded corners.
Its edges are stroked with the current line style
of the Graphics object.
It can have a solid color fill, a gradient fill, or no fill.
A solid fill can have an alpha transparency.
A gradient fill can be linear or radial. You can specify
up to 15 colors and alpha values at specified points along
the gradient, and you can specify a rotation angle
or transformation matrix for the gradient.
Finally, the rectangle can have a rounded rectangular hole
carved out of it.
This versatile rectangle-drawing routine is used by many skins.
It calls the drawRect() or
drawRoundRect()
methods (in the flash.display.Graphics class) to draw into this
skin's Graphics object.
Parameters
| x:Number — Horizontal position of upper-left corner
of rectangle within this skin.
|
| |
| y:Number — Vertical position of upper-left corner
of rectangle within this skin.
|
| |
| w:Number — Width of rectangle, in pixels.
|
| |
| h:Number — Height of rectangle, in pixels.
|
| |
| r:Object (default = null)null, a Number, or an Object.
If it is null, it specifies that the corners should be square
rather than rounded.
If it is a Number, it specifies the same radius, in pixels,
for all four corners.
If it is an Object, it should have properties named
tl, tr, bl, and
br, whose values are Numbers specifying
the radius, in pixels, for the top left, top right,
bottom left, and bottom right corners.
For example, you can pass a plain Object such as
{ tl: 5, tr: 5, bl: 0, br: 0 }.
The default value is null (square corners).
|
| |
| c:Object (default = null)null, a uint, or an Array.
If it is null, the rectangle not filled.
If it is a uint, it specifies an RGB fill color.
For example, pass 0xFF0000 to fill with red.
If it is an Array, it should contain uints
specifying the gradient colors.
For example, pass [ 0xFF0000, 0xFFFF00, 0x0000FF ]
to fill with a red-to-yellow-to-blue gradient.
You can specify up to 15 colors in the gradient.
The default value is null (no fill).
|
| |
| alpha:Object (default = null)color is null.
If color is a uint specifying an RGB fill color,
then alpha should be a Number specifying
the transparency of the fill, where 0.0 is completely transparent
and 1.0 is completely opaque.
You can also pass null instead of 1.0 in this case
to specify complete opaqueness.
If color is an Array specifying gradient colors,
then alpha should be an Array of Numbers, of the
same length, that specifies the corresponding alpha values
for the gradient.
In this case, the default value is null (completely opaque).
|
| |
| rot:Object (default = null)horizontalGradientMatrix(),
verticalGradientMatrix(), and
rotatedGradientMatrix() can be used to create the value for
this parameter.
|
| |
| gradient:String (default = null)GradientType.LINEAR or GradientType.RADIAL.
(The GradientType class is in the package flash.display.)
|
| |
| ratios:Array (default = null)color parameter.
Each value defines the percentage of the width where the color is
sampled at 100%. The value 0 represents the left-hand position in
the gradient box, and 255 represents the right-hand position in the
gradient box.
|
| |
| hole:Object (default = null) |
See also
public function effectFinished(effectInst:IEffectInstance):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the effect instance when it stops playing on the component.
You can use this method to restore a modification to the component made
by the effectStarted() method when the effect started,
or perform some other action when the effect ends.
Parameters
| effectInst:IEffectInstance — The effect instance object playing on the component.
|
public function effectStarted(effectInst:IEffectInstance):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the effect instance when it starts playing on the component.
You can use this method to perform a modification to the component as part
of an effect. You can use the effectFinished() method
to restore the modification when the effect ends.
Parameters
| effectInst:IEffectInstance — The effect instance object playing on the component.
|
public function endEffectsStarted():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Ends all currently playing effects on the component.
public function executeBindings(recurse:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Executes all the bindings for which the UIComponent object is the destination.
Parameters
| recurse:Boolean (default = false) |
public function finishPrint(obj:Object, target:IFlexDisplayObject):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called after printing is complete.
For the UIComponent class, the method performs no action.
Flex containers override the method to restore the container after printing.
This method is normally not used by application developers.
Parameters
| obj:Object — Contains the properties of the component that
restore it to its state before printing.
|
| |
| target:IFlexDisplayObject — The component that just finished printing.
It can be the current component or one of its children.
|
See also
protected function focusInHandler(event:FocusEvent):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The event handler called when a UIComponent object gets focus.
If you override this method, make sure to call the base class version.
Parameters
protected function focusOutHandler(event:FocusEvent):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The event handler called when a UIComponent object loses focus.
If you override this method, make sure to call the base class version.
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 getClassStyleDeclarations():Array| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Finds the type selectors for this UIComponent instance.
The algorithm walks up the superclass chain.
For example, suppose that class MyButton extends Button.
A MyButton instance first looks for a MyButton type selector
then, it looks for a Button type selector.
then, it looks for a UIComponent type selector.
(The superclass chain is considered to stop at UIComponent, not Object.)
Returns | Array — An Array of type selectors for this UIComponent instance.
|
public function getConstraintValue(constraintName:String):*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a layout constraint value, which is the same as
getting the constraint style for this component.
Parameters
| constraintName:String — The name of the constraint style, which
can be any of the following: left, right, top, bottom,
verticalCenter, horizontalCenter, baseline
|
Returns | * — Returns the layout constraint value, which can be
specified in either of two forms. It can be specified as a
numeric string, for example, "10" or it can be specified as
identifier:numeric string. For identifier:numeric string,
identifier is the id of a ConstraintRow or
ConstraintColumn. For example, a value of "cc1:10" specifies a
value of 10 for the ConstraintColumn that has the
id "cc1."
|
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 getFocus():InteractiveObject| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets the object that currently has focus.
It might not be this object.
Note that this method does not necessarily return the component
that has focus.
It can return the internal subcomponent of the component
that has focus.
To get the component that has focus, use the
focusManager.focus property.
Returns 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 getRepeaterItem(whichRepeater:int = -1):Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated.
The argument whichRepeater is 0 for the outermost
Repeater, 1 for the next inner Repeater, and so on.
If whichRepeater is not specified,
the innermost Repeater is used.
Parameters
| whichRepeater:int (default = -1) |
Returns | Object — The requested repeater item.
|
public function getStyle(styleProp:String):*| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets a style property that has been set anywhere in this
component's style lookup chain.
This same method is used to get any kind of style property,
so the value returned can be a Boolean, String, Number, int,
uint (for an RGB color), Class (for a skin), or any kind of object.
Therefore the return type is simply specified as *.
If you are getting a particular style property, you
know its type and often want to store the result in a
variable of that type.
No casting from * to that type is necessary.
var backgroundColor:uint = getStyle("backgroundColor");
If the style property has not been set anywhere in the
style lookup chain, the value returned by getStyle()
is undefined.
Note that undefined is a special value that is
not the same as false, "",
NaN, 0, or null.
No valid style value is ever undefined.
You can use the method
IStyleManager2.isValidStyleValue()
to test whether the value was set.
Parameters
| styleProp:String — Name of the style property.
|
ReturnsSee also
public function globalToContent(point:Point):Point| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a Point object from global to content coordinates.
Global coordinates specify a pixel position relative to the upper-left corner
of the stage, that is, the outermost edge of the application.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Parameters
| point:Point — A Point object that
specifies the x and y coordinates in the global (Stage)
coordinate system as properties.
|
Returns | Point — Point A Point object with coordinates relative to the component.
|
See also
public function hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent.
Parameters
| stateName:String — The name of the state being checked.
|
Returns | Boolean — Whether or not the specified state has been defined
|
public function horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient.
For performance reasons, the Matrix is stored in a static variable
which is reused by all calls to horizontalGradientMatrix()
and verticalGradientMatrix().
Therefore, pass the resulting Matrix
to drawRoundRect() before calling
horizontalGradientMatrix()
or verticalGradientMatrix() again.
Parameters
| x:Number — The left coordinate of the gradient, in pixels.
|
| |
| y:Number — The top coordinate of the gradient, in pixels.
|
| |
| width:Number — The width of the gradient, in pixels.
|
| |
| height:Number — The height of the gradient, in pixels.
|
Returns | Matrix — The Matrix for the horizontal gradient.
|
protected function initAdvancedLayoutFeatures():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component.
Call this function before attempting to use any of the features implemented
by the AdvancedLayoutFeatures object.
protected function initializationComplete():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Finalizes the initialization of this component.
This method is the last code that executes when you add a component
to a parent for the first time using addChild()
or addChildAt().
It handles some housekeeping related to dispatching
the initialize event.
If you are writing a component, you do not need
to override this method.
public function initialize():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes the internal structure of this component.
Initializing a UIComponent is the fourth step in the creation
of a visual component instance, and happens automatically
the first time that the instance is added to a parent.
Therefore, you do not generally need to call
initialize(); the Flex framework calls it for you
from UIComponent's override of the addChild()
and addChildAt() methods.
The first step in the creation of a visual component instance
is construction, with the new operator:
var okButton:Button = new Button();
After construction, the new Button instance is a solitary
DisplayObject; it does not yet have a UITextField as a child
to display its label, and it doesn't have a parent.
The second step is configuring the newly-constructed instance
with the appropriate properties, styles, and event handlers:
okButton.label = "OK";
okButton.setStyle("cornerRadius", 0);
okButton.addEventListener(MouseEvent.CLICK, clickHandler);
The third step is adding the instance to a parent:
someContainer.addChild(okButton);
A side effect of calling addChild()
or addChildAt(), when adding a component to a parent
for the first time, is that initialize gets
automatically called.
This method first dispatches a preinitialize event,
giving developers using this component a chance to affect it
before its internal structure has been created.
Next it calls the createChildren() method
to create the component's internal structure; for a Button,
this method creates and adds the UITextField for the label.
Then it dispatches an initialize event,
giving developers a chance to affect the component
after its internal structure has been created.
Note that it is the act of attaching a component to a parent
for the first time that triggers the creation of its internal structure.
If its internal structure includes other UIComponents, then this is a
recursive process in which the tree of DisplayObjects grows by one leaf
node at a time.
If you are writing a component, you do not need
to override this method.
protected function initializeAccessibility():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes this component's accessibility code.
This method is called by the initialize() method to hook in the
component's accessibility code, which resides in a separate class
in the mx.accessibility package.
Each subclass that supports accessibility must override this method
because the hook-in process uses a different static variable
in each subclass.
public function initializeRepeaterArrays(parent:IRepeaterClient):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initializes various properties which keep track of repeated instances
of this component.
An MXML <mx:Repeater/> tag can cause repeated instances
of a component to be created, one instance for each item in the
Repeater's data provider.
The instanceIndices, repeaters,
and repeaterIndices properties of UIComponent
keep track of which instance came from which data item
and which Repeater.
This method is an internal method which is automatically called
by the Flex framework.
You do not have to call it or override it.
Parameters
| parent:IRepeaterClient — The parent object containing the Repeater that created
this component.
|
public function invalidateDisplayList():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marks a component so that its updateDisplayList()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate
work by delaying processing of changes to a component until a
later screen update.
For example, if you want to change the width and height,
it would be wasteful to update the component immediately after you
change the width and then update again with the new height.
It is more efficient to change both properties and then render
the component with its new size once.
Invalidation methods rarely get called.
In general, setting a property on a component automatically
calls the appropriate invalidation method.
public function invalidateLayering():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.4 |
Called by a component's items to indicate that their depth
property has changed. Note that while this function is defined on
UIComponent, it is up to subclasses to implement support
for complex layering.
By default, only Group and DataGroup support
arbitrary layering of their children.
See also
protected function invalidateParentSizeAndDisplayList():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true).
public function invalidateProperties():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marks a component so that its commitProperties()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate
work by delaying processing of changes to a component until a
later screen update.
For example, if you want to change the text color and size,
it would be wasteful to update the color immediately after you
change it and then update the size when it gets set.
It is more efficient to change both properties and then render
the text with its new size and color once.
Invalidation methods rarely get called.
In general, setting a property on a component automatically
calls the appropriate invalidation method.
public function invalidateSize():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Marks a component so that its measure()
method gets called during a later screen update.
Invalidation is a useful mechanism for eliminating duplicate
work by delaying processing of changes to a component until a
later screen update.
For example, if you want to change the text and font size,
it would be wasteful to update the text immediately after you
change it and then update the size when it gets set.
It is more efficient to change both properties and then render
the text with its new size once.
Invalidation methods rarely get called.
In general, setting a property on a component automatically
calls the appropriate invalidation method.
protected function isOurFocus(target:DisplayObject):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
Parameters
| target:DisplayObject — A UIComponent object containing a UITextField object
that can receive focus.
|
Returns | Boolean — Returns true if the UITextField object has focus.
|
protected function keyDownHandler(event:KeyboardEvent):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The event handler called for a keyDown event.
If you override this method, make sure to call the base class version.
Parameters
protected function keyUpHandler(event:KeyboardEvent):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The event handler called for a keyUp event.
If you override this method, make sure to call the base class version.
Parameters
public function localToContent(point:Point):Point| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Converts a Point object from local to content coordinates.
Local coordinates specify a pixel position relative to the
upper left corner of the component.
Content coordinates specify a pixel position relative to the upper left corner
of the component's content, and include all of the component's content area,
including any regions that are currently clipped and must be
accessed by scrolling the component.
You use the content coordinate system to set and get the positions of children
of a container that uses absolute positioning.
Parameters
| point:Point — A Point object that specifies the x and y
coordinates in the local coordinate system as properties.
|
Returns | Point — Point A Point object with coordinates relative to the
content coordinate system.
|
See also
public function matchesCSSState(cssState:String):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true if cssState matches currentCSSState.
Typically, you do not call this method directly.
It is called by the mx.styles.CSSCondition.matchesStyleClient() method.
Note Spark components use their skin state as the pseudo state.
Halo components use the currentState property.
Parameters
| cssState:String — A possible value of CSSCondition.value.
It represents the current state of this component used to match CSS pseudo-selectors.
|
Returns | Boolean — true if cssState matches currentCSSState.
By default, currentCSSState is the same as currentState.
If no state exists, return null.
|
public function matchesCSSType(cssType:String):Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether this instance is the same as, or is a subclass of,
the given type.
Typically, you do not call this method directly.
It is called by the mx.styles.CSSCondition.matchesStyleClient() method.
Parameters
| cssType:String — A CSSSelector object.
|
Returns | Boolean — true if cssType is in the hierarchy of qualified type selectors.
|
protected function measure():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the default size, and optionally the default minimum size,
of the component. This is an advanced method that you might override when
creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
measure() method when the component is added to a container
using the addChild() method, and when the component's
invalidateSize() method is called.
When you set a specific height and width of a component,
Flex does not call the measure() method,
even if you explicitly call the invalidateSize() method.
That is, Flex only calls the measure() method if
the explicitWidth property or the explicitHeight
property of the component is NaN.
In your override of this method, you must set the
measuredWidth and measuredHeight properties
to define the default size.
You can optionally set the measuredMinWidth and
measuredMinHeight properties to define the default
minimum size.
Most components calculate these values based on the content they are
displaying, and from the properties that affect content display.
A few components simply have hard-coded default values.
The conceptual point of measure() is for the component to provide
its own natural or intrinsic size as a default. Therefore, the
measuredWidth and measuredHeight properties
should be determined by factors such as:
- The amount of text the component needs to display.
- The styles, such as
fontSize, for that text. - The size of a JPEG image that the component displays.
- The measured or explicit sizes of the component's children.
- Any borders, margins, and gaps.
In some cases, there is no intrinsic way to determine default values.
For example, a simple GreenCircle component might simply set
measuredWidth = 100 and measuredHeight = 100 in its measure() method to
provide a reasonable default size. In other cases, such as a TextArea,
an appropriate computation (such as finding the right width and height
that would just display all the text and have the aspect ratio of a Golden Rectangle)
might be too time-consuming to be worthwhile.
The default implementation of measure()
sets measuredWidth, measuredHeight,
measuredMinWidth, and measuredMinHeight
to 0.
See also
public function measureHTMLText(htmlText:String):flash.text:TextLineMetrics| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent.
Parameters
| htmlText:String — A String specifying the HTML text to measure.
|
Returns public function measureText(text:String):flash.text:TextLineMetrics| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. Does not
work for Spark components since they don't use UITextField
(or UIFTETextField). To measure text in Spark components,
get the measurements of a spark.components.Label
or spark.components.RichText
Parameters
| text:String — A String specifying the text to measure.
|
Returns public function move(x:Number, y:Number):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves the component to a specified position within its parent.
Calling this method is exactly the same as
setting the component's x and y properties.
If you are overriding the updateDisplayList() method
in a custom component, call the move() method
rather than setting the x and y properties.
The difference is that the move() method changes the location
of the component and then dispatches a move event when you
call the method, while setting the x and y
properties changes the location of the component and dispatches
the event on the next screen refresh.
Parameters
| x:Number — Left position of the component within its parent.
|
| |
| y:Number — Top position of the component within its parent.
|
public function notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Propagates style changes to the children.
You typically never need to call this method.
Parameters
| styleProp:String — String specifying the name of the style property.
|
| |
| recursive:Boolean — Recursivly notify all children of this component.
|
public function owns(child: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 prepareToPrint(target:IFlexDisplayObject):Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Prepares an IFlexDisplayObject for printing.
For the UIComponent class, the method performs no action.
Flex containers override the method to prepare for printing;
for example, by removing scroll bars from the printed output.
This method is normally not used by application developers.
Parameters
| target:IFlexDisplayObject — The component to be printed.
It can be the current component or one of its children.
|
Returns | Object — Object containing the properties of the current component
required by the finishPrint() method
to restore it to its previous state.
|
See also
public function regenerateStyleCache(recursive:Boolean):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well.
The Flex framework calls this method in the following
situations:
- When you add a UIComponent to a parent using the
addChild() or addChildAt() methods. - When you change the
styleName property
of a UIComponent. - When you set a style in a CSS selector using the
setStyle() method of CSSStyleDeclaration.
Building the style cache is a computation-intensive operation,
so avoid changing styleName or
setting selector styles unnecessarily.
This method is not called when you set an instance style
by calling the setStyle() method of UIComponent.
Setting an instance style is a relatively fast operation
compared with setting a selector style.
You do not need to call or override this method.
Parameters
| recursive:Boolean — Recursively regenerates the style cache for
all children of this component.
|
public function registerEffects(effects:Array):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
For each effect event, registers the EffectManager
as one of the event listeners.
You typically never need to call this method.
Parameters
| effects:Array — The names of the effect events.
|
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.
|
protected function resourcesChanged():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way.
This event is dispatched when you set the ResourceManager's
localeChain property, when a resource module
has finished loading, and when you call the ResourceManager's
update() method.
Subclasses should override this method and, after calling
super.resourcesChanged(), do whatever is appropriate
in response to having new resource values.
public static function resumeBackgroundProcessing():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing().
Refer to the description of
suspendBackgroundProcessing() for more information.
public function setActualSize(w:Number, h:Number):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sizes the object.
Unlike directly setting the width and height
properties, calling the setActualSize() method
does not set the explictWidth and
explicitHeight properties, so a future layout
calculation can result in the object returning to its previous size.
This method is used primarily by component developers implementing
the updateDisplayList() method, by Effects,
and by the LayoutManager.
Parameters
| w:Number — Width of the object.
|
| |
| h:Number — Height of the object.
|
public function setConstraintValue(constraintName:String, value:*):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets a layout constraint value, which is the same as
setting the constraint style for this component.
Parameters
| constraintName:String — The name of the constraint style, which
can be any of the following: left, right, top, bottom,
verticalCenter, horizontalCenter, baseline
|
| |
| value:* |
public function setCurrentState(stateName:String, playTransition:Boolean = true):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Set the current state.
Parameters
| stateName:String — The name of the new view state.
|
| |
| playTransition:Boolean (default = true)true, play
the appropriate transition when the view state changes.
|
See also
public function setFocus():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the focus to this component.
The component can in turn pass focus to a subcomponent.
Note: Only the TextInput and TextArea controls show a highlight
when this method sets the focus.
All controls show a highlight when the user tabs to the control.
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.
|
protected function setStretchXY(stretchX:Number, stretchY:Number):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Specifies a transform stretch factor in the horizontal and vertical direction.
The stretch factor is applied to the computed matrix before any other transformation.
Parameters
| stretchX:Number — The horizontal component of the stretch factor.
|
| |
| stretchY:Number — The vertical component of the stretch factor.
|
public function setStyle(styleProp:String, newValue:*):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets a style property on this component instance.
This can override a style that was set globally.
Calling the setStyle() method can result in decreased performance.
Use it only when necessary.
Parameters
| styleProp:String — Name of the style property.
|
| |
| newValue:* — New value for the style.
|
See also
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.
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.
|
protected function stateChanged(oldState:String, newState:String, recursive:Boolean):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
This method is called when a state changes to check whether
state-specific styles apply to this component. If there is a chance
of a matching CSS pseudo-selector for the current state, the style
cache needs to be regenerated for this instance and, potentially all
children, if the recursive param is set to true.
Parameters
| oldState:String — The name of th eold state.
|
| |
| newState:String — The name of the new state.
|
| |
| recursive:Boolean — Set to true to perform a recursive check.
|
public function styleChanged(styleProp:String):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Detects changes to style properties. When any style property is set,
Flex calls the styleChanged() method,
passing to it the name of the style being set.
This is an advanced method that you might override
when creating a subclass of UIComponent. When you create a custom component,
you can override the styleChanged() method
to check the style name passed to it, and handle the change accordingly.
This lets you override the default behavior of an existing style,
or add your own custom style properties.
If you handle the style property, your override of
the styleChanged() method should call the
invalidateDisplayList() method to cause Flex to execute
the component's updateDisplayList() method at the next screen update.
Parameters
| styleProp:String — The name of the style property, or null if all styles for this
component have changed.
|
public function stylesInitialized():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Flex calls the stylesInitialized() method when
the styles for a component are first initialized.
This is an advanced method that you might override
when creating a subclass of UIComponent. Flex guarantees that
your component's styles are fully initialized before
the first time your component's measure and
updateDisplayList methods are called. For most
components, that is sufficient. But if you need early access to
your style values, you can override the stylesInitialized() function
to access style properties as soon as they are initialized the first time.
public static function suspendBackgroundProcessing():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called.
These methods can be useful when you have time-critical code
which needs to execute without interruption.
For example, when you set the suspendBackgroundProcessing
property of an Effect to true,
suspendBackgroundProcessing() is automatically called
when it starts playing, and resumeBackgroundProcessing
is called when it stops, in order to ensure that the animation
is smooth.
Since the LayoutManager uses callLater(),
this means that commitProperties(),
measure(), and updateDisplayList()
is not called in between calls to
suspendBackgroundProcessing() and
resumeBackgroundProcessing().
It is safe for both an outer method and an inner method
(i.e., one that the outer methods calls) to call
suspendBackgroundProcessing()
and resumeBackgroundProcessing(), because these
methods actually increment and decrement a counter
which determines whether background processing occurs.
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 point, in the component's own coordinates,
to keep fixed relative to its parent.
|
| |
| scale:Vector3D (default = null) |
| |
| rotation:Vector3D (default = null) |
| |
| translation:Vector3D (default = null) |
| |
| postLayoutScale:Vector3D (default = null) |
| |
| postLayoutRotation:Vector3D (default = null) |
| |
| postLayoutTranslation:Vector3D (default = null) |
| |
| invalidateLayout:Boolean (default = true)true, the parent container size and display are
invalidated. Layouts calling this method pass false
so that a subsequent layout pass is not triggered.
|
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 is 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 updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the object and/or sizes and positions its children.
This is an advanced method that you might override
when creating a subclass of UIComponent.
You do not call this method directly. Flex calls the
updateDisplayList() method when the component is added to a container
using the addChild() method, and when the component's
invalidateDisplayList() method is called.
If the component has no children, this method
is where you would do programmatic drawing
using methods on the component's Graphics object
such as graphics.drawRect().
If the component has children, this method is where
you would call the move() and setActualSize()
methods on its children.
Components can do programmatic drawing even if
they have children. In doing either, use the
component's unscaledWidth and unscaledHeight
as its bounds.
It is important to use unscaledWidth and
unscaledHeight instead of the width
and height properties.
Parameters
| unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
|
| |
| unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
See also
public function validateDisplayList():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Validates the position and size of children and draws other
visuals.
If the LayoutManager.invalidateDisplayList() method is called with
this ILayoutManagerClient, then the validateDisplayList() method
is called when it's time to update the display list.
public function validateNow():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Validate and update the properties and layout of this object
and redraw it, if necessary.
Processing properties that require substantial computation are normally
not processed until the script finishes executing.
For example setting the width property is delayed, because it can
require recalculating the widths of the objects children or its parent.
Delaying the processing prevents it from being repeated
multiple times if the script sets the width property more than once.
This method lets you manually override this behavior.
public function validateProperties():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Used by layout logic to validate the properties of a component
by calling the commitProperties() method.
In general, subclassers should
override the commitProperties() method and not this method.
public function validateSize(recursive:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements.
Parameters
| recursive:Boolean (default = false)true, call this method
on the objects children.
|
public function validationResultHandler(event:ValidationResultEvent):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles both the valid and invalid events from a
validator assigned to this component.
You typically handle the valid and invalid events
dispatched by a validator by assigning event listeners to the validators.
If you want to handle validation events directly in the component that is being validated,
you can override this method to handle the valid
and invalid events. You typically call
super.validationResultHandler(event) in your override.
Parameters
See also
public function verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient.
For performance reasons, the Matrix is stored in a static variable
which is reused by all calls to horizontalGradientMatrix()
and verticalGradientMatrix().
Therefore, pass the resulting Matrix
to drawRoundRect() before calling
horizontalGradientMatrix()
or verticalGradientMatrix() again.
Parameters
| x:Number — The left coordinate of the gradient, in pixels.
|
| |
| y:Number — The top coordinate of the gradient, in pixels.
|
| |
| width:Number — The width of the gradient, in pixels.
|
| |
| height:Number — The height of the gradient, in pixels.
|
Returns | Matrix — The Matrix for the vertical gradient.
|
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(), addChildAt(),
addElement(), or addElementAt() 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.
This event is only dispatched when there are one or more relevant listeners
attached to the dispatching object.
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,
property processing, measuring, layout, and drawing.
At this point, depending on its visible property,
the component is not visible even though it has been drawn.
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.
This event is only dispatched when there are one or more
relevant listeners attached to the dispatching object.
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.
This event is only dispatched when there are one or more
relevant listeners attached to the dispatching object.
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 an application running in Flash Player,
the event is dispatched many times when you move the mouse over any component.
In an application running in AIR, the event is dispatched only once.
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 do not get any of the
other drag events.
In Flash Player, 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 can change the type of drag action by calling the
DragManager.showFeedback() method.
In AIR, the default value of the action property is
DragManager.COPY.
Because of the way data to a Tree control is structured,
the Tree control handles drag and drop differently from the other list-based controls.
For the Tree control, the event handler for the dragDrop event
only performs an action when you move or copy data in the same Tree control,
or copy data to another Tree control.
If you drag data from one Tree control and drop it onto another Tree control
to move the data, the event handler for the dragComplete event
actually performs the work to add the data to the destination Tree control,
rather than the event handler for the dragDrop event,
and also removes the data from the source Tree control.
This is necessary because to reparent the data being moved,
Flex must remove it first from the source Tree control.
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 Flash Player, the event is dispatched
when you drag an item over a valid drop target.
In AIR, the event is dispatched when you drag an item over
any component, even if the component is not a valid drop target.
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.
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 can 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.DragEventproperty DragEvent.type = mx.events.DragEvent.DRAG_START| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched by the drag initiator when starting a drag operation.
This event is used internally by the list-based controls;
you do not handle it when implementing drag and drop.
If you want to control the start of a drag-and-drop operation,
use the mouseDown or mouseMove event.
The DragEvent.DRAG_START constant defines the value of the
type property of the event object for a
dragStart 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.EffectEventproperty EffectEvent.type = mx.events.EffectEvent.EFFECT_END| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched after an effect ends.
The effect makes the last set of visual changes
before this event is fired, but those changes are not
rendered on the screen.
Thus, you might have to use the callLater() method
to delay any other changes that you want to make until after the
changes have been rendered onscreen.
The
EffectEvent.EFFECT_END constant defines the value of the
type property of the event object for an
effectEnd 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. |
effectInstance | The effect instance object
for the event. |
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.EffectEventproperty EffectEvent.type = mx.events.EffectEvent.EFFECT_START| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched just before an effect starts.
The effect does not start changing any visuals
until after this event is fired.
The
EffectEvent.EFFECT_START constant defines the value of the
type property of the event object for an
effectStart 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. |
effectInstance | The effect instance object
for the event. |
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.EffectEventproperty EffectEvent.type = mx.events.EffectEvent.EFFECT_STOP| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched after an effect is stopped, which happens
only by a call to stop() on the effect.
The effect then dispatches the EFFECT_END event
as the effect finishes. The purpose of the EFFECT_STOP
event is to let listeners know that the effect came to
a premature end, rather than ending naturally or as a
result of a call to end().
The
EffectEvent.EFFECT_STOP constant defines the value of the
type property of the event object for an
effectStop 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. |
effectInstance | The effect instance object
for the event. |
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.ENTER_STATE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched after the component has entered a view state.
This event is only dispatched when there are one or more
relevant listeners attached to the dispatching object.
The
FlexEvent.ENTER_STATE constant defines the value of the
type property of the event object for a
enterState 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.EXIT_STATE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched just before the component exits a view state.
This event is only dispatched when there are one or more
relevant listeners attached to the dispatching object.
The
FlexEvent.EXIT_STATE constant defines the value of the
type property of the event object for a
exitState 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.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.
After the initialization phase, properties are processed, the component
is measured, laid out, and drawn, after which the
creationComplete event is dispatched.
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.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.INVALID| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a component is monitored by a Validator
and the validation failed.
The
FlexEvent.INVALID constant defines the value of the
type property of the event object for a
invalid 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.
This event only dispatched when there are one or more
relevant listeners attached to the dispatching object.
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(), removeChildAt(),
removeElement(), or removeElementAt() 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.
This event only dispatched when there are one or more relevant listeners
attached to the dispatching object.
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.
This event only dispatched when there are one or more
relevant listeners attached to the dispatching object.
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 is to 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. |
Event Object Type: mx.events.FlexEventproperty FlexEvent.type = mx.events.FlexEvent.UPDATE_COMPLETE| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when an object has had its commitProperties(),
measure(), and
updateDisplayList() methods called (if needed).
This is the last opportunity to alter the component before it is
displayed. All properties have been committed and the component has
been measured and layed out.
This event is only dispatched when there are one or more
relevant listeners attached to the dispatching object.
The
FlexEvent.UPDATE_COMPLETE constant defines the value of the
type property of the event object for a
updateComplete 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.VALID| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when a component is monitored by a Validator
and the validation succeeded.
The
FlexEvent.VALID constant defines the value of the
type property of the event object for a
valid 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.VALUE_COMMIT| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when values are changed programmatically
or by user interaction.
Because a programmatic change triggers this event, make sure
that any valueCommit event handler does not change
a value that causes another valueCommit event.
For example, do not change a control's dataProvider
property in a valueCommit event handler.
The
FlexEvent.VALUE_COMMIT constant defines the value of the
type property of the event object for a
valueCommit
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. |
public static const DEFAULT_MAX_HEIGHT:Number = 10000| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the maxHeight property.
The default value is 10000.
public static const DEFAULT_MAX_WIDTH:Number = 10000| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the maxWidth property.
The default value is 10000.
public static const DEFAULT_MEASURED_HEIGHT:Number = 22| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the measuredHeight property.
Most components calculate a measuredHeight but some are flow-based and
have to pick a number that looks reasonable.
The default value is 22.
public static const DEFAULT_MEASURED_MIN_HEIGHT:Number = 22| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the measuredMinHeight property.
Most components calculate a measuredMinHeight but some are flow-based and
have to pick a number that looks reasonable.
The default value is 22.
public static const DEFAULT_MEASURED_MIN_WIDTH:Number = 40| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the measuredMinWidth property.
Most components calculate a measuredMinWidth but some are flow-based and
have to pick a number that looks reasonable.
The default value is 40.
public static const DEFAULT_MEASURED_WIDTH:Number = 160| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default value for the measuredWidth property.
Most components calculate a measuredWidth but some are flow-based and
have to pick a number that looks reasonable.
The default value is 160.
Show MXML Syntax
Hide MXML Syntax
