public function refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean
Language Version: | ActionScript 3.0 |
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 | Boolean — true if the refresh() method completed,
and false if the refresh is incomplete,
which can mean that items are still pending.
|