Packagefeathers.controls
Classpublic class List
InheritanceList Inheritance Scroller Inheritance FeathersControl Inheritance Sprite Inheritance DisplayObjectContainer Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusDisplayObject

Displays a one-dimensional list of items. Supports scrolling, custom item renderers, and custom layouts.

Layouts may be, and are highly encouraged to be, virtual, meaning that the List is capable of creating a limited number of item renderers to display a subset of the data provider instead of creating a renderer for every single item. This allows for optimal performance with very large data providers.

Default MXML PropertydataProvider

See also

http://wiki.starling-framework.org/feathers/list
GroupedList


Public Properties
 PropertyDefined By
 Inheritedalpha : Number
The opacity of the object.
DisplayObject
 InheritedbackgroundDisabledSkin : DisplayObject
A background to display when the container is disabled.
Scroller
 InheritedbackgroundSkin : DisplayObject
The default background to display.
Scroller
 Inheritedbase : DisplayObject
[read-only] The topmost object in the display tree the object is part of.
DisplayObject
 InheritedblendMode : String
The blend mode determines how the object is blended with the objects underneath.
DisplayObject
 Inheritedbounds : Rectangle
[read-only] The bounds of the object relative to the local coordinates of the parent.
DisplayObject
 InheritedclipContent : Boolean
If true, the viewport will be clipped to the scroller's bounds.
Scroller
 InheritedclipRect : Rectangle
[override]
FeathersControl
  dataProvider : ListCollection
The collection of data displayed by the list.
List
 InheriteddefaultTextEditorFactory : Function
[static] A function used by all UI controls that support text editor to create an ITextEditor instance.
FeathersControl
 InheriteddefaultTextRendererFactory : Function
[static] A function used by all UI controls that support text renderers to create an ITextRenderer instance.
FeathersControl
 Inheritedelasticity : Number
If the scroll position goes outside the minimum or maximum bounds, the scrolling will be constrained using this multiplier.
Scroller
 InheritedelasticSnapDuration : Number
The duration, in seconds, of the animation when a the scroller snaps back to the minimum or maximum position after going out of bounds.
Scroller
 Inheritedfilter : FragmentFilter
The filter that is attached to the display object.
DisplayObject
 InheritedfocusManager : IFocusManager
The current focus manager for this component.
FeathersControl
 InheritedhasElasticEdges : Boolean
Determines if the scrolling can go beyond the edges of the viewport.
Scroller
 InheritedhasVisibleArea : Boolean
[read-only] Indicates if an object occupies any visible area.
DisplayObject
 Inheritedheight : Number
[override] The height of the component, in pixels.
FeathersControl
 InheritedhideScrollBarAnimationDuration : Number
The duration, in seconds, of the animation when a scroll bar fades out.
Scroller
 InheritedhideScrollBarAnimationEase : Object
The easing function used for hiding the scroll bars, if applicable.
Scroller
 InheritedhorizontalPageIndex : int
[read-only] The index of the horizontal page, if snapping is enabled.
Scroller
 InheritedhorizontalScrollBarFactory : Function
Creates the horizontal scroll bar.
Scroller
 InheritedhorizontalScrollBarProperties : Object
A set of key/value pairs to be passed down to the scroller's horizontal scroll bar instance (if it exists).
Scroller
 InheritedhorizontalScrollPolicy : String
Determines whether the scroller may scroll horizontally (on the x-axis) or not.
Scroller
 InheritedhorizontalScrollPosition : Number
The number of pixels the scroller has been scrolled horizontally (on the x-axis).
Scroller
 InheritedhorizontalScrollStep : Number
The number of pixels the scroller can be stepped horizontally.
Scroller
 InheritedincludeInLayout : Boolean
Determines if the ILayout should use this object or ignore it.
FeathersControl
 InheritedinteractionMode : String
Determines how the user may interact with the scroller.
Scroller
 InheritedisEnabled : Boolean
Indicates whether the control is interactive or not.
FeathersControl
 InheritedisFlattened : Boolean
