fl.controls
public class SelectableList
继承SelectableList Inheritance BaseScrollPane Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
实现 IFocusManagerComponent
子类 DataGrid, List, TileList

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

SelectableList 是所有基于列表的组件(例如 List、TileList、DataGrid 和 ComboBox 组件)的基类。 此类提供多种方法和属性,用于行的呈现和布局以及设置滚动条样式和数据提供者。

注意:此类未创建组件;它只是执行了公开,因此可进行扩展。

另请参见

fl.controls.DataGrid
fl.controls.List
fl.controls.TileList
fl.data.DataProvider



公共 属性
 属性定义方
 InheritedaccessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。
DisplayObject
  allowMultipleSelection : Boolean
获取一个布尔值,指示能否一次选择多个列表项目。
SelectableList
 Inheritedalpha : Number
指示指定对象的 Alpha 透明度值。
DisplayObject
 InheritedblendMode : String
BlendMode 类中的一个值,用于指定要使用的混合模式。
DisplayObject
 InheritedbuttonMode : Boolean
指定此 sprite 的按钮模式。
Sprite
 InheritedcacheAsBitmap : Boolean
如果设置为 true,则 Flash Player 将缓存显示对象的内部位图表示形式。
DisplayObject
 Inheritedconstructor : Object
对类对象或给定对象实例的构造函数的引用。
Object
 InheritedcontextMenu : ContextMenu
指定与此对象相关联的上下文菜单。
InteractiveObject
  dataProvider : DataProvider
获取或设置要查看的项目列表的数据模型。
SelectableList
 InheriteddoubleClickEnabled : Boolean
指定此对象是否接收 doubleClick 事件。
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] 指定拖动 sprite 时经过的显示对象,或放置 sprite 的显示对象。
Sprite
 Inheritedenabled : Boolean
获取或设置一个值,该值指示组件是否可以接受用户交互。
UIComponent
 Inheritedfilters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。
DisplayObject
 InheritedfocusEnabled : Boolean
获取或设置一个布尔值,该值指示组件是否可以在用户单击它后获得焦点。
UIComponent
 InheritedfocusManager : IFocusManager
获取或设置为此组件及其同级组件控制焦点的 FocusManager。
UIComponent
 InheritedfocusRect : Object
指定此对象是否显示焦点矩形。
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] 指定属于此 sprite 的 Graphics 对象,在此 sprite 中可执行矢量绘画命令。
Sprite
 Inheritedheight : Number
获取或设置组件的高度,以像素为单位。
UIComponent
 InheritedhitArea : Sprite
指定一个 sprite 用作另一个 sprite 的点击区域。
Sprite
 InheritedhorizontalLineScrollSize : Number
获取或设置一个值,该值描述当单击滚动箭头时要在水平方向上滚动的内容量。
BaseScrollPane
 InheritedhorizontalPageScrollSize : Number
获取或设置按滚动条轨道时水平滚动条上滚动滑块要移动的像素数。
BaseScrollPane
 InheritedhorizontalScrollBar : ScrollBar
[read-only] 获取对水平滚动条的引用。
BaseScrollPane
 InheritedhorizontalScrollPolicy : String
获取或设置一个值,该值指示水平滚动条的状态。
BaseScrollPane
 InheritedhorizontalScrollPosition : Number
获取或设置一个值,该值描述滚动窗格中水平滚动条的水平位置(以像素为单位)。
BaseScrollPane
  length : uint
[read-only] 获取数据提供者中的项目数。
SelectableList
 InheritedloaderInfo : LoaderInfo
[read-only] 返回一个 LoaderInfo 对象,其中包含加载此显示对象所属的文件的相关信息。
DisplayObject
 Inheritedmask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。
DisplayObject
  maxHorizontalScrollPosition : Number
获取或设置当 horizontalScrollPolicy 属性设置为 ScrollPolicy.ON 时,列表可以向右滚动的像素数。
SelectableList
 InheritedmaxVerticalScrollPosition : Number
[read-only] 获取当前内容的最大垂直滚动位置(以像素为单位)。
BaseScrollPane
 InheritedmouseChildren : Boolean
确定对象的子项是否支持鼠标。
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
指定此对象是否接收鼠标消息。
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
获取或设置一个值,该值指示组件是否可以在用户单击它后获得焦点。
UIComponent
 InheritedmouseX : Number
[read-only] 指示鼠标位置的 x 坐标,以像素为单位。
DisplayObject
 InheritedmouseY : Number
[read-only] 指示鼠标位置的 y 坐标,以像素为单位。
DisplayObject
 Inheritedname : String
指示 DisplayObject 的实例名称。
DisplayObject
 InheritednumChildren : int
[read-only] 返回此对象的子项数目。
DisplayObjectContainer
 InheritedopaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] 指示包含此显示对象的 DisplayObjectContainer 对象。
DisplayObject
 Inheritedprototype : Object
[static] 对类或函数对象的原型对象的引用。
Object
 Inheritedroot : DisplayObject
[read-only] 对于加载的 SWF 文件中的显示对象,root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。
DisplayObject
 Inheritedrotation : Number
指示 DisplayObject 实例距其原始方向的旋转程度,以度为单位。
DisplayObject
  rowCount : uint
[read-only] 获取列表中至少部分可见的行的行数。
SelectableList
 Inheritedscale9Grid : Rectangle
当前有效的缩放网格。
DisplayObject
 InheritedscaleX : Number
将组件的当前宽度与缩放系数相乘。
UIComponent
 InheritedscaleY : Number
将组件的当前高度与缩放系数相乘。
UIComponent
 InheritedscrollRect : Rectangle
显示对象的滚动矩形范围。
DisplayObject
  selectable : Boolean
获取或设置一个布尔值,指示列表中的项目是否可选。
SelectableList
  selectedIndex : int
获取或设置单选列表中的选定项目的索引。
SelectableList
  selectedIndices : Array
获取或设置一个数组,其中包含从多选列表中选定的项目。
SelectableList
  selectedItem : Object
获取或设置从单选列表中选择的项目。
SelectableList
  selectedItems : Array
获取或设置一个数组,其中包含多选列表中的选定项目的对象。
SelectableList
 InheritedsoundTransform : SoundTransform
控制此 sprite 中的声音。
Sprite
 Inheritedstage : Stage
