com.adobe.mosaic.layouts.MosaicLayoutBase - ActionScript® 3.0 Reference for the Adobe® Flash® Platform

Package	com.adobe.mosaic.layouts
Class	public class MosaicLayoutBase
Inheritance	MosaicLayoutBase LayoutBase OnDemandEventDispatcher Object
Subclasses	FlowLayout, SmartColumnLayout, SmartGridLayout, SmartRowLayout

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 MosaicLayoutBase component is the base class for most composite application layouts, such as FlowLayout and SmartGridLayout.

Layouts using this base class must support padding, vertical and horizontal gaps, when placing their Group's children.

All layouts derived from MosaicLayoutBase automatically get maximize capability as well as some animation effects (eg, when an item is deleted).

The calculateLayoutPositions() function is the key layout function and should be overridden in every sub-class. This is the function that distinguishes one layout from another.

Public Properties

Hide Inherited Public Properties

Show Inherited 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
		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
		prototype : Object [static] A reference to the prototype object of a class or function object.	Object
		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

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		MosaicLayoutBase() Constructor	MosaicLayoutBase
		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

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		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 Calculates the bounds for the drop indicator that provides visual feedback to the user of where the items will be inserted at the end of a drag and drop gesture.	LayoutBase
		calculateLayoutPositions(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array This is the key function of the layout.	MosaicLayoutBase
		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

animationDuration

property

animationDuration:int

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 amount of time to give any annimation to run its course. The default value is 350ms.

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 animationDuration():int
public function set animationDuration(value:int):void

effectEndHandler

property

public var effectEndHandler:Function

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 function used to handle EffectEvent events.

effectList

property

protected var effectList:Parallel

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

A collection of effects to play in parallel.

elementBeingRemoved

property

protected var elementBeingRemoved:int = -1

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 index of the element being removed, referenced to generate the special effects to display the removal, and then reset to -1 (default).

horizontalGap

property

horizontalGap:int

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 spacing between the columns.

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 horizontalGap():int
public function set horizontalGap(value:int):void

layoutUndefined

property

protected var layoutUndefined:Boolean = true

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

Default is true.

maximized

property

protected var maximized:Boolean = false

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

Default is false.

maximizedElement

property

protected var maximizedElement:IVisualElement

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 IVisualElement being maximized.

measuredMaxHeight

property

protected var measuredMaxHeight:Number

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 measured maximum height of an element.

measuredMaxWidth

property

protected var measuredMaxWidth:Number

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

property

protected var restoreCellHeight:Number

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 height to restore a minimized element to.

restoreCellWidth

property

protected var restoreCellWidth:Number

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 width to restore a minimized element to.

target

property

target:GroupBase[override]

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

Called when the target group is set for this layout.

Implementation
override public function get target():GroupBase
override public function set target(value:GroupBase):void

verticalGap

property

verticalGap:int

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 spacing between the rows.

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 verticalGap():int
public function set verticalGap(value:int):void

Constructor Detail

MosaicLayoutBase

()

Constructor

public function MosaicLayoutBase()

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

calculateDropIndex

()

method

override protected function calculateDropIndex(x:Number, y:Number):int

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

Locates the item under the point using a simple look-up, accounting for horizontal and vertical gaps.

Parameters

	`x:Number` — Specifies the horizontal position of the point.

	`y:Number` — Specifies the vertical position of the point.

Returns

int — The index of the child under this point.

calculateDropLocation

()

method

override public function calculateDropLocation(dragEvent:DragEvent):DropLocation

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

Returns the location of the drop based on the event given. The location contains the (x,y) point of the drop location as well as the index of the item under the mouse.

Parameters

dragEvent:DragEvent — Specifies the event that contains the position of the mouse.

Returns

DropLocation — The location where the drop could happen.

calculateLayoutPositions

()

method

 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

This is the key function of the layout. It should determine where each child is located and what size the child should be. The updateInPlace parameter determines if the child should be moved (true) or just calculated (false). The returnArray parameter determines if an array of the calculated sizes and positions should be returned (true) or not (false).

Parameters

	`width:Number` — Specifies the maximum allowed width.

	`height:Number` — Specifies the maximum allowed height.

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

	`returnArray:Boolean` — when true, an array of sizes and positions are returned.

Returns

()

method

public function getLayoutChildAt(index:int):ILayoutChild

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

Returns the ILayoutChild that occupies the given display list index.

Parameters

index:int — Specifies the index of the child in the display list.

Returns

ILayoutChild — The child at the given index.

isMaximized

()

method

public function isMaximized():Boolean

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

When a value of true is return, this layout is currently showing a maximized child element.

Returns

Boolean — True if the layout is currently displaying a maximized child.

maximizedLayout

()

method

protected function maximizedLayout(width:Number, height:Number):void

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

Sizes and positions the maximized element.

Parameters

	`width:Number` — Specifies the width of the target group area.

	`height:Number` — Specifies the height of the target group area.

maximizeElement

()

method

public function maximizeElement(element:IVisualElement):void

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

Maximizes the given element to take up entire target space (minus padding, of course).

Parameters

element:IVisualElement — Specifies the visual element that is being maximized.

normalLayout

()

method

protected function normalLayout(width:Number, height:Number):void

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 to use when operating in a non-maximized mode.

Parameters

	`width:Number` — Specifies the width of the target group area.

	`height:Number` — Specifies the height of the target group area.

onEffectEnd

()

method

protected function onEffectEnd(event:EffectEvent):void

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

Called when the effects are over to reset the elementBeingMoved value.

Parameters

event:EffectEvent — The effect event.

restoreMaximizedElement

()

method

public function restoreMaximizedElement(element:IVisualElement):void

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

Restores an element that has been maximized.

Parameters

element:IVisualElement — Specifies the visual element that was previously maximized.

restoreVanishedElement

()

method

public function restoreVanishedElement(element:IVisualElement):void

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

Handles the layout side of restoring a previously minimized element by making it appear.

Parameters

element:IVisualElement — Specifies the visual element that is being made part of the layout again.

vanishElement

()

method

public function vanishElement(element:IVisualElement):void

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

Handles the layout side of a minimized element by making it disappear.

Parameters

element:IVisualElement — Specifies the visual element that is being removed from the layout.

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

Classes x

animationDuration

effectEndHandler

effectList

elementBeingRemoved

horizontalGap

layoutUndefined

maximized

maximizedElement

measuredMaxHeight

measuredMaxWidth

minimizedElements

paddingBottom

paddingLeft

paddingRight

paddingTop

restoreCellHeight

restoreCellWidth

target

verticalGap

MosaicLayoutBase

calculateDropIndex

calculateDropLocation

calculateLayoutPositions

displayRemovedElements

elementAdded

elementRemoved

getLayoutChildAt

isMaximized

maximizedLayout

maximizeElement

normalLayout

onEffectEnd

restoreMaximizedElement

restoreVanishedElement

vanishElement