ArrayList

套件	mx.collections
類別	public class ArrayList
繼承	ArrayList EventDispatcher Object
實作	IList, IExternalizable, IPropertyChangeNotifier
子類別	Conflicts

語言版本:

ActionScript 3.0

產品版本:

Flex 4

執行階段版本:

Flash Player 10, AIR 1.5

The ArrayList class is a simple implementation of IList that uses a backing Array as the source of the data. Items in the backing Array can be accessed and manipulated using the methods and properties of the IList interface. Operations on an ArrayList instance modify the data source; for example, if you use the removeItemAt() method on an ArrayList, you remove the item from the underlying Array. This base class will not throw ItemPendingErrors but it is possible that a subclass might.

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

預設 MXML 屬性source

公用屬性

隱藏繼承公用屬性

顯示繼承公用屬性

	屬性		定義自
		constructor : Object 類別物件的參照或是特定物件實體的建構函數。	Object
		length : int [唯讀] Get the number of items in the list.	ArrayList
		source : Array The source array for this ArrayList.	ArrayList
		uid : String Provides access to the unique id for this list.	ArrayList

公用方法

隱藏繼承公用方法

顯示繼承公用方法

	方法		定義自
		ArrayList(source:Array = null) Construct a new ArrayList using the specified array as its source.	ArrayList
		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.	ArrayList
		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.	ArrayList
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。	EventDispatcher
		addItem(item:Object):void Add the specified item to the end of the list.	ArrayList
		addItemAt(item:Object, index:int):void Add the item at the specified index.	ArrayList
		dispatchEvent(event:Event):Boolean 會將事件傳送到事件流程。	EventDispatcher
		getItemAt(index:int, prefetch:int = 0):Object Get the item at the specified index.	ArrayList
		getItemIndex(item:Object):int Return the index of the item if it is in the list such that 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 Notify the view that an item has been updated.	ArrayList
		propertyIsEnumerable(name:String):Boolean 指出指定的屬性是否存在，以及是否可列舉。	Object
		removeAll():void Remove all items from the list.	ArrayList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 會從 EventDispatcher 物件移除偵聽程式。	EventDispatcher
		removeItem(item:Object):Boolean Removes the specified item from this list, should it exist.	ArrayList
		removeItemAt(index:int):Object Remove the item at the specified index and return it.	ArrayList
		setItemAt(item:Object, index:int):Object Place the item at the specified index.	ArrayList
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void 為迴圈作業設定動態屬性的可用性。	Object
		toArray():Array Return an Array that is populated in the same order as the IList implementation.	ArrayList
		toLocaleString():String 傳回代表此物件的字串，根據地區特定慣例進行格式化。	Object
		toString():String [覆寫] Pretty prints the contents of this ArrayList to a string and returns it.	ArrayList
		valueOf():Object 會傳回指定之物件的基本值。	Object
		willTrigger(type:String):Boolean 檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。	EventDispatcher

保護方法

	方法		定義自
		itemUpdateHandler(event:PropertyChangeEvent):void Called when any of the contained items in the list dispatch an ObjectChange event.	ArrayList
		startTrackUpdates(item:Object):void If the item is an IEventDispatcher, watch it for updates.	ArrayList
		stopTrackUpdates(item:Object):void If the item is an IEventDispatcher, stop watching it for updates.	ArrayList

事件

按一下以瞭解事件的詳細資訊

隱藏繼承事件

顯示繼承事件

	摘要	定義自
activate	[廣播事件] 當 Flash Player 或 AIR 應用程式取得作業系統焦點並成為作用中時傳送。	EventDispatcher
collectionChange	Dispatched when the IList has been updated in some way.	ArrayList
deactivate	[廣播事件] 當 Flash Player 或 AIR 應用程式失去作業系統焦點並成為非作用中時傳送。	EventDispatcher

屬性詳細資訊

length

屬性

length:int [唯讀]

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Get the number of items in the list. An ArrayList should always know its length so it shouldn't return -1, though a subclass may override that behavior.

此屬性可以做為資料繫結的來源。一旦修改此屬性，將傳送 collectionChange 事件。

實作
public function get length():int

source

屬性

source:Array

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

