ActionScript® 3.0 Referenzhandbuch für die Adobe® Flash®-Plattform
Home  |  Liste der Pakete und Klassen ausblenden |  Pakete  |  Klassen  |  Neue Funktionen  |  Stichwortverzeichnis  |  Anhänge  |  Warum auf Englisch?
Filter: Daten werden vom Server abgerufen...
Daten werden vom Server abgerufen...
mx.collections 

GroupingField  - AS3 Flex

Paketmx.collections
Klassepublic class GroupingField
VererbungGroupingField Inheritance Object

Sprachversion: ActionScript 3.0
Produktversion: Flex 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Die GroupingField-Klasse stellt einzelne Datenfelder dar, die Sie verwenden können, um flache Daten für die Anzeige mit dem AdvancedDataGrid-Steuerelement zu gruppieren.

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 Grouping-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-SyntaxexpandedMXML-Syntax ausblenden
The <mx.GroupingField> inherits all the tag attributes of its superclass, and defines the following tag attributes:

  <mx:GroupingField
  Properties 
    caseInsensitive="false|true"
    compareFunction="No default"
    descending="false|true"
    groupingFunction="No default"
    groupingObjectFunction="No default"
    name="null"
    numeric="false|true"
    summaries="No default"
  />
  

Standard-MXML-Eigenschaftsummaries

Verwandte API-Elemente



Öffentliche Eigenschaften
 EigenschaftDefiniert von
  caseInsensitive : Boolean
Hat den Wert „true“, wenn die Sortierung für dieses Feld nicht zwischen Groß- und Kleinschreibung unterscheidet.
GroupingField
  compareFunction : Function
Die Funktion, die zwei Elemente bei der Sortierung von Elementen für die zugehörige Sammlung vergleicht.
GroupingField
 Inheritedconstructor : Object
Ein Verweis auf das Klassenobjekt oder die Konstruktorfunktion für eine angegebene Objektinstanz.
Object
  descending : Boolean
Hat den Wert „true“, wenn die Sortierung für dieses Feld in absteigender Reihenfolge erfolgen soll.
GroupingField
  groupingFunction : Function
Eine Funktion, die die Beschriftung für diese Gruppe bestimmt.
GroupingField
  groupingObjectFunction : Function
Eine Callback-Funktion, die für jeden Gruppenknoten zum Bestimmen des Gruppierungsobjekts ausgeführt werden soll.
GroupingField
  name : String
Der Name des zu sortierenden Felds.
GroupingField
  numeric : Boolean
Gibt an, dass der Komparator einen numerischen Vergleich verwendet, wenn das sortierte Feld numerische Werte (number/int/uint) oder Stringdarstellungen numerischer Werte enthält.
GroupingField
  summaries : Array
Array von SummaryRow-Instanzen, das die Übersichten auf Gruppenebene definiert.
GroupingField
Öffentliche Methoden
 MethodeDefiniert von
  
GroupingField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Boolean = false)
Konstruktor.
GroupingField
 Inherited
Gibt an, ob für ein Objekt eine bestimmte Eigenschaft definiert wurde.
Object
 Inherited
Gibt an, ob eine Instanz der Object-Klasse in der Prototypkette des Objekts vorhanden ist, das als Parameter angegeben wurde.
Object
 Inherited
Gibt an, ob die angegebene Eigenschaft vorhanden ist und durchlaufen werden kann.
Object
 Inherited
Legt die Verfügbarkeit einer dynamischen Eigenschaft für Schleifenoperationen fest.
Object
 Inherited
Gibt die Stringdarstellung dieses Objekts zurück, formatiert entsprechend den Konventionen des Gebietsschemas.
Object
 Inherited
Gibt das angegebene Objekt als String zurück.
Object
 Inherited
Gibt den Grundwert des angegebenen Objekts zurück.
Object
Eigenschaftendetails

caseInsensitive

Eigenschaft
caseInsensitive:Boolean

Sprachversion: ActionScript 3.0
Produktversion: Flex 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Hat den Wert true, wenn die Sortierung für dieses Feld nicht zwischen Groß- und Kleinschreibung unterscheidet.

Der Standardwert ist false.



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 die compareFunction-Eigenschaft in einem Grouping-Objekt angeben, ignoriert Flex alle compareFunction-Eigenschaften der GroupingField-Objekte.

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 erscheinen soll.
  • 0, wenn a gleich b ist.
  • -1, wenn a in der sortierten Sequenz nach b erscheinen soll.

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.



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

descending

Eigenschaft 
descending:Boolean