[read-only] Indicates if the sprite was flattened.
Sprite
 InheritedisFocusEnabled : Boolean
Determines if this component can receive focus.
FeathersControl
 InheritedisInitialized : Boolean
[read-only] Determines if the component has been initialized yet.
FeathersControl
 InheritedisQuickHitAreaEnabled : Boolean
Similar to mouseChildren on the classic display list.
FeathersControl
  isSelectable : Boolean
Determines if an item in the list may be selected.
List
  itemRendererFactory : Function
A function called that is expected to return a new item renderer.
List
  itemRendererName : String
A name to add to all item renderers in this list.
List
  itemRendererProperties : Object
A set of key/value pairs to be passed down to all of the list's item renderers.
List
  itemRendererType : Class
The class used to instantiate item renderers.
List
  layout : ILayout
The layout algorithm used to position and, optionally, size the list's items.
List
 InheritedlayoutData : ILayoutData
Extra parameters associated with this display object that will be used by the layout algorithm.
FeathersControl
 InheritedmaxHeight : Number
The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmaxHorizontalScrollPosition : Number
[read-only] The maximum number of pixels the scroller may be scrolled horizontally (on the x-axis).
Scroller
 InheritedmaxVerticalScrollPosition : Number
[read-only] The maximum number of pixels the scroller may be scrolled vertically (on the y-axis).
Scroller
 InheritedmaxWidth : Number
The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminHeight : Number
The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedminTouchHeight : Number
If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded.
FeathersControl
 InheritedminTouchWidth : Number
If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded.
FeathersControl
 InheritedminWidth : Number
The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component.
FeathersControl
 InheritedmouseWheelScrollDuration : Number
The duration, in seconds, of the animation when the mouse wheel initiates a scroll action.
Scroller
 Inheritedname : String
[override] The concatenated nameList, with each name separated by spaces.
FeathersControl
 InheritednameList : TokenList
[read-only] Contains a list of all "names" assigned to this control.
FeathersControl
 InheritednextTabFocus : IFocusDisplayObject
The next object that will receive focus when the tab key is pressed.
FeathersControl
 InheritednumChildren : int
[read-only] The number of children of this container.
DisplayObjectContainer
 Inheritedpadding : Number
Quickly sets all padding properties to the same value.
Scroller
 InheritedpaddingBottom : Number
The minimum space, in pixels, between the container's bottom edge and the container's content.
Scroller
 InheritedpaddingLeft : Number
The minimum space, in pixels, between the container's left edge and the container's content.
Scroller
 InheritedpaddingRight : Number
The minimum space, in pixels, between the container's right edge and the container's content.
Scroller
 InheritedpaddingTop : Number
The minimum space, in pixels, between the container's top edge and the container's content.
Scroller
 InheritedpageThrowDuration : Number
The duration, in seconds, of the animation when the scroller is thrown to a page.
Scroller
 Inheritedparent : DisplayObjectContainer
[read-only] The display object container that contains this display object.
DisplayObject
 InheritedpivotX : Number
The x coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 InheritedpivotY : Number
The y coordinate of the object's origin in its own coordinate space (default: 0).
DisplayObject
 Inheritedroot : DisplayObject
