IList - Adobe ActionScript® 3 (AS3 Flex) API-Referenz

Paket	mx.collections
Schnittstelle	public interface IList extends IEventDispatcher
Umsetzer	ArrayList, AsyncListView, ListCollectionView, NumericDataProvider

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Eine ordinal angelegte Sammlung von Elementen. Sie stellt Methoden für den Zugriff und die Änderung basierend auf dem Index bereit.

Eine IList kann eine Ansicht von Daten sein, die von einer Remote-Position abgerufen wurden. Wenn eine Sammlung, die möglicherweise remote ist, bearbeitet wird, muss der Fall behandelt werden, dass Daten noch nicht verfügbar sind. Dies wird von ItemPendingError angezeigt.

Die ICollectionView-Instanz ist eine Alternative zu IList.

Verwandte API-Elemente

mx.collections.errors.ItemPendingError
mx.collections.ICollectionView
mx.collections.ListCollectionView

Öffentliche Eigenschaften

	Eigenschaft		Definiert von
		length : int [schreibgeschützt] Die Anzahl der Elemente in dieser Sammlung.	IList

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void Registriert ein Ereignis-Listener-Objekt bei einem EventDispatcher-Objekt, sodass der Listener über ein Ereignis benachrichtigt wird.	IEventDispatcher
		addItem(item:Object):void Fügt das angegebene Element am Ende der Liste hinzu.	IList
		addItemAt(item:Object, index:int):void Fügt das Element an der angegebenen Indexposition hinzu.	IList
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	IEventDispatcher
		getItemAt(index:int, prefetch:int = 0):Object Ruft das Element am angegebenen Index ab.	IList
		getItemIndex(item:Object):int Gibt den Index des Elements zurück, wenn es in der Liste enthalten ist, sodass gilt: getItemAt(Index) == Element.	IList
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	IEventDispatcher
		itemUpdated(item:Object, property:Object = null, oldValue:Object = null, newValue:Object = null):void Informiert die Ansicht darüber, dass ein Element aktualisiert wurde.	IList
		removeAll():void Entfernt alle Elemente aus der Liste.	IList
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	IEventDispatcher
		removeItemAt(index:int):Object Entfernt das Element am angegebenen Index und gibt es zurück.	IList
		setItemAt(item:Object, index:int):Object Platziert das Element am angegebenen Index.	IList
		toArray():Array Gibt ein Array zurück, das in derselben Reihenfolge gefüllt wird wie die IList-Implementierung.	IList
		willTrigger(type:String):Boolean Überprüft, ob bei diesem EventDispatcher-Objekt oder bei einem seiner Vorgänger ein Ereignis-Listener für einen bestimmten Ereignistyp registriert ist.	IEventDispatcher

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

	Ereignis		Übersicht	Definiert von
		collectionChange	Wird ausgelöst, wenn IList auf irgendeine Weise aktualisiert wurde.	IList

Eigenschaftendetails

length

Eigenschaft

length:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die Anzahl der Elemente in dieser Sammlung. 0 bedeutet keine Elemente, -1 bedeutet, dass die Länge unbekannt ist.

Implementierung
public function get length():int

Methodendetails

addItem

()

Methode

public function addItem(item:Object):void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Fügt das angegebene Element am Ende der Liste hinzu. Entspricht addItemAt(item, length).

Parameter

item:Object — Das hinzuzufügende Element.

addItemAt

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Fügt das Element an der angegebenen Indexposition hinzu. Der Index eines Elements, der größer als der Index des hinzugefügten Element ist, wird um 1 erhöht. Wenn der angegebene Index kleiner als 0 oder größer als die Länge der Liste ist, wird ein RangeError ausgegeben.

Parameter

	`item:Object` — Das Element, das an die Indexposition platziert werden soll.

	`index:int` — Die Indexposition, an der das Element platziert werden soll.

Auslöser

RangeError — Wenn der Index kleiner als 0 oder größer als die Länge der Liste ist.

getItemAt

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Ruft das Element am angegebenen Index ab.

Parameter

	`index:int` — Die Indexposition in der Liste, aus der das Element abgerufen werden soll.

	`prefetch:int` (default = `0`) — Ein `int`-Wert, der sowohl die Richtung als auch die Anzahl von Elementen angibt, die während der Anforderung abgerufen werden sollen, wenn das Element nicht lokal ist.

Rückgabewerte

Object — Das Element an diesem Index oder null, wenn keines vorhanden ist.

Auslöser

	`ItemPendingError` — Wenn die Daten für diesen Index von einem Remote-Speicherort geladen werden müssen.

	`RangeError` — Wenn `index < 0` oder `index >= length`.

getItemIndex

()

Methode

public function getItemIndex(item:Object):int

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt den Index des Elements zurück, wenn es in der Liste enthalten ist, sodass gilt: getItemAt(Index) == Element.

Hinweis: Im Unterschied zu IViewCursor.findxxx()-Methoden kann die getItemIndex()-Methode keine Parameter mit einer Untergruppe der Felder im gesuchten Element verwenden. Diese Methode sucht immer nach einem Element, das genau dem Eingabeparameter entspricht.

Parameter

item:Object — Das zu suchende Element.

Rückgabewerte

int — Der Index des Elements oder -1, wenn das Element nicht in der Liste enthalten ist.

