| Package | mx.collections |
| Classe | public class SortField |
| Héritage | SortField  EventDispatcher Object |
| Implémente | ISortField |
| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
 | A partir de Flex 4.5, Adobe vous recommande d’utiliser la classe spark.collections.SortField comme alternative à cette classe. |
Fournit les informations de tri requises pour réaliser un tri sur un champ ou une propriété dans une vue de collection. La classe SortField est destinée à une utilisation avec la classe Sort. Le tri est généralement défini pour des collections d’éléments complexes, c’est-à-dire pour des éléments dans lesquels le tri est réalisé sur les propriétés de ces objets. Exemple :
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;
String, Date, Boolean, etc. Dans ce cas, le tri doit être appliqué directement au type simple. Lorsque vous créez un tri pour cette fonction, un seul champ de tri est nécessaire. Sa propriété name ne doit pas être définie. Par exemple :
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;
Par défaut, la comparaison fournie par la classe SortField ne permet pas d’effectuer correctement un tri spécifique par langue des chaînes de caractères. Pour ce type de tri, reportez-vous aux classes spark.collections.Sort et spark.collections.SortField.
Afficher la syntaxe MXML
Masquer la syntaxe MXMLThe <mx:SortField> tag has the following attributes:
<mx:SortField Properties caseInsensitive="false" compareFunction="Internal compare function" descending="false" name="null" numeric="null" />
Eléments de l’API associés
| Propriété | Défini par | ||
|---|---|---|---|
| arraySortOnOptions : int [lecture seule]
Cette propriété d’assistance est utilisée en interne par les méthodes findItem() et sort(). | SortField | ||
| caseInsensitive : Boolean
Détermine si le tri de ce champ doit ou non être sensible à la casse. | SortField | ||
| compareFunction : Function
Fonction comparant deux éléments lors d’un tri d’éléments pour la collection associée. | SortField | ||
 | constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | |
