| Package | feathers.data |
| Class | public class ListCollection |
| Inheritance | ListCollection  EventDispatcher Object |
Default MXML Propertydata
See also
| Property | Defined By | ||
|---|---|---|---|
| data : Object
The data source for this collection. | ListCollection | ||
| dataDescriptor : IListCollectionDataDescriptor
Describes the underlying data source by translating APIs. | ListCollection | ||
| length : int [read-only]
The number of items in the collection. | ListCollection | ||
| Method | Defined By | ||
|---|---|---|---|
ListCollection(data:Object = null)
Constructor
| ListCollection | ||
addAll(collection:ListCollection):void
Adds all items from another collection. | ListCollection | ||
addAllAt(collection:ListCollection, index:int):void
Adds all items from another collection, placing the items at a
specific index in this collection. | ListCollection | ||
 | addEventListener(type:String, listener:Function):void Registers an event listener at a certain object. | EventDispatcher | |
addItem(item:Object):void
Adds an item to the end of the collection. | ListCollection | ||
addItemAt(item:Object, index:int):void
Adds an item to the collection, at the specified index. | ListCollection | ||
contains(item:Object):Boolean
Determines if the specified item is in the collection. | ListCollection | ||
| 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 | |
getItemAt(index:int):Object
Returns the item at the specified index in the collection. | ListCollection | ||
getItemIndex(item:Object):int
Determines which index the item appears at within the collection. | ListCollection | ||
| hasEventListener(type:String):Boolean Returns if there are listeners registered for a certain event type. | EventDispatcher | |
pop():Object
Removes the item from the end of the collection and returns it. | ListCollection | ||
push(item:Object):void
Adds an item to the end of the collection. | ListCollection | ||
removeAll():void
Removes all items from the collection. | ListCollection | ||
| removeEventListener(type:String, listener:Function):void Removes an event listener from the object. | EventDispatcher | |
| removeEventListeners(type:String = null):void Removes all event listeners with a certain type, or all of them if type is null. | EventDispatcher | |
removeItem(item:Object):void
Removes a specific item from the collection. | ListCollection | ||
removeItemAt(index:int):Object
Removes the item at the specified index from the collection and
returns it. | ListCollection | ||
setItemAt(item:Object, index:int):void
Replaces the item at the specified index with a new item. | ListCollection | ||
shift():Object
Removed the item from the beginning of the collection and returns it. | ListCollection | ||
unshift(item:Object):void
Adds an item to the beginning of the collection. | ListCollection | ||
updateItemAt(index:int):void
If an item doesn't dispatch an event or signal to indicate that it
has changed, you can manually tell the collection about the change,
and the collection will dispatch the CollectionEventType.UPDATE_ITEM
event to manually notify the component that renders the data. | ListCollection | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when an item is added to the collection. | ListCollection | |||
| Dispatched when the underlying data source changes and the ui will need to redraw the data. | ListCollection | |||
| Dispatched when an item is removed from the collection. | ListCollection | |||
| Dispatched when an item is replaced in the collection. | ListCollection | |||
| Dispatched when the collection has changed drastically, such as when the underlying data source is replaced completely. | ListCollection | |||
| Dispatched when a property of an item in the collection has changed and the item doesn't have its own change event or signal. | ListCollection | |||
| data | property |
Hide Inherited Public Methods
Show Inherited Public Methodsdata:Object
The data source for this collection. May be any type of data, but a
dataDescriptor needs to be provided to translate from
the data source's APIs to something that can be understood by
ListCollection.
Data sources of type Array, Vector, and XMLList are automatically
detected, and no dataDescriptor needs to be set if the
ListCollection uses one of these types.
public function get data():Object public function set data(value:Object):void| dataDescriptor | property |
dataDescriptor:IListCollectionDataDescriptorDescribes the underlying data source by translating APIs.
public function get dataDescriptor():IListCollectionDataDescriptor public function set dataDescriptor(value:IListCollectionDataDescriptor):voidSee also
| length | property |
length:int [read-only] The number of items in the collection.
public function get length():int| ListCollection | () | Constructor |
public function ListCollection(data:Object = null)Constructor
Parametersdata:Object (default = null) |
| addAll | () | method |
public function addAll(collection:ListCollection):voidAdds all items from another collection.
Parameters
collection:ListCollection |
| addAllAt | () | method |
public function addAllAt(collection:ListCollection, index:int):voidAdds all items from another collection, placing the items at a specific index in this collection.
Parameters
collection:ListCollection | |
index:int |
| addItem | () | method |
public function addItem(item:Object):voidAdds an item to the end of the collection.
Parameters
item:Object |
| addItemAt | () | method |
public function addItemAt(item:Object, index:int):voidAdds an item to the collection, at the specified index.
Parameters
item:Object | |
index:int |
| contains | () | method |
public function contains(item:Object):BooleanDetermines if the specified item is in the collection.
Parameters
item:Object |
Boolean |
| getItemAt | () | method |
public function getItemAt(index:int):ObjectReturns the item at the specified index in the collection.
Parameters
index:int |
Object |
| getItemIndex | () | method |
public function getItemIndex(item:Object):int
Determines which index the item appears at within the collection. If
the item isn't in the collection, returns -1.
Parameters
item:Object |
int |
| pop | () | method |
public function pop():ObjectRemoves the item from the end of the collection and returns it.
ReturnsObject |
| push | () | method |
public function push(item:Object):voidAdds an item to the end of the collection.
Parameters
item:Object |
| removeAll | () | method |
public function removeAll():voidRemoves all items from the collection.
| removeItem | () | method |
public function removeItem(item:Object):voidRemoves a specific item from the collection.
Parameters
item:Object |
| removeItemAt | () | method |
public function removeItemAt(index:int):ObjectRemoves the item at the specified index from the collection and returns it.
Parameters
index:int |
Object |
| setItemAt | () | method |
public function setItemAt(item:Object, index:int):voidReplaces the item at the specified index with a new item.
Parameters
item:Object | |
index:int |
| shift | () | method |
public function shift():ObjectRemoved the item from the beginning of the collection and returns it.
ReturnsObject |
| unshift | () | method |
public function unshift(item:Object):voidAdds an item to the beginning of the collection.
Parameters
item:Object |
| updateItemAt | () | method |
public function updateItemAt(index:int):void
If an item doesn't dispatch an event or signal to indicate that it
has changed, you can manually tell the collection about the change,
and the collection will dispatch the CollectionEventType.UPDATE_ITEM
event to manually notify the component that renders the data.
Parameters
index:int |
| addItem | Event |
starling.events.Eventfeathers.events.CollectionEventType.ADD_ITEMDispatched when an item is added to the collection.
The data property of the event is the index of the
item that has been updated. It is of type int.
| change | Event |
starling.events.Eventstarling.events.Event.CHANGEDispatched when the underlying data source changes and the ui will need to redraw the data.
An event type to be utilized in custom events. Not used by Starling right now.| removeItem | Event |
starling.events.Eventfeathers.events.CollectionEventType.REMOVE_ITEMDispatched when an item is removed from the collection.
The data property of the event is the index of the
item that has been updated. It is of type int.
| replaceItem | Event |
starling.events.Eventfeathers.events.CollectionEventType.REPLACE_ITEMDispatched when an item is replaced in the collection.
The data property of the event is the index of the
item that has been updated. It is of type int.
| reset | Event |
starling.events.Eventfeathers.events.CollectionEventType.RESETDispatched when the collection has changed drastically, such as when the underlying data source is replaced completely.
Dispatched when the data provider's source is completely replaced.| updateItem | Event |
starling.events.Eventfeathers.events.CollectionEventType.UPDATE_ITEM
Dispatched when a property of an item in the collection has changed
and the item doesn't have its own change event or signal. This event
is only dispatched when the updateItemAt() function is
called on the ListCollection.
In general, it's better for the items themselves to dispatch events or signals when their properties change.
The data property of the event is the index of the
item that has been updated. It is of type int.