ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Hide Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
mx.core 

ILayoutElement  - AS3 Flex

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagemx.core
Interfacepublic interface ILayoutElement extends IEventDispatcher
Implementors GraphicElement, UIMovieClip

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
 PropertyDefined 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
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
  
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
  
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
ILayoutElement
  
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
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
  
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
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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.

Related API Elements

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:Booleantrue to cause the parent container to re-layout its children. You typically pass true to the invalidateLayout() method.

Related API Elements

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:Booleantrue to cause the parent container to re-layout its children. You typically pass true to the invalidateLayout() method.

Related API Elements

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.