| Package | graphics.layouts |
| Class | public class GridLayout |
| Inheritance | GridLayout BoxLayout CoreLayout Object |
| Property | Defined By | ||
|---|---|---|---|
![]() | align : uint
The alignement of the layout. | CoreLayout | |
![]() | bounds : Rectangle
A rectangle that defines the area of the layout. | CoreLayout | |
![]() | childCount : int
Determinates the number of childs visible in this layout to calculates size with the measure method. | BoxLayout | |
| columns : uint
Determinates the number of columns in the grid layout if the direction of this container is Direction.HORIZONTAL. | GridLayout | ||
![]() | container : DisplayObjectContainer
Indicates the container reference to change with the layout. | CoreLayout | |
![]() | direction : String
Indicates the direction value of this layout ("horizontal" or "vertical"). | BoxLayout | |
![]() | horizontalGap : Number
Number of pixels between children in the horizontal direction. | BoxLayout | |
| lines : uint
Determinates the number of lines in the matrix layout if the direction of this container is Direction.VERTICAL. | GridLayout | ||
![]() | measuredHeight : Number
The default height of the component, in pixels. | CoreLayout | |
![]() | measuredWidth : Number
The default width of the component, in pixels. | CoreLayout | |
![]() | order : String
Indicates the direction order of to layout all children in the container. | BoxLayout | |
| orientation : uint
The orientation of the layout. | GridLayout | ||
![]() | padding : EdgeMetrics
Specifies the thickness, in pixels, of the four edge regions around the box layout. | BoxLayout | |
![]() | propHeight : String = height
The height property name use in the container to layout all items. | BoxLayout | |
![]() | propWidth : String = width
The width property name use in the container to layout all items. | BoxLayout | |
![]() | propX : String = x
The x property name use in the container to layout all items. | BoxLayout | |
![]() | propY : String = y
The y property name use in the container to layout all items. | BoxLayout | |
![]() | renderer : Signaler
This signal emit before the rendering is started. | CoreLayout | |
![]() | udpater : Signaler
This signal emit when the rendering is finished. | CoreLayout | |
![]() | verticalGap : Number
Number of pixels between children in the vertical direction. | BoxLayout | |
| Method | Defined By | ||
|---|---|---|---|
GridLayout(container:DisplayObjectContainer = null, init:Object = null, auto:Boolean = false)
Creates a new GridLayout instance. | GridLayout | ||
![]() | getChildPositionAt(n:Number):Point
Returns the child position with the specified index and the current direction of this layout. | BoxLayout | |
![]() | getCoordinateProperty():String
Returns the string representation of the coordinate attribute used in this display with the current direction value. | BoxLayout | |
![]() | getSizeProperty():String
Returns the string representation of the size attribute with the current direction. | BoxLayout | |
![]() | isLocked():Boolean
Returns true if the object is locked. | CoreLayout | |
![]() | isVertical():Boolean
Indicates if the layout is vertical. | BoxLayout | |
![]() | lock():void
Locks the object. | CoreLayout | |
measure():void [override]
Calculates the default sizes and minimum and maximum values. | GridLayout | ||
render():void [override]
Render the layout, refresh and change the position of all childs in a specific container. | GridLayout | ||
![]() | resetLock():void
Reset the lock security of the display. | CoreLayout | |
![]() | run(... arguments):void
Run the layout (render and update). | CoreLayout | |
![]() | unlock():void
Unlocks the display. | CoreLayout | |
update():void [override]
This method is invoked when the rendering is finished to finalize the it after the measure invokation. | GridLayout | ||
| Method | Defined By | ||
|---|---|---|---|
isBottomToTop():Boolean
Indicates if the layout orientation is bottom-to-top. | GridLayout | ||
isRightToLeft():Boolean
Indicates if the layout orientation is right-to-left. | GridLayout | ||
| columns | property |
columns:uintDeterminates the number of columns in the grid layout if the direction of this container is Direction.HORIZONTAL.
public function get columns():uint public function set columns(value:uint):voidSee also
| lines | property |
lines:uintDeterminates the number of lines in the matrix layout if the direction of this container is Direction.VERTICAL.
public function get lines():uint public function set lines(value:uint):voidSee also
| orientation | property |
orientation:uintThe orientation of the layout.
public function get orientation():uint public function set orientation(value:uint):voidSee also
| GridLayout | () | Constructor |
public function GridLayout(container:DisplayObjectContainer = null, init:Object = null, auto:Boolean = false)Creates a new GridLayout instance.
Parameterscontainer:DisplayObjectContainer (default = null) — The container to layout.
| |
init:Object (default = null) — An object that contains properties with which to populate the newly layout object. If init is not an object, it is ignored.
| |
auto:Boolean (default = false) — This boolean indicates if the layout is auto running or not (default false).
|
| isBottomToTop | () | method |
protected function isBottomToTop():BooleanIndicates if the layout orientation is bottom-to-top.
ReturnsBoolean |
| isRightToLeft | () | method |
protected function isRightToLeft():BooleanIndicates if the layout orientation is right-to-left.
ReturnsBoolean |
| measure | () | method |
override public function measure():voidCalculates the default sizes and minimum and maximum values. If the Box layout's direction property is set to Direction.HORIZONTAL, its measuredWidth property is equal to the sum of default widths of all of the children in the container, plus the thickness of the borders (padding), plus the left and right padding, plus the horizontal gap between each child. The value of the measuredHeight property is the maximum of all the children's default heights, plus room for the borders and padding. If the Box layout's direction property is set to Direction.VERTICAL, these two values are reversed.
| render | () | method |
override public function render():voidRender the layout, refresh and change the position of all childs in a specific container.
| update | () | method |
override public function update():voidThis method is invoked when the rendering is finished to finalize the it after the measure invokation.