[read-only] The root object the display object is connected to (i.e.
DisplayObject
 Inheritedrotation : Number
The rotation of the object in radians.
DisplayObject
 InheritedscaleX : Number
The horizontal scale factor.
DisplayObject
 InheritedscaleY : Number
The vertical scale factor.
DisplayObject
 InheritedscrollBarDisplayMode : String
Determines how the scroll bars are displayed.
Scroller
 InheritedscrollerProperties : Object
DEPRECATED: A set of key/value pairs to be passed down to the container's scroller sub-component.
Scroller
  selectedIndex : int
The index of the currently selected item.
List
  selectedItem : Object
The currently selected item.
List
 InheritedskewX : Number
The horizontal skew angle in radians.
DisplayObject
 InheritedskewY : Number
The vertical skew angle in radians.
DisplayObject
 InheritedsnapScrollPositionsToPixels : Boolean
If enabled, the scroll position will always be adjusted to whole pixels.
Scroller
 InheritedsnapToPages : Boolean
Determines if scrolling will snap to the nearest page.
Scroller
 Inheritedstage : Stage
[read-only] The stage the display object is connected to, or null if it is not connected to the stage.
DisplayObject
 InheritedthrowEase : Object
The easing function used for "throw" animations.
Scroller
 Inheritedtouchable : Boolean
Indicates if this object (and its children) will receive touch events.
DisplayObject
 InheritedtransformationMatrix : Matrix
The transformation matrix of the object relative to its parent.
DisplayObject
  typicalItem : Object
Used to auto-size the list.
List
 InheriteduseHandCursor : Boolean
Indicates if the mouse cursor should transform into a hand while it's over the sprite.
DisplayObject
 InheritedverticalPageIndex : int
[read-only] The index of the vertical page, if snapping is enabled.
Scroller
 InheritedverticalScrollBarFactory : Function
Creates the vertical scroll bar.
Scroller
 InheritedverticalScrollBarProperties : Object
A set of key/value pairs to be passed down to the scroller's vertical scroll bar instance (if it exists).
Scroller
 InheritedverticalScrollPolicy : String
Determines whether the scroller may scroll vertically (on the y-axis) or not.
Scroller
 InheritedverticalScrollPosition : Number
The number of pixels the scroller has been scrolled vertically (on the y-axis).
Scroller
 InheritedverticalScrollStep : Number
The number of pixels the scroller can be stepped vertically.
Scroller
 InheritedviewPort : IViewPort
The display object displayed and scrolled within the Scroller.
Scroller
 Inheritedvisible : Boolean
The visibility of the object.
DisplayObject
 Inheritedwidth : Number
[override] The width of the component, in pixels.
FeathersControl
 Inheritedx : Number
The x coordinate of the object relative to the local coordinates of the parent.
DisplayObject
 Inheritedy : Number
The y coordinate of the object relative to the local coordinates of the parent.
DisplayObject
Protected Properties
 PropertyDefined By
 InheritedactualHeight : Number = 0
The final height value that should be used for layout.
FeathersControl
 InheritedactualWidth : Number = 0
The final width value that should be used for layout.
FeathersControl
 InheritedexplicitHeight : Number = NaN
The height value explicitly set by calling the height setter or setSize().
FeathersControl
 InheritedexplicitWidth : Number = NaN
The width value explicitly set by calling the width setter or setSize().
FeathersControl
 InheritedhorizontalScrollBar : IScrollBar
The horizontal scrollbar instance.
Scroller
 InheritedhorizontalScrollBarName : String = feathers-scroller-horizontal-scroll-bar
The value added to the nameList of the horizontal scroll bar.
Scroller
 InheritedpendingHorizontalPageIndex : int = -1
The pending horizontal page index to scroll to after validating.
Scroller
 InheritedpendingHorizontalScrollPosition : Number = NaN
The pending horizontal scroll position to scroll to after validating.
Scroller
  pendingItemIndex : int = -1
The pending item index to scroll to after validating.
List
 InheritedpendingScrollDuration : Number
The duration of the pending scroll action.
Scroller
 InheritedpendingVerticalPageIndex : int = -1
The pending vertical page index to scroll to after validating.
Scroller
 InheritedpendingVerticalScrollPosition : Number = NaN
The pending vertical scroll position to scroll to after validating.
Scroller
 InheritedverticalScrollBar : IScrollBar
The vertical scrollbar instance.
Scroller
 InheritedverticalScrollBarName : String = feathers-scroller-vertical-scroll-bar
The value added to the nameList of the vertical scroll bar.
Scroller
Public Methods
 MethodDefined By
  
Constructor.
List
 Inherited
Adds a child to the container.
DisplayObjectContainer
 Inherited
Adds a child to the container at a certain index.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function):void
[override]
DisplayObject
 Inherited
