IGroupingCollection2 - Adobe ActionScript® 3 (AS3 Flex) API 参考

包	mx.collections
接口	public interface IGroupingCollection2 extends IHierarchicalData , IEventDispatcher
实现器	GroupingCollection2

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

IGroupingCollection2 接口定义根据平面数据创建分组数据所需的接口。

公共属性

	属性		由以下参数定义
		grouping : Grouping 应用于源数据的 Grouping 对象。	IGroupingCollection2

公共方法

隐藏继承的公共方法

显示继承的公共方法

	方法		由以下参数定义
		addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void 使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。	IEventDispatcher
		cancelRefresh():void 如果异步执行刷新，请取消刷新操作并停止构建组。	IGroupingCollection2
		canHaveChildren(node:Object):Boolean 如果该节点可以包含子项，则返回 true。	IHierarchicalData
		dispatchEvent(event:Event):Boolean 将事件调度到事件流中。	IEventDispatcher
		getChildren(node:Object):Object 返回表示节点子项的 Object。	IHierarchicalData
		getData(node:Object):Object 返回节点中的数据。	IHierarchicalData
		getRoot():Object 返回根数据项。	IHierarchicalData
		hasChildren(node:Object):Boolean 如果该节点包含子项，则返回 true。	IHierarchicalData
		hasEventListener(type:String):Boolean 检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。	IEventDispatcher
		refresh(async:Boolean = false, dispatchCollectionEvents:Boolean = false):Boolean 对该集合应用分组。	IGroupingCollection2
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void 从 EventDispatcher 对象中删除侦听器。	IEventDispatcher
		willTrigger(type:String):Boolean 检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。	IEventDispatcher

属性详细信息

grouping

属性

grouping:Grouping

语言版本:

ActionScript 3.0

产品版本:

Flex 4

运行时版本:

Flash Player 10, AIR 1.5

应用于源数据的 Grouping 对象。设置此属性不会自动刷新视图；因此，必须在设置此属性后调用 refresh() 方法。

注意：IGroupingCollection2 的 Flex 实现将先检索远程位置的所有项目，然后再执行分组。

实现
public function get grouping():Grouping
public function set grouping(value:Grouping):void

方法详细信息

cancelRefresh

()

方法

public function cancelRefresh():void

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 10, AIR 1.5

如果异步执行刷新，请取消刷新操作并停止构建组。与异步刷新相对应，此方法仅取消由调用带有 asynch 参数 true 的 refresh() 方法启动的刷新。

refresh

()

方法

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

语言版本:

ActionScript 3.0

产品版本:

Flex 3

运行时版本:

Flash Player 10, AIR 1.5

对该集合应用分组。该集合不会自动检测对组进行的更改，因此设置 grouping、source 或 summaries 属性后，必须调用 refresh() 方法以更新该集合。修改集合的 GroupingField（如通过更改 caseInsensitive、compareFunction 或 groupingFunction 属性）时您也调用 refresh() 方法。

可以同步或异步应用 refresh() 方法。

同步调用 refresh() 时，在该方法返回之前，会一起更新所有组和摘要。这意味着您的应用程序在该调用期间无法执行其它处理操作。客户端应等待 kind 属性值设置为 CollectionEventKind.REFRESH 的 CollectionEvent 事件，以确保完成 refresh() 方法。

在异步刷新中，会单独更新所有组和摘要。refresh() 方法在更新组和摘要之前返回，这样您的应用程序可以继续执行。此外，控件是在刷新过程中更新的，这样用户可以继续与其交互。

单独更新组和摘要（而不是一次全部更新）的开销使异步刷新比同步刷新花费的时间更长。但是，对于大型数据集，您的应用程序会在刷新过程中继续操作。

参数

	`async:Boolean` (default = `false`) — 如果为 `true`，则定义为异步刷新。默认情况下，为 `false`，指示同步刷新。

	`dispatchCollectionEvents:Boolean` (default = `false`) — 若为 `true`，则当形成组时调度事件。为了使性能更佳，可将其设置为 `false`。若为 `true`，则事件是作为组调度的，且会同步计算摘要以更新控件。注意：如果 `async` 为 `true`，则会始终将 `dispatchCollectionEvents` 设置为 `true`。默认情况下，它为 `false`，指示将不会调度任何事件。

Boolean — 如果 refresh() 方法已完成，则为 true；如果刷新尚未完成，则为 false，这样可以表示这些项目仍未处理。

法律声明 | 在线隐私策略

IGroupingCollection2 - AS3 Flex

包x

语言元素

附录

包 mx.collections

grouping

cancelRefresh

refresh