Package | feathers.layout |
Class | public class WaterfallLayout |
Inheritance | WaterfallLayout BaseVariableVirtualLayout starling.events.EventDispatcher |
Implements | IVariableVirtualLayout |
Product Version : | Feathers 2.2.0 |
See also
Property | Defined By | ||
---|---|---|---|
gap : Number
Quickly sets both horizontalGap and verticalGap
to the same value. | WaterfallLayout | ||
hasVariableItemDimensions : Boolean
When the layout is virtualized, and this value is true, the items
may have variable dimensions. | BaseVariableVirtualLayout | ||
horizontalAlign : String
The alignment of the items horizontally, on the x-axis. | WaterfallLayout | ||
horizontalGap : Number
The horizontal space, in pixels, between columns. | WaterfallLayout | ||
padding : Number
Quickly sets all padding properties to the same value. | WaterfallLayout | ||
paddingBottom : Number
The space, in pixels, that appears on the bottom, below the items. | WaterfallLayout | ||
paddingLeft : Number
The minimum space, in pixels, to the left of the items. | WaterfallLayout | ||
paddingRight : Number
The minimum space, in pixels, to the right of the items. | WaterfallLayout | ||
paddingTop : Number
The space, in pixels, that appears on top, above the items. | WaterfallLayout | ||
requestedColumnCount : int
Requests that the layout uses a specific number of columns, if
possible. | WaterfallLayout | ||
requiresLayoutOnScroll : Boolean [read-only]
Determines if the container calls layout() when the
scroll position changes. | BaseVariableVirtualLayout | ||
typicalItem : DisplayObject
Used internally by a component that supports layout virtualization,
such as List, to provide a display object with
dimensions that represent a "typical" item in the layout. | BaseVariableVirtualLayout | ||
useVirtualLayout : Boolean
Determines if virtual layout should be used. | BaseVariableVirtualLayout | ||
verticalGap : Number
The vertical space, in pixels, between items in a column. | WaterfallLayout |
Method | Defined By | ||
---|---|---|---|
Constructor. | WaterfallLayout | ||
addToVariableVirtualCacheAtIndex(index:int, item:DisplayObject = null):void
Inserts an item in to the cache at the specified index, pushing the
old cached value at that index, and all following values, up one
index. | BaseVariableVirtualLayout | ||
calculateNavigationDestination(items:Vector.<DisplayObject>, index:int, keyCode:uint, bounds:LayoutBoundsResult):int
Using the current index and a key press, calculates the new index. | WaterfallLayout | ||
getNearestScrollPositionForIndex(index:int, scrollX:Number, scrollY:Number, items:Vector.<DisplayObject>, x:Number, y:Number, width:Number, height:Number, result:Point = null):Point
Calculates the scroll position nearest to the current scroll position
that will display the full bounds of the item within the view port. | WaterfallLayout | ||
getScrollPositionForIndex(index:int, items:Vector.<DisplayObject>, x:Number, y:Number, width:Number, height:Number, result:Point = null):Point
Using the item dimensions, calculates a scroll position that will
ensure that the item at a given index will be visible within the
specified bounds. | WaterfallLayout | ||
getVisibleIndicesAtScrollPosition(scrollX:Number, scrollY:Number, width:Number, height:Number, itemCount:int, result:Vector.<int> = null):Vector.<int>
Used internally by a component, such as List, to
determines which indices are visible with the specified view port
bounds and scroll position. | WaterfallLayout | ||
layout(items:Vector.<DisplayObject>, viewPortBounds:ViewPortBounds = null, result:LayoutBoundsResult = null):LayoutBoundsResult
Positions (and possibly resizes) the supplied items within the
optional bounds argument. | WaterfallLayout | ||
measureViewPort(itemCount:int, viewPortBounds:ViewPortBounds = null, result:Point = null):Point
Used internally by a component, such as List, to measure
the view port based on the typical item dimensions or cached
dimensions, if available. | WaterfallLayout | ||
removeFromVariableVirtualCacheAtIndex(index:int):void
Removes an item in to the cache at the specified index, moving the
values at following indexes down by one. | BaseVariableVirtualLayout | ||
resetVariableVirtualCache():void
Clears the cached dimensions for all virtualized indices. | BaseVariableVirtualLayout | ||
resetVariableVirtualCacheAtIndex(index:int, item:DisplayObject = null):void
Clears the cached dimensions for one specific virtualized index. | BaseVariableVirtualLayout |
Event | Summary | Defined By | ||
---|---|---|---|---|
Dispatched when a property of the layout changes, indicating that a redraw is probably needed. | WaterfallLayout | |||
Dispatched when the layout would like to adjust the container's scroll position. | BaseVariableVirtualLayout |
gap | property |
gap:Number
Quickly sets both horizontalGap
and verticalGap
to the same value. The gap
getter always returns the
value of horizontalGap
, but the value of
verticalGap
may be different.
The default value is 0
.
public function get gap():Number
public function set gap(value:Number):void
See also
horizontalAlign | property |
horizontalAlign:String
The alignment of the items horizontally, on the x-axis.
Note: The HorizontalAlign.JUSTIFY
constant is not supported.
The default value is feathers.layout.HorizontalAlign.CENTER
.
public function get horizontalAlign():String
public function set horizontalAlign(value:String):void
See also
horizontalGap | property |
horizontalGap:Number
The horizontal space, in pixels, between columns.
The default value is 0
.
public function get horizontalGap():Number
public function set horizontalGap(value:Number):void
padding | property |
padding:Number
Quickly sets all padding properties to the same value. The
padding
getter always returns the value of
paddingTop
, but the other padding values may be
different.
The default value is 0
.
public function get padding():Number
public function set padding(value:Number):void
See also
paddingBottom | property |
paddingBottom:Number
The space, in pixels, that appears on the bottom, below the items.
The default value is 0
.
public function get paddingBottom():Number
public function set paddingBottom(value:Number):void
paddingLeft | property |
paddingLeft:Number
The minimum space, in pixels, to the left of the items.
The default value is 0
.
public function get paddingLeft():Number
public function set paddingLeft(value:Number):void
paddingRight | property |
paddingRight:Number
The minimum space, in pixels, to the right of the items.
The default value is 0
.
public function get paddingRight():Number
public function set paddingRight(value:Number):void
paddingTop | property |
paddingTop:Number
The space, in pixels, that appears on top, above the items.
The default value is 0
.
public function get paddingTop():Number
public function set paddingTop(value:Number):void
requestedColumnCount | property |
requestedColumnCount:int
Requests that the layout uses a specific number of columns, if
possible. Set to 0
to calculate the maximum of columns
that will fit in the available space.
If the view port's explicit or maximum width is not large enough
to fit the requested number of columns, it will use fewer. If the
view port doesn't have an explicit width and the maximum width is
equal to Number.POSITIVE_INFINITY
, the width will be
calculated automatically to fit the exact number of requested
columns.
The default value is 0
.
public function get requestedColumnCount():int
public function set requestedColumnCount(value:int):void
verticalGap | property |
verticalGap:Number
The vertical space, in pixels, between items in a column.
The default value is 0
.
public function get verticalGap():Number
public function set verticalGap(value:Number):void
WaterfallLayout | () | Constructor |
public function WaterfallLayout()
Constructor.
calculateNavigationDestination | () | method |
public function calculateNavigationDestination(items:Vector.<DisplayObject>, index:int, keyCode:uint, bounds:LayoutBoundsResult):int
Using the current index and a key press, calculates the new index.
This might be use to change a list's selectedIndex
when
a key is pressed.
Parameters
items:Vector.<DisplayObject> | |
index:int | |
keyCode:uint | |
bounds:LayoutBoundsResult |
int |
getNearestScrollPositionForIndex | () | method |
public function getNearestScrollPositionForIndex(index:int, scrollX:Number, scrollY:Number, items:Vector.<DisplayObject>, x:Number, y:Number, width:Number, height:Number, result:Point = null):Point
Calculates the scroll position nearest to the current scroll position that will display the full bounds of the item within the view port. If the item is already fully displayed in the view port, the current scroll position will be returned unchanged.
While the item will be displayed in the view port without being
clipped in any way, it may not be placed in the most prominent
position possible. To give the item a more prominent location, use
getScrollPositionForIndex()
instead.
This function should always be called after the
layout()
function. The width and height arguments are
the final bounds of the view port, which may be calculated in the
layout() function.
Parameters
index:int | |
scrollX:Number | |
scrollY:Number | |
items:Vector.<DisplayObject> | |
x:Number | |
y:Number | |
width:Number | |
height:Number | |
result:Point (default = null )
|
Point |
getScrollPositionForIndex | () | method |
public function getScrollPositionForIndex(index:int, items:Vector.<DisplayObject>, x:Number, y:Number, width:Number, height:Number, result:Point = null):Point
Using the item dimensions, calculates a scroll position that will ensure that the item at a given index will be visible within the specified bounds.
Typically, this function is used to show the item in the most
prominent way, such as centering. To scroll a minimum distance
required to display the full bounds of the item in the view port,
use getNearestScrollPositionForIndex()
instead.
This function should always be called after the
layout()
function. The width and height arguments are
the final bounds of the view port, which may be calculated in the
layout() function.
Parameters
index:int | |
items:Vector.<DisplayObject> | |
x:Number | |
y:Number | |
width:Number | |
height:Number | |
result:Point (default = null )
|
Point |
getVisibleIndicesAtScrollPosition | () | method |
public function getVisibleIndicesAtScrollPosition(scrollX:Number, scrollY:Number, width:Number, height:Number, itemCount:int, result:Vector.<int> = null):Vector.<int>
Used internally by a component, such as List
, to
determines which indices are visible with the specified view port
bounds and scroll position. Indices that aren't returned are
typically not displayed and can be replaced virtually. Uses the
typical items dimensions, or cached dimensions, if available.
This function is meant to be called by the List
or
other component that uses the virtual layout. If you're simply
creating a layout for a List
or another component, do
not call this function. It is meant for developers creating custom
components only.
Parameters
scrollX:Number | |
scrollY:Number | |
width:Number | |
height:Number | |
itemCount:int | |
result:Vector.<int> (default = null )
|
Vector.<int> |
layout | () | method |
public function layout(items:Vector.<DisplayObject>, viewPortBounds:ViewPortBounds = null, result:LayoutBoundsResult = null):LayoutBoundsResult
Positions (and possibly resizes) the supplied items within the optional bounds argument. If no bounds are specified, the layout algorithm will assume that the bounds start a 0,0 and have unbounded dimensions. Returns the actual bounds of the content, which may be different than the specified bounds.
Note: The items are not absolutely restricted to appear only within the bounds. The bounds can affect positioning, but the algorithm may very well ignore them completely.
If a layout implementation needs to access accurate width
and height
values from items that are of type
IFeathersControl
, it must call validate()
manually. For performance reasons, the container that is the parent
of the items will not call validate()
before passing the
items to a layout implementation. Meeting this requirement may be as
simple as looping through the items at the beginning of
layout()
and validating all items that are Feathers UI
controls:
const itemCount:int = items.length; for(var i:int = 0; i < itemCount; i++) { var item:IFeathersControl = items[i] as IFeathersControl; if(item) { item.validate(); } }
Parameters
items:Vector.<DisplayObject> | |
viewPortBounds:ViewPortBounds (default = null )
| |
result:LayoutBoundsResult (default = null )
|
LayoutBoundsResult |
measureViewPort | () | method |
public function measureViewPort(itemCount:int, viewPortBounds:ViewPortBounds = null, result:Point = null):Point
Used internally by a component, such as List
, to measure
the view port based on the typical item dimensions or cached
dimensions, if available.
This function is meant to be called by the List
or
other component that uses the virtual layout. If you're simply
creating a layout for a List
or another component, do
not call this function. It is meant for developers creating custom
components only.
Parameters
itemCount:int | |
viewPortBounds:ViewPortBounds (default = null )
| |
result:Point (default = null )
|
Point |
change | Event |
starling.events.Event
starling.events.Event.CHANGE
Dispatched when a property of the layout changes, indicating that a redraw is probably needed.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget . |
data | null |
target | The Object that dispatched the event;
it is not always the Object listening for the event. Use the
currentTarget property to always access the Object
listening for the event. |