baseline:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The vertical distance in pixels from the anchor target to
the control's baseline position.
By default the anchor target is the 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 spcify an anchor target, set the property value to a string in the format
"anchorTargetName:value" e.g. "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 10, AIR 1.5 |
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.
Each component should override this property.
Implementation public function get baselinePosition():Numberbottom:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 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 spcify an anchor target, set the property value to a string in the format
"anchorTargetName:value" e.g. "row1:10".
Implementation public function get bottom():Object public function set bottom(value:Object):voiddepth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Determines the order in which items inside of containers
are rendered.
Spark containers order their items based on their
depth property, with the lowest depth in the back,
and the higher in the front.
Items with the same depth value appear in the order
they are added to the container.
Implementation public function get depth():Number public function set depth(value:Number):voiddesignLayer: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):voidhasLayoutMatrix3D:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
True if the element has 3D Matrix.
Use hasLayoutMatrix3D instead of calling and examining the
value of getLayoutMatrix3D() as that method returns a valid
matrix even when the element is in 2D.
Implementation public function get hasLayoutMatrix3D():BooleanhorizontalCenter:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 preceeding 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" e.g. "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 10, AIR 1.5 |
The identifier for this object.
Implementation public function get id():String public function set id(value:String):voidincludeInLayout:Boolean| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
Implementation public function get includeInLayout():Boolean public function set includeInLayout(value:Boolean):voidis3D:Boolean [read-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
True, when the element is in 3D. The element can be in 3D either because
it has 3D transform properties or it has 3D transform offsets or both.
Implementation public function get is3D():Booleanleft:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 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 spcify an anchor target, set the property value to a string in the format
"anchorTargetName:value" e.g. "col1:10".
Implementation public function get left():Object public function set left(value:Object):voidowner:DisplayObjectContainer| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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):voidpercentHeight:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Number that specifies the height of a component as a percentage
of its parent's size. Allowed values are 0-100.
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.
Implementation public function get percentHeight():Number public function set percentHeight(value:Number):voidpercentWidth:Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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.
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 9, AIR 1.1 |
Implementation public function get postLayoutTransformOffsets():mx.geom:TransformOffsets public function set postLayoutTransformOffsets(value:mx.geom:TransformOffsets):voidright:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 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 spcify an anchor target, set the property value to a string in the format
"anchorTargetName:value" e.g. "col1:10".
Implementation public function get right():Object public function set right(value:Object):voidrotationX:Number[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the x-axis rotation of the DisplayObject instance, in degrees,
from its original orientation relative to the 3D parent container.
Values from 0 to 180 represent clockwise rotation; values from 0 to -180
represent counterclockwise rotation. Values outside this range are added
to or subtracted from 360 to obtain a value within the range.
This property is ignored during calculation by any of Flex's 2D layouts.
Implementation override public function get rotationX():Number override public function set rotationX(value:Number):voidrotationY:Number[override]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Indicates the y-axis rotation of the DisplayObject instance, in degrees,
from its original orientation relative to the 3D parent container.
Values from 0 to 180 represent clockwise rotation; values from 0 to -180
represent counterclockwise rotation. Values outside this range are added
to or subtracted from 360 to obtain a value within the range.
This property is ignored during calculation by any of Flex's 2D layouts.
Implementation override public function get rotationY():Number override public function set rotationY(value:Number):voidscaleY:Number[override]
Implementation override public function get scaleY():Number override public function set scaleY(value:Number):voidtop:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 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 spcify an anchor target, set the property value to a string in the format
"anchorTargetName:value" e.g. "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 object 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 object.
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 object 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 transformY,
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 object.
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 object 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 transformZ,
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 object.
Implementation public function get transformZ():Number public function set transformZ(value:Number):voidSee also
verticalCenter:Object| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
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 preceeding 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" e.g. "row1:10".
Implementation public function get verticalCenter():Object public function set verticalCenter(value:Object):voidviewHeight:Number [write-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the vertical space that the graphic uses in the layout. When you set this value, the content is not scaled.
Whereas, if you specify the value of the height property, the content is scaled.
There are two cases where this can be useful:
1) Specify a viewHeight larger than the natural size of the content. You might do this so that the graphic takes
up more space than its visual size.
2) Specify a viewHeight that is smaller than the natural size of the content. You might do this if your graphic has extra
chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.
Implementation protected function set viewHeight(value:Number):voidviewWidth:Number [write-only]
| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Defines the horizontal space that the graphic uses in the layout. When you set this value, the content is not scaled.
Whereas, if you specify the value of the width property, the content is scaled.
There are two cases where this can be useful:
1) Specify a viewWidth larger than the natural size of the content. You might do this so that the graphic takes
up more space than its visual size.
2) Specify a viewWidth that is smaller than the natural size of the content. You might do this if your graphic has extra
chrome or a border that extends past the edges of the graphic. In this scenario, be sure to disable clipping in your layout.
Implementation protected function set viewWidth(value:Number):voidvisible:Boolean[override]
Controls the visibility of this visual element.
If true, the object is visible.
If an object is not visible, but the includeInLayout
property is set to true, then the object
takes up space in the container, but is invisible.
If visible is set to true, the object may not
necessarily be visible due to its size and whether container clipping
is enabled.
Setting visible to false,
prevents the component from getting focus.
Implementation override public function get visible():Boolean override public function set visible(value:Boolean):voidz:Number[override]
Implementation override public function get z():Number override public function set z(value:Number):voidpublic function SpriteVisualElement()| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Constructor.
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 measure() to predict what
the element position will be, if the element is resized to particular dimesions.
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 measure() to predict what
the element position will be, if the element is resized to particular dimesions.
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 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 — Returns 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 — Returns 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) |
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) |
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) |
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 as getExplicitOrMeasuredHeight().
|
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) |
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 as getExplicitOrMeasuredWidth().
|
protected function invalidateParentSizeAndDisplayList():void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Invalidates parent size and display list if
this object affects its layout (includeInLayout is true).
public function setLayoutBoundsPosition(newBoundsX:Number, newBoundsY: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
| newBoundsX: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 setLayoutSize can affect the layout position, so
setLayoutPosition should be called after setLayoutSize.
|
| |
| newBoundsY: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 to the specified dimensions. This is the size that
the element uses to draw on screen.
If one of the dimensions is left unspecified (NaN), it's size
will be picked such that element can be optimally sized to fit the other
dimension. This is useful when the caller doesn't want to
overconstrain the element, for example when the element's width and height
are corelated (text, components with complex transforms, etc.)
If both dimensions are left unspecified, the element will have its layout size
set to its preferred size.
setLayoutSize does not clip against minium or maximum sizes.
Note that calls to setLayoutSize can affect the layout position, so
setLayoutSize should be called before setLayoutPosition.
Parameters
| width:Number — The target width.
|
| |
| height:Number — The target 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.
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.
Note that layout Matrix 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.
Developers that call this method directly typically pass true
to invalidateLayout so that the parent container is notified that
it needs to re-layout the children.
Parameters
public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Similarly to the layoutMatrix3D property, sets the layout Matrix3D, but
doesn't trigger a layout pass.
Parameters
public function transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null):void| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Parameters
protected function transformHeightForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Transform the element's size.
Parameters
| width:Number — The target pre-transform width.
|
| |
| height:Number — The target pre-transform height.
|
| |
| postLayoutTransform:Boolean (default = true) |
Returns | Number — Returns the transformed height. Transformation is this element's
layout transformation matrix.
|
public function transformPointToParent(transformCenter:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void Parameters
protected function transformWidthForLayout(width:Number, height:Number, postLayoutTransform:Boolean = true):Number| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
Transform the element's size.
Parameters
| width:Number — The target pre-transform width.
|
| |
| height:Number — The target pre-transform height.
|
| |
| postLayoutTransform:Boolean (default = true) |
Returns | Number — Returns the transformed width. Transformation is this element's
layout transformation matrix.
|
© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00 
FlexSprite 
Hide Inherited Public Properties
Show Inherited Public Properties