[read-only] 显示对象的舞台。
DisplayObject
 InheritedtabChildren : Boolean
确定对象的子项是否支持 Tab 键。
DisplayObjectContainer
 InheritedtabEnabled : Boolean
指定此对象是否遵循 Tab 键顺序。
InteractiveObject
 InheritedtabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。
InteractiveObject
 InheritedtextSnapshot : TextSnapshot
[read-only] 返回此 DisplayObjectContainer 实例的 TextSnapshot 对象。
DisplayObjectContainer
 Inheritedtransform : Transform
一个对象,具有与显示对象的矩阵、颜色转换和像素范围有关的属性。
DisplayObject
 InheriteduseBitmapScrolling : Boolean
设置为 true 时,滚动内容的 cacheAsBitmap 属性设置为 true;设置为 false 时,该值会关闭。
BaseScrollPane
 InheriteduseHandCursor : Boolean
布尔值,指示当鼠标滑过其 buttonMode 属性设置为 true 的 sprite 时是否显示手指形(手形光标)。
Sprite
 Inheritedversion : String = "3.0.0.13"
组件的版本号。
UIComponent
 InheritedverticalLineScrollSize : Number
获取或设置一个值,该值描述当单击滚动箭头时要在垂直方向上滚动多少像素。
BaseScrollPane
 InheritedverticalPageScrollSize : Number
获取或设置按滚动条轨道时垂直滚动条上滚动滑块要移动的像素数。
BaseScrollPane
 InheritedverticalScrollBar : ScrollBar
[read-only] 获取对垂直滚动条的引用。
BaseScrollPane
 InheritedverticalScrollPolicy : String
获取或设置一个值,该值指示垂直滚动条的状态。
BaseScrollPane
 InheritedverticalScrollPosition : Number
获取或设置一个值,该值描述滚动窗格中垂直滚动条的垂直位置(以像素为单位)。
BaseScrollPane
 Inheritedvisible : Boolean
获取或设置一个值,该值指示当前组件实例是否可见。
UIComponent
 Inheritedwidth : Number
获取或设置组件的宽度(以像素为单位)。
UIComponent
 Inheritedx : Number
获取或设置 x 坐标,该坐标表示组件在其父容器内沿 x 轴的位置。
UIComponent
 Inheritedy : Number
获取或设置 y 坐标,该坐标表示组件在其父容器内沿 y 轴的位置。
UIComponent
公共 方法
 方法定义方
  
创建新的 SelectableList 实例。
SelectableList
 Inherited
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。
DisplayObjectContainer
 Inherited
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象,以使侦听器能够接收事件通知。
EventDispatcher
  
向项目列表的末尾追加项目。
SelectableList
  
addItemAt(item:Object, index:uint):void
在指定索引位置处将项目插入列表。
SelectableList
 Inherited
指示安全限制是否会导致出现以下情况:在列表中忽略了使用指定 point 点调用 DisplayObjectContainer.getObjectsUnderPoint() 方法时返回的所有显示对象。
DisplayObjectContainer
  
clearRendererStyle(name:String, column:int = -1):void
清除列表中渲染器上所设置的样式。
SelectableList
  
清除列表中当前所选的项目,并将 selectedIndex 属性设置为 -1。
SelectableList
 Inherited
删除此组件实例中的样式属性。
UIComponent
 Inherited
确定指定显示对象是 DisplayObjectContainer 实例的子项还是该实例本身。
DisplayObjectContainer
 Inherited
将事件调度到事件流中。
EventDispatcher
 Inherited
在此组件上显示或隐藏焦点指示符。
UIComponent
 Inherited
启动立即绘制操作,但不像 invalidateNow 那样使全部设置失效。
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。
DisplayObject
 Inherited
返回位于指定索引处的子显示对象实例。
DisplayObjectContainer
 Inherited
返回具有指定名称的子显示对象。
DisplayObjectContainer
 Inherited
返回 DisplayObject 的 child 实例的索引位置。
DisplayObjectContainer
 Inherited
检索当前具有焦点的对象。
UIComponent
  
检索指定索引处的项目。
SelectableList
 Inherited
返回对象的数组,这些对象位于指定点下,并且是该 DisplayObjectContainer 实例的子项(或孙子项,依此类推)。
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
返回一个矩形,该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界,但不包括形状上的任何笔触。
DisplayObject
  
getRendererStyle(name:String, column:int = -1):Object
检索列表中渲染器上所设置的样式。
SelectableList
 Inherited
检索组件的样式查找链中设置的样式属性。
UIComponent
  
[static] 检索当前组件的默认样式映射。
SelectableList
 Inherited
将 point 对象从舞台(全局)坐标转换为显示对象的(本地)坐标。
DisplayObject
 Inherited
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。
EventDispatcher
 Inherited
指示对象是否已经定义了指定的属性。
Object
 Inherited
计算显示对象,以确定它是否与 obj 显示对象重叠或相交。
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
计算显示对象,以确定它是否与 x 和 y 参数指定的点重叠或相交。
DisplayObject
 Inherited
invalidate(property:String, callLater:Boolean = true):void
在未另外指定的情况下,将属性标记为无效,并在下一帧上重绘组件。
UIComponent
  
使特定项目渲染器失效。
SelectableList
  
使位于指定索引处的项目的渲染器失效。
SelectableList
  
使整个列表失效,强制重绘列表项目。
SelectableList
  
检查列表中的指定项目是否处于选中状态。
SelectableList
 Inherited
指示 Object 类的实例是否在指定为参数的对象的原型链中。
Object
  
为给定的项目对象(如果有)检索 ICellRenderer。
SelectableList
 Inherited
将 point 对象从显示对象的(本地)坐标转换为舞台(全局)坐标。
DisplayObject
 Inherited
[static] 将多个类的样式合并到一个对象中。
UIComponent
 Inherited
将组件移动到其父项内的指定位置。
UIComponent
 Inherited
指示指定的属性是否存在、是否可枚举。
Object
  
删除列表中的所有项目。
SelectableList
 Inherited
从 DisplayObjectContainer 实例的子列表中删除指定的 child DisplayObject 实例。
DisplayObjectContainer
 Inherited
从 DisplayObjectContainer 的子列表中指定的 index 位置删除子 DisplayObject。
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
从 EventDispatcher 对象中删除侦听器。
EventDispatcher
  
从列表中删除指定项目。
SelectableList
  
