Pacote | mx.collections |
Interface | public interface IGroupingCollection2 extends IHierarchicalData , IEventDispatcher |
Implementadores | GroupingCollection2 |
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Flex 4 |
Versões de runtime: | Flash Player 10, AIR 1.5 |
Elementos da API relacionados
Propriedade | Definido por | ||
---|---|---|---|
grouping : Grouping
The Grouping object applied to the source data. | IGroupingCollection2 |
Método | Definido por | ||
---|---|---|---|
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registra um objeto de ouvinte de evento em um objeto EventDispatcher, de forma que o ouvinte receba a notificação de um evento. | IEventDispatcher | ||
If the refresh is performed asynchronously,
cancels the refresh operation and stops the building of the groups. | IGroupingCollection2 | ||
Returns true if the node can contain children. | IHierarchicalData | ||
Envia um evento para o fluxo de eventos. | IEventDispatcher | ||
Returns an Object representing the node's children. | IHierarchicalData | ||
Returns data from a node. | IHierarchicalData | ||
Returns the root data item. | IHierarchicalData | ||
Returns true if the node has children. | IHierarchicalData | ||
Verifica se o objeto EventDispatcher tem ouvintes registrados para um tipo específico de evento. | IEventDispatcher | ||
Applies the grouping to the collection. | IGroupingCollection2 | ||
Remove um ouvinte do objeto EventDispatcher. | IEventDispatcher | ||
Verifica se um ouvinte de evento está registrado nesse objeto EventDispatcher ou em qualquer um de seus ancestrais para o tipo de evento especificado. | IEventDispatcher |
grouping | propriedade |
grouping:Grouping
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Flex 4 |
Versões de runtime: | 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.
Implementação
public function get grouping():Grouping
public function set grouping(value:Grouping):void
cancelRefresh | () | método |
public function cancelRefresh():void
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Flex 3 |
Versões de runtime: | 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 | () | método |
public function refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean
Versão da linguagem: | ActionScript 3.0 |
Versão de produto: | Flex 3 |
Versões de runtime: | 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.
Parâmetros
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.
|
Boolean — true if the refresh() method completed,
and false if the refresh is incomplete,
which can mean that items are still pending.
|
Wed Jun 13 2018, 11:10 AM Z