GODPAPER | All Packages | All Classes | Index | Frames No Frames |
GroupedList

Package | feathers.controls
Class | public class GroupedList
Inheritance | GroupedList Scroller FeathersControl Sprite DisplayObjectContainer DisplayObject EventDispatcher Object
Implements | IFocusDisplayObject

Displays a list of items divided into groups or sections. Takes a hierarchical provider limited to two levels of hierarchy. This component supports scrolling, custom item (and header and footer) 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 Property `dataProvider`

See also

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

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | alpha : Number The opacity of the object. | DisplayObject
|  | backgroundDisabledSkin : DisplayObject A background to display when the container is disabled. | Scroller
|  | backgroundSkin : DisplayObject The default background to display. | Scroller
|  | base : DisplayObject [read-only] The topmost object in the display tree the object is part of. | DisplayObject
|  | blendMode : String The blend mode determines how the object is blended with the objects underneath. | DisplayObject
|  | bounds : Rectangle [read-only] The bounds of the object relative to the local coordinates of the parent. | DisplayObject
|  | clipContent : Boolean If true, the viewport will be clipped to the scroller's bounds. | Scroller
|  | clipRect : Rectangle [override] | FeathersControl
|  | dataProvider : HierarchicalCollection The collection of data displayed by the list. | GroupedList
|  | defaultTextEditorFactory : Function [static] A function used by all UI controls that support text editor to create an ITextEditor instance. | FeathersControl
|  | defaultTextRendererFactory : Function [static] A function used by all UI controls that support text renderers to create an ITextRenderer instance. | FeathersControl
|  | elasticity : Number If the scroll position goes outside the minimum or maximum bounds, the scrolling will be constrained using this multiplier. | Scroller
|  | elasticSnapDuration : 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
|  | filter : FragmentFilter The filter that is attached to the display object. | DisplayObject
|  | firstItemRendererFactory : Function A function called that is expected to return a new item renderer for the first item in a group. | GroupedList
|  | firstItemRendererName : String A name to add to all item renderers in this list that are the first item in a group. | GroupedList
|  | firstItemRendererType : Class The class used to instantiate the item renderer for the first item in a group. | GroupedList
|  | focusManager : IFocusManager The current focus manager for this component. | FeathersControl
|  | footerField : String The field in a group that contains the data for a footer. | GroupedList
|  | footerFunction : Function A function used to generate footer data for a specific group. | GroupedList
|  | footerRendererFactory : Function A function called that is expected to return a new footer renderer. | GroupedList
|  | footerRendererName : String A name to add to all footer renderers in this grouped list. | GroupedList
|  | footerRendererProperties : Object A set of key/value pairs to be passed down to all of the grouped list's footer renderers. | GroupedList
|  | footerRendererType : Class The class used to instantiate footer renderers. | GroupedList
|  | hasElasticEdges : Boolean Determines if the scrolling can go beyond the edges of the viewport. | Scroller
|  | hasVisibleArea : Boolean [read-only] Indicates if an object occupies any visible area. | DisplayObject
|  | headerField : String The field in a group that contains the data for a header. | GroupedList
|  | headerFunction : Function A function used to generate header data for a specific group. | GroupedList
|  | headerRendererFactory : Function A function called that is expected to return a new header renderer. | GroupedList
|  | headerRendererName : String A name to add to all header renderers in this grouped list. | GroupedList
|  | headerRendererProperties : Object A set of key/value pairs to be passed down to all of the grouped list's header renderers. | GroupedList
|  | headerRendererType : Class The class used to instantiate header renderers. | GroupedList
|  | height : Number [override] The height of the component, in pixels. | FeathersControl
|  | hideScrollBarAnimationDuration : Number The duration, in seconds, of the animation when a scroll bar fades out. | Scroller
|  | hideScrollBarAnimationEase : Object The easing function used for hiding the scroll bars, if applicable. | Scroller
|  | horizontalPageIndex : int [read-only] The index of the horizontal page, if snapping is enabled. | Scroller
|  | horizontalScrollBarFactory : Function Creates the horizontal scroll bar. | Scroller
|  | horizontalScrollBarProperties : Object A set of key/value pairs to be passed down to the scroller's horizontal scroll bar instance (if it exists). | Scroller
|  | horizontalScrollPolicy : String Determines whether the scroller may scroll horizontally (on the x-axis) or not. | Scroller
|  | horizontalScrollPosition : Number The number of pixels the scroller has been scrolled horizontally (on the x-axis). | Scroller
|  | horizontalScrollStep : Number The number of pixels the scroller can be stepped horizontally. | Scroller
|  | includeInLayout : Boolean Determines if the ILayout should use this object or ignore it. | FeathersControl
|  | interactionMode : String Determines how the user may interact with the scroller. | Scroller
|  | isEnabled : Boolean Indicates whether the control is interactive or not. | FeathersControl
|  | isFlattened : Boolean [read-only] Indicates if the sprite was flattened. | Sprite
|  | isFocusEnabled : Boolean Determines if this component can receive focus. | FeathersControl
|  | isInitialized : Boolean [read-only] Determines if the component has been initialized yet. | FeathersControl
|  | isQuickHitAreaEnabled : Boolean Similar to mouseChildren on the classic display list. | FeathersControl
|  | isSelectable : Boolean Determines if an item in the list may be selected. | GroupedList
|  | itemRendererFactory : Function A function called that is expected to return a new item renderer. | GroupedList
|  | itemRendererName : String A name to add to all item renderers in this list. | GroupedList
|  | itemRendererProperties : Object A set of key/value pairs to be passed down to all of the list's item renderers. | GroupedList
|  | itemRendererType : Class The class used to instantiate item renderers. | GroupedList
|  | lastItemRendererFactory : Function A function called that is expected to return a new item renderer for the last item in a group. | GroupedList
|  | lastItemRendererName : String A name to add to all item renderers in this list that are the last item in a group. | GroupedList
|  | lastItemRendererType : Class The class used to instantiate the item renderer for the last item in a group. | GroupedList
|  | layout : ILayout The layout algorithm used to position and, optionally, size the list's items. | GroupedList
|  | layoutData : ILayoutData Extra parameters associated with this display object that will be used by the layout algorithm. | FeathersControl
|  | maxHeight : Number The maximum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | maxHorizontalScrollPosition : Number [read-only] The maximum number of pixels the scroller may be scrolled horizontally (on the x-axis). | Scroller
|  | maxVerticalScrollPosition : Number [read-only] The maximum number of pixels the scroller may be scrolled vertically (on the y-axis). | Scroller
|  | maxWidth : Number The maximum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | minHeight : Number The minimum recommended height to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | minTouchHeight : Number If using isQuickHitAreaEnabled, and the hit area's height is smaller than this value, it will be expanded. | FeathersControl
|  | minTouchWidth : Number If using isQuickHitAreaEnabled, and the hit area's width is smaller than this value, it will be expanded. | FeathersControl
|  | minWidth : Number The minimum recommended width to be used for self-measurement and, optionally, by any code that is resizing this component. | FeathersControl
|  | mouseWheelScrollDuration : Number The duration, in seconds, of the animation when the mouse wheel initiates a scroll action. | Scroller
|  | name : String [override] The concatenated nameList, with each name separated by spaces. | FeathersControl
|  | nameList : TokenList [read-only] Contains a list of all "names" assigned to this control. | FeathersControl
|  | nextTabFocus : IFocusDisplayObject The next object that will receive focus when the tab key is pressed. | FeathersControl
|  | numChildren : int [read-only] The number of children of this container. | DisplayObjectContainer
|  | padding : Number Quickly sets all padding properties to the same value. | Scroller
|  | paddingBottom : Number The minimum space, in pixels, between the container's bottom edge and the container's content. | Scroller
|  | paddingLeft : Number The minimum space, in pixels, between the container's left edge and the container's content. | Scroller
|  | paddingRight : Number The minimum space, in pixels, between the container's right edge and the container's content. | Scroller
|  | paddingTop : Number The minimum space, in pixels, between the container's top edge and the container's content. | Scroller
|  | pageThrowDuration : Number The duration, in seconds, of the animation when the scroller is thrown to a page. | Scroller
|  | parent : DisplayObjectContainer [read-only] The display object container that contains this display object. | DisplayObject
|  | pivotX : Number The x coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | pivotY : Number The y coordinate of the object's origin in its own coordinate space (default: 0). | DisplayObject
|  | root : DisplayObject [read-only] The root object the display object is connected to (i.e. | DisplayObject
|  | rotation : Number The rotation of the object in radians. | DisplayObject
|  | scaleX : Number The horizontal scale factor. | DisplayObject
|  | scaleY : Number The vertical scale factor. | DisplayObject
|  | scrollBarDisplayMode : String Determines how the scroll bars are displayed. | Scroller
|  | scrollerProperties : Object DEPRECATED: A set of key/value pairs to be passed down to the container's scroller sub-component. | Scroller
|  | selectedGroupIndex : int [read-only] The group index of the currently selected item. | GroupedList
|  | selectedItem : Object The currently selected item. | GroupedList
|  | selectedItemIndex : int [read-only] The item index of the currently selected item. | GroupedList
|  | singleItemRendererFactory : Function A function called that is expected to return a new item renderer for an item in a group with no other items. | GroupedList
|  | singleItemRendererName : String A name to add to all item renderers in this list that are an item in a group with no other items. | GroupedList
|  | singleItemRendererType : Class The class used to instantiate the item renderer for an item in a group with no other items. | GroupedList
|  | skewX : Number The horizontal skew angle in radians. | DisplayObject
|  | skewY : Number The vertical skew angle in radians. | DisplayObject
|  | snapScrollPositionsToPixels : Boolean If enabled, the scroll position will always be adjusted to whole pixels. | Scroller
|  | snapToPages : Boolean Determines if scrolling will snap to the nearest page. | Scroller
|  | stage : Stage [read-only] The stage the display object is connected to, or null if it is not connected to the stage. | DisplayObject
|  | throwEase : Object The easing function used for "throw" animations. | Scroller
|  | touchable : Boolean Indicates if this object (and its children) will receive touch events. | DisplayObject
|  | transformationMatrix : Matrix The transformation matrix of the object relative to its parent. | DisplayObject
|  | typicalFooter : Object Used to auto-size the grouped list. | GroupedList
|  | typicalHeader : Object Used to auto-size the grouped list. | GroupedList
|  | typicalItem : Object An item used to create a sample item renderer used for virtual layout measurement. | GroupedList
|  | useHandCursor : Boolean Indicates if the mouse cursor should transform into a hand while it's over the sprite. | DisplayObject
|  | verticalPageIndex : int [read-only] The index of the vertical page, if snapping is enabled. | Scroller
|  | verticalScrollBarFactory : Function Creates the vertical scroll bar. | Scroller
|  | verticalScrollBarProperties : Object A set of key/value pairs to be passed down to the scroller's vertical scroll bar instance (if it exists). | Scroller
|  | verticalScrollPolicy : String Determines whether the scroller may scroll vertically (on the y-axis) or not. | Scroller
|  | verticalScrollPosition : Number The number of pixels the scroller has been scrolled vertically (on the y-axis). | Scroller
|  | verticalScrollStep : Number The number of pixels the scroller can be stepped vertically. | Scroller
|  | viewPort : IViewPort The display object displayed and scrolled within the Scroller. | Scroller
|  | visible : Boolean The visibility of the object. | DisplayObject
|  | width : Number [override] The width of the component, in pixels. | FeathersControl
|  | x : Number The x coordinate of the object relative to the local coordinates of the parent. | DisplayObject
|  | y : Number The y coordinate of the object relative to the local coordinates of the parent. | DisplayObject

Protected Properties
Hide Inherited Protected Properties
Show Inherited Protected Properties

| Property | Defined By
--- | --- | ---
|  | actualHeight : Number = 0 The final height value that should be used for layout. | FeathersControl
|  | actualWidth : Number = 0 The final width value that should be used for layout. | FeathersControl
|  | explicitHeight : Number = NaN The height value explicitly set by calling the height setter or setSize(). | FeathersControl
|  | explicitWidth : Number = NaN The width value explicitly set by calling the width setter or setSize(). | FeathersControl
|  | horizontalScrollBar : IScrollBar The horizontal scrollbar instance. | Scroller
|  | horizontalScrollBarName : String = feathers-scroller-horizontal-scroll-bar The value added to the nameList of the horizontal scroll bar. | Scroller
|  | pendingGroupIndex : int = -1 The pending group index to scroll to after validating. | GroupedList
|  | pendingHorizontalPageIndex : int = -1 The pending horizontal page index to scroll to after validating. | Scroller
|  | pendingHorizontalScrollPosition : 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. | GroupedList
|  | pendingScrollDuration : Number The duration of the pending scroll action. | Scroller
|  | pendingVerticalPageIndex : int = -1 The pending vertical page index to scroll to after validating. | Scroller
|  | pendingVerticalScrollPosition : Number = NaN The pending vertical scroll position to scroll to after validating. | Scroller
|  | verticalScrollBar : IScrollBar The vertical scrollbar instance. | Scroller
|  | verticalScrollBarName : String = feathers-scroller-vertical-scroll-bar The value added to the nameList of the vertical scroll bar. | Scroller

Public Methods
Hide Inherited Public Methods
Show Inherited Public Methods

| Method | Defined By
--- | --- | ---
|  | GroupedList() Constructor. | GroupedList
|  | addChild(child:DisplayObject):DisplayObject Adds a child to the container. | DisplayObjectContainer
|  | addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child to the container at a certain index. | DisplayObjectContainer
|  | addEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | 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
|  | broadcastEvent(event:Event):void Dispatches an event on all children (recursively). | DisplayObjectContainer
|  | broadcastEventWith(type:String, data:Object = null):void Dispatches an event with the given parameters on all children (recursively). | DisplayObjectContainer
|  | contains(child:DisplayObject):Boolean Determines if a certain object is a child of the container (recursively). | DisplayObjectContainer
|  | dispatchEvent(event:Event):void Dispatches an event to all objects that have registered listeners for its type. | EventDispatcher
|  | 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
|  | dispose():void [override] Disposes the resources of all children. | Sprite
|  | flatten():void Optimizes the sprite for optimal rendering performance. | Sprite
|  | getBounds(targetSpace:DisplayObject, resultRect:Rectangle = null):Rectangle [override] Returns a rectangle that completely encloses the object as it appears in another coordinate system. | Sprite
|  | getChildAt(index:int):DisplayObject Returns a child object at a certain index. | DisplayObjectContainer
|  | getChildByName(name:String):DisplayObject Returns a child object with a certain name (non-recursively). | DisplayObjectContainer
|  | getChildIndex(child:DisplayObject):int Returns the index of a child within the container, or "-1" if it is not found. | DisplayObjectContainer
|  | 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
|  | getTransformationMatrix(targetSpace:DisplayObject, resultMatrix:Matrix = null):Matrix Creates a matrix that represents the transformation from the local coordinate system to another. | DisplayObject
|  | globalToLocal(globalPoint:Point, resultPoint:Point = null):Point Transforms a point from global (stage) coordinates to the local coordinate system. | DisplayObject
|  | groupToFooterData(group:Object):Object Extracts footer data from a group object. | GroupedList
|  | groupToHeaderData(group:Object):Object Extracts header data from a group object. | GroupedList
|  | hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher
|  | 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
|  | invalidate(flag:String):void Call this function to tell the UI control that a redraw is pending. | FeathersControl
|  | isInvalid(flag:String = null):Boolean Indicates whether the control is pending validation or not. | FeathersControl
|  | localToGlobal(localPoint:Point, resultPoint:Point = null):Point Transforms a point from the local coordinate system to global (stage) coordinates. | DisplayObject
|  | removeChild(child:DisplayObject, dispose:Boolean = false):DisplayObject Removes a child from the container. | DisplayObjectContainer
|  | removeChildAt(index:int, dispose:Boolean = false):DisplayObject Removes a child at a certain index. | DisplayObjectContainer
|  | removeChildren(beginIndex:int = 0, endIndex:int = -1, dispose:Boolean = false):void Removes a range of children from the container (endIndex included). | DisplayObjectContainer
|  | removeEventListener(type:String, listener:Function):void [override] | DisplayObject
|  | removeEventListeners(type:String = null):void [override] | DisplayObject
|  | removeFromParent(dispose:Boolean = false):void Removes the object from its parent, if it has one, and optionally disposes it. | DisplayObject
|  | render(support:RenderSupport, parentAlpha:Number):void [override] Renders the display object with the help of a support object. | Sprite
|  | scrollToDisplayIndex(groupIndex:int, itemIndex:int, animationDuration:Number = 0):void After the next validation, scrolls the list so that the specified item is visible. | GroupedList
|  | scrollToPageIndex(horizontalPageIndex:int, verticalPageIndex:int, animationDuration:Number = 0):void After the next validation, scrolls to a specific page index. | Scroller
|  | scrollToPosition(horizontalScrollPosition:Number, verticalScrollPosition:Number, animationDuration:Number = 0):void After the next validation, scrolls to a specific position. | Scroller
|  | setChildIndex(child:DisplayObject, index:int):void Moves a child to a certain index. | DisplayObjectContainer
|  | setSelectedLocation(groupIndex:int, itemIndex:int):void Sets the selected group and item index. | GroupedList
|  | setSize(width:Number, height:Number):void Sets both the width and the height of the control. | FeathersControl
|  | sortChildren(compareFunction:Function):void Sorts the children according to a given function (that works just like the sort function of the Vector class). | DisplayObjectContainer
|  | stopScrolling():void 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
|  | swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the indexes of two children. | DisplayObjectContainer
|  | swapChildrenAt(index1:int, index2:int):void Swaps the indexes of two children. | DisplayObjectContainer
|  | unflatten():void Removes the rendering optimizations that were created when flattening the sprite. | Sprite
|  | validate():void Immediately validates the control, which triggers a redraw, if one is pending. | FeathersControl

Protected Methods
Show Inherited Protected Methods
Show Inherited Protected Methods

| Method | Defined By
--- | --- | ---
|  | autoSizeIfNeeded():Boolean Automatically determines the ideal width and height of the control, if required. | Scroller
|  | createScrollBars():void Creates the scroll bars from the provided factories. | Scroller
|  | draw():void Override to customize layout and to adjust properties of children. | FeathersControl
|  | handlePendingScroll():void Scrolls to a pending scroll position, if required. | Scroller
|  | 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
|  | layoutChildren():void Positions and sizes children based on the actual width and height values. | Scroller
|  | refreshBackgroundSkin():void Choose the appropriate background skin based on the control's current state. | Scroller
|  | setSizeInternal(width:Number, height:Number, canInvalidate:Boolean):Boolean Sets the width and height of the control, with the option of invalidating or not. | FeathersControl
|  | throwTo(targetHorizontalScrollPosition:Number, targetVerticalScrollPosition:Number, duration:Number = 0.5):void Immediately throws the scroller to the specified position, with optional animation. | Scroller
|  | 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
Hide Inherited Events
Show Inherited Events

| Event | Summary | Defined By
--- | --- | --- | ---
|  | added | Dispatched when an object is added to a parent. | DisplayObject
|  | addedToStage | Dispatched when an object is connected to the stage (directly or indirectly). | DisplayObject
|  | beginInteraction | Dispatched when the user starts dragging the scroller. | Scroller
|  | change | Dispatched when the selected item changes. | GroupedList
|  | endInteraction | Dispatched when the user stops dragging the scroller. | Scroller
|  | enterFrame | Dispatched once every frame on every object that is connected to the stage. | DisplayObject
|  | flatten | Dispatched on all children when the object is flattened. | Sprite
|  | initialize | Dispatched after initialize() has been called, but before the first time that draw() has been called. | FeathersControl
|  | keyDown | Dispatched when a key on the keyboard is pressed. | DisplayObject
|  | keyUp | Dispatched when a key on the keyboard is released. | DisplayObject
|  | removed | Dispatched when an object is removed from its parent. | DisplayObject
|  | removedFromStage | Dispatched when an object is removed from the stage and won't be rendered any longer. | DisplayObject
|  | rendererAdd | Dispatched when an item renderer is added to the list. | GroupedList
|  | rendererRemove | Dispatched when an item renderer is removed from the list. | GroupedList
|  | resize | Dispatched when the width or height of the control changes. | FeathersControl
|  | scroll | Dispatched when the scroller scrolls in either direction. | Scroller
|  | scrollComplete | Dispatched when the scroller finishes scrolling in either direction after being thrown. | Scroller
|  | touch | Dispatched when an object is touched. | DisplayObject

Public Constants
Hide Inherited Public Constants
Show Inherited Public Constants

| Constant | Defined By
--- | --- | ---
|  | ALTERNATE_CHILD_NAME_INSET_FIRST_ITEM_RENDERER : String = feathers-grouped-list-inset-first-item-renderer [static] An alternate name to use for item renderers to give them an inset style. | GroupedList
|  | ALTERNATE_CHILD_NAME_INSET_FOOTER_RENDERER : String = feathers-grouped-list-inset-footer-renderer [static] An alternate name to use with footer renderers to give them an inset style. | GroupedList
|  | ALTERNATE_CHILD_NAME_INSET_HEADER_RENDERER : String = feathers-grouped-list-inset-header-renderer [static] An alternate name to use with header renderers to give them an inset style. | GroupedList
|  | ALTERNATE_CHILD_NAME_INSET_ITEM_RENDERER : String = feathers-grouped-list-inset-item-renderer [static] An alternate name to use with item renderers to give them an inset style. | GroupedList
|  | ALTERNATE_CHILD_NAME_INSET_LAST_ITEM_RENDERER : String = feathers-grouped-list-inset-last-item-renderer [static] An alternate name to use for item renderers to give them an inset style. | GroupedList
|  | ALTERNATE_CHILD_NAME_INSET_SINGLE_ITEM_RENDERER : String = feathers-grouped-list-inset-single-item-renderer [static] An alternate name to use for item renderers to give them an inset style. | GroupedList
|  | ALTERNATE_NAME_INSET_GROUPED_LIST : String = feathers-inset-grouped-list [static] An alternate name to use with GroupedList to allow a theme to give it an inset style. | GroupedList
|  | DEFAULT_CHILD_NAME_FOOTER_RENDERER : String = feathers-grouped-list-footer-renderer [static] The default name to use with footer renderers. | GroupedList
|  | DEFAULT_CHILD_NAME_HEADER_RENDERER : String = feathers-grouped-list-header-renderer [static] The default name to use with header renderers. | GroupedList
|  | DEFAULT_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
|  | DEFAULT_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. | GroupedList
|  | INTERACTION_MODE_TOUCH : String = touch [static] The user may touch anywhere on the scroller and drag to scroll. | GroupedList
|  | INVALIDATION_FLAG_ALL : String = all [static] Flag to indicate that everything is invalid and should be redrawn. | FeathersControl
|  | INVALIDATION_FLAG_DATA : String = data [static] Invalidation flag to indicate that the primary data displayed by the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_LAYOUT : String = layout [static] Invalidation flag to indicate that the layout of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SCROLL : String = scroll [static] Invalidation flag to indicate that the scroll position of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SELECTED : String = selected [static] Invalidation flag to indicate that the selection of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_SIZE : String = size [static] Invalidation flag to indicate that the dimensions of the UI control have changed. | FeathersControl
|  | INVALIDATION_FLAG_SKIN : String = skin [static] Invalidation flag to indicate that the skin of the UI control has changed. | FeathersControl
|  | INVALIDATION_FLAG_STATE : String = state [static] Invalidation flag to indicate that the state has changed. | FeathersControl
|  | INVALIDATION_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. | GroupedList
|  | 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. | GroupedList
|  | SCROLL_BAR_DISPLAY_MODE_NONE : String = none [static] The scroll bars are never visible. | GroupedList
|  | SCROLL_POLICY_AUTO : String = auto [static] The scroller may scroll if the view port is larger than the scroller's bounds. | GroupedList
|  | SCROLL_POLICY_OFF : String = off [static] The scroller does not scroll at all. | GroupedList
|  | SCROLL_POLICY_ON : String = on [static] The scroller will always scroll. | GroupedList

Protected Constants
Hide Inherited Protected Constants
Show Inherited Protected Constants

| Constant | Defined By
--- | --- | ---
|  | INVALIDATION_FLAG_CLIPPING : String = clipping [static] Flag to indicate that the clipping has changed. | Scroller

Property Detail

dataProvider | property

`dataProvider:HierarchicalCollection`

The collection of data displayed by the list.

Implementation
`public function get dataProvider():HierarchicalCollection`
`public function set dataProvider(value:HierarchicalCollection):void`

firstItemRendererFactory | property |

`firstItemRendererFactory:Function`

A function called that is expected to return a new item renderer for the first item in a group. Has a higher priority than `firstItemRendererType`. Typically, you would use an `firstItemRendererFactory` instead of an `firstItemRendererType` 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():IGroupedListItemRenderer

Implementation
`public function get firstItemRendererFactory():Function`
`public function set firstItemRendererFactory(value:Function):void`

See also

feathers.controls.renderers.IGroupedListItemRenderer
firstItemRendererType
itemRendererType
itemRendererFactory
lastItemRendererType
lastItemRendererFactory
singleItemRendererType
singleItemRendererFactory

firstItemRendererName | property |

`firstItemRendererName:String`

A name to add to all item renderers in this list that are the first item in a group. Typically used by a theme to provide different skins to different lists, and to differentiate first items from regular items if they are created with the same class. If this value is null the regular `itemRendererName` will be used instead.

Implementation
`public function get firstItemRendererName():String`
`public function set firstItemRendererName(value:String):void`

See also

feathers.core.FeathersControl.nameList
itemRendererName
lastItemRendererName
singleItemRendererName

firstItemRendererType | property |

`firstItemRendererType:Class`

The class used to instantiate the item renderer for the first item in a group.

Implementation
`public function get firstItemRendererType():Class`
`public function set firstItemRendererType(value:Class):void`

See also

feathers.controls.renderer.IGroupedListItemRenderer
firstItemRendererFactory
itemRendererType
itemRendererFactory
lastItemRendererType
lastItemRendererFactory
singleItemRendererType
singleItemRendererFactory

footerField | property |

`footerField:String`

The field in a group that contains the data for a footer. If the group does not have this field, and a `footerFunction` is not defined, then no footer will be displayed for the group. In other words, a footer is optional, and a group may not have one.

All of the footer fields and functions, ordered by priority:

1. `footerFunction`
2. `footerField`

Implementation
`public function get footerField():String`
`public function set footerField(value:String):void`

See also

footerFunction

footerFunction | property |

`footerFunction:Function`

A function used to generate footer data for a specific group. If this function is not null, then the `footerField` will be ignored.

All of the footer fields and functions, ordered by priority:

1. `footerFunction`
2. `footerField`

Implementation
`public function get footerFunction():Function`
`public function set footerFunction(value:Function):void`

See also

footerField

footerRendererFactory | property |

`footerRendererFactory:Function`

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

The function is expected to have the following signature:

    function():IGroupedListHeaderOrFooterRenderer

Implementation
`public function get footerRendererFactory():Function`
`public function set footerRendererFactory(value:Function):void`

See also

feathers.controls.renderers.IGroupedListHeaderOrFooterRenderer
footerRendererType

footerRendererName | property |

`footerRendererName:String`

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

Implementation
`public function get footerRendererName():String`
`public function set footerRendererName(value:String):void`

See also

feathers.core.FeathersControl.nameList

footerRendererProperties | property |

`footerRendererProperties:Object`

A set of key/value pairs to be passed down to all of the grouped list's footer renderers. These values are shared by each footer 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 footer renderers using a `footerRendererFactory` 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 footerRendererProperties():Object`
`public function set footerRendererProperties(value:Object):void`

See also

itemRendererFactory

footerRendererType | property |

`footerRendererType:Class`

The class used to instantiate footer renderers.

Implementation
`public function get footerRendererType():Class`
`public function set footerRendererType(value:Class):void`

See also

feathers.controls.renderers.IGroupedListHeaderOrFooterRenderer
footerRendererFactory

headerField | property |

`headerField:String`

The field in a group that contains the data for a header. If the group does not have this field, and a `headerFunction` is not defined, then no header will be displayed for the group. In other words, a header is optional, and a group may not have one.

All of the header fields and functions, ordered by priority:

1. `headerFunction`
2. `headerField`

Implementation
`public function get headerField():String`
`public function set headerField(value:String):void`

See also

headerFunction

headerFunction | property |

`headerFunction:Function`

A function used to generate header data for a specific group. If this function is not null, then the `headerField` will be ignored.

All of the header fields and functions, ordered by priority:

1. `headerFunction`
2. `headerField`

Implementation
`public function get headerFunction():Function`
`public function set headerFunction(value:Function):void`

See also

headerField

headerRendererFactory | property |

`headerRendererFactory:Function`

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

The function is expected to have the following signature:

    function():IGroupedListHeaderOrFooterRenderer

Implementation
`public function get headerRendererFactory():Function`
`public function set headerRendererFactory(value:Function):void`

See also

feathers.controls.renderers.IGroupedListHeaderOrFooterRenderer
headerRendererType

headerRendererName | property |

`headerRendererName:String`

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

Implementation
`public function get headerRendererName():String`
`public function set headerRendererName(value:String):void`

See also

feathers.core.FeathersControl.nameList

headerRendererProperties | property |

`headerRendererProperties:Object`

A set of key/value pairs to be passed down to all of the grouped list's header renderers. These values are shared by each header 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 header renderers using a `headerRendererFactory` 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 headerRendererProperties():Object`
`public function set headerRendererProperties(value:Object):void`

See also

headerRendererFactory

headerRendererType | property |

`headerRendererType:Class`

The class used to instantiate header renderers.

Implementation
`public function get headerRendererType():Class`
`public function set headerRendererType(value:Class):void`

See also

feathers.controls.renderers.IGroupedListHeaderOrFooterRenderer
headerRendererFactory

isSelectable | property |

`isSelectable:Boolean`

Determines if an item in the list may be selected.

Implementation
`public function get isSelectable():Boolean`
`public function set isSelectable(value:Boolean):void`

itemRendererFactory | property |

`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():IGroupedListItemRenderer

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

See also

feathers.controls.renderers.IGroupedListItemRenderer
itemRendererType
firstItemRendererType
firstItemRendererFactory
lastItemRendererType
lastItemRendererFactory
singleItemRendererType
singleItemRendererFactory

itemRendererName | property |

`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

feathers.core.FeathersControl.nameList
firstItemRendererName
lastItemRendererName
singleItemRendererName

itemRendererProperties | property |

`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

feathers.controls.renderers.IGroupedListItemRenderer
itemRendererFactory

itemRendererType | property |

`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.IGroupedListItemRenderer
itemRendererFactory
firstItemRendererType
firstItemRendererFactory
lastItemRendererType
lastItemRendererFactory
singleItemRendererType
singleItemRendererFactory

lastItemRendererFactory | property |

`lastItemRendererFactory:Function`

A function called that is expected to return a new item renderer for the last item in a group. Has a higher priority than `lastItemRendererType`. Typically, you would use an `lastItemRendererFactory` instead of an `lastItemRendererType` 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():IGroupedListItemRenderer

Implementation
`public function get lastItemRendererFactory():Function`
`public function set lastItemRendererFactory(value:Function):void`

See also

feathers.controls.renderers.IGroupedListItemRenderer
lastItemRendererType
itemRendererType
itemRendererFactory
firstItemRendererType
firstItemRendererFactory
singleItemRendererType
singleItemRendererFactory

lastItemRendererName | property |

`lastItemRendererName:String`

A name to add to all item renderers in this list that are the last item in a group. Typically used by a theme to provide different skins to different lists, and to differentiate last items from regular items if they are created with the same class. If this value is null the regular `itemRendererName` will be used instead.

Implementation
`public function get lastItemRendererName():String`
`public function set lastItemRendererName(value:String):void`

See also

feathers.core.FeathersControl.nameList
itemRendererName
firstItemRendererName
singleItemRendererName

lastItemRendererType | property |

`lastItemRendererType:Class`

The class used to instantiate the item renderer for the last item in a group.

Implementation
`public function get lastItemRendererType():Class`
`public function set lastItemRendererType(value:Class):void`

See also

feathers.controls.renderer.IGroupedListItemRenderer
lastItemRendererFactory
itemRendererType
itemRendererFactory
firstItemRendererType
firstItemRendererFactory
singleItemRendererType
singleItemRendererFactory

layout | property |

`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`

pendingGroupIndex | property |

`protected var pendingGroupIndex:int = -1`

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

pendingItemIndex | property |

`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.

selectedGroupIndex | property |

`selectedGroupIndex:int` [read-only]

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

Implementation
`public function get selectedGroupIndex():int`

See also

selectedItemIndex

selectedItem | property |

`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`

selectedItemIndex | property |

`selectedItemIndex:int` [read-only]

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

Implementation
`public function get selectedItemIndex():int`

See also

selectedGroupIndex

singleItemRendererFactory | property |

`singleItemRendererFactory:Function`

A function called that is expected to return a new item renderer for an item in a group with no other items. Has a higher priority than `singleItemRendererType`. Typically, you would use an `singleItemRendererFactory` instead of an `singleItemRendererType` 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():IGroupedListItemRenderer

Implementation
`public function get singleItemRendererFactory():Function`
`public function set singleItemRendererFactory(value:Function):void`

See also

feathers.controls.renderers.IGroupedListItemRenderer
singleItemRendererType
itemRendererType
itemRendererFactory
firstItemRendererType
firstItemRendererFactory
lastItemRendererType
lastItemRendererFactory

singleItemRendererName | property |

`singleItemRendererName:String`

A name to add to all item renderers in this list that are an item in a group with no other items. Typically used by a theme to provide different skins to different lists, and to differentiate single items from other items if they are created with the same class. If this value is null the regular `itemRendererName` will be used instead.

Implementation
`public function get singleItemRendererName():String`
`public function set singleItemRendererName(value:String):void`

See also

feathers.core.FeathersControl.nameList
itemRendererName
firstItemRendererName
lastItemRendererName

singleItemRendererType | property |

`singleItemRendererType:Class`

The class used to instantiate the item renderer for an item in a group with no other items.

Implementation
`public function get singleItemRendererType():Class`
`public function set singleItemRendererType(value:Class):void`

See also

feathers.controls.renderer.IGroupedListItemRenderer
singleItemRendererFactory
itemRendererType
itemRendererFactory
firstItemRendererType
firstItemRendererFactory
lastItemRendererType
lastItemRendererFactory

typicalFooter | property |

`typicalFooter:Object`

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

Implementation
`public function get typicalFooter():Object`
`public function set typicalFooter(value:Object):void`

typicalHeader | property |

`typicalHeader:Object`

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

Implementation
`public function get typicalHeader():Object`
`public function set typicalHeader(value:Object):void`

typicalItem | property |

`typicalItem:Object`

An item used to create a sample item renderer used for virtual layout measurement.

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

GroupedList | () | Constructor

`public function GroupedList()`

Constructor.

Method Detail

groupToFooterData | () | method

`public function groupToFooterData(group:Object):Object`

Extracts footer data from a group object.

Parameters

| `group:Object`

Returns

| `Object`

groupToHeaderData | () | method |

`public function groupToHeaderData(group:Object):Object`

Extracts header data from a group object.

Parameters

| `group:Object`

Returns

| `Object`

scrollToDisplayIndex | () | method |

`public function scrollToDisplayIndex(groupIndex:int, itemIndex:int, animationDuration:Number = 0):void`

After the next validation, 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

| `groupIndex:int`
| `itemIndex:int`
| `animationDuration:Number` (default = `0`)``

setSelectedLocation | () | method |

`public function setSelectedLocation(groupIndex:int, itemIndex:int):void`

Sets the selected group and item index.

Parameters

| `groupIndex:int`
| `itemIndex:int`

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

ALTERNATE_CHILD_NAME_INSET_FIRST_ITEM_RENDERER | Constant

`public static const ALTERNATE_CHILD_NAME_INSET_FIRST_ITEM_RENDERER:String = feathers-grouped-list-inset-first-item-renderer`

An alternate name to use for item renderers to give them an inset style. Typically meant to be used for the renderer of the first item in a group.

ALTERNATE_CHILD_NAME_INSET_FOOTER_RENDERER | Constant |

`public static const ALTERNATE_CHILD_NAME_INSET_FOOTER_RENDERER:String = feathers-grouped-list-inset-footer-renderer`

An alternate name to use with footer renderers to give them an inset style.

ALTERNATE_CHILD_NAME_INSET_HEADER_RENDERER | Constant |

`public static const ALTERNATE_CHILD_NAME_INSET_HEADER_RENDERER:String = feathers-grouped-list-inset-header-renderer`

An alternate name to use with header renderers to give them an inset style.

ALTERNATE_CHILD_NAME_INSET_ITEM_RENDERER | Constant |

`public static const ALTERNATE_CHILD_NAME_INSET_ITEM_RENDERER:String = feathers-grouped-list-inset-item-renderer`

An alternate name to use with item renderers to give them an inset style.

ALTERNATE_CHILD_NAME_INSET_LAST_ITEM_RENDERER | Constant |

`public static const ALTERNATE_CHILD_NAME_INSET_LAST_ITEM_RENDERER:String = feathers-grouped-list-inset-last-item-renderer`

An alternate name to use for item renderers to give them an inset style. Typically meant to be used for the renderer of the last item in a group.

ALTERNATE_CHILD_NAME_INSET_SINGLE_ITEM_RENDERER | Constant |

`public static const ALTERNATE_CHILD_NAME_INSET_SINGLE_ITEM_RENDERER:String = feathers-grouped-list-inset-single-item-renderer`

An alternate name to use for item renderers to give them an inset style. Typically meant to be used for the renderer of an item in a group that has no other items.

ALTERNATE_NAME_INSET_GROUPED_LIST | Constant |

`public static const ALTERNATE_NAME_INSET_GROUPED_LIST:String = feathers-inset-grouped-list`

An alternate name to use with GroupedList to allow a theme to give it an inset style. If a theme does not provide a skin for this name, it will fall back to its default style instead of leaving the list unskinned.

DEFAULT_CHILD_NAME_FOOTER_RENDERER | Constant |

`public static const DEFAULT_CHILD_NAME_FOOTER_RENDERER:String = feathers-grouped-list-footer-renderer`

The default name to use with footer renderers.

DEFAULT_CHILD_NAME_HEADER_RENDERER | Constant |

`public static const DEFAULT_CHILD_NAME_HEADER_RENDERER:String = feathers-grouped-list-header-renderer`

The default name to use with header renderers.

INTERACTION_MODE_MOUSE | Constant |

`public static const INTERACTION_MODE_MOUSE:String = mouse`

The user may interact with the scroll bars to scroll.

INTERACTION_MODE_TOUCH | Constant |

`public static const INTERACTION_MODE_TOUCH:String = touch`

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

SCROLL_BAR_DISPLAY_MODE_FIXED | Constant |

`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_FLOAT | Constant |

`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_NONE | Constant |

`public static const SCROLL_BAR_DISPLAY_MODE_NONE:String = none`

The scroll bars are never visible.

SCROLL_POLICY_AUTO | Constant |

`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_OFF | Constant |

`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_ON | Constant |

`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.

Thu Jan 16 2014, 01:11 PM +08:00