ArrayCollection

Package	mx.collections
Class	public class ArrayCollection
Inheritance	ArrayCollection ListCollectionView Proxy
Implements	IExternalizable
Subclasses	ApproverCollection, DocumentCollection, ModeratorCollection, Node, ReminderCollection, ReviewerCollection, SelectableList, StageCollection

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The ArrayCollection class is a wrapper class that exposes an Array as a collection that can be accessed and manipulated using the methods and properties of the ICollectionView or IList interfaces. Operations on a ArrayCollection instance modify the data source; for example, if you use the removeItemAt() method on an ArrayCollection, you remove the item from the underlying Array.

MXML Syntax expanded

Hide MXML Syntax

The <mx:ArrayCollection> tag inherits all the attributes of its superclass, and adds the following attributes:

  <mx:ArrayCollection
  Properties
  source="null"
  />

Default MXML Propertysource

More examples

Setting a data provider in ActionScript
Example: Updating an Array by using data view methods and properties

Learn more

About collections and data provider components
Collection events and manual change notification
Hierarchical data objects
Data providers and the uid property

Public Properties

	Property		Defined By
		filterFunction : Function A function that the view will use to eliminate items that do not match the function's criteria.	ListCollectionView
		length : int [read-only] The number of items in this view.	ListCollectionView
		list : IList The IList that this collection view wraps.	ListCollectionView
		sort : ISort The ISort that will be applied to the ICollectionView.	ListCollectionView
		source : Array The source of data in the ArrayCollection.	ArrayCollection

Protected Properties

	Property		Defined By
		localIndex : Array When the view is sorted or filtered the localIndex property contains an array of items in the sorted or filtered (ordered, reduced) view, in the sorted order.	ListCollectionView

Public Methods

	Method		Defined By
		ArrayCollection(source:Array = null) Constructor.	ArrayCollection
		addAll(addList:IList):void Adds a list of items to the current list, placing them at the end of the list in the order they are passed.	ListCollectionView
		addAllAt(addList:IList, index:int):void Adds a list of items to the current list, placing them at the position index passed in to the function.	ListCollectionView
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.	ListCollectionView
		addItem(item:Object):void Adds the specified item to the end of the list.	ListCollectionView
		addItemAt(item:Object, index:int):void Adds the item at the specified index.	ListCollectionView
		contains(item:Object):Boolean Returns whether the view contains the specified object.	ListCollectionView
		createCursor():IViewCursor Creates a new IViewCursor that works with this view.	ListCollectionView
		disableAutoUpdate():void Prevents changes to the collection itself and items within the collection from being dispatched by the view.	ListCollectionView
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	ListCollectionView
		enableAutoUpdate():void Enables auto-updating.	ListCollectionView
		getItemAt(index:int, prefetch:int = 0):Object Gets the item at the specified index.	ListCollectionView
		getItemIndex(item:Object):int Returns the index of the item if it is in the list such that getItemAt(index) == item.	ListCollectionView
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	ListCollectionView
		initialized(document:Object, id:String):void Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.	ListCollectionView
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Notifies the view that an item has been updated.	ListCollectionView
		refresh():Boolean Applies the sort and filter to the view.	ListCollectionView
		removeAll():void Remove all items from the list.	ListCollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	ListCollectionView
		removeItemAt(index:int):Object Removes the item at the specified index and returns it.	ListCollectionView
		setItemAt(item:Object, index:int):Object Places the item at the specified index.	ListCollectionView
		toArray():Array Returns an Array that is populated in the same order as the IList implementation.	ListCollectionView
		toString():String Prints the contents of this view to a string and returns it.	ListCollectionView
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	ListCollectionView

Events

Click for more information on events

	Event		Summary	Defined By
		collectionChange	Dispatched when the ICollectionView has been updated in some way.	ListCollectionView

Property Detail

source

property

source:Array

Language Version:

ActionScript 3.0

Product Version:

Flex 3

Runtime Versions:

Flash Player 9, AIR 1.1

The source of data in the ArrayCollection. The ArrayCollection object does not represent any changes that you make directly to the source array. Always use the ICollectionView or IList methods to modify the collection.

This property can be used as the source for data binding. When this property is modified, it dispatches the listChanged event.

Implementation
public function get source():Array
public function set source(value:Array):void

Constructor Detail