alignPivot(hAlign:String = center, vAlign:String = center):void
Moves the pivot point to a certain position within the local coordinate system of the object.
DisplayObject
 Inherited
broadcastEvent(event:Event):void
Dispatches an event on all children (recursively).
DisplayObjectContainer
 Inherited
broadcastEventWith(type:String, data:Object = null):void
Dispatches an event with the given parameters on all children (recursively).
DisplayObjectContainer
 Inherited
contains(child:DisplayObject):Boolean
Determines if a certain object is a child of the container (recursively).
DisplayObjectContainer
 Inherited
dispatchEvent(event:Event):void
Dispatches an event to all objects that have registered listeners for its type.
EventDispatcher
 Inherited
dispatchEventWith(type:String, bubbles:Boolean = false, data:Object = null):void
Dispatches an event with the given parameters to all objects that have registered listeners for the given type.
EventDispatcher
 Inherited
dispose():void
[override] Disposes the resources of all children.
Sprite
 Inherited
flatten():void
Optimizes the sprite for optimal rendering performance.
Sprite
 Inherited
getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
[override] Returns a rectangle that completely encloses the object as it appears in another coordinate system.
Sprite
 Inherited
Returns a child object at a certain index.
DisplayObjectContainer
 Inherited
Returns a child object with a certain name (non-recursively).
DisplayObjectContainer
 Inherited
Returns the index of a child within the container, or "-1" if it is not found.
DisplayObjectContainer
 Inherited
getClipRect(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle
Returns the bounds of the container's clipRect in the given coordinate space, or null if the sprite doens't have a clipRect.
Sprite
 Inherited
getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix
Creates a matrix that represents the transformation from the local coordinate system to another.
DisplayObject
 Inherited
globalToLocal(globalPoint:Point, resultPoint:Point = null):Point
Transforms a point from global (stage) coordinates to the local coordinate system.
DisplayObject
 Inherited
hasEventListener(type:String):Boolean
Returns if there are listeners registered for a certain event type.
EventDispatcher
 Inherited
hitTest(localPoint:Point, forTouch:Boolean = false):DisplayObject
[override] Returns the object that is found topmost beneath a point in local coordinates, or nil if the test fails.
Sprite
 Inherited
invalidate(flag:String):void
Call this function to tell the UI control that a redraw is pending.
FeathersControl
 Inherited
isInvalid(flag:String = null):Boolean
Indicates whether the control is pending validation or not.
FeathersControl
 Inherited
localToGlobal(localPoint:Point, resultPoint:Point = null):Point
Transforms a point from the local coordinate system to global (stage) coordinates.
DisplayObject
 Inherited
removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject
Removes a child from the container.
DisplayObjectContainer
 Inherited
removeChildAt(index:int, dispose:Boolean = false):DisplayObject
Removes a child at a certain index.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void
Removes a range of children from the container (endIndex included).
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function):void
[override]
DisplayObject
 Inherited
removeEventListeners(type:String = null):void
[override]
DisplayObject
 Inherited
removeFromParent(dispose:Boolean = false):void
Removes the object from its parent, if it has one, and optionally disposes it.
DisplayObject
 Inherited
render(support:RenderSupport, parentAlpha:Number):void
[override] Renders the display object with the help of a support object.
Sprite
  
scrollToDisplayIndex(index:int, animationDuration:Number = 0):void
Scrolls the list so that the specified item is visible.
List
 Inherited
scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number = 0):void
After the next validation, scrolls to a specific page index.
Scroller
 Inherited
scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number = 0):void
After the next validation, scrolls to a specific position.
Scroller
 Inherited
setChildIndex(child:DisplayObject, index:int):void
Moves a child to a certain index.
DisplayObjectContainer
 Inherited
setSize(width:Number, height:Number):void
Sets both the width and the height of the control.
FeathersControl
 Inherited
