Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.collections 
IGroupingCollection2 
Packagemx.collections
Interfacepublic interface IGroupingCollection2 extends IHierarchicalData , IEventDispatcher
Implementors GroupingCollection2

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The IGroupingCollection2 interface defines the interface required to create grouped data from flat data.

See also



Public Properties
 PropertyDefined By
  grouping : Grouping
The Grouping object applied to the source data.
IGroupingCollection2
Public Methods
 MethodDefined By
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
IEventDispatcher
  
If the refresh is performed asynchronously, cancels the refresh operation and stops the building of the groups.
IGroupingCollection2
 Inherited
Returns true if the node can contain children.
IHierarchicalData
 Inherited
Dispatches an event into the event flow.
IEventDispatcher
 Inherited
Returns an Object representing the node's children.
IHierarchicalData
 Inherited
Returns data from a node.
IHierarchicalData
 Inherited
Returns the root data item.
IHierarchicalData
 Inherited
Returns true if the node has children.
IHierarchicalData
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
IEventDispatcher
  
refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean
Applies the grouping to the collection.
IGroupingCollection2
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
IEventDispatcher
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
IEventDispatcher
Property Detail

grouping

property
grouping:Grouping

Language Version: ActionScript 3.0
Product Version: Flex 4
Runtime Versions: Flash Player 10, AIR 1.5

The Grouping object applied to the source data. Setting this property does not automatically refresh the view; therefore, you must call the refresh() method after setting this property.

Note: The Flex implementations of IGroupingCollection2 retrieve all items from a remote location before executing grouping.



Implementation
    public function get grouping():Grouping
    public function set grouping(value:Grouping):void
Method Detail

cancelRefresh

()method
public function cancelRefresh():void

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 10, AIR 1.5

If the refresh is performed asynchronously, cancels the refresh operation and stops the building of the groups. This method only cancels the refresh if it is initiated by a call to the refresh() method with an asynch argument of true, corresponding to an asynchronous refresh.

refresh

()method 
public function refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean

Language Version: ActionScript 3.0
Product Version: Flex 3
Runtime Versions: Flash Player 10, AIR 1.5

Applies the grouping to the collection. The collection does not detect changes to a group automatically, so you must call the refresh() method to update the collection after setting the grouping, source, or summaries properties. You also call the refresh() method when you modify a GroupingField of the collection, such as by changing the caseInsensitive, compareFunction, or groupingFunction properties.

The refresh() method can be applied synchronously or asynchronously.

When refresh() is called synchronously, all groups and summaries are updated together before the method returns. That means your application cannot perform other processing operations for the duration of the call. A client should wait for a CollectionEvent event with the value of the kind property set to CollectionEventKind.REFRESH to ensure that the refresh() method completed.

In asynchronous refresh, all groups and summaries are updated individually. The refresh() method returns before the groups and summaries are updated so that your application can continue execution. Also, the control is updated during the refresh so that the user can continue to interact with it.

The overhead of updating groups and summaries individually, rather than all at once, makes an asynchronous refresh take longer than a synchronous one. However, for large data sets, your application continues to operate during the refresh.

Parameters

async:Boolean (default = false) — If true, defines the refresh to be asynchronous. By default it is false denoting synchronous refresh.
 
dispatchCollectionEvents:Boolean (default = false) — If true, events are dispatched when groups are formed. For better performance, set it to false. If true, then events are dispatched as groups and summaries are calculated synchronously to update the control. Note: If async is true, the dispatchCollectionEvents is always set to true. By default it is false denoting no events will be dispatched.

Returns
Booleantrue if the refresh() method completed, and false if the refresh is incomplete, which can mean that items are still pending.