itemUpdated

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Informiert die Ansicht darüber, dass ein Element aktualisiert wurde. Dies ist nützlich, wenn der Inhalt der Ansicht IEventDispatcher nicht implementiert und ein PropertyChangeEvent auslöst. Wenn eine Eigenschaft angegeben wird, kann die Ansicht möglicherweise ihre Benachrichtigungsfunktion optimieren. Andernfalls wird möglicherweise einfach die gesamte Ansicht aktualisiert.

Parameter

	`item:Object` — Das Element in der Ansicht, die aktualisiert wurde.

	`property:Object` (default = `null`) — Der Name der Eigenschaft, die aktualisiert wurde.

	`oldValue:Object` (default = `null`) — Der alte Wert dieser Eigenschaft. (Wenn die Eigenschaft „null“ war, kann dies der alte Wert des Elements sein.)

	`newValue:Object` (default = `null`) — Der neue Wert dieser Eigenschaft. (Wenn die Eigenschaft „null“ war, muss der Wert nicht angegeben werden, da davon ausgegangen wird, dass das Element den neuen Wert hat.)

Verwandte API-Elemente

mx.events.CollectionEvent
mx.events.PropertyChangeEvent

removeAll

()

Methode

public function removeAll():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Entfernt alle Elemente aus der Liste.

Wenn ein Element nicht lokal ist und ein asynchroner Vorgang ausgeführt werden muss, wird ein ItemPendingError ausgegeben.

Weitere Informationen zur Verwendung von ItemPendingError finden Sie in der ItemPendingError-Dokumentation und der Dokumentation zu den Sammlungen.

removeItemAt

()

Methode

public function removeItemAt(index:int):Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Entfernt das Element an der angegebenen Indexposition und gibt es zurück. Alle Elemente, die sich nach diesem Index befanden, sind nun um eine Indexposition weiter vorne.

Parameter

index:int — Die Indexposition, an der das Element entfernt werden soll.

Rückgabewerte

Object — Das entfernte Element.

Auslöser

RangeError — Wenn der Index kleiner als 0 oder größer als die Länge ist.

setItemAt

()

Methode

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

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Platziert das Element am angegebenen Index. Wenn sich bereits ein Element an diesem Index befand, wird es vom neuen Element ersetzt und zurückgegeben.

Parameter

	`item:Object` — Das neue Element, das am angegebenen Index platziert werden soll.

	`index:int` — Die Indexposition, an der das Element platziert werden soll.

Rückgabewerte

Object — Das Element, das ersetzt wurde, oder null, wenn keines ersetzt wurde.

Auslöser

RangeError — Wenn der Index kleiner als 0 oder größer als die Länge ist.

toArray

()

Methode

public function toArray():Array

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt ein Array zurück, das in derselben Reihenfolge gefüllt wird wie die IList-Implementierung. Diese Methode kann einen ItemPendingError ausgeben.

Rückgabewerte

Array — Anschließend wird das Array.

Auslöser

ItemPendingError — Wenn die Daten noch nicht vollständig von einem Remote-Speicherort geladen wurden.

Ereignisdetails

collectionChange

Ereignis

Ereignisobjekttyp: mx.events.CollectionEvent
Eigenschaft CollectionEvent.type = mx.events.CollectionEvent.COLLECTION_CHANGE

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wird ausgelöst, wenn IList auf irgendeine Weise aktualisiert wurde.

Die CollectionEvent.COLLECTION_CHANGE-Konstante definiert den Wert der type-Eigenschaft des Ereignisobjekts für ein Ereignis, das ausgelöst wird, wenn eine Sammlung geändert wird.

Die Eigenschaften des Ereignisobjekts haben die folgenden Werte. Nicht alle Eigenschaften sind für alle Ereignistypen sinnvoll. Weitere Informationen finden Sie in den ausführlichen Eigenschaftsbeschreibungen.

Eigenschaft	Wert
`bubbles`	false
`cancelable`	false
`currentTarget`	Das Objekt, das den Ereignis-Listener definiert, der das Ereignis übernimmt. Wenn Sie beispielsweise `myButton.addEventListener()` zur Registrierung eines Ereignis-Listeners verwenden, weist `currentTarget` den Wert „myButton“ auf.
`items`	Ein Array von Objekten mit Informationen zu den Elementen, die von dem Ereignis betroffen sind. Die Inhalte in diesem Feld hängen von der Art des Ereignisses ab; weitere Informationen finden Sie im Abschnitt zur `items`-Eigenschaft.
`kind`	Die Art des Ereignisses. Die gültigen Werte werden in der CollectionEventKind-Klasse als Konstanten definiert.
`location`	Position in der Zielsammlung der Elemente, die in der `items`-Eigenschaft angegebenen sind.
`oldLocation`	Die vorherige Position in der Sammlung des Elements, das in der `items`-Eigenschaft angegebenen ist.
`target`	Das Objekt, von dem das Ereignis ausgelöst wurde. Dies ist nicht immer das Objekt, das auf das Ereignis wartet. Verwenden Sie die `currentTarget`-Eigenschaft, damit immer auf das Objekt, das auf das Ereignis wartet, zugegriffen wird.
`type`	CollectionEvent.COLLECTION_CHANGE

Rechtliche Hinweise | Onlinedatenschutzerklärung

IList - AS3 Flex

Klassen x

length

addItem

addItemAt

getItemAt

getItemIndex

itemUpdated

removeAll

removeItemAt

setItemAt

toArray

collectionChange