sortChildren(compareFunction:Function):void
Sorts the children according to a given function (that works just like the sort function of the Vector class).
DisplayObjectContainer
 Inherited
If the user is scrolling with touch or if the scrolling is animated, calling stopScrolling() will cause the scroller to ignore the drag and stop animations.
Scroller
 Inherited
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the indexes of two children.
DisplayObjectContainer
 Inherited
unflatten():void
Removes the rendering optimizations that were created when flattening the sprite.
Sprite
 Inherited
validate():void
Immediately validates the control, which triggers a redraw, if one is pending.
FeathersControl
Protected Methods
 MethodDefined By
 Inherited
Automatically determines the ideal width and height of the control, if required.
Scroller
 Inherited
Creates the scroll bars from the provided factories.
Scroller
 Inherited
draw():void
Override to customize layout and to adjust properties of children.
FeathersControl
 Inherited
Scrolls to a pending scroll position, if required.
Scroller
 Inherited
initialize():void
Called the first time that the UI control is added to the stage, and you should override this function to customize the initialization process.
FeathersControl
 Inherited
Positions and sizes children based on the actual width and height values.
Scroller
 Inherited
Choose the appropriate background skin based on the control's current state.
Scroller
 Inherited
setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean
Sets the width and height of the control, with the option of invalidating or not.
FeathersControl
 Inherited
throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void
Immediately throws the scroller to the specified position, with optional animation.
Scroller
 Inherited
throwToPage(targetHorizontalPageIndex:int = -1, targetVerticalPageIndex:int = -1, duration:Number = 0.5):void
Immediately throws the scroller to the specified page index, with optional animation.
Scroller
Events
 Event Summary Defined By
 InheritedDispatched when an object is added to a parent.DisplayObject
 InheritedDispatched when an object is connected to the stage (directly or indirectly).DisplayObject
 InheritedDispatched when the user starts dragging the scroller.Scroller
  Dispatched when the selected item changes.List
 InheritedDispatched when the user stops dragging the scroller.Scroller
 InheritedDispatched once every frame on every object that is connected to the stage.DisplayObject
 InheritedDispatched on all children when the object is flattened.Sprite
 InheritedDispatched after initialize() has been called, but before the first time that draw() has been called.FeathersControl
 InheritedDispatched when a key on the keyboard is pressed.DisplayObject
 InheritedDispatched when a key on the keyboard is released.DisplayObject
 InheritedDispatched when an object is removed from its parent.DisplayObject
 InheritedDispatched when an object is removed from the stage and won't be rendered any longer.DisplayObject
  Dispatched when an item renderer is added to the list.List
  Dispatched when an item renderer is removed from the list.List
 InheritedDispatched when the width or height of the control changes.FeathersControl
 InheritedDispatched when the scroller scrolls in either direction.Scroller
 InheritedDispatched when the scroller finishes scrolling in either direction after being thrown.Scroller
 InheritedDispatched when an object is touched.DisplayObject
Public Constants
 ConstantDefined By
 InheritedDEFAULT_CHILD_NAME_HORIZONTAL_SCROLL_BAR : String = feathers-scroller-horizontal-scroll-bar
[static] The default value added to the nameList of the horizontal scroll bar.
Scroller
 InheritedDEFAULT_CHILD_NAME_VERTICAL_SCROLL_BAR : String = feathers-scroller-vertical-scroll-bar
[static] The default value added to the nameList of the vertical scroll bar.
Scroller
  INTERACTION_MODE_MOUSE : String = mouse
[static] The user may interact with the scroll bars to scroll.
List
  INTERACTION_MODE_TOUCH : String = touch
[static] The user may touch anywhere on the scroller and drag to scroll.
List
 InheritedINVALIDATION_FLAG_ALL : String = all
[static] Flag to indicate that everything is invalid and should be redrawn.
FeathersControl
 InheritedINVALIDATION_FLAG_DATA : String = data
