List 类

继承 UIObject > UIComponent > View > ScrollView > ScrollSelectList > List

动作脚本类命名空间 mx.controls.List

List 组件由下列三个部分组成:

项是用于将信息单位存储在列表中的一个“动作脚本”对象。可以将列表看作一个数组;数组中的每个索引空间就是一个项。项是一个对象,它通常有一个 label 属性(用于进行显示)和一个 data 属性(用于存储数据)。

行是用于显示项的一个组件。默认情况下,列表会提供行(使用 SelectableRow 类),或者您也可以提供行,它们通常作为 SelectableRow 类的子类。SelectableRow 类会实现 CellRenderer 接口,该接口是属性和方法的集合,通过它们,列表可以操作各行并将数据和状态信息(例如,已突出显示、已被选中,等等)发送到该行来进行显示。

数据提供程序是列表中的项列表的数据模型。同一帧中作为列表的任何数组都会自动得到一些方法,这些方法允许您操作数据并将更改广播给多个视图。您可以创建一个 Array 实例或者从服务器上获取一个实例,然后将它用作多个 List、ComboBox、DataGrid 等的数据模型。List 组件有一组代理其数据提供程序的方法(例如,addItem()removeItem())。如果没有为列表提供外部数据提供程序,则这些方法会自动创建一个数据提供程序实例,该实例会通过 List.dataProvider 被公开。

要将一个 List 组件添加到应用程序的 Tab 键顺序,请设置其 tabIndex 属性(请参阅 UIComponent.tabIndex)。List 组件用 FocusManager 覆盖默认的 Flash Player 焦点矩形,并绘制一个带有圆角的自定义焦点矩形。有关详细信息,请参阅创建自定义焦点导航

每个组件类都有一个 version 属性,该属性是一个类属性。类属性只能用于该类本身。version 属性会返回一个字符串,该字符串指明组件的版本。要访问 version 属性,请使用以下代码:

trace(mx.controls.List.version);

注意:下面的代码返回未定义的:trace(myListInstance.version);

List 类的方法摘要

方法

描述

List.addItem()>

向列表的结尾添加项目。

List.addItemAt()>

将项目添加到指定索引处的列表。

List.getItemAt()>

返回指定索引处的项目。

List.removeAll()>

删除列表中的所有项目。

List.removeItemAt()>

删除指定索引处的项目。

List.replaceItemAt()>

用其他项目替换指定索引处的项目。

List.setPropertiesAt()>

将指定的属性应用到指定的项目。

List.sortItems()>

按照指定的比较函数对列表中的项目进行排序。

List.sortItemsBy()>

按照指定的属性对列表中的项目进行排序。

继承 UIObject 类UIComponent 类中的所有方法。

List 类的属性摘要

属性

描述

List.cellRenderer

指定 cellRenderer 以用于列表的每行。

List.dataProvider

列表项目的来源。

List.hPosition

列表的水平位置。

List.hScrollPolicy

指明是 ("on") 否 ("off") 显示水平滚动条。

List.iconField

各项目中用于指定图标的字段。

List.iconFunction

一个函数,它确定要使用的图标。

List.labelField

指定各项目中用作标签文本的字段。

List.labelFunction

一个函数,它确定各个项目的哪些字段要用作标签文本。

List.length

项目中列表的长度。该属性为只读。

List.maxHPosition

当将 List.hScrollPolicy> 设置为 "on" 时,指定列表可以向右滚动的像素数目。

List.multipleSelection>

指明列表中允许 (true) 还是不允许 (false) 多选。

List.rowCount

列表中至少可以看到一部分的行数。

List.rowHeight

列表中每行的像素高度。

List.selectable>

指定列表是 (true) 否 (false) 为可选择列表。

List.selectedIndex

单选列表中的选择索引。

List.selectedIndices

多选列表中的已选择项目的数组。

List.selectedItem

单选列表中的已选择项目。该属性为只读。

List.selectedItems

多选列表中的已选择的项目对象。该属性为只读。

List.vPosition

滚动列表,以便使最顶部可见的项目为指定的数。

List.vScrollPolicy

指明是显示 ("on")、不显示 ("off") 还是在需要时显示 ("auto") 垂直滚动条。

继承 UIObject 类UIComponent 类的所有属性。

List 类的事件摘要

事件

描述

List.change>

所选内容因用户交互操作而更改时广播。

List.itemRollOut>

指针在列表项目上滑过然后又滑离时广播。

List.itemRollOver>

指针在列表项目上滑过时广播。

List.scroll>

滚动列表时,进行广播。

继承 UIObject 类UIComponent 类的所有事件。