删除指定索引位置处的项目。
SelectableList
  
用其它项目替换指定索引位置处的项目。
SelectableList
  
scrollToIndex(newCaretIndex:int):void
将列表滚动至位于指定索引处的项目。
SelectableList
  
将列表滚动至由 selectedIndex 属性的当前值指示的位置处的项目。
SelectableList
 Inherited
更改现有子项在显示对象容器中的位置。
DisplayObjectContainer
 Inherited
设置此组件的焦点。
UIComponent
 Inherited
设置循环操作动态属性的可用性。
Object
  
setRendererStyle(name:String, style:Object, column:uint = 0):void
设置列表中渲染器上的样式。
SelectableList
 Inherited
setSize(width:Number, height:Number):void
将组件设置为指定宽度和高度。
UIComponent
 Inherited
setStyle(style:String, value:Object):void
对此组件实例设置样式属性。
UIComponent
  
sortItems(... sortArgs):*
对当前数据提供者的元素进行排序。
SelectableList
  
sortItemsOn(field:String, options:Object = null):*
以当前数据提供者的一个或多个字段为依据对其元素进行排序。
SelectableList
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
允许用户拖动指定的 Sprite。
Sprite
 Inherited
结束 startDrag() 方法。
Sprite
 Inherited
交换两个指定子对象的 Z 轴顺序(从前到后顺序)。
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
在子级列表中两个指定的索引位置,交换子对象的 Z 轴顺序(前后顺序)。
DisplayObjectContainer
 Inherited
返回指定对象的字符串表示形式。
Object
 Inherited
验证并更新此对象的属性和布局,如果需要的话重绘对象。
UIComponent
 Inherited
返回指定对象的原始值。
Object
 Inherited
检查是否用此 EventDispatcher 对象或其任何始祖为指定事件类型注册了事件侦听器。
EventDispatcher
事件
 事件摘要定义方
 Inherited Flash Player 获得操作系统焦点并变为活动状态时调度。EventDispatcher
 Inherited 将显示对象添加到显示列表中时调度。DisplayObject
 Inherited 在将显示对象直接添加到舞台显示列表或将包含显示对象的子树添加至舞台显示列表中时调度。DisplayObject
   当在列表中选择了另一项目后调度。SelectableList
 Inherited 用户在同一 InteractiveObject 上按下并释放用户指针设备的主按钮时调度。InteractiveObject
 Inherited Flash Player 失去操作系统焦点并变为非活动状态时调度。EventDispatcher
 Inherited 如果 InteractiveObject 的 doubleClickEnabled 标志设置为 true,当用户在该对象上快速连续按下两次并释放指针设备的主按钮时调度。InteractiveObject
 Inherited 播放头进入新帧时调度。DisplayObject
 Inherited 显示对象获得焦点后调度。InteractiveObject
 Inherited 显示对象失去焦点后调度。InteractiveObject
 Inherited 在组件可见性从可见改为不可见以后调度。UIComponent
   当用户单击组件中的项目时调度。SelectableList
   当用户快速连续单击两次组件中的项目时调度。SelectableList
   当用户将指针滑离组件中的项目时调度。SelectableList
   当用户将指针滑过组件中的项目时调度。SelectableList
 Inherited 用户按下某个键时调度。InteractiveObject
 Inherited 用户尝试使用键盘导航更改焦点时调度。InteractiveObject
 Inherited 用户释放某个键时调度。InteractiveObject
 Inherited 在 Flash Player 窗口中,用户在 InteractiveObject 实例上按下指针设备按钮时调度。InteractiveObject
 Inherited 用户尝试使用指针设备更改焦点时调度。InteractiveObject
 Inherited 用户移动 InteractiveObject 上的指针设备时调度。InteractiveObject
 Inherited 用户将指针设备从 InteractiveObject 实例上移开时调度。InteractiveObject
 Inherited 在 Flash Player 窗口中,用户将指针设备移动到 InteractiveObject 实例上时调度。InteractiveObject
 Inherited 在 Flash Player 窗口中,用户在 InteractiveObject 实例上释放指针设备按钮时调度。InteractiveObject
 Inherited 在 Flash Player 窗口中,鼠标滚轮滚动到 InteractiveObject 实例上时调度。InteractiveObject
 Inherited 在移动组件以后调度。UIComponent
 Inherited 将要从显示列表中删除显示对象时调度。DisplayObject
 Inherited 在从显示列表中直接删除显示对象或删除包含显示对象的子树时调度。DisplayObject
 Inherited 将要更新和呈现显示列表时调度。DisplayObject
 Inherited 在调整组件大小以后调度。UIComponent
   当用户将指针滑离组件时调度。SelectableList
   当用户将指针滑过组件时调度。SelectableList
   当用户水平或垂直滚动时调度。SelectableList
 Inherited 在组件可见性从不可见改为可见以后调度。UIComponent
 Inherited 对象的 tabChildren 标志值发生更改时调度。InteractiveObject
 Inherited 对象的 tabEnabled 标志发生更改时调度。InteractiveObject
 Inherited 对象的 tabIndex 属性值发生更改时调度。InteractiveObject
样式
 样式说明定义方
  
cellRenderer
类型: Class
为组件中的每个项目提供单元格渲染器的类。 默认值为 fl.contols.listClasses.CellRenderer.
SelectableList
  
contentPadding
类型: Number   格式: Length
用于分隔列表边框和列表内容的填充(以像素为单位)。 默认值为 null.
SelectableList
  
disabledAlpha
类型: Number
当 enabled 属性为 false 时将列表设置为的 Alpha 值。 默认值为 null.
SelectableList
 Inherited 类型: flash.text.TextFormat
用于在禁用了按钮的情况下呈现组件标签的 TextFormat 对象。 默认值为 TextFormat("_sans", 11, 0x999999, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).
UIComponent
 Inherited 类型: Class
类的名称,该类用作当禁用了滚动条时滚动条的向下箭头按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowDown_disabledSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当单击滚动条的向下箭头按钮时该按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowDown_downSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当鼠标指针在滚动条的向下箭头按钮上方时该按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowDown_overSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作滚动条的向下箭头按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowDown_upSkin.
BaseScrollPane
 Inherited 类型: Number   格式: Length
用于分隔组件的外边框和焦点指示符的外边框的填充(以像素为单位)。 默认值为 2.
UIComponent
 Inherited 类型: Class