[static] Invalidation flag to indicate that the primary data displayed by the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_LAYOUT : String = layout
[static] Invalidation flag to indicate that the layout of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SCROLL : String = scroll
[static] Invalidation flag to indicate that the scroll position of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SELECTED : String = selected
[static] Invalidation flag to indicate that the selection of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SIZE : String = size
[static] Invalidation flag to indicate that the dimensions of the UI control have changed.
FeathersControl
 InheritedINVALIDATION_FLAG_SKIN : String = skin
[static] Invalidation flag to indicate that the skin of the UI control has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STATE : String = state
[static] Invalidation flag to indicate that the state has changed.
FeathersControl
 InheritedINVALIDATION_FLAG_STYLES : String = styles
[static] Invalidation flag to indicate that the styles or visual appearance of the UI control has changed.
FeathersControl
  SCROLL_BAR_DISPLAY_MODE_FIXED : String = fixed
[static] The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.
List
  SCROLL_BAR_DISPLAY_MODE_FLOAT : String = float
[static] The scroll bars appear above the scroller's view port, and fade out when not in use.
List
  SCROLL_BAR_DISPLAY_MODE_NONE : String = none
[static] The scroll bars are never visible.
List
  SCROLL_POLICY_AUTO : String = auto
[static] The scroller may scroll if the view port is larger than the scroller's bounds.
List
  SCROLL_POLICY_OFF : String = off
[static] The scroller does not scroll at all.
List
  SCROLL_POLICY_ON : String = on
[static] The scroller will always scroll.
List
Protected Constants
 ConstantDefined By
 InheritedINVALIDATION_FLAG_CLIPPING : String = clipping
[static] Flag to indicate that the clipping has changed.
Scroller
Property Detail
dataProviderproperty
dataProvider:ListCollection

The collection of data displayed by the list.


Implementation
    public function get dataProvider():ListCollection
    public function set dataProvider(value:ListCollection):void
isSelectableproperty 
isSelectable:Boolean

Determines if an item in the list may be selected.

The default value is true.


Implementation
    public function get isSelectable():Boolean
    public function set isSelectable(value:Boolean):void
itemRendererFactoryproperty 
itemRendererFactory:Function

A function called that is expected to return a new item renderer. Has a higher priority than itemRendererType. Typically, you would use an itemRendererFactory instead of an itemRendererType if you wanted to initialize some properties on each separate item renderer, such as skins.

The function is expected to have the following signature:

function():IListItemRenderer


Implementation
    public function get itemRendererFactory():Function
    public function set itemRendererFactory(value:Function):void

See also

itemRendererNameproperty 
itemRendererName:String

A name to add to all item renderers in this list. Typically used by a theme to provide different skins to different lists.


Implementation
    public function get itemRendererName():String
    public function set itemRendererName(value:String):void

See also

itemRendererPropertiesproperty 
itemRendererProperties:Object

A set of key/value pairs to be passed down to all of the list's item renderers. These values are shared by each item renderer, so values that cannot be shared (such as display objects that need to be added to the display list) should be passed to the item renderers using an itemRendererFactory or with a theme.

If the subcomponent has its own subcomponents, their properties can be set too, using attribute @ notation. For example, to set the skin on the thumb of a SimpleScrollBar which is in a Scroller which is in a List, you can use the following syntax:

list.scrollerProperties.@verticalScrollBarProperties.@thumbProperties.defaultSkin = new Image(texture);


Implementation
    public function get itemRendererProperties():Object
    public function set itemRendererProperties(value:Object):void

See also

itemRendererTypeproperty 
itemRendererType:Class

The class used to instantiate item renderers.


Implementation
    public function get itemRendererType():Class
    public function set itemRendererType(value:Class):void

See also

feathers.controls.renderer.IListItemRenderer
itemRendererFactory
layoutproperty 
layout:ILayout

The layout algorithm used to position and, optionally, size the list's items.


Implementation
    public function get layout():ILayout
    public function set layout(value:ILayout):void
pendingItemIndexproperty 
protected var pendingItemIndex:int = -1

