Packagecom.gestureworks.cml.layouts
Classpublic class ListLayout
InheritanceListLayout Inheritance Layout Inheritance CMLObject Inheritance flash.events.EventDispatcher

The ListLayout positions the display objects in a list.
        
        //horizontal list layout 
        var h_list:Container = getImageContainer();
        h_list.x = 475;
        h_list.y = 25;
        addChild(h_list);
                    
        var horiztonalLayout:ListLayout = new ListLayout();
        horiztonalLayout.spacingX = 200;
        horiztonalLayout.tween = true;
        horiztonalLayout.tweenTime = 1500;
        h_list.applyLayout(horiztonalLayout);
        
        //vertical list layout
        var v_list:Container = getImageContainer();
        v_list.x = 750;
        v_list.y = 200;
        addChild(v_list);
                    
        var verticalLayout:ListLayout = new ListLayout();
        verticalLayout.type = "vertical";
        verticalLayout.useMargins = true;
        verticalLayout.marginY = 5;
        verticalLayout.tween = true;
        verticalLayout.tweenTime = 1500;
        v_list.applyLayout(verticalLayout);        

        
        function getImageContainer():Container
        {
            var container:Container = new Container();
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));            
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));            
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));            
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));            
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));            
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));                        
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));                        
            container.addChild(getImageElement("../../../../assets/images/plane.jpg"));                        
            return container;
        }
        
        
        function getImageElement(source:String):Image
        {
            var img:Image = new Image();
            img.open(source);
            img.width = 250;
            img.height = 150;
            img.resample = true;
            return img;
        }
        
     

See also

GridLayout
FanLayout
PileLayout
PointLayout
RandomLayout
com.gestureworks.cml.layouts.Layout
com.gestureworks.cml.elements.Container


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
Specifies the alpha value of the display objects in the layout
Layout
 InheritedcacheTransforms : Boolean
Flag indicating the childTransformations are to be cached and reapplied for convenience.
Layout
 InheritedcenterColumn : Boolean
Flag indicating the alignment of the objects' centers with the center of the column.
Layout
 InheritedcenterRow : Boolean
Flag indicating the alignment of the objects' centers with the center of the row.
Layout
 InheritedchildList : ChildList
Returns the object's childList.
CMLObject
 InheritedcmlIndex : int
Returns the index created by the CML parser.
CMLObject
 InheritedcontinuousTransform : Boolean
Flag indicating the application of a transform relative to the current transform.
Layout
 Inheritedeasing : *
Specifies the easing equation.
Layout
 Inheritedexclusions : Array
An array of objects to exclude from the layout application
Layout
 Inheritedid : String
Returns the object's id.
CMLObject
 InheritedmarginX : Number
Layout
 InheritedmarginY : Number
Spacing added to the height of an object
Layout
 InheritedonComplete : Function
Function to call on layout complete
Layout
 InheritedonCompleteParams : Array
Parameters for onComplete function
Layout
 InheritedonUpdate : Function
Function to call on layout update
Layout
 InheritedonUpdateParams : Array
Parameters for onUpdate function
Layout
 InheritedoriginX : Number
Starting x coordinate of layout relative to the container
Layout
 Inherited_originY : Number = 0
Layout
 InheritedoriginY : Number
Starting y coordinate of layout relative to the container
Layout
 Inheritedrotation : Number
Specifies the rotation value of the display objects in the layout
Layout
 Inheritedscale : Number
Specifies the scale value of the display objects in the layout
Layout
 InheritedspacingX : Number
Horizontal distance between the origins of two objects
Layout
 InheritedspacingY : Number
Vertical distance between the origins of two objects
Layout
 Inheritedstate : Array
CMLObject
 Inheritedtween : Boolean
Flag indicating the display objects will animate to their layout positions.
Layout
 InheritedtweenTime : Number
The time(ms) the display objects will take to move into positions
Layout
 Inheritedtype : String
Specifies a layout subtype
Layout
 InheriteduseMargins : Boolean
Flag indicating the use of margins or spacing
Layout
Protected Properties
 PropertyDefined By
 InheritedchildTransformations : Array
Layout
Public Methods
 MethodDefined By
  
Constructor
ListLayout
 Inherited
clone():*
Clone method.
CMLObject
  
dispose():void
[override] Disposal function
ListLayout
  
horizontal(container:DisplayObjectContainer):void
Distributes the the children of the container in a list about the x-axis.
ListLayout
 Inherited
init():void
Initialization method.
CMLObject
 Inherited
killTween(child:* = null):void
Kills the tweening of the provided child.
Layout
  
layout(container:DisplayObjectContainer):void
[override] Apply layout type to container object Object passed must implement IContainer
ListLayout
 Inherited
parseCML(cml:XMLList):XMLList
Internal CML parse method.
CMLObject
 Inherited
postparseCML(cml:XMLList):void
Abstract method allows the setting of a postparse CML routine.
CMLObject
 Inherited
updateProperties(state:* = 0):void
Updates properties from state.
CMLObject
  
vertical(container:DisplayObjectContainer):void
Distributes the the children of the container in a vertical list about the y-axis.
ListLayout
Protected Methods
 MethodDefined By
 Inherited
degreesToRadians(degrees:Number):Number
[static] Converts degrees to radians
Layout
 Inherited
getMatrixObj(mtx:Matrix):Object
[static] Converts transformation matrix to TweenMax syntax
Layout
 Inherited
getMaxHeight(c:DisplayObjectContainer):Number
[static] Returns the max height of the container's children
Layout
 Inherited
getMaxWidth(c:DisplayObjectContainer):Number
[static] Returns the max width of the container's children
Layout
 Inherited
pointRotateMatrix(angle:Number, aroundX:Number, aroundY:Number, m:Matrix = null):Matrix
[static] Returns a matrix rotated around a specific point at a specific angle
Layout
 Inherited
randomMinMax(min:Number, max:Number):Number
[static] Generates a reandom number between min and max
Layout
 Inherited
rotateAroundPoint(obj:*, angle:Number, aroundX:Number, aroundY:Number):void
[static] Rotates an object around a spcecific point at a specific angle of rotation
Layout
 Inherited
rotateTransform(m:Matrix, rot:Number):void
Apply a rotation to the provided transformation matrix
Layout
 Inherited
scaleTransform(m:Matrix, s:Number):void
Apply a scale to the provided transformation matrix
Layout
 Inherited
translateTransform(m:Matrix, x:Number, y:Number):void
Apply a translation to the provided transformation matrix
Layout
 Inherited
validObject(obj:*):Boolean
Determines if an object meets the criteria to be included in the layout
Layout
Constructor Detail
ListLayout()Constructor
public function ListLayout()

Constructor

Method Detail
dispose()method
override public function dispose():void

Disposal function

horizontal()method 
public function horizontal(container:DisplayObjectContainer):void

Distributes the the children of the container in a list about the x-axis. Margin is multiplied by 2 to represent the margin between two objects.

Parameters

container:DisplayObjectContainer

layout()method 
override public function layout(container:DisplayObjectContainer):void

Apply layout type to container object Object passed must implement IContainer

Parameters

container:DisplayObjectContainer

vertical()method 
public function vertical(container:DisplayObjectContainer):void

Distributes the the children of the container in a vertical list about the y-axis. Margin is multiplied by 2 to represent the margin between two objects.

Parameters

container:DisplayObjectContainer