| Language Version: | ActionScript 3.0 |
| Runtime Versions: | Flash Player 10, AIR 1.5 |
The ILayoutElement interface is used primarily by the layout classes to query,
size and position the elements of the GroupBase based containers.
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".
The default value is null.
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".
The default value is null.
Implementation public function get bottom():Object public function set bottom(value:Object):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".
The default value is null.
Implementation public function get horizontalCenter():Object public function set horizontalCenter(value:Object):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):voidleft: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".
The default value is null.
Implementation public function get left():Object public function set left(value:Object):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.
The default value is NaN.
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.
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.
The default value is NaN.
Implementation public function get percentWidth():Number public function set percentWidth(value:Number):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".
The default value is null.
Implementation public function get right():Object public function set right(value:Object):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".
The default value is null.
Implementation public function get top():Object public function set top(value:Object):voidverticalCenter: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".
The default value is null.
Implementation public function get verticalCenter():Object public function set verticalCenter(value:Object):void 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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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.
|
See also
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.
|
See also
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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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) |
ReturnsSee also
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().
|
See also
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().
|
See also
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 setLayoutSize can affect the layout position, so
setLayoutPosition should be called after setLayoutSize.
|
| |
| y:Number |
| |
| postLayoutTransform:Boolean (default = true) |
See also
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) |
See also
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
See also
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.
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
See also
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 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) |
© 2009 Adobe Systems Incorporated. All rights reserved.
Sat Oct 3 2009, 04:15 AM -07:00 
Hide Inherited Public Methods
Show Inherited Public Methods