Sprachversion: ActionScript 3.0
Produktversion: Flex 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Hat den Wert true, wenn die Sortierung für dieses Feld in absteigender Reihenfolge erfolgen soll.

Der Standardwert ist false.



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

groupingFunction

Eigenschaft 
public var groupingFunction:Function

Sprachversion: ActionScript 3.0
Produktversion: Flex 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Eine Funktion, die die Beschriftung für diese Gruppe bestimmt. Standardmäßig zeigt die Gruppe den Text für das Feld in den Daten, die zu dem Feld passen, das von der name-Eigenschaft angegeben wurde. Möglicherweise sollen jedoch die Elemente basierend auf mehreren Datenfeldern oder auf anderen Feldern, bei denen es sich nicht um einfache Stringfelder handelt, gruppiert werden. In diesem Fall legen Sie mit der groupingFunction-Eigenschaft eine Rückruffunktion fest.

Eine Rückruffunktion kann z. B. eine Zahl für den Monat in den String für den Monat konvertieren oder mehrere Elemente anhand von anderen Kriterien, als dem tatsächlichen Wert des Felds, in einer Gruppe zusammenfassen.

Für das GroupField-Steuerelement hat die Methodensignatur folgende Form:

groupingFunction(item:Object, field:GroupField):String

Dabei gilt: item enthält das Datenelementobjekt und field enthält das GroupField-Objekt.

Beispiel: Ein groupingFunction-Objekt, das das erste Zeichen als Gruppenname zurückgibt, kann wie folgt geschrieben werden -
      private function groupFunc(item:Object, field:GroupingField):String
      {
          return item[field.name].toString().substr(0, 1);
      }
      

groupingObjectFunction

Eigenschaft 
public var groupingObjectFunction:Function

Sprachversion: ActionScript 3.0
Produktversion: Flex 3
Laufzeitversionen: Flash Player 9, AIR 1.1

Eine Callback-Funktion, die für jeden Gruppenknoten zum Bestimmen des Gruppierungsobjekts ausgeführt werden soll. Standardmäßig wird für Gruppenknoten ein neues Objekt erstellt.

Sie können eine groupingObjectFunction angeben, die das geeignete Objekt für Gruppenknoten bereitstellt.

Die Methodensignatur lautet wie folgt:

      myGroupObjectFunction(label:String):Object

Dabei enthält label den Wert, der für diesen Gruppenknoten angezeigt wird. Standardmäßig gibt die Funktion ein Objekt zurück, das für Gruppenknoten verwendet wird.

Beispiel: Eine groupingObjectFunction, die ein Objekt zurückgibt, das eine „name“-Eigenschaft mit dem Wert „Bob“ enthält, kann wie folgt geschrieben werden -
      private function groupObjFunction(label:String):Object
      {
          var obj:Object = {};
          obj.name = "Bob";
     
          return obj;
      }
      

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.



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

numeric

Eigenschaft 
numeric:Boolean

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. Wenn diese Eigenschaft false ist, werden Felder mit Stringdarstellungen von Zahlen mithilfe eines Stringvergleichs sortiert, sodass 100 vor 99 kommt, da „1“ ein kleinerer Stringwert als „9“ ist.

Der Standardwert ist false.



Implementierung
    public function get numeric():Boolean
    public function set numeric(value:Boolean):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, das die Übersichten auf Gruppenebene definiert. 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:Grouping>
                     <mx:GroupingField name="Region">
                       <mx:summaries>
                           <mx:SummaryRow summaryPlacement="group">
                             <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:GroupingField>
                 </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

Konstruktordetails

GroupingField

()Konstruktor
public function GroupingField(name:String = null, caseInsensitive:Boolean = false, descending:Boolean = false, numeric:Boolean = false)

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:Boolean (default = false) — Weist den Komparator an, ob Sortierelemente als Zahlenwerte verglichen werden sollen, anstatt alphabetisch.




[ X ]Warum auf Englisch?
Inhalt des ActionScript 3.0-Referenzhandbuchs wird in englischer Sprache angezeigt

Nicht alle Teile des ActionScript 3.0-Referenzhandbuchs wurden in alle Sprachen übersetzt. Wenn der Text zu einem Sprachelement nicht übersetzt wurde, wird er auf Englisch angezeigt. Zum Beispiel wurden die Informationen zur ga.controls.HelpBox-Klasse nicht in andere Sprachen übersetzt. In der deutschen Version des Referenzhandbuchs erscheint der Abschnitt zur ga.controls.HelpBox-Klasse deshalb auf Englisch.