GroupingCollection

Paket	mx.collections
Klasse	public class GroupingCollection
Vererbung	GroupingCollection HierarchicalData EventDispatcher Object
Implementiert	IGroupingCollection

Veraltet seit 4.0: Verwenden Sie GroupingCollection2

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Mit der GroupingCollection-Klasse können Sie aus flachen Daten gruppierte Daten für die Anzeige im AdvancedDataGrid-Steuerelement erstellen. Wenn Sie die Instanz der GroupingCollection-Klasse aus Ihren flachen Daten erstellen, geben Sie das Datenfeld bzw. die Datenfelder an, die zum Erstellen der Hierarchie verwendet werden.

Um das AdvancedDataGrid-Steuerelement mit gruppierten Daten auszufüllen, erstellen Sie aus den flachen Daten eine Instanz der GroupingCollection-Klasse und übergeben dann diese GroupingCollection-Instanz an den Datenprovider des AdvancedDataGrid-Steuerelements. Um die Gruppierungsfelder der flachen Daten anzugeben, übergeben Sie eine Grouping-Instanz an die GroupingCollection.grouping-Eigenschaft. Die Grouping-Instanz enthält ein Array von GroupingField-Instanzen, eine pro Gruppierungsfeld.

Das folgende Beispiel verwendet die GroupingCollection-Klasse zur Definition von zwei Gruppierungsfeldern: „Region“ und „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>

MXML-Syntax expanded

MXML-Syntax ausblenden

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.

Standard-MXML-Eigenschaftgrouping

Verwandte API-Elemente

mx.controls.AdvancedDataGrid
mx.collections.Grouping
mx.collections.GroupingField

Öffentliche Eigenschaften

Vererbte öffentliche Eigenschaften ausblenden

Vererbte öffentliche Eigenschaften anzeigen

	Eigenschaft		Definiert von
		childrenField : String Gibt den Feldnamen an, der zur Erkennung von untergeordneten Objekten in einem Datenelement verwendet werden soll.	HierarchicalData
		constructor : Object Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.	Object
		grouping : Grouping Gibt die auf die Quelldaten angewendete Grouping-Instanz an.	GroupingCollection
		source : Object [override] Die Quellsammlung, die die zu gruppierenden flachen Daten enthält.	GroupingCollection
		summaries : Array Array von SummaryRow-Instanzen, die alle Datenübersichten auf Stammebene definieren.	GroupingCollection

Geschützte Eigenschaften

	Eigenschaft		Definiert von
		timer : flash.utils:Timer Der Timer, der einem asynchronen Aktualisierungsvorgang zugeordnet ist.	GroupingCollection

Öffentliche Methoden

Vererbte öffentliche Methoden ausblenden

Vererbte öffentliche Methoden anzeigen

	Methode		Definiert von
		GroupingCollection() Konstruktor.	GroupingCollection
		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
		cancelRefresh():void Wenn eine asynchrone Aktualisierung durchgeführt wird, wird der Aktualisierungsvorgang abgebrochen und die Erstellung der Gruppen gestoppt.	GroupingCollection
		canHaveChildren(node:Object):Boolean Gibt „true“ zurück, wenn der Knoten untergeordnete Knoten enthalten kann.	HierarchicalData
		dispatchEvent(event:Event):Boolean Sendet ein Ereignis in den Ereignisablauf.	EventDispatcher
		getChildren(node:Object):Object Gibt ein Objekt zurück, das die untergeordneten Knoten des Knotens darstellt.	HierarchicalData
		getData(node:Object):Object Gibt Daten aus einem Knoten zurück.	HierarchicalData
		getRoot():Object [override] Gibt „super.source“ zurück, wenn die Grouping-Eigenschaft eingerichtet ist, und andernfalls eine ICollectionView-Instanz, die auf „super.source“ verweist.	GroupingCollection
		hasChildren(node:Object):Boolean Gibt „true“ zurück, wenn der Knoten untergeordnete Knoten enthält.	HierarchicalData
		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
		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
		refresh(async:Boolean = false):Boolean Wendet die Gruppierung auf die Ansicht an.	GroupingCollection
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Entfernt einen Listener aus dem EventDispatcher-Objekt.	EventDispatcher
		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

Geschützte Methoden

	Methode		Definiert von
		getParent(node:Object):* Gibt das übergeordnete Element eines Knotens zurück.	GroupingCollection

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

grouping

Eigenschaft

