| 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 |
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
| 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 | ||
| 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 | ||
|---|---|---|---|
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 | |
[override]
Returns the location of the drop based on the event given. | MosaicLayoutBase | ||
|
When useVirtualLayout is true,
this method can be used by the layout target
to clear cached layout information when the target changes. | LayoutBase | |
|
Dispatches an event into the event flow. | OnDemandEventDispatcher | |
[override]
Called whenever an element is added to the target. | MosaicLayoutBase | ||
[override]
Called whenever an element is removed. | MosaicLayoutBase | ||
|
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 | |
|
Returns the change to the horizontal scroll position to handle
different scrolling options. | LayoutBase | |
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 | |
|
Computes the verticalScrollPosition and
horizontalScrollPosition deltas needed to
scroll the element at the specified index into view. | LayoutBase | |
|
Returns the change to the vertical scroll position to handle
different scrolling options. | LayoutBase | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | OnDemandEventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Hides the previously shown drop indicator,
created by the showDropIndicator() method,
removes it from the display list and also stops the drag scrolling. | LayoutBase | |
When a value of true is return, this layout is currently showing a maximized child element. | MosaicLayoutBase | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Maximizes the given element to take up entire target space (minus
padding, of course). | MosaicLayoutBase | ||
|
Measures the target's default size based on its content, and optionally
measures the target's default minimum size. | LayoutBase | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Removes a listener from the EventDispatcher object. | OnDemandEventDispatcher | |
Restores an element that has been maximized. | MosaicLayoutBase | ||
Handles the layout side of restoring a previously minimized element by
making it appear. | MosaicLayoutBase | ||
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sizes, positions and parents the drop indicator based on the specified
drop location. | LayoutBase | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
|
Returns the string representation of the specified object. | Object | |
|
Sizes and positions the target's elements. | LayoutBase | |
|
Called by the target at the end of its updateDisplayList
to have the layout update its scrollRect. | LayoutBase | |
|
Returns the primitive value of the specified object. | Object | |
Handles the layout side of a minimized element by making it disappear. | MosaicLayoutBase | ||
|
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 | ||
|---|---|---|---|
|
Calculates how much to scroll for the specified dropLocation
during a drag and drop gesture. | LayoutBase | |
[override]
Locates the item under the point using a simple look-up, accounting for horizontal
and vertical gaps. | MosaicLayoutBase | ||
|
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 | ||
Generates a series of Move and Resize effects for item being placing them into their new
positions. | MosaicLayoutBase | ||
|
Returns the bounds of the first layout element that either spans or
is above the scrollRect's top edge. | LayoutBase | |
|
Returns the bounds of the first layout element that either spans or
is below the scrollRect's bottom edge. | LayoutBase | |
|
Returns the bounds of the first layout element that either spans or
is to the left of the scrollRect's left edge. | LayoutBase | |
|
Returns the bounds of the first layout element that either spans or
is to the right of the scrollRect's right edge. | LayoutBase | |
|
Returns the bounds of the target's scroll rectangle in layout coordinates. | LayoutBase | |
Sizes and positions the maximized element. | MosaicLayoutBase | ||
The layout to use when operating in a non-maximized mode. | MosaicLayoutBase | ||
Called when the effects are over to reset the elementBeingMoved
value. | MosaicLayoutBase | ||
|
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):voideffectEndHandler | 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):voidlayoutUndefined | 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 |
The measured maximum width of an element.
minimizedElements | property |
protected var minimizedElements: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 |
The Array of IVisualElement elements currently minimized.
paddingBottom | property |
paddingBottom: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 space between the container edge and the bottom row of items.
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 paddingBottom():int public function set paddingBottom(value:int):voidpaddingLeft | property |
paddingLeft: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 space between the container edge and the left column of items.
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 paddingLeft():int public function set paddingLeft(value:int):voidpaddingRight | property |
paddingRight: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 space between the container edge and the right column of items.
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 paddingRight():int public function set paddingRight(value:int):voidpaddingTop | property |
paddingTop: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 space between the container edge and the top row of items.
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 paddingTop():int public function set paddingTop(value:int):voidrestoreCellHeight | 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):voidverticalGap | 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):voidConstructor 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.
|
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.
|
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.
|
Array — Array of sizes and positions or null. Each item of the array should have:
{child (the element), newX, newY, newWidth, newHeight}
|
displayRemovedElements | () | method |
protected function displayRemovedElements():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 |
Generates a series of Move and Resize effects for item being placing them into their new positions.
elementAdded | () | method |
override public function elementAdded(index:int):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 whenever an element is added to the target.
Parameters
index:int — Specifies the index of the child in the target display list.
|
elementRemoved | () | method |
override public function elementRemoved(index:int):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 whenever an element is removed.
Parameters
index:int — Specifies the index of the child in the target display list.
|
getLayoutChildAt | () | 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.
|
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.
ReturnsBoolean — 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.
|
Thu Dec 4 2014, 05:50 PM -08:00