FlowLayout

Package	com.adobe.mosaic.layouts
Class	public class FlowLayout
Inheritance	FlowLayout MosaicLayoutBase LayoutBase OnDemandEventDispatcher Object

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

The Flow layout arranges the children of its target group one after the other until no more can fit across (or down). The next element that cannot fit is placed onto a new row (or column).

Public Properties

	Property		Defined By
		animationDuration : int The amount of time to give any annimation to run its course.	MosaicLayoutBase
		clipAndEnableScrolling : Boolean If true, specifies to clip the children to the boundaries of the viewport.	LayoutBase
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		dropIndicator : DisplayObject The DisplayObject that this layout uses for the drop indicator during a drag-and-drop operation.	LayoutBase
		effectEndHandler : Function The function used to handle EffectEvent events.	MosaicLayoutBase
		horizontalGap : int The spacing between the columns.	MosaicLayoutBase
		horizontalScrollPosition : Number The x coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.	LayoutBase
		orientation : String The layout can be filled either column-wise (default) or row-wise.	FlowLayout
		paddingBottom : int The space between the container edge and the bottom row of items.	MosaicLayoutBase
		paddingLeft : int The space between the container edge and the left column of items.	MosaicLayoutBase
		paddingRight : int The space between the container edge and the right column of items.	MosaicLayoutBase
		paddingTop : int The space between the container edge and the top row of items.	MosaicLayoutBase
		target : GroupBase [override] Called when the target group is set for this layout.	MosaicLayoutBase
		typicalLayoutElement : ILayoutElement Used by layouts when fixed row/column sizes are requested but a specific size isn't specified.	LayoutBase
		useVirtualLayout : Boolean A container can hold any number of children.	LayoutBase
		verticalGap : int The spacing between the rows.	MosaicLayoutBase
		verticalScrollPosition : Number The y coordinate of the origin of the viewport in the component's coordinate system, where the default value is (0,0) corresponding to the upper-left corner of the component.	LayoutBase

Protected Properties

	Property		Defined By
		effectList : Parallel A collection of effects to play in parallel.	MosaicLayoutBase
		elementBeingRemoved : int = -1 The index of the element being removed, referenced to generate the special effects to display the removal, and then reset to -1 (default).	MosaicLayoutBase
		layoutUndefined : Boolean = true Default is true.	MosaicLayoutBase
		maximized : Boolean = false Default is false.	MosaicLayoutBase
		maximizedElement : IVisualElement The IVisualElement being maximized.	MosaicLayoutBase
		measuredMaxHeight : Number The measured maximum height of an element.	MosaicLayoutBase
		measuredMaxWidth : Number The measured maximum width of an element.	MosaicLayoutBase
		minimizedElements : Array The Array of IVisualElement elements currently minimized.	MosaicLayoutBase
		restoreCellHeight : Number The height to restore a minimized element to.	MosaicLayoutBase
		restoreCellWidth : Number The width to restore a minimized element to.	MosaicLayoutBase

Public Methods

	Method		Defined By
		FlowLayout() Constructor	FlowLayout
		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.	OnDemandEventDispatcher
		calculateDropLocation(dragEvent:DragEvent):DropLocation [override] Returns the location of the drop based on the event given.	MosaicLayoutBase
		clearVirtualLayoutCache():void When useVirtualLayout is true, this method can be used by the layout target to clear cached layout information when the target changes.	LayoutBase
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	OnDemandEventDispatcher
		elementAdded(index:int):void [override] Called whenever an element is added to the target.	MosaicLayoutBase
		elementRemoved(index:int):void [override] Called whenever an element is removed.	MosaicLayoutBase
		getElementBounds(index:int):Rectangle Returns the specified element's layout bounds as a Rectangle or null if the index is invalid, the corresponding element is null, includeInLayout=false, or if this layout's target property is null.	LayoutBase
		getHorizontalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the horizontal scroll position to handle different scrolling options.	LayoutBase
		getLayoutChildAt(index:int):ILayoutChild Returns the ILayoutChild that occupies the given display list index.	MosaicLayoutBase
		getNavigationDestinationIndex(currentIndex:int, navigationUnit:uint, arrowKeysWrapFocus:Boolean):int Delegation method that determines which item to navigate to based on the current item in focus and user input in terms of NavigationUnit.	LayoutBase
		getScrollPositionDeltaToElement(index:int):Point Computes the verticalScrollPosition and horizontalScrollPosition deltas needed to scroll the element at the specified index into view.	LayoutBase
		getVerticalScrollPositionDelta(navigationUnit:uint):Number Returns the change to the vertical scroll position to handle different scrolling options.	LayoutBase
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	OnDemandEventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hideDropIndicator():void Hides the previously shown drop indicator, created by the showDropIndicator() method, removes it from the display list and also stops the drag scrolling.	LayoutBase
		isMaximized():Boolean When a value of true is return, this layout is currently showing a maximized child element.	MosaicLayoutBase
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		maximizeElement(element:IVisualElement):void Maximizes the given element to take up entire target space (minus padding, of course).	MosaicLayoutBase
		measure():void Measures the target's default size based on its content, and optionally measures the target's default minimum size.	LayoutBase
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	OnDemandEventDispatcher
		restoreMaximizedElement(element:IVisualElement):void Restores an element that has been maximized.	MosaicLayoutBase
		restoreVanishedElement(element:IVisualElement):void Handles the layout side of restoring a previously minimized element by making it appear.	MosaicLayoutBase
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		showDropIndicator(dropLocation:DropLocation):void Sizes, positions and parents the drop indicator based on the specified drop location.	LayoutBase
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		updateDisplayList(width:Number, height:Number):void Sizes and positions the target's elements.	LayoutBase
		updateScrollRect(w:Number, h:Number):void Called by the target at the end of its updateDisplayList to have the layout update its scrollRect.	LayoutBase
		valueOf():Object Returns the primitive value of the specified object.	Object
		vanishElement(element:IVisualElement):void Handles the layout side of a minimized element by making it disappear.	MosaicLayoutBase
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	OnDemandEventDispatcher

