Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
ILayoutElement

Package | mx.core
Interface | public interface ILayoutElement extends flash.events.IEventDispatcher
Implementors | GraphicElement

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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 GroupBase containers.

Public Properties

| Property | Defined By
--- | --- | ---
|  | baseline : Object The vertical distance in pixels from the anchor target to the control's baseline position. | ILayoutElement
|  | baselinePosition : Number [read-only] The y-coordinate of the baseline of the first line of text of the component. | ILayoutElement
|  | bottom : Object The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge. | ILayoutElement
|  | hasLayoutMatrix3D : Boolean [read-only] Contains true if the element has 3D Matrix. | ILayoutElement
|  | horizontalCenter : Object The horizontal distance in pixels from the center of the component to the center of the anchor target's content area. | ILayoutElement
|  | includeInLayout : Boolean Specifies whether this component is included in the layout of the parent container. | ILayoutElement
|  | left : Object The horizontal distance in pixels from the left edge of the component to the anchor target's left edge. | ILayoutElement
|  | percentHeight : Number Specifies the height of a component as a percentage of its parent's size. | ILayoutElement
|  | percentWidth : Number Specifies the width of a component as a percentage of its parent's size. | ILayoutElement
|  | right : Object The horizontal distance in pixels from the right edge of the component to the anchor target's right edge. | ILayoutElement
|  | top : Object The vertical distance in pixels from the top edge of the component to the anchor target's top edge. | ILayoutElement
|  | verticalCenter : Object The vertical distance in pixels from the center of the component to the center of the anchor target's content area. | ILayoutElement

Public Methods

| Method | Defined By
--- | --- | ---
|  | getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the x coordinate of the element's bounds at the specified element size. | ILayoutElement
|  | getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number Returns the y coordinate of the element's bounds at the specified element size. | ILayoutElement
|  | getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's layout height. | ILayoutElement
|  | getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's layout width. | ILayoutElement
|  | getLayoutBoundsX(postLayoutTransform:Boolean = true):Number Returns the x coordinate that the element uses to draw on screen. | ILayoutElement
|  | getLayoutBoundsY(postLayoutTransform:Boolean = true):Number Returns the y coordinate that the element uses to draw on screen. | ILayoutElement
|  | getLayoutMatrix():Matrix Returns the transform matrix that is used to calculate the component's layout relative to its siblings. | ILayoutElement
|  | getLayoutMatrix3D():Matrix3D Returns the layout transform Matrix3D for this element. | ILayoutElement
|  | getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's maximum height. | ILayoutElement
|  | getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's maximum width. | ILayoutElement
|  | getMinBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's minimum height. | ILayoutElement
|  | getMinBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's minimum width. | ILayoutElement
|  | getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number Returns the element's preferred height. | ILayoutElement
|  | getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number Returns the element's preferred width. | ILayoutElement
|  | setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void Sets the coordinates that the element uses to draw on screen. | ILayoutElement
|  | setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void Sets the layout size of the element. | ILayoutElement
|  | setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings. | ILayoutElement
|  | setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings. | ILayoutElement
|  | 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 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. | ILayoutElement

Property Detail

baseline | property

`baseline:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get baseline():Object`
`public function set baseline(value:Object):void`

baselinePosition | property |

`baselinePosition:Number` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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():Number`

bottom | property |

`bottom:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get bottom():Object`
`public function set bottom(value:Object):void`

hasLayoutMatrix3D | property |

`hasLayoutMatrix3D:Boolean` [read-only]

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Contains `true` if the element has 3D Matrix.

Use `hasLayoutMatrix3D` instead of calling and examining the return value of `getLayoutMatrix3D()` because that method returns a valid matrix even when the element is in 2D.

Implementation
`public function get hasLayoutMatrix3D():Boolean`

horizontalCenter | property |

`horizontalCenter:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get horizontalCenter():Object`
`public function set horizontalCenter(value:Object):void`

includeInLayout | property |

`includeInLayout:Boolean`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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):void`