The source array for this ArrayList. Any changes done through the IList interface will be reflected in the source array. If no source array was supplied the ArrayList will create one internally. Changes made directly to the underlying Array (e.g., calling theList.source.pop() will not cause CollectionEvents to be dispatched.

實作
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

Provides access to the unique id for this list.

實作
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

Construct a new ArrayList using the specified array as its source. If no source is specified an empty array will be used.

參數

source:Array (default = null) — The Array to use as a source for the ArrayList.

方法詳細資訊

addAll

()

方法

public function addAll(addList:IList):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Adds a list of items to the current list, placing them at the end of the list in the order they are passed.

參數

addList:IList — The list of items to add to the current list

addAllAt

()

方法

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Adds a list of items to the current list, placing them at the position index passed in to the function. The items are placed at the index location and placed in the order they are recieved.

參數

	`addList:IList` — The list of items to add to the current list

	`index:int` — The location of the current list to place the new items.

addItem

()

方法

public function addItem(item:Object):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Add the specified item to the end of the list. Equivalent to addItemAt(item, length);

參數

item:Object — the item to add

addItemAt

()

方法

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Add the item at the specified index. Any item that was after this index is moved out by one.

參數

	`item:Object` — the item to place at the index

	`index:int` — the index at which to place the item

擲回值

RangeError — if index is less than 0 or greater than the length

getItemAt

()

方法

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Get the item at the specified index.

參數

	`index:int` — the index in the list from which to retrieve the item

	`prefetch:int` (default = `0`) — int indicating both the direction and amount of items to fetch during the request should the item not be local.

傳回值

Object — the item at that index, null if there is none

擲回值

	`Error` — if the data for that index needs to be loaded from a remote location

	`RangeError` — if the index < 0 or index >= length

getItemIndex

()

方法

public function getItemIndex(item:Object):int

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Return the index of the item if it is in the list such that getItemAt(index) == item. Note that in this implementation the search is linear and is therefore O(n).

參數

item:Object — the item to find

傳回值

int — the index of the item, -1 if the item is not in the list.

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

Notify the view that an item has been updated. This is useful if the contents of the view do not implement IEventDispatcher. If a property is specified the view may be able to optimize its notification mechanism. Otherwise it may choose to simply refresh the whole view.

參數

	`item:Object` — The item within the view that was updated.

	`property:Object` (default = `null`) — A String, QName, or int specifying the property that was updated.

	`oldValue:Object` (default = `null`) — The old value of that property. (If property was null, this can be the old value of the item.)

	`newValue:Object` (default = `null`) — The new value of that property. (If property was null, there's no need to specify this as the item is assumed to be the new value.)

itemUpdateHandler

()

方法

protected function itemUpdateHandler(event:PropertyChangeEvent):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Called when any of the contained items in the list dispatch an ObjectChange event. Wraps it in a CollectionEventKind.UPDATE object.

參數

event:PropertyChangeEvent — The event object for the ObjectChange event.

removeAll

()

方法

public function removeAll():void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Remove all items from the list.

removeItem

()

方法

public function removeItem(item:Object):Boolean

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Removes the specified item from this list, should it exist.

參數

item:Object — Object reference to the item that should be removed.

傳回值

Boolean — Boolean indicating if the item was removed.

removeItemAt

()

方法

public function removeItemAt(index:int):Object

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Remove the item at the specified index and return it. Any items that were after this index are now one index earlier.

參數

index:int — The index from which to remove the item.

傳回值

Object — The item that was removed.

擲回值

RangeError — if index < 0 or index >= length.

setItemAt

()

方法

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

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Place the item at the specified index. If an item was already at that index the new item will replace it and it will be returned.

參數

	`item:Object` — the new value for the index

	`index:int` — the index at which to place the item

傳回值

Object — the item that was replaced, null if none

擲回值

RangeError — if index is less than 0 or greater than or equal to length

startTrackUpdates

()

方法

protected function startTrackUpdates(item:Object):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

If the item is an IEventDispatcher, watch it for updates. This method is called by the addItemAt() method, and when the source is initially assigned.

參數

item:Object — The item passed to the addItemAt() method.

stopTrackUpdates

()

方法

protected function stopTrackUpdates(item:Object):void

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

If the item is an IEventDispatcher, stop watching it for updates. This method is called by the removeItemAt() and removeAll() methods, and before a new source is assigned.

參數

item:Object — The item passed to the removeItemAt() method.

toArray

()

方法

public function toArray():Array

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Return an Array that is populated in the same order as the IList implementation.

傳回值

Array — An Array populated in the same order as the IList implementation.

擲回值

Error — if the data is not yet completely loaded from a remote location

toString

()

方法

override public function toString():String

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Pretty prints the contents of this ArrayList to a string and returns it.

傳回值

String — A String containing the contents of the ArrayList.

事件詳細資訊

collectionChange

事件

事件物件類型: mx.events.CollectionEvent
屬性 CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

語言版本:

ActionScript 3.0

產品版本:

Flex 3

執行階段版本:

Flash Player 9, AIR 1.1

Dispatched when the IList has been updated in some way.

The CollectionEvent.COLLECTION_CHANGE constant defines the value of the type property of the event object for an event that is dispatched when a collection has changed.

The properties of the event object have the following values. Not all properties are meaningful for all kinds of events. See the detailed property descriptions for more information.

Property	Value
`bubbles`	false
`cancelable`	false
`currentTarget`	The Object that defines the event listener that handles the event. For example, if you use `myButton.addEventListener()` to register an event listener, myButton is the value of the `currentTarget`.
`items`	An Array of objects with information about the items affected by the event. The contents of this field depend on the event kind; for details see the `items` property
`kind`	The kind of event. The valid values are defined in the CollectionEventKind class as constants.
`location`	Location within the target collection of the item(s) specified in the `items` property.
`oldLocation`	the previous location in the collection of the item specified in the `items` property.
`target`	The Object that dispatched the event; it is not always the Object listening for the event. Use the `currentTarget` property to always access the Object listening for the event.
`type`	CollectionEvent.COLLECTION_CHANGE

法律聲明 | 線上隱私權政策

ArrayList - AS3 Flex

類別 x

length

source

uid

ArrayList

addAll

addAllAt

addItem

addItemAt

getItemAt

getItemIndex

itemUpdated

itemUpdateHandler

removeAll

removeItem

removeItemAt

setItemAt

startTrackUpdates

stopTrackUpdates

toArray

toString

collectionChange