HierarchicalCollectionViewCursor

Paket	mx.collections
Klasse	public class HierarchicalCollectionViewCursor
Vererbung	HierarchicalCollectionViewCursor EventDispatcher Object
Implementiert	IHierarchicalCollectionViewCursor

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die HierarchicalCollectionViewCursor-Klasse definiert einen Cursor für eine hierarchische Ansicht einer Standardsammlung. Die Sammlung, die dieser Cursor durchläuft, muss nicht hierarchisch sein, sondern kann auch flach sein. Diese Klasse delegiert an die IHierarchicalData-Klasse für Informationen hinsichtlich der Baumstruktur der Daten, die durchlaufen werden.

Verwandte API-Elemente

HierarchicalCollectionView

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		afterLast : Boolean [schreibgeschützt] Wenn der Cursor sich hinter dem letzten Element in der Ansicht befindet, ist diese Eigenschaft „true“.	HierarchicalCollectionViewCursor
		beforeFirst : Boolean [schreibgeschützt] Wenn der Cursor sich vor dem ersten Element in der Ansicht befindet, ist diese Eigenschaft „true“.	HierarchicalCollectionViewCursor
		bookmark : CursorBookmark [schreibgeschützt] Bietet Zugriff auf ein Lesezeichen, das dem von der aktuellen Eigenschaft zurückgegebenen Element entspricht.	HierarchicalCollectionViewCursor
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		current : Object [schreibgeschützt] Bietet Zugriff auf das Objekt an der Position in der Quellsammlung, die von diesem Cursor referenziert wird.	HierarchicalCollectionViewCursor
		currentDepth : int [schreibgeschützt] Enthält die Tiefe des Knotens an der Position in der Quellsammlung, die von diesem Cursor referenziert wird.	HierarchicalCollectionViewCursor
		view : ICollectionView [schreibgeschützt] Ein Verweis auf die ICollectionView, der dieser Cursor zugeordnet ist.	HierarchicalCollectionViewCursor

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData) Konstruktor.	HierarchicalCollectionViewCursor
		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.	EventDispatcher
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		findAny(values:Object):Boolean Sucht in der Sammlung ein Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element.	HierarchicalCollectionViewCursor
		findFirst(values:Object):Boolean Sucht in der Sammlung das erste Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element.	HierarchicalCollectionViewCursor
		findLast(values:Object):Boolean Sucht in der Sammlung das letzte Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element.	HierarchicalCollectionViewCursor
		hasEventListener(type:String):Boolean Überprüft, ob das EventDispatcher-Objekt Listener für einen bestimmten Ereignistyp registriert hat.	EventDispatcher
		hasOwnProperty(name:String):Boolean Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.	Object
		insert(item:Object):void Fügt das angegebene Element vor der aktuellen Cursor-Position ein.	HierarchicalCollectionViewCursor
		isPrototypeOf(theClass:Object):Boolean Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.	Object
		moveNext():Boolean Verschiebt den Cursor auf das nächste Element in der Sammlung.	HierarchicalCollectionViewCursor
		movePrevious():Boolean Verschiebt den Cursor auf das vorherige Element in der Sammlung.	HierarchicalCollectionViewCursor
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		remove():Object Entfernt das aktuelle Elemente und gibt es zurück.	HierarchicalCollectionViewCursor
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void Verschiebt den Cursor an eine Position an einem Offset vom angegebenen Lesezeichen.	HierarchicalCollectionViewCursor
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.	Object
		toLocaleString():String Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.	Object
		toString():String Gibt das angegebene Objekt als String zurück.	Object
		valueOf():Object Gibt den Grundwert des angegebenen Objekts zurück.	Object
		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.	EventDispatcher

Ereignisse

Klicken Sie, um weitere Informationen zu Ereignissen zu erhalten.

Vererbte Ereignisse ausblenden

