Apache Flex 4.16.1 API Reference | All Packages | All Classes | Index | Frames No Frames |
ArrayCollection

Package | mx.collections
Class | public class ArrayCollection
Inheritance | ArrayCollection ListCollectionView flash.utils.Proxy
Implements | flash.utils.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 Syntax Show 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 Property `source`

Public Properties
Hide Inherited Public Properties
Show Inherited Public Properties

| Property | Defined By
--- | --- | ---
|  | complexFieldWatcher : ComplexFieldChangeWatcher | ListCollectionView
|  | 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
Hide Inherited Protected Properties
Show Inherited 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
Hide Inherited Public Methods
Show Inherited 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(eventType: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
|  | 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 | 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(eventType: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(eventType:String, listener:Function, useCapture:Boolean = false):void | ListCollectionView
|  | removeItem(item:Object):Boolean Removes the specified item from this list, should it exist. | 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
|  | toJSON(s:String):* Converts an Array Collection to JavaScript Object Notation (JSON) format. | ArrayCollection
|  | toString():String Prints the contents of this view to a string and returns it. | ListCollectionView
|  | willTrigger(eventType:String):Boolean | ListCollectionView

Events
Hide Inherited Events
Show Inherited 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.

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`)`` — The source Array.

Method Detail

toJSON | () | method

`public function toJSON(s:String):*`

Language Version : | ActionScript 3.0

Product Version : | Apache Flex

Runtime Versions : | Flash Player 11, AIR 3.0

Converts an Array Collection to JavaScript Object Notation (JSON) format. Called by the JSON.stringify() method and should not be called directly.

Parameters

| `s:String`

Returns

| `*`

Wed Nov 15 2017, 09:50 AM +01:00