用于显示焦点指示符的外观。 默认值为 focusRectSkin.
UIComponent
 Inherited 类型: Number   格式: Time
在第一次调度 buttonDown 事件之后、发送第二个 buttonDown 事件之前等待的毫秒数。. 默认值为 500.
BaseScrollPane
 Inherited 类型: Number   格式: Time
在由 repeatDelay 样式指定的延迟之后调度的 buttonDown 事件之间的间隔(以毫秒为单位)。. 默认值为 35.
BaseScrollPane
  
skin
类型: Class
提供组件背景的外观的类。 默认值为 List_skin.
SelectableList
 Inherited 类型: flash.text.TextFormat
用于呈现组件标签的 TextFormat 对象。 默认值为 TextFormat("_sans", 11, 0x000000, false, false, false, '', '', TextFormatAlign.LEFT, 0, 0, 0, 0).
UIComponent
 Inherited 类型: Class
用于指示缩略图的禁用状态的外观。. 默认值为 ScrollThumb_upSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当单击滚动条的缩略图时该缩略图的外观。. 默认值为 ScrollThumb_downSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作滚动条的缩略图的图标。. 默认值为 ScrollBar_thumbIcon.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当鼠标指针在滚动条的缩略图上方时该缩略图的外观。. 默认值为 ScrollThumb_overSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作滚动条的缩略图的外观。. 默认值为 ScrollThumb_upSkin.
BaseScrollPane
 Inherited 类型: Class
用于指示被禁用轨道的外观。. 默认值为 ScrollTrack_Skin.
BaseScrollPane
 Inherited 类型: Class
用于指示被禁用外观的按下状态的外观。. 默认值为 ScrollTrack_Skin.
BaseScrollPane
 Inherited 类型: Class
用于指示滚动轨道的鼠标悬停状态的外观。. 默认值为 ScrollTrack_Skin.
BaseScrollPane
 Inherited 类型: Class
用于指示滚动轨道的鼠标松开状态的外观。. 默认值为 ScrollTrack_Skin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当禁用了滚动条时滚动条的向上箭头按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowUp_disabledSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当单击滚动条的向上箭头按钮时该按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowUp_downSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作当鼠标指针在滚动条的向上箭头按钮上方时该按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowUp_overSkin.
BaseScrollPane
 Inherited 类型: Class
类的名称,该类用作滚动条的向上箭头按钮的外观。 如果以图形化方式或编程方式更改该外观,您应当确保新外观与轨道具有相同的高度(对于水平滚动条)或高度(对于垂直滚动条)。. 默认值为 ScrollArrowUp_upSkin.
BaseScrollPane
属性详细信息
allowMultipleSelection属性
allowMultipleSelection:Boolean  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取一个布尔值,指示能否一次选择多个列表项目。 true 值指示可以一次选择多个项目;false 值指示一次只能选择一个项目。

默认值为 false.


实现
    public function get allowMultipleSelection():Boolean
    public function set allowMultipleSelection(value:Boolean):void

另请参见


示例
如何使用示例

下例创建一个新的 List 实例,并在列表中的所选项目发生更改时跟踪 selectedIndexselectedIndices 属性:

import fl.controls.List;
import fl.data.DataProvider;

var items:XML = <items>
        <item label="Item A" />
        <item label="Item B" />
        <item label="Item C" />
    </items>;

var dp:DataProvider = new DataProvider(items);

var myList:List = new List();
myList.dataProvider = dp;
myList.allowMultipleSelection = true;
myList.move(10, 10);
myList.setSize(320, 240);
myList.addEventListener(Event.CHANGE, changeHandler);
addChild(myList);

function changeHandler(event:Event):void {
    var lst:List = event.currentTarget as List;
    trace("change:");
    trace("\t" + "selectedIndex:", lst.selectedIndex);
    trace("\t" + "selectedIndices:", lst.selectedIndices);
    trace("\t" + "Number selected items:", lst.selectedIndices.length);
}
dataProvider属性 
dataProvider:DataProvider  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置要查看的项目列表的数据模型。 数据提供者可由多个基于列表的组件共享。 对数据提供者所做的更改会立即应用于将其用作数据源的所有组件。

默认值为 null.


实现
    public function get dataProvider():DataProvider
    public function set dataProvider(value:DataProvider):void
length属性 
length:uint  [read-only]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取数据提供者中的项目数。


实现
    public function get length():uint

示例
如何使用示例

下例创建一个 List 组件实例,并将 rowCount 属性设置为列表中的当前项目数:

import fl.controls.List;

var myList:List = new List();
myList.addItem({label:"Item A"});
myList.addItem({label:"Item B"});
myList.addItem({label:"Item C"});
myList.addItem({label:"Item D"});
myList.rowCount = myList.length;
myList.move(10, 10);
addChild(myList);
maxHorizontalScrollPosition属性 
maxHorizontalScrollPosition:Number  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置当 horizontalScrollPolicy 属性设置为 ScrollPolicy.ON 时列表向右滚动的像素数。


实现
    public function get maxHorizontalScrollPosition():Number
    public function set maxHorizontalScrollPosition(value:Number):void

另请参见

rowCount属性 
rowCount:uint  [read-only]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取列表中至少部分可见的行的行数。

注意:在扩展 SelectableList 的任何类中都必须覆盖此属性。

默认值为 0.


实现
    public function get rowCount():uint

示例
如何使用示例

此示例设置列表的大小,并通过跟踪 rowCount 属性来确定可能成为可见行的数量:

import fl.data.DataProvider;
import fl.controls.List;

var dp:DataProvider = new DataProvider();
var i:uint;
for(i=0; i<100; i++) {
    dp.addItem( { label: "Item " + i } );
}

var list:List = new List();
list.setSize(100,300);
list.dataProvider = dp;
addChild(list);

trace(list.rowCount); // 15
selectable属性 
selectable:Boolean  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置一个布尔值,指示列表中的项目是否可选。 true 值指示列表项目可选;false 值指示列表项目不可选。

默认值为 true.


实现
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

另请参见

selectedIndex属性 
selectedIndex:int  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置单选列表中的选定项目的索引。 单选列表是一次只能从中选择一个项目的列表。

值为 -1 指示未选择任何项目;如果选择了多项,则该值等于所选的一组项目中最后一个选定项目的索引。

