| 套件 | mx.collections |
| 介面 | public interface IList extends IEventDispatcher |
| 實作者 | ArrayList, AsyncListView, ListCollectionView, NumericDataProvider |
| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
An IList may be a view onto data
that has been retrieved from a remote location.
When writing for a collection that may be remote,
it is important to handle the case where data
may not yet be available, which is indicated
by the ItemPendingError.
The ICollectionView is an alternative
to the IList.
相關 API 元素
mx.collections.ICollectionView
mx.collections.ListCollectionView
隱藏繼承公用方法
顯示繼承公用方法| 方法 | 定義自 | ||
|---|---|---|---|
 | addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
會在 EventDispatcher 物件註冊事件偵聽程式，以便讓偵聽程式收到事件的通知。 | IEventDispatcher | |
Adds the specified item to the end of the list. | IList | ||
Adds the item at the specified index. | IList | ||
|
會將事件傳送到事件流程。 | IEventDispatcher | |
Gets the item at the specified index. | IList | ||
Returns the index of the item if it is in the list such that
getItemAt(index) == item. | IList | ||
|
會檢查 EventDispatcher 物件是否有對特定的事件類型註冊偵聽程式。 | IEventDispatcher | |
itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void
Notifies the view that an item has been updated. | IList | ||
Removes all items from the list. | IList | ||
|
會從 EventDispatcher 物件移除偵聽程式。 | IEventDispatcher | |
Removes the item at the specified index and returns it. | IList | ||
Places the item at the specified index. | IList | ||
Returns an Array that is populated in the same order as the IList
implementation. | IList | ||
|
檢查此 EventDispatcher 物件是否已註冊事件偵聽程式，或者此物件的任何祖系已為特定事件類型註冊事件偵聽程式。 | IEventDispatcher | |
| 事件 | 摘要 | 定義自 | ||
|---|---|---|---|---|
| Dispatched when the IList has been updated in some way. | IList | |||
length | 屬性 |
addItem | () | 方法 |
addItemAt | () | 方法 |
public function addItemAt(item:Object, index:int):void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Adds the item at the specified index. The index of any item greater than the index of the added item is increased by one. If the the specified index is less than zero or greater than the length of the list, a RangeError is thrown.
參數
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 of the list.
|
getItemAt | () | 方法 |
public function getItemAt(index:int, prefetch:int = 0):Object| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Gets 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 number of items to fetch during the request if the item is
not local.
|
Object — The item at that index, or null if there is none.
|
擲回值
ItemPendingError — if the data for that index needs to be
loaded from a remote location.
| |
RangeError — if index < 0
or index >= length.
|
getItemIndex | () | 方法 |
public function getItemIndex(item:Object):int| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Returns the index of the item if it is in the list such that getItemAt(index) == item.
Note: unlike IViewCursor.findxxx() methods,
The getItemIndex() method cannot take a parameter with
only a subset of the fields in the item being serched for;
this method always searches for an item that exactly matches
the input parameter.
參數
item:Object — The item to find.
|
int — The index of the item, or -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 |
Notifies the view that an item has been updated.
This is useful if the contents of the view do not implement
IEventDispatcher and dispatches a
PropertyChangeEvent.
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) | |
oldValue:Object (default = null) | |
newValue:Object (default = null) |
相關 API 元素
removeAll | () | 方法 |
public function removeAll():void| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Removes all items from the list.
If any item is not local and an asynchronous operation must be
performed, an ItemPendingError will be thrown.
See the ItemPendingError documentation as well as
the collections documentation for more information
on using the ItemPendingError.
removeItemAt | () | 方法 |
public function removeItemAt(index:int):Object| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Removes the item at the specified index and returns 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 — is index is less than 0 or greater than length.
|
setItemAt | () | 方法 |
public function setItemAt(item:Object, index:int):Object| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Places 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 item to be placed at the specified index.
| |
index:int — The index at which to place the item.
|
Object — The item that was replaced, or null if none.
|
擲回值
RangeError — if index is less than 0 or greater than length.
|
toArray | () | 方法 |
public function toArray():Array| 語言版本: | ActionScript 3.0 |
| 產品版本: | Flex 3 |
| 執行階段版本: | Flash Player 9, AIR 1.1 |
Returns an Array that is populated in the same order as the IList implementation. This method can throw an ItemPendingError.
傳回值Array — The array.
|
擲回值
ItemPendingError — If the data is not yet completely loaded
from a remote location.
|
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 thetype 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 |
Tue Jun 12 2018, 03:47 PM Z