ArrayList

包	mx.collections
类	public class ArrayList
继承	ArrayList EventDispatcher Object
实现	IList, IExternalizable, IPropertyChangeNotifier
子类	Conflicts

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

ArrayList 类是使用后备 Array 作为数据源的 IList 的一个简单实现。可以通过使用 IList 接口的方法和属性，访问和操纵后备 Array 中的项目。对 ArrayList 实例进行操作会修改数据源；例如，如果对 ArrayList 使用 removeItemAt() 方法，就会删除基础 Array 中的项目。此基类将不会引发 ItemPendingErrors，但子类有可能会引发。

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

默认 MXML 属性source

公共属性

隐藏继承的公共属性

显示继承的公共属性

	属性		由以下参数定义
		constructor : Object 对类对象或给定对象实例的构造函数的引用。	Object
		length : int [只读] 获取列表中的项目数。	ArrayList
		source : Array 此 ArrayList 的源数组。	ArrayList
		uid : String 提供对此列表的唯一 ID 的访问。	ArrayList

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		ArrayList(source:Array = null) 使用指定的数组作为 ArrayList 源，构造新的 ArrayList。	ArrayList
		addAll(addList:IList):void 向当前列表添加一组项目，将它们按传入顺序放置在列表的末尾。	ArrayList
		addAllAt(addList:IList, index:int):void 向当前列表添加一组项目，将它们放置在传递给函数的索引指定的位置。	ArrayList
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	EventDispatcher
		addItem(item:Object):void 将指定的项目添加到列表末尾。	ArrayList
		addItemAt(item:Object, index:int):void 在指定的索引处添加项目。	ArrayList
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	EventDispatcher
		getItemAt(index:int, prefetch:int = 0):Object 获取位于指定索引处的项目。	ArrayList
		getItemIndex(item:Object):int 如果项目位于列表中（这样的话 getItemAt(index) == item），则返回该项目的索引。	ArrayList
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	EventDispatcher
		hasOwnProperty(name:String):Boolean 表示对象是否已经定义了指定的属性。	Object
		isPrototypeOf(theClass:Object):Boolean 表示 Object 类的实例是否在指定为参数的对象的原型链中。	Object
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void 通知视图，某个项目已更新。	ArrayList
		propertyIsEnumerable(name:String):Boolean 表示指定的属性是否存在、是否可枚举。	Object
		removeAll():void 删除列表中的所有项目。	ArrayList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	EventDispatcher
		removeItem(item:Object):Boolean 从此列表中删除指定的项目（如果存在）。	ArrayList
		removeItemAt(index:int):Object 删除指定索引处的项目并返回该项目。	ArrayList
		setItemAt(item:Object, index:int):Object 将项目置于指定索引处。	ArrayList
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 设置循环操作动态属性的可用性。	Object
		toArray():Array 返回与 IList 实现的填充顺序相同的 Array。	ArrayList
		toLocaleString():String 返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。	Object
		toString():String [覆盖] 将此 ArrayList 的内容整齐显示为字符串并将其返回。	ArrayList
		valueOf():Object 返回指定对象的原始值。	Object
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	EventDispatcher

受保护的方法

	方法		由以下参数定义
		itemUpdateHandler(event:PropertyChangeEvent):void 列表中包含的任何项调度 ObjectChange 事件时调用。	ArrayList
		startTrackUpdates(item:Object):void 如果该项是 IEventDispatcher，请观察其更新。	ArrayList
		stopTrackUpdates(item:Object):void 如果该项是 IEventDispatcher，请停止观察其更新。	ArrayList

事件

单击此处了解有关事件的更多信息

隐藏继承的事件

显示继承的事件

	摘要	由以下参数定义
