Package | mx.collections |
Class | public class ArrayCollection |
Inheritance | ArrayCollection ListCollectionView flash.utils.Proxy |
Implements | flash.utils.IExternalizable |
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 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
getItemAt
method and an IViewCursor object that it obtains using the ICollectionView
createCursor
method.
var myCollection:ArrayCollection = new ArrayCollection([ { first: 'Matt', last: 'Matthews' } ]); var myCursor:IViewCursor = myCollection.createCursor(); var firstItem:Object = myCollection.getItemAt(0); var firstItemFromCursor:Object = myCursor.current; if (firstItem == firstItemFromCursor) doCelebration();
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
The number of items in this collection.
| ListCollectionView | ||
list : IList
The IList that this collection view wraps.
| ListCollectionView | ||
sort : Sort
The Sort that will be applied to the ICollectionView.
| ListCollectionView | ||
source : Array
The source of data in the ArrayCollection.
| ArrayCollection |
Method | Defined by | ||
---|---|---|---|
ArrayCollection(source:Array = null)
Constructor.
| ArrayCollection | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
| 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 | ||
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
| 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
| 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
| 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
| ListCollectionView |
source | property |
source:Array
[read-write]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.
Implementation public function get source():Array
public function set source(value:Array):void
ArrayCollection | () | constructor |
public function ArrayCollection(source:Array = null)
Constructor.
Creates a new ArrayCollection using the specified source array. If no array is specified an empty array will be used.
Parameterssource:Array (default = null )
|