Guide de référence ActionScript® 3.0 pour la plate-forme Adobe® Flash®
Accueil  |  Masquer la liste des packages et des classes |  Packages  |  Classes  |  Nouveautés  |  Index  |  Annexes  |  Pourquoi existe-t-il du contenu en anglais ?
Filtres : Récupération des données du serveur...
Récupération des données du serveur...
mx.collections 

Grouping  - AS3 Flex

Packagemx.collections
Classepublic class Grouping
HéritageGrouping Inheritance Object

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

La classe Grouping définit les champs du fournisseur de données du contrôle AdvancedDataGrid utilisés pour regrouper des données. Utilisez cette classe pour créer des groupes lorsque les données d’entrée du contrôle AdvancedDataGrid sont des données à plat.

Pour que des données groupées viennent remplir le contrôle AdvancedDataGrid, créez une instance de la classe GroupingCollection à partir des données à plat, puis transmettez cette instance GroupingCollection au fournisseur de données du contrôle AdvancedDataGrid. Pour spécifier les champs de regroupement des données à plat, transmettez une instance Grouping à la propriété GroupingCollection.grouping. L’instance Grouping contient un tableau d’instances GroupingField (une par champ de regroupement).

L’exemple suivant utilise la classe Grouping pour définir deux champs de regroupement : Region et Territory.

  <mx:AdvancedDataGrid id="myADG"    
    <mx:dataProvider> 
      <mx:GroupingCollection id="gc" source="{dpFlat}"> 
        <mx:grouping> 
          <mx:Grouping> 
            <mx:GroupingField name="Region"/> 
            <mx:GroupingField name="Territory"/> 
          </mx:Grouping> 
        </mx:grouping> 
      </mx:GroupingCollection> 
    </mx:dataProvider>  
     
    <mx:columns> 
      <mx:AdvancedDataGridColumn dataField="Region"/> 
      <mx:AdvancedDataGridColumn dataField="Territory"/> 
      <mx:AdvancedDataGridColumn dataField="Territory_Rep"/> 
      <mx:AdvancedDataGridColumn dataField="Actual"/> 
      <mx:AdvancedDataGridColumn dataField="Estimate"/> 
    </mx:columns> 
  </mx:AdvancedDataGrid>
  

Syntaxe MXMLexpandedMasquer la syntaxe MXML
The <mx.Grouping> tag defines the following tag attributes:

  <mx:Grouping
  Properties 
    compareFunction="No default"
    fields="null"
    groupingObjectFunction="No default"
    label="GroupLabel"
  />
  

Propriété MXML par défautfields

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
  compareFunction : Function
Méthode utilisée pour comparer des éléments lors du tri.
Grouping
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
  fields : Array
Tableau d’objets GroupingField spécifiant les champs utilisés pour regrouper les données.
Grouping
  groupingObjectFunction : Function
Fonction de rappel à exécuter sur chaque nœud du groupe pour déterminer l’objet de regroupement.
Grouping
  label : String = "GroupLabel"
Nom du champ ajouté aux données à plat pour créer la hiérarchie.
Grouping
Méthodes publiques
 MéthodeDéfini par
  
Constructeur.
Grouping
 Inherited
Indique si la propriété spécifiée d’un objet est définie.
Object
 Inherited
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
 Inherited
Indique si la propriété spécifiée existe et est énumérable.
Object
 Inherited
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle.
Object
 Inherited
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur.
Object
 Inherited
Renvoie la représentation sous forme de chaîne de l’objet spécifié.
Object
 Inherited
Renvoie la valeur primitive de l’objet spécifié.
Object
Détails de la propriété

compareFunction

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

Méthode utilisée pour comparer des éléments lors du tri. Si vous spécifiez cette propriété, Flex ignore les propriétés compareFunction que vous spécifiez dans les objets SortField utilisés dans cette classe.

La fonction de comparaison doit présenter la signature suivante :

         function [name](a:Object, b:Object, fields:Array=null):int