grouping:Grouping

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt die auf die Quelldaten angewendete Grouping-Instanz an. Durch das Einrichten der grouping-Eigenschaft wird nicht automatisch die Ansicht aktualisiert. Sie müssen die refresh()-Methode nach dem Einrichten der Eigenschaft aufrufen.

Implementierung
public function get grouping():Grouping
public function set grouping(value:Grouping):void

Verwandte API-Elemente

mx.collections.GroupingCollection.refresh()

source

Eigenschaft

source:Object[override]

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Die Quellsammlung, die die zu gruppierenden flachen Daten enthält. Wenn die Quelle keine Sammlung ist, wird sie automatisch in eine Sammlung eingeschlossen.

Implementierung
override public function get source():Object
override public function set source(value:Object):void

summaries

Eigenschaft

public var summaries:Array

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Array von SummaryRow-Instanzen, die alle Datenübersichten auf Stammebene definieren. Gibt einen oder mehrere SummaryRow-Instanzen an, um die Datenübersichten zu definieren, wie im folgenden Beispiel:

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

Verwandte API-Elemente

mx.collections.SummaryRow
mx.collections.SummaryField

timer

Eigenschaft

protected var timer:flash.utils:Timer

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Der Timer, der einem asynchronen Aktualisierungsvorgang zugeordnet ist. Sie können mit ihm das Zeitintervall ändern, die Aktualisierung unterbrechen oder andere Aktionen durchführen. Der Standardwert für die delay-Eigenschaft der Timer-Instanz ist 1. Dies entspricht 1 Millisekunde.

Konstruktordetails

()

Konstruktor

public function GroupingCollection()

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Konstruktor.

Methodendetails

cancelRefresh

()

Methode

public function cancelRefresh():void

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wenn eine asynchrone Aktualisierung durchgeführt wird, wird der Aktualisierungsvorgang abgebrochen und die Erstellung der Gruppen gestoppt. Diese Methode bricht die Aktualisierung nur ab, wenn sie durch einen Aufruf der refresh()-Methode mit dem Argument true gestartet wurde, was einer asynchronen Aktualisierung entspricht.

getParent

()

Methode

protected function getParent(node:Object):*

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt das übergeordnete Element eines Knotens zurück. Der übergeordnete Knoten eines Knotens der obersten Ebene ist null.

Parameter

node:Object — Das Objekt, das den Knoten definiert.

Rückgabewerte

* — Der übergeordnete Knoten, dem der untergeordnete Knoten zugehört, null bei einem Knoten der obersten Ebene und undefined, wenn der übergeordnete Knoten nicht ermittelt werden kann.

getRoot

()

Methode

override public function getRoot():Object

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Gibt super.source zurück, wenn die grouping-Eigenschaft angegeben wurde, und andernfalls eine ICollectionView-Instanz, die auf super.source verweist.

Rückgabewerte

Object — Das zurückzugebende Objekt.

refresh

()

Methode

public function refresh(async:Boolean = false):Boolean

Sprachversion:

ActionScript 3.0

Produktversion:

Flex 3

Laufzeitversionen:

Flash Player 9, AIR 1.1

Wendet die Gruppierung auf die Ansicht an. Die IGroupingCollection erkennt Änderungen einer Gruppe nicht automatisch. Daher müssen Sie die refresh()-Methode aufrufen, um die Ansicht nach dem Einrichten der group-Eigenschaft zu aktualisieren.

Die refresh()-Methode kann asynchron durch den Aufruf von refresh(true) angewendet werden.

Wenn refresh() synchron aufgerufen wird, sollte ein Client auf ein CollectionEvent-Ereignis warten, dessen kind-Eigenschaft den Wert CollectionEventKind.REFRESH hat, um sicherzustellen, dass die refresh()-Methode abgeschlossen wurde.

Parameter

async:Boolean (default = false) — Wenn true, wird die Aktualisierung als asynchron definiert. Standardmäßig ist dies der Parameter false zur Angabe einer synchronen Aktualisierung.

Rückgabewerte

Boolean — true, wenn die refresh()-Methode abgeschlossen wurde, und false, wenn der Aktualisierungsvorgang noch nicht abgeschlossen wurde, d. h. dass die Bearbeitung von Elementen möglicherweise noch aussteht.

Rechtliche Hinweise | Onlinedatenschutzerklärung

GroupingCollection - AS3 Flex

Klassen x

grouping

source

summaries

timer