Vererbte Ereignisse anzeigen

	Ereignis		Übersicht	Definiert von
		activate	[broadcast event] Wird ausgelöst, wenn Flash Player oder eine AIR-Anwendung den Betriebssystemfokus erhält und aktiv wird.	EventDispatcher
		deactivate	[broadcast event] Wird ausgelöst, wenn Flash Player- oder die AIR-Anwendung den Fokus verliert und inaktiv wird.	EventDispatcher

Eigenschaftendetails

afterLast

Eigenschaft

afterLast:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wenn der Cursor sich hinter dem letzten Element in der Ansicht befindet, ist diese Eigenschaft true. Wenn die ICollectionView leer ist (length == 0), ist diese Eigenschaft true.

Implementierung
public function get afterLast():Boolean

beforeFirst

Eigenschaft

beforeFirst:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wenn der Cursor sich vor dem ersten Element in der Ansicht befindet, ist diese Eigenschaft true. Wenn die ICollectionView leer ist (length == 0), ist diese Eigenschaft true.

Implementierung
public function get beforeFirst():Boolean

bookmark

Eigenschaft

bookmark:CursorBookmark [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Bietet Zugriff auf ein Lesezeichen, das dem von der current-Eigenschaft zurückgegebenen Element entspricht. Das Lesezeichen kann verwendet werden, um den Cursor an ein zuvor besuchtes Element oder eine Position relativ zu diesem Element zu verschieben. (Weitere Informationen finden Sie unter der seek()-Methode.)

Implementierung
public function get bookmark():CursorBookmark

current

Eigenschaft

current:Object [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Bietet Zugriff auf das Objekt an der Position in der Quellsammlung, die von diesem Cursor referenziert wird. Wenn der Cursor sich hinter dem Ende der Sammlung befindet (beforeFirst, afterLast) wird null zurückgegeben.

Implementierung
public function get current():Object

currentDepth

Eigenschaft

currentDepth:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Enthält die Tiefe des Knotens an der Position in der Quellsammlung, die von diesem Cursor referenziert wird. Wenn der Cursor sich hinter dem Ende der Sammlung befindet, enthält diese Eigenschaft 0.

Implementierung
public function get currentDepth():int

view

Eigenschaft

view:ICollectionView [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Ein Verweis auf die ICollectionView, der dieser Cursor zugeordnet ist.

Implementierung
public function get view():ICollectionView

Konstruktordetails

()

Konstruktor

public function HierarchicalCollectionViewCursor(collection:HierarchicalCollectionView, model:ICollectionView, hierarchicalData:IHierarchicalData)

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Konstruktor.

Parameter

	`collection:HierarchicalCollectionView` — Die von diesem Cursor referenzierte HierarchicalCollectionView-Instanz.

	`model:ICollectionView` — Die Quelldatensammlung.

	`hierarchicalData:IHierarchicalData` — Die Daten, die zum Erstellen der HierarchicalCollectionView-Instanz verwendet werden.

Methodendetails

findAny

()

Methode

public function findAny(values:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Sucht in der Sammlung ein Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element. Wenn das Element nicht gefunden wird, ändert sich die Cursorposition nicht.

Die findAny()-Methode kann nur für sortierte Ansichten aufgerufen werden. Wenn die Ansicht nicht sortiert ist, wird ein CursorError ausgegeben.

Wenn die zugehörige Sammlung remote ist und nicht alle Elemente lokal zwischengespeichert wurden, beginnt diese Methode einen asynchronen Abruf aus der Remote-Sammlung. Wenn bereits ein Abruf ausgeführt wird, wartet diese Methode, bis der Abruf beendet wurde, bevor eine weitere Abrufanforderung gestellt wird.

Wenn mehrere Elemente die Suchkriterien erfüllen, ist das gefundene Elemente nicht-deterministisch. Wenn es wichtig ist, das erste oder letzte Vorkommen eines Elements in einem nicht eindeutigen Index zu finden, verwenden Sie die findFirst()- oder findLast()-Methode.

Wenn die Daten nicht lokal sind und ein asynchroner Vorgang ausgeführt werden muss, wird ein ItemPendingError ausgegeben.

Parameter

values:Object — Die Suchkriterien. Die Werte im Objekt müssen als Name/Wert-Paare konfiguriert sein, wie in einem assoziativen Array (oder sie sind das zu suchende Objekt selbst). Die Werte der angegebenen Namen müssen Eigenschaften entsprechen, die für die Sortierung angegeben wurden. Beispiel: Wenn die Eigenschaften x, y und z in der aktuellen Sortierung enthalten sind, sollten die angegebenen Werte {x: x-value, y: y-value, z: z-value} sein.

Rückgabewerte

Boolean — Wenn alle Daten lokal sind, gibt diese Methode true zurück, falls das Element gefunden werden kann, andernfalls false.

findFirst

()

Methode

public function findFirst(values:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Sucht in der Sammlung das erste Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element. Wenn das Element nicht gefunden wird, ändert sich die Cursorposition nicht.

Die findFirst()-Methode kann nur für sortierte Ansichten aufgerufen werden. Wenn die Ansicht nicht sortiert ist, wird ein CursorError ausgegeben.

Wenn es nicht wichtig ist, das erste Vorkommen eines Elements in einem nicht eindeutigen Index zu finden, verwenden Sie die findAny()-Methode, die möglicherweise ein wenig schneller ist als die findFirst()-Methode.

Wenn die Daten nicht lokal sind und ein asynchroner Vorgang ausgeführt werden muss, wird ein ItemPendingError ausgegeben.

Parameter

Rückgabewerte

Boolean — Wenn alle Daten lokal sind, gibt diese Methode true zurück, falls das Element gefunden werden kann, andernfalls false.

findLast

()

Methode

public function findLast(values:Object):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Sucht in der Sammlung das letzte Element mit den angegebenen Eigenschaften und platziert den Cursor auf diesem Element. Wenn das Element nicht gefunden wird, ändert sich die Cursorposition nicht.

Die findLast()-Methode kann nur für sortierte Ansichten aufgerufen werden. Wenn die Ansicht nicht sortiert ist, wird ein CursorError ausgegeben.

Wenn es nicht wichtig ist, das letzte Vorkommen eines Elements in einem nicht eindeutigen Index zu finden, verwenden Sie die findAny()-Methode, die möglicherweise ein wenig schneller ist.

Wenn die Daten nicht lokal sind und ein asynchroner Vorgang ausgeführt werden muss, wird ein ItemPendingError ausgegeben.

Parameter

Rückgabewerte

Boolean — Wenn alle Daten lokal sind, gibt diese Methode true zurück, falls das Element gefunden werden kann, andernfalls false.

insert

()

Methode

public function insert(item:Object):void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Fügt das angegebene Element vor der aktuellen Cursor-Position ein. Wenn der Cursor afterLast ist, erfolgt die Einfügung am Ende der Ansicht. Wenn der Cursor bei einer nicht leeren Ansicht beforeFirst ist, wird ein Fehler ausgegeben.

Parameter

item:Object — Das Element, das vor der aktuellen Cursor-Position eingefügt werden soll.

moveNext

()

Methode

public function moveNext():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Verschiebt den Cursor auf das nächste Element in der Sammlung. Bei Erfolg wird die Eigenschaft current aktualisiert, um das Objekt an dieser neuen Position zu referenzieren. Gibt true zurück, wenn die resultierende Eigenschaft current gültig ist, andernfalls false (der Eigenschaftswert ist afterLast).

Wenn die Daten nicht lokal sind 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.

Rückgabewerte

Boolean — true, wenn noch in der Liste, false, wenn current ursprünglich den Wert afterLast hatte oder diesen Wert aktuell hat.

movePrevious

()

Methode

public function movePrevious():Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Verschiebt den Cursor auf das vorherige Element in der Sammlung. Bei Erfolg wird die Eigenschaft current aktualisiert, um das Objekt an dieser neuen Position zu referenzieren. Gibt true zurück, wenn die resultierende Eigenschaft current gültig ist, andernfalls false (der Eigenschaftswert ist beforeFirst).

Rückgabewerte

Boolean — true, wenn noch in der Liste, false, wenn current ursprünglich den Wert beforeFirst hatte oder diesen Wert aktuell hat. Beispiel:

      var myArrayCollection:ICollectionView = new ArrayCollection([ "Bobby", "Mark", "Trevor", "Jacey", "Tyler" ]);
      var cursor:IViewCursor = myArrayCollection.createCursor();
      cursor.seek(CursorBookmark.last);
      while (!cursor.beforeFirst)
      {
          trace(current);
          cursor.movePrevious();
      }

remove

()

Methode

public function remove():Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Entfernt das aktuelle Elemente und gibt es zurück. Wenn die Cursorposition beforeFirst oder afterLast ist, gibt die Methode einen CursorError aus. Wenn Sie ein anderes Element als das letzte Element entfernen, wird der Cursor zum nächsten Element verschoben. Wenn Sie das letzte Element entfernen, befindet sich der Cursor beim AFTER_LAST-Lesezeichen.

Wenn die Daten nach dem entfernten Element nicht lokal sind 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.

Rückgabewerte

Object — Das entfernte Element.

seek

()

Methode

public function seek(bookmark:CursorBookmark, offset:int = 0, prefetch:int = 0):void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Verschiebt den Cursor an eine Position an einem Offset vom angegebenen Lesezeichen. Der Offset kann negativ sein. In diesem Fall wird der Cursor um die in offset angegebene Anzahl von Elementen vor dem angegebenen Lesezeichen platziert.

Wenn die zugehörige Sammlung remote ist und nicht alle Elemente lokal zwischengespeichert wurden, beginnt diese Methode einen asynchronen Abruf aus der Remote-Sammlung.

Parameter

	`bookmark:CursorBookmark` — `CursorBookmark`-Verweis auf Markeninformationen, die eine Neuplatzierung an einer bestimmten Position ermöglichen. Sie können diesen Parameter auf den Wert setzen, der von der `bookmark`-Eigenschaft zurückgegeben wurde, oder auf einen der folgenden konstanten Lesezeichenwerte: `CursorBookmark.FIRST` - Vom Beginn der Sammlung aus (erstes Element) suchen `CursorBookmark.CURRENT` - Von der aktuellen Position der Sammlung aus suchen `CursorBookmark.LAST` - Vom Ende der Sammlung aus (letztes Element) suchen

	`offset:int` (default = `0`) — Gibt an, wie weit vom angegebenen Lesezeichen gesucht werden soll. Wenn die angegebene Zahl negativ ist, versucht der Cursor, sich vor dem angegebene Lesezeichen zu platzieren. Wenn der angegebene Offset sich nach dem Ende der Sammlung befindet, wird der Cursor hinter das Ende platziert, an die Position `beforeFirst` oder `afterLast`.

	`prefetch:int` (default = `0`) — Wird für Remote-Daten verwendet. Gibt eine Priorität an, die Sammlung in einer angegebene Richtung zu durchlaufen, wenn der Suchvorgang abgeschlossen wurde. Dies verringert die Anzahl der erforderlichen Netzwerk-Roundtrips bei einer Suche. Wenn die Durchlaufrichtung zum Zeitpunkt der Anforderung bekannt ist, kann die geeignete Datenmenge zurückgegeben werden, bevor die Anforderung die Daten durchläuft.

Rechtliche Hinweise | Onlinedatenschutzerklärung

HierarchicalCollectionViewCursor - AS3 Flex

Paketex

Sprachelemente

Anhänge

Paket mx.collections

afterLast

beforeFirst

bookmark

current

currentDepth

view