| descending : Boolean
Détermine si ce champ doit être trié dans l’ordre décroissant. | SortField | ||
| name : String
Nom du champ à trier. | SortField | ||
| numeric : Object
Force le comparateur à utiliser une comparaison numérique si le champ trié contient des valeurs numériques (number/int/uint) ou des représentations de chaîne de valeurs numériques. | SortField | ||
| usingCustomCompareFunction : Boolean [lecture seule]
La valeur est true si cet objet ISortField utilise une fonction de comparaison personnalisée. | SortField | ||
| Méthode | Défini par | ||
|---|---|---|---|
SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)
Constructeur. | SortField | ||
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | |
|
Distribue un événement dans le flux d’événements. | EventDispatcher | |
|
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | |
|
Indique si la propriété spécifiée d’un objet est définie. | Object | |
Fonction d’assistance appelée par la classe de tri pour définir la fonction de comparaison par défaut et réaliser une comparaison en fonction de l’un de ces trois éléments : si une fonction de comparaison personnalisée a été définie ou non, le type de données du champ spécifié ou la valeur de la propriété numeric. | SortField | ||
|
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | |
|
Indique si la propriété spécifiée existe et est énumérable. | Object | |
|
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | |
Inverse les critères de ce champ de tri. | SortField | ||
|
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | |
|
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | |
|
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | |
|
Renvoie la valeur primitive de l’objet spécifié. | Object | |
|
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher | |
arraySortOnOptions | propriété |
arraySortOnOptions:int [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Cette propriété d’assistance est utilisée en interne par les méthodes findItem() et sort(). Les autres utilisations de cette propriété ne sont pas prises en charge. Renvoie la valeur -1 si ISortField ne doit pas être utilisé par la classe Sort pour trier le champ (il n’existe aucune fonction compareFunction ni de nom). Dans le cas contraire, renvoie un masque binaire d’options de tri.
Implémentation
public function get arraySortOnOptions():intcaseInsensitive | propriété |
caseInsensitive:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine si le tri de ce champ doit ou non être sensible à la casse.
La valeur par défaut est false.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement caseInsensitiveChanged .
Implémentation
public function get caseInsensitive():Boolean public function set caseInsensitive(value:Boolean):voidcompareFunction | propriété |
compareFunction:Function| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction comparant deux éléments lors d’un tri d’éléments pour la collection associée. Si vous spécifiez une propriété compareFunction dans un objet ISort, Flex ignore les propriétés compareFunction des objets SortField de l’objet ISort.
La fonction de comparaison doit présenter la signature suivante :
function myCompare(a:Object, b:Object):int
Cette fonction doit renvoyer les valeurs suivantes :
- -1 si
aapparaît avantbdans la séquence triée - 0 si
a=b - 1 si
aapparaît aprèsbdans la séquence triée
La valeur par défaut est une fonction de comparaison interne qui réalise une comparaison de chaîne, de nombre ou de date dans l’ordre croissant ou décroissant, en prenant ou non en compte la casse des chaînes. Spécifiez votre propre fonction uniquement si vous souhaitez disposer d’un algorithme de comparaison personnalisé. Normalement, cela est nécessaire uniquement lorsqu’un champ calculé est utilisé dans un affichage.
Remarque : si vous avez besoin d’effectuer un tri spécifique par langue, utilisez la classespark.collections.SortField.
Implémentation
public function get compareFunction():Function public function set compareFunction(value:Function):voidEléments de l’API associés
descending | propriété |
descending:Boolean| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine si ce champ doit être trié dans l’ordre décroissant.
La valeur par défaut est false (ordre croissant).
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement descendingChanged .
Implémentation
public function get descending():Boolean public function set descending(value:Boolean):voidname | propriété |
name:String| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Nom du champ à trier.
La valeur par défaut est null.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement nameChanged .
Implémentation
public function get name():String public function set name(value:String):voidnumeric | propriété |
numeric:Object| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Force le comparateur à utiliser une comparaison numérique si le champ trié contient des valeurs numériques (number/int/uint) ou des représentations de chaîne de valeurs numériques.
Cette propriété est utilisée par la classe SortField si aucune fonction de comparaison personnalisée n’est fournie.
Si la valeur de cette propriété est true, la fonction de comparaison numérique intégrée est utilisée. Chacun des éléments de données est projeté vers une fonction Number() avant la comparaison.
Si la valeur de cette propriété est false, la fonction de comparaison de chaînes intégrée est utilisée. Chacun des éléments de données est projeté vers une fonction String() avant la comparaison.
Si la valeur de cette propriété est null, le premier élément de données est introspecté afin de déterminer s’il s’agit d’un nombre ou d’une chaîne. Le tri est réalisé en fonction de cette introspection.
La valeur par défaut est null.
Cette propriété peut être utilisée comme source de la liaison de données. Lorsque cette propriété est modifiée, elle distribue l’événement numericChanged .
Implémentation
public function get numeric():Object public function set numeric(value:Object):voidusingCustomCompareFunction | propriété |
usingCustomCompareFunction:Boolean [lecture seule] | Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
La valeur est true si cet objet ISortField utilise une fonction de comparaison personnalisée.
Implémentation
public function get usingCustomCompareFunction():BooleanSortField | () | Constructeur |
public function SortField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Object = null)| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
Paramètresname:String (default = null)null.
| |
caseInsensitive:Boolean (default = false) | |
descending:Boolean (default = false) | |
numeric:Object (default = null) |
initializeDefaultCompareFunction | () | méthode |
public function initializeDefaultCompareFunction(obj:Object):void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Fonction d’assistance appelée par la classe Sort pour définir la fonction de comparaison par défaut et réaliser une comparaison en fonction de l’un de ces trois éléments : si une fonction de comparaison personnalisée a été définie ou non, le type de données du champ spécifié ou la valeur de la propriété numeric. Si la propriété numeric a la valeur true, une comparaison numérique est effectuée lors du tri.
Paramètres
obj:Object — Objet qui contient les données. Si le nom du champ a été défini avec la propriété name, le nom est utilisé pour accéder à la valeur de données à partir de cet objet. Dans tous les autres cas, l’objet lui-même est utilisé en tant que valeur de données.
|
reverse | () | méthode |
public function reverse():void| Version du langage: | ActionScript 3.0 |
| Version du produit: | Flex 3 |
| Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Inverse les critères de ce champ de tri. Si le champ était trié dans l’ordre décroissant, par exemple, il est trié dans l’ordre croissant.
Remarque : une interface ICollectionView n’est pas automatiquement mise à jour lorsque les objets ISortField sont modifiés. Appelez sa méthode refresh() pour actualiser la vue.
Tue Jun 12 2018, 09:30 AM Z