com.gestureworks.cml.layouts.ListLayout

Package	com.gestureworks.cml.layouts
Class	public class ListLayout
Inheritance	ListLayout LayoutFactory ObjectFactory 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;
        }

Public Properties

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		alpha : Number Specifies the alpha value of the display objects in the layout	LayoutFactory
		cacheTransforms : Boolean Flag indicating the childTransformations are to be cached and reapplied for convenience.	LayoutFactory
		centerColumn : Boolean Flag indicating the alignment of the objects' centers with the center of the column.	LayoutFactory
		centerRow : Boolean Flag indicating the alignment of the objects' centers with the center of the row.	LayoutFactory
		cmlIndex : int sets the index of cml	ObjectFactory
		continuousTransform : Boolean Flag indicating the application of a transform relative to the current transform.	LayoutFactory
		easing : * Specifies the easing equation.	LayoutFactory
		exclusions : Array An array of objects to exclude from the layout application	LayoutFactory
		id : String sets the id	ObjectFactory
		marginX : Number	LayoutFactory
		marginY : Number Spacing added to the height of an object	LayoutFactory
		onComplete : Function Function to call on layout complete	LayoutFactory
		onUpdate : Function Function to call on layout update	LayoutFactory
		originX : Number Starting x coordinate of layout relative to the container	LayoutFactory
		_originY : Number = 0	LayoutFactory
		originY : Number Starting y coordinate of layout relative to the container	LayoutFactory
		propertyStates : Array Deprecated: Please Use state	ObjectFactory
		rotation : Number Specifies the rotation value of the display objects in the layout	LayoutFactory
		scale : Number Specifies the scale value of the display objects in the layout	LayoutFactory
		spacingX : Number Horizontal distance between the origins of two objects	LayoutFactory
		spacingY : Number Vertical distance between the origins of two objects	LayoutFactory
		state : Array property states array	ObjectFactory
		tween : Boolean Flag indicating the display objects will animate to their layout positions.	LayoutFactory
		tweenTime : Number The time(ms) the display objects will take to move into positions	LayoutFactory
		type : String Specifies a layout subtype	LayoutFactory
		useMargins : Boolean Flag indicating the use of margins or spacing	LayoutFactory

	Property	Defined By
		childTransformations : Array	LayoutFactory

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		ListLayout() Constructor	ListLayout
		clone():* Returns clone of self	ObjectFactory
		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
		killTween(child:* = null):void Kills the tweening of the provided child.	LayoutFactory
		layout(container:DisplayObjectContainer):void [override] Apply layout type to container object Object passed must implement IContainer	ListLayout
		parseCML(cml:XMLList):XMLList parses cml file	ObjectFactory
		postparseCML(cml:XMLList):void postparse method	ObjectFactory
		updateProperties(state:Number = 0):void update the properties	ObjectFactory
		vertical(container:DisplayObjectContainer):void Distributes the the children of the container in a vertical list about the y-axis.	ListLayout

Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		degreesToRadians(degrees:Number):Number [static] Converts degrees to radians	LayoutFactory
		getMatrixObj(mtx:Matrix):Object [static] Converts transformation matrix to TweenMax syntax	LayoutFactory
		getMaxHeight(c:DisplayObjectContainer):Number [static] Returns the max height of the container's children	LayoutFactory
		getMaxWidth(c:DisplayObjectContainer):Number [static] Returns the max width of the container's children	LayoutFactory
		pointRotateMatrix(angle:Number, aroundX:Number, aroundY:Number, m:Matrix = null):Matrix [static] Returns a matrix rotated around a specific point at a specific angle	LayoutFactory
		randomMinMax(min:Number, max:Number):Number [static] Generates a reandom number between min and max	LayoutFactory
		rotateAroundPoint(obj:*, angle:Number, aroundX:Number, aroundY:Number):void [static] Rotates an object around a spcecific point at a specific angle of rotation	LayoutFactory
		rotateTransform(m:Matrix, rot:Number):void Apply a rotation to the provided transformation matrix	LayoutFactory
		scaleTransform(m:Matrix, s:Number):void Apply a scale to the provided transformation matrix	LayoutFactory
		translateTransform(m:Matrix, x:Number, y:Number):void Apply a translation to the provided transformation matrix	LayoutFactory
		validObject(obj:*):Boolean Determines if an object meets the criteria to be included in the layout	LayoutFactory

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

Tue Apr 16 2013, 03:24 PM -06:00

Gestureworks Flash 3.6	All Packages \| All Classes \| Index \| Frames No Frames
ListLayout	Properties \| Methods