使用 ActionScript 设置此属性时,位于指定索引处的项目将替换当前选定的内容。 通过编程方式更改选定内容时,不会调度 change 事件对象。


实现
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void

另请参见


示例
如何使用示例

此示例跟踪列表中被单击的任意项目的标签和行索引:

import fl.controls.List;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
var i:uint;
for (i = 0; i < 5; i++) {
    dp.addItem( { label: "Sample Name"} );
}

var list:List = new List();
list.dataProvider = dp;
list.addEventListener(Event.CHANGE,announceClickedItem)
addChild(list);

function announceClickedItem(e:Event):void {
    trace("You have clicked: " + list.selectedItem.label + " in row " + list.selectedIndex);
}
selectedIndices属性 
selectedIndices:Array  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置一个数组,其中包含从多选列表中选定的项目。

若要通过编程方式替换当前选定的内容,可以对此属性进行显式赋值。 可以通过将此属性设置为空数组或 undefined 值来清除当前选定的内容。 如果未从项目列表中选择任何项目,则此属性为 undefined

数组中的值序列反映了从多选列表中选择项目的顺序。 例如,如果您从列表中单击第二项,再单击第三项,最后单击第一项,则此属性所包含数组的值按以下次序排列:[1,2,0]


实现
    public function get selectedIndices():Array
    public function set selectedIndices(value:Array):void

另请参见

selectedItem属性 
selectedItem:Object  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置从单选列表中选择的项目。 对于从中选择了多个项目的多选列表,此属性包含最后选择的项目。

如果未选定任何内容,则此属性的值为 null


实现
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void

另请参见


示例
如何使用示例

此示例跟踪列表中被单击的任意项目的标签和行索引:

import fl.controls.List;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
var i:uint;
for (i = 0; i < 5; i++) {
    dp.addItem( { label: "Sample Name"} );
}

var list:List = new List();
list.dataProvider = dp;
list.addEventListener(Event.CHANGE,announceClickedItem)
addChild(list);

function announceClickedItem(e:Event):void {
    trace("You have clicked: " + list.selectedItem.label + " in row " + list.selectedIndex);
}
selectedItems属性 
selectedItems:Array  [read-write]

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

获取或设置一个数组,其中包含多选列表中的选定项目的对象。

对于单选列表,此属性的值为包含一个选定项目的数组。 在单选列表中,allowMultipleSelection 属性设置为 false


实现
    public function get selectedItems():Array
    public function set selectedItems(value:Array):void

另请参见


示例
如何使用示例

下例创建一个 List 组件实例,并将所选项目从列表 A 复制到列表 B 中:

import fl.controls.List;
import fl.data.DataProvider;

var listA:List = new List();
listA.allowMultipleSelection = true;
listA.addItem({label:"Item A"});
listA.addItem({label:"Item B"});
listA.addItem({label:"Item C"});
listA.addItem({label:"Item D"});
listA.addItem({label:"Item E"});
listA.addItem({label:"Item F"});
listA.addItem({label:"Item G"});
listA.move(10, 10);
listA.addEventListener(Event.CHANGE, changeHandler);
addChild(listA);

var listB:List = new List();
listB.selectable = false;
listB.move(120, 10);
addChild(listB);

function changeHandler(event:Event):void {
    if (listA.selectedItems.length > 0) {
        listB.dataProvider = new DataProvider(listA.selectedItems);
    }
}
构造函数详细信息
SelectableList()构造函数
public function SelectableList()

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

创建新的 SelectableList 实例。

方法详细信息
addItem()方法
public function addItem(item:Object):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

向项目列表的末尾追加项目。

项目应包含 labeldata 属性;但包含其它属性的项目也可以添加到列表。 默认情况下,项目的 label 属性用于显示行的标签;data 属性用于存储行的数据。

参数

item:Object — 要添加到数据提供者的项目。

另请参见

addItemAt()方法 
public function addItemAt(item:Object, index:uint):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

在指定索引位置处将项目插入列表。 位于指定索引位置处或之后的项目的索引将增加 1。

参数

item:Object — 要添加到列表的项目。
 
index:uint — 要添加项目处的索引。


引发
RangeError — 指定的索引小于 0 或大于等于数据提供者的长度。

另请参见

clearRendererStyle()方法 
public function clearRendererStyle(name:String, column:int = -1):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

清除列表中渲染器上所设置的样式。

参数

name:String — 要清除的样式的名称。
 
column:int (default = -1)

另请参见

clearSelection()方法 
public function clearSelection():void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

清除列表中当前所选的项目,并将 selectedIndex 属性设置为 -1。


示例
如何使用示例

下例创建一个 List 组件实例,并在单击 Button 组件时清除当前所选的列表项目:

import fl.controls.Button;
import fl.controls.List;
import fl.data.DataProvider;

var data:XML = <items>
        <item label="Person A" id="p001" />
        <item label="Person B" id="p002" />
        <item label="Person C" id="p003" />
    </items>;

var dp:DataProvider = new DataProvider(data);

var myList:List = new List();
myList.allowMultipleSelection = false;
myList.dataProvider = dp;
myList.move(10, 10);
myList.selectedIndex = 0;
addChild(myList);

var clearButton:Button = new Button();
clearButton.label = "Clear selection";
clearButton.move(120, 10);
clearButton.addEventListener(MouseEvent.CLICK, clickHandler);
addChild(clearButton);

function clickHandler(event:MouseEvent):void {
    trace("selectedIndex (before):", myList.selectedIndex);
    myList.clearSelection();
    trace("selectedIndex (after):", myList.selectedIndex);
}
getItemAt()方法 
public function getItemAt(index:uint):Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

检索指定索引处的项目。

参数

index:uint — 要检索的项目的索引。

返回
Object — 位于指定索引位置处的对象。

引发
RangeError — 指定的索引小于 0 或大于等于数据提供者的长度。
getRendererStyle()方法 
public function getRendererStyle(name:String, column:int = -1):Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

检索列表中渲染器上所设置的样式。

参数

name:String — 要检索的样式的名称。
 
column:int (default = -1) — 要检索的样式的值。

返回
Object

另请参见

getStyleDefinition()方法 
public static function getStyleDefinition():Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