activate	[广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。	EventDispatcher
collectionChange	以某种方式更新 IList 后调度。	ArrayList
deactivate	[广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。	EventDispatcher

属性详细信息

length

属性

length:int [只读]

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

获取列表中的项目数。ArrayList 应该始终知道其 length，因此它不应该返回 -1（尽管某个子类可能会覆盖该行为）。

此属性可用作数据绑定的源。修改此属性后，将调度 collectionChange 事件。

实现
public function get length():int

source

属性

source:Array

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

此 ArrayList 的源数组。在源数组中将反映通过 IList 接口所进行的任何更改。如果未提供源数组，则 ArrayList 将在内部创建一个。直接对基础 Array 所做的更改（例如，调用 theList.source.pop()）将不会导致 CollectionEvents 被调度。

实现
public function get source():Array
public function set source(value:Array):void

uid

属性

uid:String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

提供对此列表的唯一 ID 的访问。

实现
public function get uid():String
public function set uid(value:String):void

构造函数详细信息

()

构造函数

public function ArrayList(source:Array = null)

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

使用指定的数组作为 ArrayList 源，构造新的 ArrayList。如果未指定源，将使用空数组。

参数

source:Array (default = null) — 用作 ArrayList 源的数组。

方法详细信息

addAll

()

方法

public function addAll(addList:IList):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

向当前列表添加一组项目，将它们按传入顺序放置在列表的末尾。

参数

addList:IList — 要添加到当前列表的项目列表

addAllAt

()

方法

public function addAllAt(addList:IList, index:int):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

向当前列表添加一组项目，将它们放置在传递给函数的索引指定的位置。这些项目按接收顺序放置在索引位置。

参数

	`addList:IList` — 要添加到当前列表的项目列表

	`index:int` — 当前列表中放置新项目的位置。

addItem

()

方法

public function addItem(item:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将指定的项目添加到列表末尾。等效于 addItemAt(item, length)；

参数

item:Object — 要添加的项目

addItemAt

()

方法

public function addItemAt(item:Object, index:int):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

在指定的索引处添加项目。原先位于此索引之后的所有项目将移动一个位置。

参数

	`item:Object` — 要置于索引处的项目

	`index:int` — 要放置项目的索引位置

引发

RangeError — 如果索引小于 0 或大于长度

getItemAt

()

方法

public function getItemAt(index:int, prefetch:int = 0):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

获取位于指定索引处的项目。

参数

	`index:int` — 要从中检索项目的列表中的索引

	`prefetch:int` (default = `0`) — 一个 int，指示当项目不是本地项目时，在请求期间要访存的项目的方向和数量。

Object — 此索引处的项目；如果没有项目，则为 null

引发

	`Error` — 如果需要从远程位置加载此索引的数据

	`RangeError` — 如果 index < 0 或 index >= length

getItemIndex

()

方法

public function getItemIndex(item:Object):int

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果项目位于列表中（这样的话 getItemAt(index) == item），则返回该项目的索引。请注意，在该实现中搜索为线性，因此为 O(n)。

参数

item:Object — 要查找的项目

int — 项目的索引；如果该项目不在列表中则返回 -1。

itemUpdated

()

方法

public function itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

通知视图，某个项目已更新。如果视图的内容不实现 IEventDispatcher，则这非常有用。如果已指定属性，该视图也许能优化其通知机制。否则，它可能选择仅刷新整个视图。

参数

	`item:Object` — 已在视图中更新的项目。

	`property:Object` (default = `null`) — 指定已更新属性的 String、QName 或 int。

	`oldValue:Object` (default = `null`) — 该属性的旧值。（如果属性为 null，则它可以是该项目的旧值。）

	`newValue:Object` (default = `null`) — 该属性的新值。（如果属性为 null，则无需指定它，因为已假定该项目为新值。）

itemUpdateHandler

()

方法

protected function itemUpdateHandler(event:PropertyChangeEvent):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

列表中包含的任何项调度 ObjectChange 事件时调用。在 CollectionEventKind.UPDATE 对象中回绕它。

参数

event:PropertyChangeEvent — ObjectChange 事件的事件对象。

removeAll

()

方法

public function removeAll():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

删除列表中的所有项目。

removeItem

()

方法

public function removeItem(item:Object):Boolean

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

从此列表中删除指定的项目（如果存在）。

参数

item:Object — 对应该删除的项目的对象引用。

Boolean — Boolean，指示是否已删除项目。

removeItemAt

()

方法

public function removeItemAt(index:int):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

删除指定索引处的项目并返回该项目。原先位于此索引之后的所有项目的索引现在都向前移动一个位置。

参数

index:int — 要从中删除项目的索引。

Object — 被删除的项目。

引发

RangeError — 如果 index < 0 或 index >= length。

setItemAt

()

方法

public function setItemAt(item:Object, index:int):Object

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将项目置于指定索引处。如果此索引处已存在项目，新项目将替代该项目，并返回该项目。

参数

	`item:Object` — 索引的新值

	`index:int` — 要放置项目的索引位置

Object — 已替换的项目；如果没有项目，则为 null

引发

RangeError — 如果索引小于 0 或大于等于 length

startTrackUpdates

()

方法

protected function startTrackUpdates(item:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果该项是 IEventDispatcher，请观察其更新。此方法是由 addItemAt() 方法在最初指定源时调用的。

参数

item:Object — 传递至 addItemAt() 方法的项。

stopTrackUpdates

()

方法

protected function stopTrackUpdates(item:Object):void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

如果该项是 IEventDispatcher，请停止观察其更新。该方法由 removeItemAt() 和 removeAll() 方法在指定新源之前调用。

参数

item:Object — 传递至 removeItemAt() 方法的项。

toArray

()

方法

public function toArray():Array

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

返回与 IList 实现的填充顺序相同的 Array。

Array — 与 IList 实现的填充顺序相同的 Array。

引发

Error — 如果数据尚未从远程位置完全加载

toString

()

方法

override public function toString():String

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

将此 ArrayList 的内容整齐显示为字符串并将其返回。

String — 包含 ArrayList 内容的 String。

事件详细信息

collectionChange

事件

事件对象类型: mx.events.CollectionEvent
属性 CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 9, AIR 1.1

以某种方式更新 IList 后调度。

CollectionEvent.COLLECTION_CHANGE 常量可为在集合发生更改时调度的事件定义事件对象的 type 属性值。

事件对象的属性具有下列值。并非所有属性对于各种事件都有意义。有关详细信息，请参阅详细的属性说明。

属性	值
`bubbles`	false
`cancelable`	false
`currentTarget`	用于定义处理该事件的事件侦听器的对象。例如，如果您使用 `myButton.addEventListener()` 注册某个事件侦听器，则 myButton 为 `currentTarget` 的值。
`items`	对象 Array，其中包含有关受事件影响的项目的信息。此字段的内容取决于事件的类型；有关详细信息，请参阅 `items` 属性
`kind`	事件的类型。有效值定义为 CollectionEventKind 类中的常量。
`location`	`items` 属性中指定的项目在目标集合中的位置。
`oldLocation`	`items` 属性中指定的项目原来在目标集合中的位置。
`target`	调度该事件的 Object；它不一定是侦听该事件的 Object。使用 `currentTarget` 属性始终可以访问侦听事件的 Object。
`type`	CollectionEvent.COLLECTION_CHANGE

法律声明 | 在线隐私策略

ArrayList - AS3 Flex

包x

语言元素

附录

包 mx.collections

length

source

uid

ArrayList

addAll

addAllAt

addItem

addItemAt

getItemAt

getItemIndex

itemUpdated

itemUpdateHandler

removeAll

removeItem

removeItemAt

setItemAt

startTrackUpdates

stopTrackUpdates

toArray

toString

collectionChange