Adobe® Flex® 4 Language Reference
Hide Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.collections 
ArrayCollection 
Packagemx.collections
Classpublic class ArrayCollection
InheritanceArrayCollection Inheritance ListCollectionView Inheritance Proxy Inheritance Object
Implements IExternalizable

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



Public Properties
 PropertyDefined By
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedfilterFunction : Function
A function that the view will use to eliminate items that do not match the function's criteria.
ListCollectionView
 Inheritedlength : int
[read-only] The number of items in this view.
ListCollectionView
 Inheritedlist : IList
The IList that this collection view wraps.
ListCollectionView
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 Inheritedsort : Sort
The Sort that will be applied to the ICollectionView.
ListCollectionView
  source : Array
The source of data in the ArrayCollection.
ArrayCollection
Protected Properties
 PropertyDefined By
 InheritedlocalIndex : 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
 MethodDefined By
  
ArrayCollection(source:Array = null)
Constructor.
ArrayCollection
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
Adds the specified item to the end of the list.
ListCollectionView
 Inherited
addItemAt(item:Object, index:int):void
Adds the item at the specified index.
ListCollectionView
 Inherited
Returns whether the view contains the specified object.
ListCollectionView
 Inherited
Creates a new IViewCursor that works with this view.
ListCollectionView
 Inherited
Prevents changes to the collection itself and items within the collection from being dispatched by the view.
ListCollectionView
 Inherited
Dispatches an event into the event flow.
ListCollectionView
 Inherited
Enables auto-updating.
ListCollectionView
 Inherited
getItemAt(index:int, prefetch:int = 0):Object
Gets the item at the specified index.
ListCollectionView
 Inherited
Returns the index of the item if it is in the list such that getItemAt(index) == item.
ListCollectionView
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
ListCollectionView
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Called automatically by the MXML compiler when the ListCollectionView is created using an MXML tag.
ListCollectionView
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated.
ListCollectionView
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Applies the sort and filter to the view.
ListCollectionView
 Inherited
Remove all items from the list.
ListCollectionView
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
ListCollectionView
 Inherited
Removes the item at the specified index and returns it.
ListCollectionView
 Inherited
setItemAt(item:Object, index:int):Object
Places the item at the specified index.
ListCollectionView
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
Returns an Array that is populated in the same order as the IList implementation.
ListCollectionView
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Prints the contents of this view to a string and returns it.
ListCollectionView
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
ListCollectionView
Events
 Event Summary Defined By
 InheritedDispatched 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

ArrayCollection

()Constructor
public function ArrayCollection(source:Array = null)

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 9, AIR 1.1

Constructor.

Creates a new ArrayCollection using the specified source array. If no array is specified an empty array will be used.

Parameters
source:Array (default = null)