检索当前组件的默认样式映射。 样式映射包含适合组件的类型,具体取决于组件使用的样式。 例如,disabledTextFormat 样式包含 null 值或 TextFormat 对象。 可以使用这些样式并对当前组件调用 setStyle()。 下面的代码覆盖指定组件上默认的 disabledTextFormat 样式:
componentInstance.setStyle("disabledTextFormat", new TextFormat());

返回
Object — 默认样式对象。

另请参见


示例
如何使用示例

下例为多个组件类创建一个样式浏览器:
import fl.controls.*;
import fl.containers.*;
import fl.controls.listClasses.*;
import fl.controls.dataGridClasses.*;
import fl.controls.progressBarClasses.*;
import fl.core.UIComponent;
import fl.data.DataProvider;

var dp:DataProvider = new DataProvider();
dp.addItem( { label: "BaseScrollPane",    data:BaseScrollPane } );
dp.addItem( { label: "Button",             data:Button } );
dp.addItem( { label: "CellRenderer",    data:CellRenderer } );
dp.addItem( { label: "CheckBox",         data:CheckBox } );
dp.addItem( { label: "ColorPicker",     data:ColorPicker } );
dp.addItem( { label: "ComboBox",         data:ComboBox } );
dp.addItem( { label: "DataGrid",         data:DataGrid } );
dp.addItem( { label: "HeaderRenderer",    data:HeaderRenderer } );
dp.addItem( { label: "ImageCell",        data:ImageCell } );
dp.addItem( { label: "IndeterminateBar",data:IndeterminateBar } );
dp.addItem( { label: "Label",             data:Label } );
dp.addItem( { label: "List",             data:List } );
dp.addItem( { label: "NumericStepper",     data:NumericStepper } );
dp.addItem( { label: "ProgressBar",     data:ProgressBar } );
dp.addItem( { label: "RadioButton",     data:RadioButton } );
dp.addItem( { label: "ScrollPane",         data:ScrollPane } );
dp.addItem( { label: "Slider",             data:Slider } );
dp.addItem( { label: "TextArea",         data:TextArea } );
dp.addItem( { label: "TextInput",         data:TextInput } );
dp.addItem( { label: "TileList",         data:TileList } );
dp.addItem( { label: "UILoader",         data:UILoader } );
dp.addItem( { label: "UIComponent",     data:UIComponent } );

var cb:ComboBox = new ComboBox();
cb.move(10,10);
cb.setSize(300,25);
cb.prompt = "Select a component to view its styles";
cb.rowCount = 12;
cb.dataProvider = dp;
cb.addEventListener(Event.CHANGE, showStyleDefinition);
addChild(cb);

var dg:DataGrid = new DataGrid();
dg.setSize(425,300);
dg.move(10,50);
dg.columns = [ new DataGridColumn("StyleName"), new DataGridColumn("DefaultValue") ];
addChild(dg);

function showStyleDefinition(e:Event):void {
    var componentClass:Class = e.target.selectedItem.data as Class;
    var styles:Object = componentClass["getStyleDefinition"].call(this);
    trace(styles.toString());
    var styleData:DataProvider = new DataProvider();
    for(var i:* in styles) {
        trace(i + " : " + styles[i]);
        styleData.addItem( { StyleName:i, DefaultValue:styles[i] } );
    }
    styleData.sortOn("StyleName");
    dg.dataProvider = styleData;
}
invalidateItem()方法 
public function invalidateItem(item:Object):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

使特定项目渲染器失效。

参数

item:Object — 数据提供者中要使之失效的项目。

另请参见

invalidateItemAt()方法 
public function invalidateItemAt(index:uint):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

使位于指定索引处的项目的渲染器失效。

参数

index:uint — 数据提供者中要使之失效项目的索引。

另请参见

invalidateList()方法 
public function invalidateList():void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

使整个列表失效,强制重绘列表项目。

另请参见

isItemSelected()方法 
public function isItemSelected(item:Object):Boolean

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

检查列表中的指定项目是否处于选中状态。

参数

item:Object — 要检查的项目。

返回
Boolean — 如果指定项目处于选中状态,此方法返回 true;否则,如果指定项目的值为 null 或列表中不包含指定项目,则此方法返回 false
itemToCellRenderer()方法 
public function itemToCellRenderer(item:Object):ICellRenderer

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

为给定的项目对象(如果有)检索 ICellRenderer。 此方法始终返回 null

参数

item:Object — 数据提供者中的项目。

返回
ICellRenderernull 值。

示例
如何使用示例

下例演示如何获取列表中所选项目的单元格渲染器:
import fl.controls.List;
import fl.controls.listClasses.ListData;
import fl.controls.listClasses.CellRenderer;
import fl.events.ListEvent;

var sampleItem1:Object = { label:"John Alpha" };
var sampleItem2:Object = { label:"Mary Bravo" };
var sampleItem3:Object = { label:"Trevor Gamma" };
var sampleItem4:Object = { label:"Susan Delta" };        

var myList:List;
myList = new List();
myList.move(10,10);
myList.addItem(sampleItem1);
myList.addItem(sampleItem2);
myList.addItem(sampleItem3);
myList.addItem(sampleItem4);
myList.addEventListener(ListEvent.ITEM_CLICK, listItemSelected);
addChild(myList);

function listItemSelected(e:ListEvent):void {
    var cr:CellRenderer = myList.itemToCellRenderer(e.item) as CellRenderer;
    var listData:ListData = cr.listData;

    trace("You have selected row: " + listData.row);
}
removeAll()方法 
public function removeAll():void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

删除列表中的所有项目。

removeItem()方法 
public function removeItem(item:Object):Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

从列表中删除指定项目。

参数

item:Object — 要删除的项目。

返回
Object — 被删除的项目。

引发
RangeError — 找不到项目。

另请参见

removeItemAt()方法 
public function removeItemAt(index:uint):Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

删除指定索引位置处的项目。 位于指定索引位置之后的项目的索引将减少 1。

参数

index:uint — 数据提供者中要删除的项目的索引。

返回
Object — 被删除的项目。

另请参见

replaceItemAt()方法 
public function replaceItemAt(item:Object, index:uint):Object

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

用其它项目替换指定索引位置处的项目。 此方法会修改 List 组件的数据提供者。 如果与其它组件共享数据提供者,则向这些组件提供的数据也会更新。

参数

item:Object — 要替换指定索引位置处的项目的项目。
 
index:uint — 要替换的项目的索引位置。

返回
Object — 被替换的项目。

