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

Paket	mx.collections
Schnittstelle	public interface ICollectionView extends IEventDispatcher
Umsetzer	ListCollectionView

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Eine ICollectionView ist eine Ansicht einer Sammlung von Daten. Die Ansicht kann modifiziert werden, um die Daten nach verschiedenen Kriterien sortiert oder durch Filter verringert anzuzeigen, ohne die zugrunde liegenden Daten zu ändern. Ein IViewCursor bietet Zugriff auf Elemente in einer Sammlung. Sie können die Sammlung mithilfe der Methoden insert() und remove() der IViewCursor-Schnittstelle modifizieren.

Eine ICollectionView kann eine Ansicht von Daten sein, die von einer Remote-Position abgerufen wurden. Wenn diese Schnittstelle für Daten implementiert wird, die möglicherweise remote gespeichert sind, muss der Fall berücksichtigt werden, wo Daten ggf. noch nicht verfügbar sind. Dies wird durch ItemPendingError angezeigt.

Die IList-Schnittstelle ist eine Alternative zur ICollectionView-Schnittstelle.

Verwandte API-Elemente

mx.collections.IViewCursor
mx.collections.errors.ItemPendingError
mx.collections.IList

Öffentliche Eigenschaften

	Eigenschaft		Definiert von
		filterFunction : Function Eine Funktion, die von der Ansicht verwendet wird, um Elemente zu entfernen, die die Funktionskriterien nicht erfüllen.	ICollectionView
		length : int [schreibgeschützt] Die Anzahl der Elemente in dieser Ansicht.	ICollectionView
		sort : ISort Das ISort-Objekt, das auf die ICollectionView angewendet wird.	ICollectionView

Ö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
		contains(item:Object):Boolean Gibt zurück, ob die Ansicht das angegebene Objekt enthält.	ICollectionView
		createCursor():IViewCursor Erstellt einen neuen IViewCursor, der mit dieser Ansicht verwendet wird.	ICollectionView
		disableAutoUpdate():void Verhindert, dass Änderungen der Sammlung selbst und Elemente aus der Sammlung von der Ansicht verteilt werden.	ICollectionView
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	IEventDispatcher
		enableAutoUpdate():void Aktiviert die automatische Aktualisierung.	ICollectionView
		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.	ICollectionView
		refresh():Boolean Wendet die Sortierung und den Filter auf die Ansicht an.	ICollectionView
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	IEventDispatcher
		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 ICollectionView auf irgendeine Weise aktualisiert wurde.	ICollectionView

Eigenschaftendetails

filterFunction

Eigenschaft

filterFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Eine Funktion, die von der Ansicht verwendet wird, um Elemente zu entfernen, die die Funktionskriterien nicht erfüllen. Eine filterFunction muss folgende Signatur haben:

f(item:Object):Boolean

Dabei ist der Rückgabewert true, wenn das angegebene Element in der Ansicht beibehalten werden soll.

Wenn ein Filter nicht unterstützt wird, gibt Flex einen Fehler aus, wenn auf diese Eigenschaft zugegriffen wird. Sie müssen refresh() aufrufen, nachdem Sie die filterFunction-Eigenschaft zum Aktualisieren der Ansicht eingerichtet haben.

Hinweis: Die Flex-Implementierungen der ICollectionView rufen alle Elemente von einer Remote-Position ab, bevor die Filterfunktion ausgeführt wird. Wenn Sie Paging verwenden, wenden Sie den Filter auf die Remote-Sammlung an, bevor Sie die Daten abrufen.

Implementierung
public function get filterFunction():Function
public function set filterFunction(value:Function):void

Verwandte API-Elemente

aktualisieren()

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 Ansicht. 0 bedeutet keine Elemente, -1 bedeutet, dass die Länge unbekannt ist.

Implementierung
public function get length():int

sort

Eigenschaft

sort:ISort

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Das ISort-Objekt, das auf die ICollectionView angewendet wird. Durch das Einrichten der Sortierung wird nicht automatisch die Ansicht aktualisiert. Sie müssen die refresh()-Methode nach dem Einrichten dieser Eigenschaft aufrufen. Wenn die Sortierung nicht unterstützt wird, gibt Flex einen Fehler aus, wenn auf diese Eigenschaft zugegriffen wird.

