SortField

Paket	mx.collections
Klasse	public class SortField
Vererbung	SortField EventDispatcher Object
Implementiert	ISortField

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Beginnend mit Flex 4.5 empfiehlt Adobe die Verwendung der Klasse spark.collections.SortField als Alternative zu dieser Klasse.

Stellt die Sortierinformationen bereit, die erforderlich sind, um eine Sortierung eines Felds oder einer Eigenschaft in einer Sammlungsansicht durchzuführen. Die SortField-Klasse wird mit der Sort-Klasse verwendet. Normalerweise wird die Sortierung für Sammlungen komplexer Elemente definiert, also für Elemente, in denen die Sortierung anhand von Eigenschaften dieser Objekte durchgeführt wird. Beispiel:


     var col:ICollectionView = new ArrayCollection();
     col.addItem({first:"Anders", last:"Dickerson"});
     var sort:Sort = new Sort();
     sort.fields = [new SortField("first", true)];
     col.sort = sort;

Es gibt Situationen, in denen die Sammlung einfache Elemente enthält, wie String, Date, Boolean usw. In diesem Fall wird die Sortierung direkt auf den einfachen Datentyp angewendet. Bei der Erstellung einer Sortierung für diese Situation ist nur ein einzelnes Sortierfeld erforderlich, für das name nicht angegeben sein sollte. Beispiel:


     var col:ICollectionView = new ArrayCollection();
     col.addItem("California");
     col.addItem("Arizona");
     var sort:Sort = new Sort();
     sort.fields = [new SortField(null, true)];
     col.sort = sort;

Standardmäßig stellt der von der SortField-Klasse bereitgestellte Vergleich keine korrekte sprachspezifische Sortierung für Strings bereit. Weitere Informationen zu dieser Sortierungsart finden Sie unter den spark.collections.Sort- und spark.collections.SortField-Klassen.

MXML-Syntax expanded

MXML-Syntax ausblenden

The <mx:SortField> tag has the following attributes:

  <mx:SortField
  Properties
  caseInsensitive="false"
  compareFunction="Internal compare function"
  descending="false"
  name="null"
  numeric="null"
  />

Verwandte API-Elemente

mx.collections.ICollectionView
mx.collections.Sort
spark.collections.Sort
spark.collections.SortField

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		arraySortOnOptions : int [schreibgeschützt] Diese helper-Eigenschaft wird intern in der findItem()- und sort()-Methode verwendet.	SortField
		caseInsensitive : Boolean Gibt an, ob die Sortierung für dieses Feld zwischen Groß- und Kleinschreibung unterscheiden soll.	SortField
		compareFunction : Function Die Funktion, die zwei Elemente bei der Sortierung von Elementen für die zugehörige Sammlung vergleicht.	SortField
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		descending : Boolean Gibt an, ob dieses Feld in absteigender Reihenfolge sortiert werden soll.	SortField
		name : String Der Name des zu sortierenden Felds.	SortField
		numeric : Object Gibt an, dass der Komparator einen numerischen Vergleich verwendet, wenn das sortierte Feld numerische Werte (number/int/uint) oder Stringdarstellungen numerischer Werte enthält.	SortField
		usingCustomCompareFunction : Boolean [schreibgeschützt] „True“, wenn dieses ISortField eine benutzerdefinierte Komparator-Funktion verwendet.	SortField

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null) Konstruktor.	SortField
		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
		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
		initializeDefaultCompareFunction(obj:Object):void Eine Hilfsfunktion, die von der Sort-Klasse aufgerufen wird, um die Standardvergleichsfunktion zur Durchführung eines Vergleichs basierend auf einer von drei Möglichkeiten festzulegen: ob eine benutzerdefinierte Vergleichsfunktion, der Datentyp für das angegebene Feld oder der Wert der numerischen Eigenschaft festgelegt wurde.	SortField
		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
		propertyIsEnumerable(name:String):Boolean Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.	Object
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		reverse():void Die Kriterien für dieses Sortierfeld umkehren.	SortField
		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

arraySortOnOptions

Eigenschaft

