ILayout

public interface
feathers.layout.ILayout

Description

Interface providing layout capabilities for containers.

API overview

Constructor

ILayout ()

Functions

Public functions

getScrollPositionForIndex ( index: Number , items: Vector.<DisplayObject> , x: Number , y: Number , width: Number , height: Number ): 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

layout ( items: Vector.<DisplayObject> , viewPortBounds: ViewPortBounds = null , result: LayoutBoundsResult = null ): LayoutBoundsResult

Positions (and possibly resizes) the supplied items within the optional bounds argument

Constructor

ILayout ()

Functions

addEventListener ( type: String , listener: Function ): Void
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#addEventListener()

Parameters

type: String
listener: Function


dispatchEvent ( event: Event ): Void
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#dispatchEvent()

Parameters

event: Event


dispatchEventWith ( type: String , bubbles: Boolean = false , data: Object = null ): Void
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#dispatchEventWith()

Parameters

type: String
bubbles: Boolean = false
data: Object = null


getScrollPositionForIndex ( index: Number , items: Vector.<DisplayObject> , x: Number , y: Number , width: Number , height: Number ): 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.

Parameters

index: Number
items: Vector.<DisplayObject>
x: Number
y: Number
width: Number
height: Number


hasEventListener ( type: String ): Boolean
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#hasEventListener()

Parameters

type: String


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 &lt; itemCount; i++) {
    var item:IFeathersControl = items[i] as IFeathersControl;
    if(item) {
        item.validate();
    }
}

See also:
feathers.core.IFeathersControl#validate()

Parameters

items: Vector.<DisplayObject>
viewPortBounds: ViewPortBounds = null
result: LayoutBoundsResult = null


removeEventListener ( type: String , listener: Function ): Void
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#removeEventListener()

Parameters

type: String
listener: Function


removeEventListeners ( type: String = null ): Void
Inherited from IFeathersEventDispatcher

See also:
loom2d.events.EventDispatcher#removeEventListeners()

Parameters

type: String = null


: