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 

GroupingCollection  - AS3 Flex

Packagemx.collections
Classepublic class GroupingCollection
HéritageGroupingCollection Inheritance HierarchicalData Inheritance EventDispatcher Inheritance Object
Implémente IGroupingCollection
Déconseillé depuis 4.0: Veuillez utiliser GroupingCollection2

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 GroupingCollection permet de créer des données regroupées à afficher dans le contrôle AdvancedDataGrid, à partir de données à plat. Lorsque vous créez l’instance de la classe GroupingCollection à partir de données à plat, vous devez spécifier le ou les champs de données à utiliser pour créer la hiérarchie.

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 GroupingCollection 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.GroupingCollection> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:GroupingCollection
  Properties 
    grouping="No default"
    source="No default"
    summaries="No default"
  />
  

This Class has been deprecated and replaced by a new Class GroupingCollection2 which provide faster, improved performance and a new summary calculation mechanism. Class SummaryField has also been deprecated and replaced by a new Class SummaryField2. Properties operation and summaryFunction are not present in the Class SummaryField2. A new property summaryOperation is introduced in SummaryField2.

Propriété MXML par défautgrouping

Eléments de l’API associés



Propriétés publiques
 PropriétéDéfini par
 InheritedchildrenField : String
Indique le nom du champ à utiliser pour détecter les objets enfant dans un élément de données.
HierarchicalData
 Inheritedconstructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet.
Object
  grouping : Grouping
Spécifie l’instance Grouping appliquée aux données source.
GroupingCollection
  source : Object
[override] Collection source contenant les données à plat à regrouper.
GroupingCollection
  summaries : Array
Tableau d’instances SummaryRow définissant un résumé de données au niveau racine.
GroupingCollection
Propriétés protégées
 PropriétéDéfini par
  timer : flash.utils:Timer
Minuteur associé à une opération d’actualisation asynchrone.
GroupingCollection
Méthodes publiques
 MéthodeDéfini par
  
Constructeur.
GroupingCollection
 Inherited
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
  
Si l’actualisation est réalisée de manière asynchrone, l’opération d’actualisation est annulée et la construction des groupes est arrêtée.
GroupingCollection
 Inherited
Renvoie true si le nœud peut contenir des enfants.
HierarchicalData
 Inherited
Distribue un événement dans le flux d’événements.
EventDispatcher
 Inherited
Renvoie un objet représentant les enfants du nœud.
HierarchicalData
 Inherited
Renvoie les données issues d’un nœud.
HierarchicalData
  
[override] Renvoie super.source si la propriété grouping est définie. Si cette propriété n’est pas définie, renvoie une instance ICollectionView faisant référence à super.source.
GroupingCollection
 Inherited
Renvoie true si le nœud contient des enfants.
HierarchicalData
 Inherited
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement.
EventDispatcher
 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
  
refresh(async:Boolean = false):Boolean
Applique le regroupement à la vue.
GroupingCollection
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Supprime un écouteur de l’objet EventDispatcher.
EventDispatcher
 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
 Inherited
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
Méthodes protégées
 MéthodeDéfini par
  
Renvoie le parent d’un nœud.
GroupingCollection
Evénements
 Evénement Synthèse Défini par
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player obtient le focus du système d’exploitation et devient active.EventDispatcher
 Inherited[Evénement de diffusion] Distribué lorsque l’application Flash Player ou AIR perd le focus du système d’exploitation et devient inactive.EventDispatcher
Détails de la propriété

grouping

propriété
grouping:Grouping

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

Spécifie l’instance Grouping appliquée aux données source. Le fait de définir la propriété grouping n’actualise pas automatiquement la vue. Par conséquent, vous devez appeler la méthode refresh() après avoir défini cette propriété.



Implémentation
    public function get grouping():Grouping
    public function set grouping(value:Grouping):void

Eléments de l’API associés

source

propriété 
source:Object[override]

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

Collection source contenant les données à plat à regrouper. Si la source n’est pas une collection, elle sera automatiquement enveloppée dans une collection.



Implémentation
    override public function get source():Object
    override public function set source(value:Object):void

summaries

propriété 
public var summaries: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’instances SummaryRow définissant un résumé de données au niveau racine. Spécifiez une ou plusieurs instances SummaryRow pour définir les résumés de données, comme l’illustre l’exemple suivant :

      <mx:AdvancedDataGrid id="myADG" 
         width="100%" height="100%" 
         initialize="gc.refresh();">        
         <mx:dataProvider>
             <mx:GroupingCollection id="gc" source="{dpFlat}">
                 <mx:summaries>
                     <mx:SummaryRow summaryPlacement="last">
                         <mx:fields>
                             <mx:SummaryField dataField="Actual" 
                                 label="Min Actual" operation="MIN"/>
                             <mx:SummaryField dataField="Actual" 
                                 label="Max Actual" operation="MAX"/>
                         </mx:fields>
                       </mx:SummaryRow>
                     </mx:summaries>
                 <mx:Grouping>
                     <mx:GroupingField name="Region"/>
                     <mx:GroupingField name="Territory"/>
                 </mx:Grouping>
             </mx:GroupingCollection>
         </mx:dataProvider>        
         
         <mx:columns>
             <mx:AdvancedDataGridColumn dataField="Region"/>
             <mx:AdvancedDataGridColumn dataField="Territory_Rep"
                 headerText="Territory Rep"/>
             <mx:AdvancedDataGridColumn dataField="Actual"/>
             <mx:AdvancedDataGridColumn dataField="Estimate"/>
             <mx:AdvancedDataGridColumn dataField="Min Actual"/>
             <mx:AdvancedDataGridColumn dataField="Max Actual"/>
         </mx:columns>
      </mx:AdvancedDataGrid>

Eléments de l’API associés

timer

propriété 
protected var timer:flash.utils:Timer

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

Minuteur associé à une opération d’actualisation asynchrone. Vous pouvez l’utiliser pour modifier l’intervalle de temporisation, suspendre l’actualisation ou réaliser différentes actions. La valeur par défaut de la propriété delay de l’instance Timer est 1, ce qui correspond à 1 milliseconde.

Détails du constructeur

GroupingCollection

()Constructeur
public function GroupingCollection()

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

Constructeur.

Détails de la méthode

cancelRefresh

()méthode
public function cancelRefresh():void

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

Si l’actualisation est réalisée de manière asynchrone, l’opération d’actualisation est annulée et la construction des groupes est arrêtée. Cette méthode annule l’actualisation uniquement si elle est initiée par un appel de la méthode refresh() utilisant un argument true, ce qui correspond à une actualisation asynchrone.

getParent

()méthode 
protected function getParent(node:Object):*

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

Renvoie le parent d’un nœud. Le parent d’un nœud de niveau supérieur est null.

Paramètres

node:Object — Objet définissant le nœud.

Valeur renvoyée
* — Nœud parent comptant le nœud parmi ses enfants. La valeur est null s’il s’agit d’un nœud de niveau supérieur et undefined s’il est impossible de déterminer le parent.

getRoot

()méthode 
override public function getRoot():Object

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

Renvoie super.source si la propriété grouping est définie. SI cette propriété n’est pas définie, renvoie une instance ICollectionView faisant référence à super.source.

Valeur renvoyée
Object — Objet à renvoyer.

refresh

()méthode 
public function refresh(async:Boolean = false):Boolean

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

Applique le regroupement à la vue. L’interface IGroupingCollection ne détecte pas automatiquement les modifications apportées à un groupe. Par conséquent, vous devez appeler la méthode refresh() pour actualiser la vue après avoir défini la propriété group.

La méthode refresh() peut être appliquée de manière asynchrone en appelant la méthode refresh(true).

Lorsque la méthode refresh() est appelée de manière synchrone, un client doit attendre qu’un événement CollectionEvent dont la propriété kind est définie sur CollectionEventKind.REFRESH soit généré pour faire en sorte que la méthode refresh() aboutisse.

Paramètres

async:Boolean (default = false) — Si la valeur est true, l’actualisation est définie comme étant asynchrone. La valeur par défaut est false, ce qui correspond à une actualisation synchrone.

Valeur renvoyée
Booleantrue si la méthode refresh() est terminée et false si cela n’est pas le cas, ce qui peut être le signe que des éléments sont toujours en attente.




[ 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.