Hinweis: Die Flex-Implementierungen der ICollectionView-Schnittstelle rufen alle Elemente von einer Remote-Position ab, bevor eine Sortierung durchgeführt wird. Wenn Sie bei einer sortierten Liste Paging verwenden, wenden Sie die Sortierung auf die Remote-Sammlung an, bevor Sie die Daten abrufen.

Implementierung
public function get sort():ISort
public function set sort(value:ISort):void

Verwandte API-Elemente

aktualisieren()

Methodendetails

contains

()

Methode

public function contains(item:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt zurück, ob die Ansicht das angegebene Objekt enthält. Im Unterschied zu IViewCursor.findxxx-Methoden ist diese Suche nur erfolgreich, wenn sie ein Element findet, das dem Parameter genau entspricht. Wenn ein Filter auf die Ansicht angewendet wird, kann diese Methode false zurückgeben, selbst wenn die zugrunde liegende Sammlung das Element enthält.

Parameter

item:Object — Das zu suchende Objekt.

Rückgabewerte

Boolean — Ist „true“, wenn die ICollectionView nach dem Anwenden von Filtern das Element enthält, andernfalls „false“.

createCursor

()

Methode

public function createCursor():IViewCursor

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Erstellt einen neuen IViewCursor, der mit dieser Ansicht verwendet wird.

Rückgabewerte

IViewCursor — Eine neue IViewCursor-Implementierung.

disableAutoUpdate

()

Methode

public function disableAutoUpdate():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Verhindert, dass Änderungen der Sammlung selbst und Elemente aus der Sammlung von der Ansicht verteilt werden. Die Methode verhindert auch, dass die Ansicht die Positionen der Elemente aktualisiert, wenn die Positionen in der Sammlung geändert werden. Die Änderungen werden in die Warteschlange geschrieben und nach dem Aufruf von enableAutoUpdate entsprechend verteilt. Wenn mehr Ereignisse als Aktualisierungen an einem einzelnen Element vorgenommen werden, wird die Ansicht möglicherweise zurückgesetzt. Die disableAutoUpdate-Methode agiert kumulativ. Es ist dieselbe Anzahl von enableAutoUpdate-Aufrufen für die Ansicht erforderlich, um Ereignisse zu verteilen und die Ansicht zu aktualisieren. Hinweis: disableAutoUpdate hat nur Auswirkungen auf die einzelne Ansicht. Änderungen können einzeln von anderen Ansichten festgestellt werden.

enableAutoUpdate

()

Methode

public function enableAutoUpdate():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Aktiviert die automatische Aktualisierung. Weitere Informationen finden Sie unter disableAutoUpdate.

Verwandte API-Elemente

disableAutoUpdate()

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. Diese Methode ist nützlich, wenn der Inhalt der Ansicht IPropertyChangeNotifier nicht implementiert. Wenn der Aufruf dieser Methode einen property-Parameter enthält, 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.core.IPropertyChangeNotifier
mx.events.PropertyChangeEvent

refresh

()

Methode

public function refresh():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wendet die Sortierung und den Filter auf die Ansicht an. Die ICollectionView erkennt Änderungen einer Gruppe nicht automatisch. Daher müssen Sie die refresh()-Methode aufrufen, um die Ansicht nach dem Einrichten der Eigenschaften sort oder filterFunction zu aktualisieren. Wenn Ihre ICollectionView-Implementierung auch die IMXMLObject-Schnittstelle implementiert, sollten Sie die refresh()-Methode von der initialized()-Methode aus aufrufen.

Gibt true zurück, wenn die Aktualisierung erfolgreich war und false, wenn die Sortierung noch nicht abgeschlossen wurde (d. h. es stehen noch Elemente aus). Ein Client der Ansicht sollte auf ein CollectionEvent-Ereignis mit der Eigenschaft CollectionEventKind.REFRESH kind warten, um sicherzustellen, dass der refresh()-Vorgang abgeschlossen wurde.

Rückgabewerte

Boolean — true, wenn refresh() abgeschlossen wurde, false, wenn refresh() nicht abgeschlossen wurde.

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 ICollectionView 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

ICollectionView - AS3 Flex

Klassen x

filterFunction

length

sort

contains

createCursor

disableAutoUpdate

enableAutoUpdate

itemUpdated

refresh

collectionChange