引发
RangeError — 指定的索引小于 0 或大于等于数据提供者的长度。

另请参见

scrollToIndex()方法 
public function scrollToIndex(newCaretIndex:int):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

将列表滚动至位于指定索引处的项目。 如果索引超出范围,则滚动位置不发生变化。

参数

newCaretIndex:int — 要滚动到的索引位置。

scrollToSelected()方法 
public function scrollToSelected():void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

将列表滚动至由 selectedIndex 属性的当前值指示的位置处的项目。

另请参见

setRendererStyle()方法 
public function setRendererStyle(name:String, style:Object, column:uint = 0):void

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

设置列表中渲染器上的样式。

参数

name:String — 要设置的样式的名称。
 
style:Object — 要设置的样式的值。
 
column:uint (default = 0)

另请参见


示例
如何使用示例

下例创建一个 List 组件,并使用 setRendererStyle() 方法将文本格式应用于列表项目:

import fl.controls.List;

var myTextFormat:TextFormat = new TextFormat();
myTextFormat.font = "Comic Sans MS";

var myList:List = new List();
myList.addItem({label:"The quick brown fox..."});
myList.addItem({label:"The quick brown fox..."});
myList.addItem({label:"The quick brown fox..."});
myList.addItem({label:"The quick brown fox..."});
myList.addItem({label:"The quick brown fox..."});
myList.addItem({label:"The quick brown fox..."});
myList.setRendererStyle("textFormat", myTextFormat);
myList.width = 150;
myList.move(10, 10);
addChild(myList);

下例创建一个 DataGrid 组件,并使用 setRendererStyle() 方法将文本格式应用于列表项目:

import fl.controls.DataGrid;

var myTextFormat:TextFormat = new TextFormat();
myTextFormat.font = "Comic Sans MS";

var myDataGrid:DataGrid = new DataGrid();
myDataGrid.addColumn("column1");
myDataGrid.addColumn("column2");
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.addItem({column1:"The quick brown fox...", column2:"...jumped over the lazy dog."});
myDataGrid.setStyle("headerTextFormat", myTextFormat);
myDataGrid.setRendererStyle("textFormat", myTextFormat);
myDataGrid.width = 300;
myDataGrid.move(10, 10);
addChild(myDataGrid);

下例创建一个 TileList 组件,并使用 setRendererStyle() 方法将文本格式应用于列表项目:

import fl.controls.TileList;

var myTextFormat:TextFormat = new TextFormat();
myTextFormat.font = "Comic Sans MS";
myTextFormat.color = 0xFF0000;
myTextFormat.bold = true;

var myTileList:TileList = new TileList();
myTileList.addItem({label:"Image 1", source:"http://www.helpexamples.com/flash/images/image1.jpg"});
myTileList.addItem({label:"Image 2", source:"http://www.helpexamples.com/flash/images/image2.jpg"});
myTileList.addItem({label:"Image 3", source:"http://www.helpexamples.com/flash/images/image3.jpg"});
myTileList.setRendererStyle("textFormat", myTextFormat);
myTileList.columnWidth = 100;
myTileList.rowHeight = 67;
myTileList.columnCount = 3;
myTileList.rowCount = 1;
myTileList.move(10, 10);
addChild(myTileList);

下例创建一个 ComboBox 组件,并使用 setRendererStyle() 方法将文本格式应用于列表项目:

import fl.controls.ComboBox;

var myTextFormat:TextFormat = new TextFormat();
myTextFormat.font = "Comic Sans MS";

var myComboBox:ComboBox = new ComboBox();
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.addItem({label:"The quick brown fox..."});
myComboBox.textField.setStyle("textFormat", myTextFormat);
myComboBox.dropdown.setRendererStyle("textFormat", myTextFormat);
myComboBox.width = 150;
myComboBox.move(10, 10);
addChild(myComboBox);
sortItems()方法 
public function sortItems(... sortArgs):*

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

对当前数据提供者的元素进行排序。 此方法将基于元素的 Unicode 值执行排序。 ASCII 是 Unicode 的一个子集。

参数

... sortArgs — 排序要依照的参数。

返回
* — 返回值取决于是否向此方法传递任何参数。 有关详细信息,请参阅 Array.sort() 方法。 请注意,当 sortArgs 参数设置为 Array.UNIQUESORT 时此方法返回 0。

另请参见

sortItemsOn()方法 
public function sortItemsOn(field:String, options:Object = null):*

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

以当前数据提供者的一个或多个字段为依据对其元素进行排序。

参数

field:String — 要依据其进行排序的字段。
 
options:Object (default = null) — 用于覆盖默认排序行为的排序参数。 使用按位 OR (|) 运算符分隔两个或更多参数。

返回
* — 返回值取决于是否向此方法传递任何参数。 有关详细信息,请参阅 Array.sortOn() 方法。 请注意,当 sortOption 参数设置为 Array.UNIQUESORT 时此方法返回 0。

另请参见


示例
如何使用示例

下例使用 sortItemsOn() 方法,根据数据提供者中的值对列表进行排序:

import fl.controls.List;
import fl.data.DataProvider;

var players:XML = <players>
        <player name="Player Q" avg="0.237" />
        <player name="Player W" avg="0.352" />
        <player name="Player E" avg="0.268" />
        <player name="Player R" avg="0.311" />
        <player name="Player T" avg="0.293" />
        <player name="Player Y" avg="0.33" />
    </players>;

var dp:DataProvider = new DataProvider(players);

var playerList:List = new List();
playerList.labelFunction = myLabelFunction;
playerList.dataProvider = dp;
playerList.sortItemsOn("avg", Array.NUMERIC | Array.DESCENDING);
playerList.move(10, 10);
playerList.setSize(160, 120);
addChild(playerList);

function myLabelFunction(item:Object):String {
    return item.name + " (" + Number(item.avg).toFixed(3) + ")";
}
事件详细信息
change 事件
事件对象类型: flash.events.Event
Event.type property = flash.events.Event.CHANGE

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当在列表中选择了另一项目后调度。

定义 change 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblestrue
cancelablefalse;没有要取消的默认行为。
currentTarget当前正在使用某个事件侦听器处理 Event 对象的对象。
target已修改其值的对象。 target 不一定是显示列表中注册此事件侦听器的对象。 请使用 currentTarget 属性来访问显示列表中当前正在处理此事件的对象。
itemClick 事件  
事件对象类型: fl.events.ListEvent
ListEvent.type property = fl.events.ListEvent.ITEM_CLICK

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户单击组件中的项目时调度。