left | property |

`left:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get left():Object`
`public function set left(value:Object):void`

percentHeight | property |

`percentHeight:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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):void`

percentWidth | property |

`percentWidth:Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

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):void`

right | property |

`right:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get right():Object`
`public function set right(value:Object):void`

top | property |

`top:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get top():Object`
`public function set top(value:Object):void`

verticalCenter | property |

`verticalCenter:Object`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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

The default value is `null`.

Implementation
`public function get verticalCenter():Object`
`public function set verticalCenter(value:Object):void`
Method Detail

getBoundsXAtSize | () | method

`public function getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns x coordinate of the element's bounding box top-left corner. The bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns

| `Number` — The x coordinate of the element's bounds at the specified element size.

See also

setLayoutBoundsSize()
getLayoutMatrix()
getLayoutMatrix3D()

getBoundsYAtSize | () | method |

`public function getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns the y coordinate of the element's bounding box top-left corner. The bounding box is in element's parent coordinate space and is calculated from the specified bounds size, layout position and layout transform matrix.

Returns

| `Number` — The y coordinate of the element's bounds at the specified element size.

See also

setLayoutBoundsSize()
getLayoutBoundsY()
getLayoutMatrix()
getLayoutMatrix3D()

getLayoutBoundsHeight | () | method |

`public function getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns

| `Number` — The element's layout height.

See also

getLayoutBoundsWidth()
getLayoutMatrix()
getLayoutMatrix3D()

getLayoutBoundsWidth | () | method |

`public function getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns the element's bounding box width. The bounding box is in element's parent coordinate space and is calculated from the element's layout size and layout transform matrix.

Returns

| `Number` — The element's layout width.

See also

getLayoutBoundsHeight()
getLayoutMatrix()
getLayoutMatrix3D()

getLayoutBoundsX | () | method |

