| 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 |
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 | |
| 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 | |
| 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
Public Methods
| Method | Defined By | ||
|---|---|---|---|
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 | |
| [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 | ||
|---|---|---|---|
calculateColumnLayout(width:Number, height:Number, updateInPlace:Boolean, returnArray:Boolean):Array
Determines the size and position of the elements in a column-oriented flow. | FlowLayout | ||
|
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 | |
[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 | ||
Determines the size and position of the elements in a row-oriented flow. | FlowLayout | ||
|
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
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):voidConstructor 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.
|
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.
|
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.
|
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.
|
Array — Array of child positions or null.
|
Mon Nov 28 2011, 06:48 AM -08:00