在更改组件的值之前调度 click 事件。 若要标识已单击的行和列,请使用事件对象的属性;请勿使用 selectedIndexselectedItem 属性。

定义 itemClick 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
cancelabletrue
columnIndex包含渲染器的列的从零开始的索引。
currentTarget当前正在使用某个事件侦听器处理事件对象的对象。
index包含渲染器的 DataProvider 中从零开始的索引。
item对属于渲染器的数据的引用。
rowIndex包含渲染器的行的从零开始的索引。
target调度了事件的对象。target 不一定是侦听该事件的对象。使用 currentTarget 属性可以访问侦听该事件的对象。
itemDoubleClick 事件  
事件对象类型: fl.events.ListEvent
ListEvent.type property = fl.events.ListEvent.ITEM_DOUBLE_CLICK

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户快速连续单击两次组件中的项目时调度。 与 click 事件不同,doubleClick 事件在组件的 selectedIndex 更改后进行调度。

定义 itemDoubleClick 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
cancelabletrue
columnIndex包含渲染器的列的从零开始的索引。
currentTarget当前正在使用某个事件侦听器处理事件对象的对象。
index包含渲染器的 DataProvider 中从零开始的索引。
item对属于渲染器的数据的引用。
rowIndex包含渲染器的行的从零开始的索引。
target调度了事件的对象。target 不一定是侦听该事件的对象。使用 currentTarget 属性可以访问侦听该事件的对象。
itemRollOut 事件  
事件对象类型: fl.events.ListEvent
ListEvent.type property = fl.events.ListEvent.ITEM_ROLL_OUT

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户将指针滑离组件中的项目时调度。

定义 itemRollOut 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
cancelablefalse;没有要取消的默认行为。
columnIndex包含渲染器的列的从零开始的索引。
currentTarget当前正在使用某个事件侦听器处理事件对象的对象。
index包含渲染器的 DataProvider 中从零开始的索引。
item对属于渲染器的数据的引用。
rowIndex包含渲染器的行的从零开始的索引。
target调度了事件的对象。target 不一定是侦听该事件的对象。使用 currentTarget 属性可以访问侦听该事件的对象。

另请参见

itemRollOver 事件  
事件对象类型: fl.events.ListEvent
ListEvent.type property = fl.events.ListEvent.ITEM_ROLL_OVER

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户将指针滑过组件中的项目时调度。

定义 itemRollOver 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
cancelablefalse;没有要取消的默认行为。
columnIndex包含渲染器的列的从零开始的索引。
currentTarget当前正在使用某个事件侦听器处理事件对象的对象。
index包含渲染器的 DataProvider 中从零开始的索引。
item对属于渲染器的数据的引用。
rowIndex包含渲染器的行的从零开始的索引。
target调度了事件的对象。target 不一定是侦听该事件的对象。使用 currentTarget 属性可以访问侦听该事件的对象。

另请参见

rollOut 事件  
事件对象类型: flash.events.MouseEvent
MouseEvent.type property = flash.events.MouseEvent.ROLL_OUT

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户将指针滑离组件时调度。

定义 rollOut 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
buttonDown如果按下鼠标主按键,则为 true;否则为 false
cancelablefalse;没有要取消的默认行为。
ctrlKey如果 Ctrl 键处于活动状态,则为 true;如果处于非活动状态,则为 false
currentTarget当前正在使用某个事件侦听器处理 Event 对象的对象。
relatedObject指针设备现在指向的显示列表对象。
localX事件发生点的相对于包含 Sprite 的水平坐标。
localY事件发生点的相对于包含 Sprite 的垂直坐标。
shiftKey如果 Shift 键处于活动状态,则为 true;如果处于非活动状态,则为 false
stageX事件发生点在全局舞台坐标中的水平坐标。
stageY事件发生点在全局舞台坐标中的垂直坐标。
target指针设备下的 InteractiveObject 实例。 target 不一定是显示列表中注册此事件侦听器的对象。 请使用 currentTarget 属性来访问显示列表中当前正在处理此事件的对象。

另请参见

rollOver 事件  
事件对象类型: flash.events.MouseEvent
MouseEvent.type property = flash.events.MouseEvent.ROLL_OVER

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户将指针滑过组件时调度。

定义 rollOver 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
buttonDown如果按下鼠标主按键,则为 true;否则为 false
cancelablefalse;没有要取消的默认行为。
ctrlKey如果 Ctrl 键处于活动状态,则为 true;如果处于非活动状态,则为 false
currentTarget当前正在使用某个事件侦听器处理 Event 对象的对象。
relatedObject指针设备指向的显示列表对象。
localX事件发生点的相对于包含 Sprite 的水平坐标。
localY事件发生点的相对于包含 Sprite 的垂直坐标。
shiftKey如果 Shift 键处于活动状态,则为 true;如果处于非活动状态,则为 false
stageX事件发生点在全局舞台坐标中的水平坐标。
stageY事件发生点在全局舞台坐标中的垂直坐标。
target指针设备下的 InteractiveObject 实例。 target 不一定是显示列表中注册此事件侦听器的对象。 请使用 currentTarget 属性来访问显示列表中当前正在处理此事件的对象。

另请参见

scroll 事件  
事件对象类型: fl.events.ScrollEvent
ScrollEvent.type property = fl.events.ScrollEvent.SCROLL

语言版本 : ActionScript 3.0
Player 版本 : Flash Player 9.0.28.0

当用户水平或垂直滚动时调度。

定义 scroll 事件对象的 type 属性值。

此事件具有以下属性:

属性
bubblesfalse
cancelablefalse;没有要取消的默认行为。
currentTarget当前正在使用某个事件侦听器处理事件对象的对象。
delta1;一个指示完成了多少滚动量的值。
directionvertical;ScrollBar 的方向。
position0;Scrollbar 滑块移动后的位置。
target调度了事件的对象。target 不一定是侦听该事件的对象。使用 currentTarget 属性可以访问侦听该事件的对象。




 

评论添加到页面后给我发送电子邮件 | 评论报告

当前页: http://livedocs.adobe.com/flash/9.0_cn/ActionScriptLangRefV3/fl/controls/SelectableList.html