arraySortOnOptions:int [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Diese helper-Eigenschaft wird intern in der findItem()- und sort()-Methode verwendet. Andere Verwendungen dieser Eigenschaft werden nicht unterstützt. Gibt -1 zurück, wenn dieses ISortField nicht von der Sort-Klasse zum Sortieren des Felds verwendet werden soll (es gibt keine compareFunction und keinen Namen). Andernfalls wird eine Bitmask von Sortieroptionen zurückgegeben.

Implementierung
public function get arraySortOnOptions():int

caseInsensitive

Eigenschaft

caseInsensitive:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt an, ob die Sortierung für dieses Feld zwischen Groß- und Kleinschreibung unterscheiden soll.

Der Standardwert ist false.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das caseInsensitiveChanged -Ereignis ausgelöst.

Implementierung
public function get caseInsensitive():Boolean
public function set caseInsensitive(value:Boolean):void

compareFunction

Eigenschaft

compareFunction:Function

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die Funktion, die zwei Elemente bei der Sortierung von Elementen für die zugehörige Sammlung vergleicht. Wenn Sie eine compareFunction-Eigenschaft in einem ISort-Objekt angeben, ignoriert Flex alle compareFunction-Eigenschaften der SortField-Objekte der ISort.

Die Vergleichsfunktion muss folgende Signatur haben:

function myCompare(a:Object, b:Object):int

Diese Funktion muss folgende Werte zurückgeben:

-1, wenn a in der sortierten Sequenz vor b erscheint.
0, wenn a gleich b ist.
-1, wenn a in der sortierten Sequenz nach b erscheint.

Der Standardwert ist eine interne Vergleichsfunktion, die einen Vergleich von Strings, numerischen Werten oder Datumsangaben in aufsteigender oder absteigender Reihenfolge durchführen kann, wobei die Stringvergleiche zwischen Groß- und Kleinschreibung unterscheiden können. Geben Sie Ihre eigene Funktion nur an, wenn ein benutzerdefinierter Vergleichsalgorithmus erforderlich ist. Dies ist normalerweise nur der Fall, wenn ein berechnetes Feld in einer Anzeige verwendet wird.

Hinweis: Wenn Sie sprachspezifische Sortierung benötigen, betrachten Sie die spark.collections.SortField-Klasse als Alternative.

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

Verwandte API-Elemente

spark.collections.SortField

descending

Eigenschaft

descending:Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt an, ob dieses Feld in absteigender Reihenfolge sortiert werden soll.

Der Standardwert ist false (aufsteigend).

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das descendingChanged -Ereignis ausgelöst.

Implementierung
public function get descending():Boolean
public function set descending(value:Boolean):void

name

Eigenschaft

name:String

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Name des zu sortierenden Felds.

Der Standardwert ist null.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das nameChanged -Ereignis ausgelöst.

Implementierung
public function get name():String
public function set name(value:String):void

numeric

Eigenschaft

numeric:Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt an, dass der Komparator einen numerischen Vergleich verwendet, wenn das sortierte Feld numerische Werte (number/int/uint) oder Stringdarstellungen numerischer Werte enthält.

Diese Eigenschaft wird von der SortField-Klasse verwendet, wenn die benutzerdefinierte Vergleichsfunktion nicht bereitgestellt wird.

Wenn diese Eigenschaft true ist, wird die integrierte Vergleichsfunktion verwendet. Jedes Datenelement wird vor dem Vergleich in eine Number()-Funktion umgewandelt.

Wenn diese Eigenschaft false ist, wird die integrierte Stringvergleichsfunktion verwendet. Jedes Datenelement wird vor dem Vergleich in eine String()-Funktion umgewandelt.

Wenn diese Eigenschaft null ist, wird das erste Datenelement geprüft, um festzustellen, ob es sich um eine Zahl oder einen String handelt, und die Sortierung wird basierend auf dieser Prüfung fortgesetzt.

Der Standardwert ist null.

Diese Eigenschaft kann als Quelle für die Datenbindung verwendet werden. Beim Ändern dieser Eigenschaft wird das numericChanged -Ereignis ausgelöst.

Implementierung
public function get numeric():Object
public function set numeric(value:Object):void

usingCustomCompareFunction

Eigenschaft

usingCustomCompareFunction:Boolean [schreibgeschützt]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

„True“, wenn dieses ISortField eine benutzerdefinierte Komparator-Funktion verwendet.

Implementierung
public function get usingCustomCompareFunction():Boolean

Konstruktordetails

()

Konstruktor

public function SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Konstruktor.

Parameter

	`name:String` (default = `null`) — Der Name der Eigenschaft, die dieses Feld für den Vergleich verwendet. Wenn das Objekt ein einfacher Typ ist, übergeben Sie `null`.

	`caseInsensitive:Boolean` (default = `false`) — Beim Sortieren von Strings wird der Komparator angewiesen, ob die Schreibweise der Werte ignoriert werden soll.

	`descending:Boolean` (default = `false`) — Weist den Komparator an, ob Elemente in absteigender Reihenfolge angeordnet werden sollen.

	`numeric:Object` (default = `null`) — Weist den Komparator an, ob Sortierelemente als Zahlenwerte verglichen werden sollen, anstatt alphabetisch.

Methodendetails

initializeDefaultCompareFunction

()

Methode

public function initializeDefaultCompareFunction(obj:Object):void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Eine Hilfsfunktion, die von der Sort-Klasse aufgerufen wird, um die Standardvergleichsfunktion zur Durchführung eines Vergleichs basierend auf einer von drei Möglichkeiten festzulegen: ob eine benutzerdefinierte Vergleichsfunktion, der Datentyp für das angegebene Feld oder der Wert der numerischen Eigenschaft festgelegt wurde. Wenn die numeric-Eigenschaft „true“ ist, wird beim Sortieren ein numerischer Vergleich durchgeführt.

Parameter

obj:Object — Das Objekt, das die Daten enthält. Wenn der Feldname mit den Namenseigenschaften festgelegt wurde, wird mit dem Namen auf den Datenwert von diesem Objekt zugegriffen. Andernfalls wird das Objekt selbst als Datenwert verwendet.

reverse

()

Methode

public function reverse():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die Kriterien für dieses Sortierfeld umkehren. Wenn das Feld z. B. in absteigender Reihenfolge sortiert war, wird es in aufsteigender Reihenfolge sortiert.

Hinweis: Eine ICollectionView wird nicht automatisch aktualisiert, wenn die ISortFields geändert werden. Rufen Sie zur Aktualisierung der Ansicht ihre refresh()-Methode auf.

Rechtliche Hinweise | Onlinedatenschutzerklärung

SortField - AS3 Flex

Paketex

Sprachelemente

Anhänge

Paket mx.collections

arraySortOnOptions

caseInsensitive

compareFunction

descending

name

numeric

usingCustomCompareFunction

SortField

initializeDefaultCompareFunction

reverse