`public function getLayoutBoundsX(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns x coordinate of the element's bounding box top-left corner. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

Returns

| `Number` — The x coordinate that the element uses to draw on screen.

See also

getLayoutBoundsY()
getLayoutMatrix()
getLayoutMatrix3D()

getLayoutBoundsY | () | method |

`public function getLayoutBoundsY(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the method returns y coordinate of the element's bounding box top-left corner. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position, and layout transform matrix.

Returns

| `Number` — The y coordinate that the element uses to draw on screen.

See also

getLayoutBoundsX()
getLayoutMatrix()
getLayoutMatrix3D()

getLayoutMatrix | () | method |

`public function getLayoutMatrix():Matrix`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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. Do not directly modify the return value; call the `setLayoutMatrix()` method instead.

See also

setLayoutMatrix()
getLayoutMatrix3D()
setLayoutMatrix3D()

getLayoutMatrix3D | () | method |

`public function getLayoutMatrix3D():Matrix3D`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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. Do not directly modify the return value but call the `setLayoutMatrix()` method instead.

See also

getLayoutMatrix()
setLayoutMatrix()
setLayoutMatrix3D()

getMaxBoundsHeight | () | method |

`public function getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's maximum height.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is true, the method returns the element's bounding box height. The bounding box is in the element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns

| `Number` — The element's maximum height.

See also

getMaxBoundsWidth()
getLayoutMatrix()
getLayoutMatrix3D()

getMaxBoundsWidth | () | method |

`public function getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's maximum width.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is true, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's maximum size and layout transform matrix.

Returns

| `Number` — The element's maximum width.

See also

getMaxBoundsHeight()
getLayoutMatrix()
getLayoutMatrix3D()

getMinBoundsHeight | () | method |

`public function getMinBoundsHeight(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's minimum height.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is `true`, the method returns the element's bounding box height. The bounding box is in the element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns

| `Number` — The element's maximum height.

See also

getMinBoundsWidth()
getLayoutMatrix()
getLayoutMatrix3D()

getMinBoundsWidth | () | method |

`public function getMinBoundsWidth(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's minimum width.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is `true`, the method returns the element's bounding box width. The bounding box is in the element's parent coordinate space and is calculated from the element's minimum size and layout transform matrix.

Returns

| `Number` — The element's maximum width.

See also

getMinBoundsHeight()
getLayoutMatrix()
getLayoutMatrix3D()

getPreferredBoundsHeight | () | method |

`public function getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's preferred height.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is `true`, the method returns the element's bounding box height. The bounding box is in the 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.

See also

getPreferredBoundsWidth()
getLayoutMatrix()
getLayoutMatrix3D()

getPreferredBoundsWidth | () | method |

`public function getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Returns the element's preferred width.

Parameters

| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is `true`, the method returns the element's bounding box width. The bounding box is in the 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.

See also

getPreferredBoundsHeight()
getLayoutMatrix()
getLayoutMatrix3D()

setLayoutBoundsPosition | () | method |

`public function setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

Runtime Versions : | Flash Player 10, AIR 1.5

Sets the coordinates that the element uses to draw on screen.

Note that calls to the `setLayoutBoundSize()` method can affect the layout position, so call `setLayoutBoundPosition()` after calling `setLayoutBoundSize()`.

Parameters

| `x:Number` — The x-coordinate of the top-left corner of the bounding box.
| `y:Number` — The y-coordinate of the top-left corner of the bounding box.
| `postLayoutTransform:Boolean` (default = `true`)`` — When `postLayoutTransform` is `true`, the element is positioned in such a way that the top-left corner of its bounding box is (x, y). The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position and layout transform matrix.

See also

setLayoutBoundsSize()
getLayoutMatrix()
getLayoutMatrix3D()

setLayoutBoundsSize | () | method |

`public function setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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`)`` — When `postLayoutTransform` is true, the specified sizes are those of the element's bounding box. The bounding box is in the element's parent coordinate space and is calculated from the element's layout size, layout position, and layout transform matrix.

See also

setLayoutBoundsPosition()
getLayoutMatrix()
getLayoutMatrix3D()

setLayoutMatrix | () | method |

`public function setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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 the `invalidateLayout()` method so that a subsequent layout pass is not triggered.

Parameters

| `value:Matrix` — The matrix.
| `invalidateLayout:Boolean` — `true` to cause the parent container to re-layout its children. You typically pass `true` to the `invalidateLayout()` method.

See also

getLayoutMatrix()
getLayoutMatrix3D()
setLayoutMatrix3D()

setLayoutMatrix3D | () | method |

`public function setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void`

Language Version : | ActionScript 3.0

Product Version : | Flex 4

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 the `invalidateLayout()` method so that a subsequent layout pass is not triggered.

Parameters

| `value:Matrix3D` — The matrix.
| `invalidateLayout:Boolean` — `true` to cause the parent container to re-layout its children. You typically pass `true` to the `invalidateLayout()` method.

See also

getLayoutMatrix()
setLayoutMatrix()
getLayoutMatrix3D()

transformAround | () | method |

`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

Product Version : | Flex 4

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`)`` — The new values for the scale of the transform.
| `rotation:Vector3D` (default = `null`)`` — the new values for the rotation of the transform
| `translation:Vector3D` (default = `null`)`` — The new values for the translation of the transform.
| `postLayoutScale:Vector3D` (default = `null`)`` — The new values for the post-layout scale of the transform.
| `postLayoutRotation:Vector3D` (default = `null`)`` — The new values for the post-layout rotation of the transform.
| `postLayoutTranslation:Vector3D` (default = `null`)`` — The new values for the post-layout translation of the transform.
| `invalidateLayout:Boolean` (default = `true`)`` — If `true`, the parent container size and display are invalidated. Layouts calling this method pass `false` so that a subsequent layout pass is not triggered.

Wed Nov 15 2017, 09:50 AM +01:00