Package | mx.collections |
Interface | public interface IGroupingCollection extends IHierarchicalData , IEventDispatcher |
Implementors | GroupingCollection |
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Related API Elements
Property | Defined By | ||
---|---|---|---|
grouping : Grouping
The Grouping object applied to the source data. | IGroupingCollection |
Method | Defined By | ||
---|---|---|---|
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. | IGroupingCollection | ||
Returns true if the node can contain children. | IHierarchicalData | ||
Dispatches an event into the event flow. | 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 | ||
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | IEventDispatcher | ||
Applies the grouping to the view. | IGroupingCollection | ||
Removes a listener from the EventDispatcher object. | IEventDispatcher | ||
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type. | IEventDispatcher |
grouping | property |
grouping:Grouping
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 IGroupingCollection retrieve all items from a remote location before executing grouping.
Implementation
public function get grouping():Grouping
public function set grouping(value:Grouping):void
cancelRefresh | () | method |
public function cancelRefresh():void
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
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 argument of true
, corresponding to an asynchronous refresh.
refresh | () | method |
public function refresh(async:Boolean = false):Boolean
Language Version: | ActionScript 3.0 |
Product Version: | Flex 3 |
Runtime Versions: | Flash Player 9, AIR 1.1 |
Applies the grouping to the view.
The IGroupingCollection does not detect changes to a group
automatically, so you must call the refresh()
method to update the view after setting the group
property.
The refresh()
method can be applied asynchronously
by calling refresh(true)
.
When refresh()
is called synchronously,
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.
Parameters
async:Boolean (default = false ) — If true , defines the refresh to be asynchronous.
By default it is false denoting synchronous refresh.
|
Boolean — true if the refresh() method completed,
and false if the refresh is incomplete,
which can mean that items are still pending.
|
Thu Dec 6 2018, 01:12 PM -08:00