Cette fonction doit renvoyer les valeurs suivantes :

  • -1 si a apparaît avant b dans la séquence triée.
  • 0 si a = b.
  • 1 si a apparaît après b dans la séquence triée.

Pour renvoyer à la fonction de comparaison interne, définissez cette valeur sur null.

Le tableau fields spécifie les champs d’objet à comparer. En général, l’algorithme compare les propriétés jusqu’à ce que la fin de la liste des champs soit atteinte ou jusqu’à ce qu’une valeur autre que zéro puisse être renvoyée. Par exemple :

        function myCompare(a:Object, b:Object, fields:Array=null):int
        {
            var result:int = 0;
            var i:int = 0;
            var propList:Array = fields ? fields : internalPropList;
            var len:int = propList.length;
            var propName:String;
            while (result == 0 && (i < len))
            {
                propName = propList[i];
                result = compareValues(a[propName], b[propName]);
                i++;
            }
            return result;
        }
     
        function compareValues(a:Object, b:Object):int
        {
            if (a == null && b == null)
                return 0;
     
            if (a == null)
              return 1;
     
            if (b == null)
               return -1;
     
            if (a < b)
                return -1;
     
            if (a > b)
                return 1;
     
            return 0;
        }

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.

Vous pouvez également spécifier des fonctions de comparaison séparées pour chaque champ de tri, à l’aide de la propriété compare de la classe SortField. Il est ainsi possible d’utiliser la comparaison par défaut pour certains champs et une comparaison personnalisée pour d’autres.



Implémentation
    public function get compareFunction():Function
    public function set compareFunction(value:Function):void

fields

propriété 
fields:Array

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Tableau d’objets GroupingField spécifiant les champs utilisés pour regrouper les données. L’ordre des objets GroupingField dans le tableau détermine l’ordre de priorité des champs lors du tri.

La valeur par défaut est null.



Implémentation
    public function get fields():Array
    public function set fields(value:Array):void

Eléments de l’API associés

groupingObjectFunction

propriété 
public var groupingObjectFunction: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 de rappel à exécuter sur chaque nœud du groupe pour déterminer l’objet de regroupement. Par défaut, un nouvel objet sera créé pour les nœuds du groupe.

Vous pouvez spécifier une fonction groupingObjectFunction fournissant l’objet adapté aux nœuds du groupe.

La signature de la méthode se présente comme suit :

      myGroupObjectFunction(label:String):Object

label contient la valeur qui sera affichée pour ce nœud du groupe. La fonction renvoie un objet qui sera utilisé pour les nœuds de groupe.

Par exemple, une fonction groupingObjectFunction renvoyant un objet contenant une propriété "name" dont la valeur est "Bob" peut être écrite comme suit :
      private function groupObjFunction(label:String):Object
      {
          var obj:Object = {};
          obj.name = "Bob";
     
          return obj;
      }
      

label

propriété 
public var label:String = "GroupLabel"

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 ajouté aux données à plat pour créer la hiérarchie. La valeur des nœuds de niveau supérieur (nœuds représentant les champs de groupe) dans chaque groupe est représentée par cette propriété. Utilisez cette propriété pour spécifier un autre nom.

La valeur par défaut est GroupLabel.

Détails du constructeur

Grouping

()Constructeur
public function Grouping()

Version du langage: ActionScript 3.0
Version du produit: Flex 3
Versions du moteur d’exécution: Flash Player 9, AIR 1.1

Constructeur.





[ X ]Pourquoi existe-t-il du contenu en anglais ?
Certaines parties du Guide de référence ActionScript 3.0 sont en anglais

Tout le contenu du Guide de référence ActionScript 3.0 n’a pas été traduit dans toutes les langues. Si un élément de langage n’est pas traduit, il s’affiche en anglais. Par exemple, la classe ga.controls.HelpBox n’est traduite dans aucune langue. Ainsi, dans la version française du guide de référence, la classe ga.controls.HelpBox apparaît en anglais.