The pending item index to scroll to after validating. A value of -1 means that the scroller won't scroll to an item after validating.

selectedIndexproperty 
selectedIndex:int

The index of the currently selected item. Returns -1 if no item is selected.


Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void
selectedItemproperty 
selectedItem:Object

The currently selected item. Returns null if no item is selected.


Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void
typicalItemproperty 
typicalItem:Object

Used to auto-size the list. If the list's width or height is NaN, the list will try to automatically pick an ideal size. This item is used in that process to create a sample item renderer.


Implementation
    public function get typicalItem():Object
    public function set typicalItem(value:Object):void
Constructor Detail
List()Constructor
public function List()

Constructor.

Method Detail
scrollToDisplayIndex()method
public function scrollToDisplayIndex(index:int, animationDuration:Number = 0):void

Scrolls the list so that the specified item is visible. If animationDuration is greater than zero, the scroll will animate. The duration is in seconds.

Parameters

index:int — The integer index of an item from the data provider.
 
animationDuration:Number (default = 0) — The length of time, in seconds, of the animation. May be zero to scroll instantly.

Event Detail
change Event
Event Object Type: starling.events.Event
Event.type property = starling.events.Event.CHANGE

Dispatched when the selected item changes.

An event type to be utilized in custom events. Not used by Starling right now.
rendererAdd Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.RENDERER_ADD

Dispatched when an item renderer is added to the list. When the layout is virtualized, item renderers may not exist for every item in the data provider. This event can be used to track which items currently have renderers.

The FeathersEventType.RENDERER_ADD event type is used by Feathers components with item renderers to indicate when a new renderer has been added. This event type is meant to be used with virtualized layouts where only a limited set of renderers will be created for a data provider that may include a larger number of items.
rendererRemove Event  
Event Object Type: starling.events.Event
Event.type property = feathers.events.FeathersEventType.RENDERER_REMOVE

Dispatched when an item renderer is removed from the list. When the layout is virtualized, item renderers may not exist for every item in the data provider. This event can be used to track which items currently have renderers.

The FeathersEventType.RENDERER_REMOVE event type is used by Feathers controls with item renderers to indicate when a renderer is removed. This event type is meant to be used with virtualized layouts where only a limited set of renderers will be created for a data provider that may include a larger number items.
Constant Detail
INTERACTION_MODE_MOUSEConstant
public static const INTERACTION_MODE_MOUSE:String = mouse

The user may interact with the scroll bars to scroll.

INTERACTION_MODE_TOUCHConstant 
public static const INTERACTION_MODE_TOUCH:String = touch

The user may touch anywhere on the scroller and drag to scroll.

SCROLL_BAR_DISPLAY_MODE_FIXEDConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FIXED:String = fixed

The scroll bars are always visible and appear next to the scroller's view port, making the view port smaller than the scroller.

SCROLL_BAR_DISPLAY_MODE_FLOATConstant 
public static const SCROLL_BAR_DISPLAY_MODE_FLOAT:String = float

The scroll bars appear above the scroller's view port, and fade out when not in use.

SCROLL_BAR_DISPLAY_MODE_NONEConstant 
public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none

The scroll bars are never visible.

SCROLL_POLICY_AUTOConstant 
public static const SCROLL_POLICY_AUTO:String = auto

The scroller may scroll if the view port is larger than the scroller's bounds. If the interaction mode is touch, the elastic edges will only be active if the maximum scroll position is greater than zero. If the scroll bar display mode is fixed, the scroll bar will only be visible when the maximum scroll position is greater than zero.

SCROLL_POLICY_OFFConstant 
public static const SCROLL_POLICY_OFF:String = off

The scroller does not scroll at all. If the scroll bar display mode is fixed or float, the scroll bar will never be visible.

SCROLL_POLICY_ONConstant 
public static const SCROLL_POLICY_ON:String = on

The scroller will always scroll. If the interaction mode is touch, elastic edges will always be active, even when the maximum scroll position is zero. If the scroll bar display mode is fixed, the scroll bar will always be visible.