Protected Methods

	Method		Defined By
		calculateColumnLayout(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array Determines the size and position of the elements in a column-oriented flow.	FlowLayout
		calculateDragScrollDelta(dropLocation:DropLocation, elapsedTime:Number):Point Calculates how much to scroll for the specified dropLocation during a drag and drop gesture.	LayoutBase
		calculateDropIndex(x:Number, y:Number):int [override] Locates the item under the point using a simple look-up, accounting for horizontal and vertical gaps.	MosaicLayoutBase
		calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle [override] Creates the bounding rectangle for the drop indicator.	FlowLayout
		calculateLayoutPositions(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array [override] Determines where the elements are positioned in the flow, based on the setting of orientation.	FlowLayout
		calculateRowLayout(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array Determines the size and position of the elements in a row-oriented flow.	FlowLayout
		displayRemovedElements():void Generates a series of Move and Resize effects for item being placing them into their new positions.	MosaicLayoutBase
		getElementBoundsAboveScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is above the scrollRect's top edge.	LayoutBase
		getElementBoundsBelowScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is below the scrollRect's bottom edge.	LayoutBase
		getElementBoundsLeftOfScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is to the left of the scrollRect's left edge.	LayoutBase
		getElementBoundsRightOfScrollRect(scrollRect:Rectangle):Rectangle Returns the bounds of the first layout element that either spans or is to the right of the scrollRect's right edge.	LayoutBase
		getScrollRect():Rectangle Returns the bounds of the target's scroll rectangle in layout coordinates.	LayoutBase
		maximizedLayout(width:Number, height:Number):void Sizes and positions the maximized element.	MosaicLayoutBase
		normalLayout(width:Number, height:Number):void The layout to use when operating in a non-maximized mode.	MosaicLayoutBase
		onEffectEnd(event:EffectEvent):void Called when the effects are over to reset the elementBeingMoved value.	MosaicLayoutBase
		scrollPositionChanged():void Called when the verticalScrollPosition or horizontalScrollPosition properties change.	LayoutBase

Property Detail

orientation

property

orientation:String

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

The layout can be filled either column-wise (default) or row-wise. When the layout is being filled column-wise, the items flow from left to right, top to bottom. When the layout is filled row-wise, the items flow from top to bottom, left to right.

This property can be used as the source for data binding. When this property is modified, it dispatches the propertyChange event.

Implementation
public function get orientation():String
public function set orientation(value:String):void

Constructor Detail

FlowLayout

()

Constructor

public function FlowLayout()

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Constructor

Method Detail

calculateColumnLayout

()

method

protected function calculateColumnLayout(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Determines the size and position of the elements in a column-oriented flow.

Parameters

	`width:Number` — The maximum horizontal space allowed.

	`height:Number` — The vertical space.

	`updateInPlace:Boolean` — If true, the elements are positioned.

	`returnArray:Boolean` — If true, an array of positions are returned.

Returns

Array — Array of child positions or null.

calculateDropIndicatorBounds

()

method

override protected function calculateDropIndicatorBounds(dropLocation:DropLocation):Rectangle

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Creates the bounding rectangle for the drop indicator. This will either appear left of the item at the drop location or to its right, depending on the position of the mouse within the item.

Parameters

dropLocation:DropLocation — The position within the layout where the drop can be expected.

Returns

Rectangle — A rectangle the describes the area of the drop.

calculateLayoutPositions

()

method

override protected function calculateLayoutPositions(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Determines where the elements are positioned in the flow, based on the setting of orientation.

Parameters

	`width:Number` — The maximum allowed width.

	`height:Number` — The maximum allowed height.

	`updateInPlace:Boolean` — If true, the elements are sized and positioned.

	`returnArray:Boolean` — If true, an Array of sizes and positions are returned.

Returns

Array — Array of sizes and positions or null. Each item of the array should have: {child (the element), newX, newY, newWidth, newHeight}

calculateRowLayout

()

method

protected function calculateRowLayout(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array

Language Version:

ActionScript 3.0

Product Version:

Adobe Digital Enterprise Platform Experience Services - Composite Application Framework 10

Runtime Versions:

AIR 2.6, Flash Player 10.2

Determines the size and position of the elements in a row-oriented flow.

Parameters

	`width:Number` — The maximum horizontal space allowed.

	`height:Number` — The maximum vertical space.

	`updateInPlace:Boolean` — If true, the elements are positioned.

	`returnArray:Boolean` — If true, an array of positions are returned.

Returns

Array — Array of child positions or null.

Legal Notices | Online Privacy Policy

FlowLayout - AS3 ADEP Composite Application

Classes x

orientation

FlowLayout

calculateColumnLayout

calculateDropIndicatorBounds

calculateLayoutPositions

calculateRowLayout