The collection of data displayed by the list.

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

See also

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.

See also

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

See also

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

See also

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

See also

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

See also

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

See also

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);

See also

The class used to instantiate footer renderers.

See also

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

See also

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

See also

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

See also

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

See also

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);

See also

The class used to instantiate header renderers.

See also

Determines if an item in the list may be selected.

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

See also

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

See also

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);

See also

The class used to instantiate item renderers.

See also

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

See also

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.

See also

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

See also

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

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.

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.

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

See also

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

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

See also

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

See also

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.

See also

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

See also

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.

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.

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

Constructor.

Extracts footer data from a group object.

Parameters

Extracts header data from a group object.

Parameters

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

Sets the selected group and item index.

Parameters

Dispatched when the selected item changes.

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.

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.

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.

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

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

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

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.

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.

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.

The default name to use with footer renderers.

The default name to use with header renderers.

The user may interact with the scroll bars to scroll.

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

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

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

The scroll bars are never visible.

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.

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

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.