| 包 | mx.controls |
| 类 | public class List |
| 继承 | List  ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| 实现 | IIMESupport |
| 子类 | EmbossedList, FileSystemList, Menu, Tree |
| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
 | 从 Flex 4.0 开始，Adobe 建议您使用 spark.components.List 类来替代此类。 |
List 控件可显示垂直项目列表。其功能与 HTML 中 SELECT 表单元素的功能非常相似。如果包含的项目太多无法同时显示，则会显示一个垂直滚动条，以便用户可访问列表中的所有项目。可以选择使用水平滚动条，以便用户在列表项目的整个宽度不适合时查看项目。用户可以根据
allowMultipleSelection 属性的值从列表中选择一个或多个项目。
List 控件具有下列默认的大小特征：
| 特征 | 说明 |
|---|---|
| 默认大小 | 足以适合前七个可见项目（如果项目少于七个，则为列表中所有可见项目）中最宽标签的宽度；高度为七行，其中每行高 20 个像素。 |
| 最小大小 | 0 个像素。 |
| 最大大小 | 5000 × 5000。 |
显示 MXML 语法
隐藏 MXML 语法The <mx:List> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
<mx:List
Properties
editable="false|true"
editedItemPosition="No default"
editorDataField="text"
editorHeightOffset="0"
editorUsesEnterKey="false|true"
editorWidthOffset="0"
editorXOffset="0"
editorYOffset="0"
imeMode="null"
itemEditor="TextInput"
itemEditorInstance="Current item editor"
rendererIsEditor="false|true"
Styles
backgroundDisabledColor="0xDDDDDD"
Events
itemEditBegin="No default"
itemEditEnd="No default"
itemEditBeginning="No default"
itemFocusIn="No default"
itemFocusOut="No default"
/>
默认 MXML 属性dataProvider
相关 API 元素
公共属性
| 属性 | 由以下参数定义 | ||
|---|---|---|---|
 | accessibilityDescription : String
一个方便的存取器，用于访问此 UIComponent 的 accessibilityProperties 对象的 description 属性。 | UIComponent | |
| accessibilityEnabled : Boolean
一个方便的存取器，用于访问此 UIComponent 的 accessibilityProperties 对象的 silent 属性。 | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
InteractiveObject 实例的当前辅助功能实现 (AccessibilityImplementation)。 | InteractiveObject | |
| accessibilityName : String
一个方便的存取器，用于访问此 UIComponent 的 accessibilityProperties 对象的 name 属性。 | UIComponent | |
| accessibilityProperties : AccessibilityProperties
此显示对象的当前辅助功能选项。 | DisplayObject | |
| accessibilityShortcut : String
一个方便的存取器，用于访问此 UIComponent 的 accessibilityProperties 对象的 shortcut 属性。 | UIComponent | |
| activeEffects : Array [只读]
组件上当前播放的效果列表，如 EffectInstance 实例的 Array。 | UIComponent | |
| allowDragSelection : Boolean = false
一个标志，指示是否启用拖动选择。 | ListBase | |
| allowMultipleSelection : Boolean
一个标志，指示是否允许您同时选择多个项目。 | ListBase | |
| alpha : Number
表示指定对象的 Alpha 透明度值。 | DisplayObject | |
| automationDelegate : Object
处理自动化相关功能的委托对象。 | UIComponent | |
| automationEnabled : Boolean [只读]
如果此组件启用了自动化，则为 true；否则为 false。 | UIComponent | |
| automationName : String
可用作此对象的标识符的名称。 | UIComponent | |
| automationOwner : DisplayObjectContainer [只读]
用于自动化目的的此组件的所有者。 | UIComponent | |
| automationParent : DisplayObjectContainer [只读]
用于自动化目的的此组件的父级。 | UIComponent | |
| automationTabularData : Object [只读]
IAutomationTabularData 接口的实现，可用于检索数据。 | UIComponent | |
| automationValue : Array [只读]
此值通常对应于对象的经呈示的外观，当对象在应用中以可视方式显示时，此值使标识符与该对象相关联。 | UIComponent | |
| automationVisible : Boolean [只读]
如果此组件对于自动化是可见的，则为 true；否则为 false。 | UIComponent | |
| baseline : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| baselinePosition : Number [只读]
组件第一行文本的基线的 y 坐标。 | UIComponent | |
| blendMode : String
BlendMode 类中的一个值，用于指定要使用的混合模式。 | DisplayObject | |
| blendShader : Shader [只写]
设置用于混合前景和背景的着色器。 | DisplayObject | |
| borderMetrics : EdgeMetrics [只读]
返回 EdgeMetrics 对象，它具有四个属性：left、top、right 和 bottom。 | ScrollControlBase | |
| bottom : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| buttonMode : Boolean
指定此 sprite 的按钮模式。 | Sprite | |
| cacheAsBitmap : Boolean
如果设置为 true，则 Flash 运行时将缓存显示对象的内部位图表示形式。 | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
如果为非 null，则 Matrix 对象会定义显示对象在 cacheAsBitmap 设置为 true 时的呈现方式。 | DisplayObject | |
| cacheHeuristic : Boolean [只写]
供 Flex 使用，表示建议为对象实施位图缓存。 | UIComponent | |
| cachePolicy : String
指定此对象的位图缓存策略。 | UIComponent | |
| className : String [只读]
此实例的类的名称，如“Button”。 | UIComponent | |
| columnCount : int
在 TileList 控件中显示的列数，或在 HorizontalList 控件中显示的项目数。 | ListBase | |
| columnWidth : Number
控件中列的宽度。 | ListBase | |
| constructor : Object
对类对象或给定对象实例的构造函数的引用。 | Object | |
| contentMouseX : Number [只读]
返回鼠标在内容坐标系中的 x 位置。 | UIComponent | |
| contentMouseY : Number [只读]
返回内容坐标系中鼠标的 y 位置。 | UIComponent | |
| contextMenu : NativeMenu
指定与此对象相关联的上下文菜单。 | InteractiveObject | |
| currentState : String
组件的当前视图状态。 | UIComponent | |
| cursorManager : ICursorManager [只读]
获取控制此组件及其同级组件的光标的 CursorManager。 | UIComponent | |
| data : Object
将此组件用作项呈示器或项目编辑器时，此组件应呈示的数据提供程序中的项目。 | ListBase | |
| dataProvider : Object
要查看的数据集。 | ListBase | |
| dataTipField : String
数据提供程序项目中作为数据提示显示的字段名称。 | ListBase | |
| dataTipFunction : Function
用户提供的函数，在各个项目上运行以确定其数据提示。 | ListBase | |
| depth : Number
确定容器内各项目的呈示顺序。 | UIComponent | |
| descriptor : UIComponentDescriptor
引用 UIComponentDescriptor（如果有），过去曾通过 createComponentFromDescriptor() 方法使用它来创建此 UIComponent 实例。 | UIComponent | |
| designLayer : DesignLayer
指定与该可视元素关联的可选 DesignLayer 实例。 | UIComponent | |
| document : Object
引用与此 UIComponent 相关联的文档对象。 | UIComponent | |
| doubleClickEnabled : Boolean [覆盖]
指定 UIComponent 对象是否接收 doubleClick 事件。 | UIComponent | |
| dragEnabled : Boolean
一个标志，指示是否可以将项目拖出此控件并放到其它控件上。 | ListBase | |
| dragMoveEnabled : Boolean
一个标志，指示在拖放操作过程中是否可以移动控件中的项目，而不只是从控件中复制这些项目。 | ListBase | |
| dropEnabled : Boolean
一个标志，指示是否可以将所拖动的项目放到此控件上。 | ListBase | |
| dropTarget : DisplayObject [只读]
指定拖动 sprite 时经过的显示对象，或放置 sprite 的显示对象。 | Sprite | |
| editable : Boolean
一个标志，指示用户能否编辑数据提供程序中的项目。 | List | ||
| editedItemPosition : Object
正在编辑的数据提供程序项目的项呈示器的列索引和行索引（如果有）。 | List | ||
| editedItemRenderer : IListItemRenderer [只读]
对当前正在编辑的项目所属的 DataGrid 控件中项呈示器的引用。 | List | ||
| editorDataField : String = "text"
项目编辑器的属性名称，其中包含列表项目的新数据。 | List | ||
| editorHeightOffset : Number = 0
项目编辑器相对于项呈示器大小的高度（以像素为单位）。 | List | ||
| editorUsesEnterKey : Boolean = false
指示项目编辑器是否使用 Enter 键的标志。 | List | ||
| editorWidthOffset : Number = 0
项目编辑器相对于项呈示器大小的宽度（以像素为单位）。 | List | ||
| editorXOffset : Number = 0
项目编辑器左上角相对于项目左上角的 x 位置（以像素为单位）。 | List | ||
| editorYOffset : Number = 0
项目编辑器左上角相对于项目左上角的 y 位置（以像素为单位）。 | List | ||
| enabled : Boolean
组件是否可以接受用户交互。 | UIComponent | |
| enableIME : Boolean [只读]
一个标志，用于指示当组件获得焦点时是否应启用 IME。 | List | ||
| errorString : String
当验证程序监视组件并且验证失败时，组件的错误提示中将显示的文本。 | UIComponent | |
| explicitHeight : Number
指定该组件在组件坐标中显式高度（以像素为单位）的数字。 | UIComponent | |
| explicitMaxHeight : Number
布局过程中父级要考虑的组件最大建议高度。 | UIComponent | |
| explicitMaxWidth : Number
布局过程中父级要考虑的组件最大建议宽度。 | UIComponent | |
| explicitMinHeight : Number
布局过程中父级要考虑的组件最小建议高度。 | UIComponent | |
| explicitMinWidth : Number
布局过程中父级要考虑的组件最小建议宽度。 | UIComponent | |
| explicitWidth : Number
指定该组件在组件坐标中显式宽度（以像素为单位）的数字。 | UIComponent | |
| filters : Array
包含当前与显示对象关联的每个滤镜对象的索引数组。 | DisplayObject | |
| flexContextMenu : IFlexContextMenu
此 UIComponent 的上下文菜单。 | UIComponent | |
| focusEnabled : Boolean
指示切换到此组件时，是否可以获得焦点。 | UIComponent | |
| focusManager : IFocusManager
获取控制此组件及其同级组件的焦点的 FocusManager。 | UIComponent | |
| focusPane : Sprite
与此对象相关联的焦点窗格。 | UIComponent | |
| focusRect : Object
指定此对象是否显示焦点矩形。 | InteractiveObject | |
| graphics : Graphics [只读]
指定属于此 sprite 的 Graphics 对象，在此 sprite 中可执行矢量绘图命令。 | Sprite | |
| hasFocusableChildren : Boolean
一个标志，指示子对象是否能够获得焦点。 | UIComponent | |
| hasLayoutMatrix3D : Boolean [只读]
如果元素具有 3D 矩阵，则为 true。 | UIComponent | |
| height : Number [覆盖]
指定组件在父坐标中的高度的数字（以像素为单位）。 | UIComponent | |
| hitArea : Sprite
指定一个 sprite 用作另一个 sprite 的点击区域。 | Sprite | |
| horizontalCenter : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| horizontalScrollPolicy : String
指示水平滚动条是始终启用、始终禁用还是自动根据传递到 setScrollBarProperties() 方法的参数进行更改的属性。 | ScrollControlBase | |
| horizontalScrollPosition : Number
内容与左边缘的偏移量。 | ScrollControlBase | |
| iconField : String
数据提供程序对象中字段的名称，该字段用于确定显示为图标的对象。 | ListBase | |
| iconFunction : Function
用户提供的函数，在每个项目上运行以确定其图标。 | ListBase | |
| id : String
组件 ID。 | UIComponent | |
| imeMode : String
指定 IME（输入法编辑器）模式。 | List | ||
| includeInLayout : Boolean
指定此组件是否包含在父容器的布局中。 | UIComponent | |
| inheritingStyles : Object
此组件的继承样式链的开头内容。 | UIComponent | |
| initialized : Boolean
一个标志，用于确定某个对象是否已通过布局的所有三个阶段：提交、测量和布局（假设每个阶段都是必需的）。 | UIComponent | |
| instanceIndex : int [只读]
重复组件的索引。 | UIComponent | |
| instanceIndices : Array
一个 Array，包含从此 UIComponent 对象的父文档引用该对象所需的索引。 | UIComponent | |
| is3D : Boolean [只读]
当元素为 3D 时，则为 true。 | UIComponent | |
| isDocument : Boolean [只读]
如果此 UIComponent 实例为文档对象，则为 true。 | UIComponent | |
| isPopUp : Boolean
PopUpManager 将其设置为 true 以指示已弹出该组件。 | UIComponent | |
| itemEditor : IFactory
如果将可编辑属性设置为 true，则为用于控件的项目编辑器的类工厂。 | List | ||
| itemEditorInstance : IListItemRenderer
对项目编辑器的当前活动实例（如果有）的引用。 | List | ||
| itemRenderer : IFactory
控件的自定义项呈示器。 | ListBase | |
| labelField : String
数据提供程序项目中作为标签显示的字段名称。 | ListBase | |
| labelFunction : Function
用户提供的函数，在每个项目上运行以确定其标签。 | ListBase | |
| layoutMatrix3D : Matrix3D [只写]
用于相对于其同级组件计算组件的布局的转换矩阵。 | UIComponent | |
| left : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| listData : BaseListData
如果使用组件作为嵌入式项呈示器或嵌入式项目编辑器，则 Flex 将使用 list 控件中的其它数据初始化组件的 listData 属性。 | ListBase | |
| liveScrolling : Boolean = true
一个标志，指示移动滚动栏滑块时实时滚动视图，还是释放滑块后才更新视图。 | ScrollControlBase | |
| loaderInfo : LoaderInfo [只读]
返回一个 LoaderInfo 对象，其中包含加载此显示对象所属的文件的相关信息。 | DisplayObject | |
| maintainProjectionCenter : Boolean
如果为 true，则该组件将使其投影矩阵在其边框的中央保持居中。 | UIComponent | |
| mask : DisplayObject
调用显示对象被指定的 mask 对象遮罩。 | DisplayObject | |
| maxHeight : Number
布局过程中父级要考虑的组件最大建议高度。 | UIComponent | |
| maxHorizontalScrollPosition : Number
horizontalScrollPosition 属性的最大值。 | ScrollControlBase | |
| maxVerticalScrollPosition : Number
verticalScrollPosition 属性的最大值。 | ScrollControlBase | |
| maxWidth : Number
布局过程中父级要考虑的组件最大建议宽度。 | UIComponent | |
| measuredHeight : Number
组件的默认高度（以像素为单位）。 | UIComponent | |
| measuredMinHeight : Number
组件的默认最小高度（以像素为单位）。 | UIComponent | |
| measuredMinWidth : Number
组件的默认最小宽度（以像素为单位）。 | UIComponent | |
| measuredWidth : Number
组件的默认宽度（以像素为单位）。 | UIComponent | |
| menuSelectionMode : Boolean = false
一个标志，指示是否应使用菜单样式选择。 | ListBase | |
| metaData : Object
如果元数据是通过 PlaceObject4 标记与此 DisplayObject 的实例一起存储在 SWF 文件中的，则获取 DisplayObject 实例的元数据对象。 | DisplayObject | |
| minHeight : Number
布局过程中父级要考虑的组件最小建议高度。 | UIComponent | |
| minWidth : Number
布局过程中父级要考虑的组件最小建议宽度。 | UIComponent | |
| moduleFactory : IFlexModuleFactory
模块工厂用作上下文，用于为此组件使用嵌入字体以及查找用于控制此组件样式的样式管理器。 | UIComponent | |
| mouseChildren : Boolean
确定对象的子级是否支持鼠标或用户输入设备。 | DisplayObjectContainer | |
| mouseEnabled : Boolean
指定此对象是否接收鼠标或其他用户输入、消息。 | InteractiveObject | |
| mouseFocusEnabled : Boolean
单击时是否可获得焦点。 | UIComponent | |
| mouseX : Number [只读]
表示此鼠标或用户输入设备位置的 x 坐标，以像素为单位。 | DisplayObject | |
| mouseY : Number [只读]
表示此鼠标或用户输入设备位置的 y 坐标，以像素为单位。 | DisplayObject | |
| name : String
表示 DisplayObject 的实例名称。 | DisplayObject | |
| needsSoftKeyboard : Boolean
指定当该 InteractiveObject 实例获得焦点时，是否显示虚拟键盘（显示在屏幕上的软键盘）。 | InteractiveObject | |
| nestLevel : int
此对象在所属关系层次结构中的深度。 | UIComponent | |
| nonInheritingStyles : Object
此组件的非继承样式链的开头内容。 | UIComponent | |
| nullItemRenderer : IFactory
控件的自定义项呈示器。 | ListBase | |
| numAutomationChildren : int [只读]
此容器包含的自动化子项数。 | UIComponent | |
| numChildren : int [只读]
返回此对象的子项数目。 | DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
项呈示器的额外行或列的目标数量，供在控件布局中使用。 | ListBase | |
| opaqueBackground : Object
指定显示对象是否由于具有某种背景颜色而不透明。 | DisplayObject | |
| owner : DisplayObjectContainer
此 IVisualElement 对象的所有者。 | UIComponent | |
| parent : DisplayObjectContainer [覆盖] [只读]
此组件的父容器或组件。 | UIComponent | |
| parentApplication : Object [只读]
引用包含此 UIComponent 实例的 Application 对象。 | UIComponent | |
| parentDocument : Object [只读]
引用此 UIComponent 的父文档对象。 | UIComponent | |
| percentHeight : Number
以组件父代大小百分比的方式指定组件高度。 | UIComponent | |
| percentWidth : Number
以组件父代大小百分比的方式指定组件宽度。 | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
定义能够应用于对象转换且在一定程度上对其父布局不可视的一组调整。 | UIComponent | |
| processedDescriptors : Boolean
临时或延迟子项创建操作后设置为 true，具体取决于发生对象。 | UIComponent | |
| rendererIsEditor : Boolean = false
指定项呈示器是否同时也是项目编辑器。 | List | ||
| repeater : IRepeater [只读]
对生成此 UIComponent 的父文档中 Repeater 对象的引用。 | UIComponent | |
| repeaterIndex : int [只读]
项目在生成此 UIComponent 的 Repeater 数据提供程序中的索引。 | UIComponent | |
| repeaterIndices : Array
一个 Array，包含项目在生成此 UIComponent 的父文档的 Repeater 数据提供程序中的索引。 | UIComponent | |
| repeaters : Array
一个 Array，包含对生成此 UIComponent 的父文档中 Repeater 对象的引用。 | UIComponent | |
| right : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| root : DisplayObject [只读]
对于加载的 SWF 文件中的显示对象，root 属性是此 SWF 文件所表示的显示列表树结构部分中的顶级显示对象。 | DisplayObject | |
| rotation : Number [覆盖]
表示 DisplayObject 实例距其原始方向的旋转程度，以度为单位。 | UIComponent | |
| rotationX : Number [覆盖]
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 x 轴旋转（以度为单位）。 | UIComponent | |
| rotationY : Number [覆盖]
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 y 轴旋转（以度为单位）。 | UIComponent | |
| rotationZ : Number [覆盖]
表示 DisplayObject 实例相对于 3D 父容器距离其原始方向的 z 轴旋转（以度为单位）。 | UIComponent | |
| rowCount : int
要显示的行数。 | ListBase | |
| rowHeight : Number
行高（以像素为单位）。 | ListBase | |
| scale9Grid : Rectangle
当前有效的缩放网格。 | DisplayObject | |
| scaleX : Number [覆盖]
用于指定水平缩放系数的数字。 | UIComponent | |
| scaleY : Number [覆盖]
用于指定垂直缩放系数的数字。 | UIComponent | |
| scaleZ : Number [覆盖]
指定沿着 z 轴的缩放因子的数值。 | UIComponent | |
| screen : Rectangle [只读]
返回包含此对象的基本绘图表面大小和位置的对象。 | UIComponent | |
| scrollRect : Rectangle
显示对象的滚动矩形范围。 | DisplayObject | |
| scrollTipFunction : Function
将要显示的字符串作为 ScrollTip 计算的函数。 | ScrollControlBase | |
| selectable : Boolean
一个标志，指示列表是否将所选项目显示为选中状态。 | ListBase | |
| selectedIndex : int
所选项目的数据提供程序中的索引。 | ListBase | |
| selectedIndices : Array
数据提供程序中所选项目的索引的数组。 | ListBase | |
| selectedItem : Object
对数据提供程序中所选项目的引用。 | ListBase | |
| selectedItems : Array
对数据提供程序中所选项目的引用的数组。 | ListBase | |
| selectedItemsCompareFunction : Function
用于比较 selectedItems 属性中的项目与数据提供程序中的项目的函数。 | ListBase | |
| showDataTips : Boolean
一个标志，指示是否为行中的文本显示数据提示。 | ListBase | |
| showInAutomationHierarchy : Boolean
用于确定自动化对象是否显示在自动化层次中的标志。 | UIComponent | |
| showScrollTips : Boolean = false
一个标志，指示拖动滚动滑块时是否应在其旁边显示工具提示。 | ScrollControlBase | |
| softKeyboard : String
控制软键盘的外观。 | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
定义当显示软键盘时应在屏幕上保留的区域（在 iOS 上不支持）。 | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
控制此 sprite 中的声音。 | Sprite | |
| stage : Stage [只读]
显示对象的舞台。 | DisplayObject | |
| states : Array
为此组件定义的视图状态。 | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
存储此对象的内嵌继承样式。 | UIComponent | |
| styleManager : IStyleManager2 [只读]
返回此组件使用的 StyleManager 实例。 | UIComponent | |
| styleName : Object
此组件使用的类样式。 | UIComponent | |
| styleParent : IAdvancedStyleClient
组件的父项用于评估后代选择器。 | UIComponent | |
| systemManager : ISystemManager
返回此组件使用的 SystemManager 对象。 | UIComponent | |
| tabChildren : Boolean
确定对象的子项是否支持 Tab 键。 | DisplayObjectContainer | |
| tabEnabled : Boolean
指定此对象是否遵循 Tab 键顺序。 | InteractiveObject | |
| tabFocusEnabled : Boolean
一个标志，指示该对象是否能够通过 Tab 键获得焦点。这与 Flash Player 使用的 tabEnabled 属性类似。对于处理键盘输入的组件该标志通常为 true，但是控件栏中的一些组件将其设置为 false，因为它们不能像编辑器一样从另外的组件窃取焦点。 | UIComponent | |
| tabIndex : int
指定 SWF 文件中的对象按 Tab 键顺序排列。 | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [只读]
返回此 DisplayObjectContainer 实例的 TextSnapshot 对象。 | DisplayObjectContainer | |
| toolTip : String
要在 ToolTip 中显示的文本。 | UIComponent | |
| top : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| transform : flash.geom:Transform [覆盖]
一个对象，具有与显示对象的矩阵、颜色转换和像素范围有关的属性。 | UIComponent | |
| transformX : Number
设置组件转换中心的 x 坐标。 | UIComponent | |
| transformY : Number
设置组件转换中心的 y 坐标。 | UIComponent | |
| transformZ : Number
设置组件转换中心的 z 坐标。 | UIComponent | |
| transitions : Array
一个 Transition 对象 Array，其中的每个 Transition 对象都定义一组效果，用于在视图状态发生更改时播放。 | UIComponent | |
| tweeningProperties : Array
当前在此对象上进行补间的属性数组。 | UIComponent | |
| uid : String
对象的唯一标识符。 | UIComponent | |
| updateCompletePendingFlag : Boolean
一个标志，确定某个对象是否已通过所有三个阶段的布局验证（假设需要通过所有验证）。 | UIComponent | |
| useHandCursor : Boolean
布尔值，表示当指针滑过 buttonMode 属性设置为 true 的 sprite 时是否显示指针手形（手形光标）。 | Sprite | |
| validationSubField : String
供验证程序用来将子字段与此组件相关联。 | UIComponent | |
| value : Object [只读]
所选项目，或者所选项目的数据或标签字段。 | ListBase | |
| variableRowHeight : Boolean
一个标志，指示各行是否可以采用不同的高度。 | ListBase | |
| verticalCenter : Object
对于组件，此布局约束属性是基于类似命名的样式的外观。 | UIComponent | |
| verticalScrollPolicy : String
指示垂直滚动条是始终启用、始终禁用还是自动根据传递到 setScrollBarProperties() 方法的参数进行更改的属性。 | ScrollControlBase | |
| verticalScrollPosition : Number
顶边到内容的偏移量。 | ScrollControlBase | |
| viewMetrics : EdgeMetrics [只读]
考虑滚动条（如果可见）的 EdgeMetrics 对象。 | ScrollControlBase | |
| visible : Boolean [覆盖]
显示对象是否可见。 | UIComponent | |
| width : Number [覆盖]
指定组件在父坐标中的宽度的数字（以像素为单位）。 | UIComponent | |
| wordWrap : Boolean
一个标志，指示行中的文本是否应自动换行。 | ListBase | |
| x : Number [覆盖]
指定组件在其父容器中的水平位置（以像素为单位）的数字。 | UIComponent | |
| y : Number [覆盖]
指定组件在其父容器中的垂直位置（以像素为单位）的数字。 | UIComponent | |
| z : Number [覆盖]
表示 DisplayObject 实例相对于 3D 父容器沿 z 轴的 z 坐标位置。 | UIComponent | |
受保护的属性
公共方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
List()
构造函数。 | List | ||
|
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | |
|
将一个 DisplayObject 子实例添加到该 DisplayObjectContainer 实例中。 | DisplayObjectContainer | |
|
如果正在运行数据更改效果，则添加项呈示器。 | ListBase | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
使用 EventDispatcher 对象注册事件侦听器对象，以使侦听器能够接收事件通知。 | EventDispatcher | |
|
将非可视样式客户端添加到该组件实例。 | UIComponent | |
|
表示安全限制是否会导致出现以下情况：在列表中忽略了使用指定 point 点调用 DisplayObjectContainer.getObjectsUnderPoint() 方法时返回的所有显示对象。 | DisplayObjectContainer | |
|
返回将放置项目添加到放置目标中的位置的索引。 | ListBase | |
|
排队稍后调用的函数。 | UIComponent | |
|
删除此组件实例的样式属性。 | UIComponent | |
|
确定指定显示对象是 DisplayObjectContainer 实例的子项还是该实例本身。 | DisplayObjectContainer | |
|
将 Point 对象由内容坐标转换为全局坐标。 | UIComponent | |
|
将 Point 对象由内容坐标转换为本地坐标。 | UIComponent | |
|
返回标识此容器中的子项的一组属性。 | UIComponent | |
|
返回标识此容器中的子项的一组属性。 | UIComponent | |
使用由 itemEditor 属性指定的编辑器在 editedItemPosition 为项呈示器创建项目编辑器。 | List | ||
[覆盖]
获取适当的呈示器，如果未指定呈示器，则使用默认呈示器。 | List | ||
|
在 IUIComponent 对象的父项文档对象上创建对此对象的 id 引用。 | UIComponent | |
|
在 IUIComponent 对象的父项文档对象上删除对此对象的 id 引用。 | UIComponent | |
关闭当前在某个项目上打开的项目编辑器。 | List | ||
|
返回与此 UIComponent 的文本样式对应的 UITextFormat 对象。 | UIComponent | |
| [覆盖]
将事件调度到事件流中。 | UIComponent | |
|
在此组件周围显示或隐藏焦点指示符。 | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
通过编程方式在此外观的 Graphics 对象中绘制一个矩形。 | UIComponent | |
|
停止在组件上播放效果实例时，由效果实例调用。 | UIComponent | |
|
开始在组件上播放效果实例时，由效果实例调用。 | UIComponent | |
|
结束组件上当前播放的所有效果。 | UIComponent | |
|
执行 UIComponent 对象是目标的所有绑定。 | UIComponent | |
|
根据 String 查找列表中的项目，并将所选内容移至该项目。 | ListBase | |
|
打印完成后调用。 | UIComponent | |
|
在指定的索引位置提供自动化对象。 | UIComponent | |
|
提供自动化对象列表。 | UIComponent | |
|
返回一个矩形，该矩形定义相对于 targetCoordinateSpace 对象坐标系的显示对象区域。 | DisplayObject | |
|
按指定的元素大小，返回元素边界的 x 坐标。 | UIComponent | |
|
按指定的元素大小，返回元素边界的 y 坐标。 | UIComponent | |
|
返回位于指定索引处的子显示对象实例。 | DisplayObjectContainer | |
|
返回具有指定名称的子显示对象。 | DisplayObjectContainer | |
|
返回 DisplayObject 的 child 实例的索引位置。 | DisplayObjectContainer | |
|
查找此 UIComponent 实例的类型选择器。 | UIComponent | |
|
返回一个约束布局值，这与获取此组件的约束样式的方式类似。 | UIComponent | |
|
确定是使用显式高度还是测量高度的一种简便方法
| UIComponent | |
|
确定是使用显式宽度还是测量宽度的一种简便方法
| UIComponent | |
|
获取当前具有焦点的对象。 | UIComponent | |
|
返回相应的工厂；如果尚未指定，则使用默认工厂。 | ListBase | |
|
返回元素的布局高度。 | UIComponent | |
|
返回元素的布局宽度。 | UIComponent | |
|
返回元素在屏幕上进行绘制时所用的 x 坐标。 | UIComponent | |
|
返回元素在屏幕上进行绘制时所用的 y 坐标。 | UIComponent | |
|
返回用于相对于其同级组件计算组件的布局的转换矩阵。 | UIComponent | |
|
返回此元素的布局转换 Matrix3D。 | UIComponent | |
|
返回元素的最大高度。 | UIComponent | |
|
返回元素的最大宽度。 | UIComponent | |
|
返回元素的最小高度。 | UIComponent | |
|
返回元素的最小宽度。 | UIComponent | |
|
返回对象的数组，这些对象位于指定点下，并且是该 DisplayObjectContainer 实例的子项（或孙子项，依此类推）。 | DisplayObjectContainer | |
|
返回元素的首选高度。 | UIComponent | |
|
返回元素的首选宽度。 | UIComponent | |
|
返回一个矩形，该矩形根据 targetCoordinateSpace 参数定义的坐标系定义显示对象的边界，但不包括形状上的任何笔触。 | DisplayObject | |
|
返回 true 或 false 以指示是否应在目标上播放效果。 | ListBase | |
|
返回 dataProvider 中由指定的 Repeater 用来生成此 Repeater 的项目；如果此 Repeater 未重复，则返回 null。 | UIComponent | |
|
获取已在此组件的样式查找链中的某个位置设置过的样式属性。 | UIComponent | |
|
将 Point 对象由全局坐标转换为内容坐标。 | UIComponent | |
|
将 point 对象从舞台（全局）坐标转换为显示对象的（本地）坐标。 | DisplayObject | |
|
将二维点从舞台（全局）坐标转换为三维显示对象的（本地）坐标。 | DisplayObject | |
|
如果 currentCSSState 不为 null，则返回 true。 | UIComponent | |
|
检查 EventDispatcher 对象是否为特定事件类型注册了任何侦听器。 | EventDispatcher | |
|
表示对象是否已经定义了指定的属性。 | Object | |
|
确定是否已在此 UIComponent 上定义指定的状态。 | UIComponent | |
|
在鼠标指针下方隐藏指示允许执行拖放操作的拖放指示符。 | ListBase | |
|
计算显示对象的边框，以确定它是否与 obj 显示对象的边框重叠或相交。 | DisplayObject | |
|
计算显示对象，以确定它是否与 x 和 y 参数指定的点重叠或相交。 | DisplayObject | |
|
返回一个框 Matrix，在绘制水平渐变时可以将其作为 rot 参数传递给 drawRoundRect() 方法。 | UIComponent | |
|
针对数据提供程序中某个项目的索引获取项呈示器（如果存在）。 | ListBase | |
|
计算 colIndex 和 rowIndex 处项目的数据提供程序中的偏移量。 | ListBase | |
|
初始化此组件的内部结构。 | UIComponent | |
|
初始化用于跟踪此组件的重复实例的各个属性。 | UIComponent | |
|
标记组件，以便在稍后屏幕更新期间调用该组件的 updateDisplayList() 方法。 | UIComponent | |
|
由某个组件的项目进行调用，以指示其 depth 属性已更改。 | UIComponent | |
|
当某元素的 layoutDirection 更改或其父代的 layoutDirection 更改时，该元素必须调用该方法。 | UIComponent | |
|
在下次更新时刷新所有行。 | ListBase | |
|
标记组件，以便在稍后屏幕更新期间调用该组件的 commitProperties() 方法。 | UIComponent | |
|
标记组件，以便在稍后屏幕更新期间调用该组件的 measure() 方法。 | UIComponent | |
确定数据提供程序项目的项呈示器是否可编辑。 | List | ||
|
确定是否加亮显示数据提供者项目的项呈示器（当鼠标滑过它，或者通过键盘导航使它位于尖号下方时）。 | ListBase | |
|
确定数据提供程序项目的项呈示器是否可选。 | ListBase | |
|
确定是否已选中数据提供程序项目的项呈示器。 | ListBase | |
|
确定数据提供程序项的项呈示器是否为键盘导航后位于尖号下方的项。 | ListBase | |
|
确定呈示器是否显示某个项目。 | ListBase | |
|
表示 Object 类的实例是否在指定为参数的对象的原型链中。 | Object | |
|
确定呈示器是否包含（或拥有）显示对象。 | ListBase | |
|
返回通过此项呈示器呈示的该项目在数据提供程序中的项目索引。 | ListBase | |
|
返回呈示器根据 dataTipField 和 dataTipFunction 属性显示给定数据对象的数据提示字符串。 | ListBase | |
|
根据 iconField 和 iconFunction 属性返回表示数据项目图标的类（如果存在）。 | ListBase | |
|
返回数据提供程序中给定项目的项呈示器（如果存在）。 | ListBase | |
|
返回呈示器根据 labelField 和 labelFunction 属性显示给定数据对象的字符串。 | ListBase | |
|
将三维显示对象的（本地）坐标的三维点转换为舞台（全局）坐标中的二维点。 | DisplayObject | |
|
将 Point 对象由本地坐标转换为内容坐标。 | UIComponent | |
|
将 point 对象从显示对象的（本地）坐标转换为舞台（全局）坐标。 | DisplayObject | |
|
如果 cssState 与 currentCSSState 匹配，则返回 true。 | UIComponent | |
|
确定此实例与给定类型相同，还是属于给定类型的子类。 | UIComponent | |
|
使用当前项呈示器测量数据提供程序中的一组项目，并返回这些项目的高度之和。 | ListBase | |
|
测量指定的 HTML 文本（该文本中可能包含 <font> 和 <b> 等 HTML 标签），假定该文本显示在单行 UITextField（使用由此 UIComponent 的样式确定的 UITextFormat）中。 | UIComponent | |
|
测量指定的文本，假定该文本使用由此 UIComponent 的样式确定的 UITextFormat 显示在单行 UITextField（或 UIFTETextField）中。 | UIComponent | |
|
使用当前项呈示器测量数据提供程序中的一组项目，并返回找到的最大宽度。 | ListBase | |
|
将组件移动到其父项内的指定位置。 | UIComponent | |
|
将样式更改传播到子项。 | UIComponent | |
|
如果 owner 属性链从 child 指向此 UIComponent，则返回 true。 | UIComponent | |
|
当在父项中添加或删除 UIComponent 对象时由 Flex 调用。 | UIComponent | |
|
准备 IFlexDisplayObject 用于打印。 | UIComponent | |
|
表示指定的属性是否存在、是否可枚举。 | Object | |
|
为此组件及其所有后代生成或重新生成 CSS 样式缓存，前提条件是递归参数为 true。 | UIComponent | |
|
针对每个效果事件，将 EffectManager 注册为一个事件侦听器。 | UIComponent | |
|
从 DisplayObjectContainer 实例的子列表中删除指定的 child DisplayObject 实例。 | DisplayObjectContainer | |
|
从 DisplayObjectContainer 的子列表中指定的 index 位置删除子 DisplayObject。 | DisplayObjectContainer | |
|
从 DisplayObjectContainer 实例的子级列表中删除所有子 DisplayObject 实例。 | DisplayObjectContainer | |
|
如果正在运行数据更改效果，则移除项呈示器。 | ListBase | |
|
从 EventDispatcher 对象中删除侦听器。 | EventDispatcher | |
|
从该组件实例删除非可视样式客户端。 | UIComponent | |
|
重放指定的事件。 | UIComponent | |
|
显示虚拟键盘。 | InteractiveObject | |
|
使用提供的 ID 解析子项。 | UIComponent | |
| [静态]
在调用 suspendBackgroundProcessing() 之后继续对使用 callLater() 排队的方法进行背景处理。 | UIComponent | |
|
确保给定索引处的数据提供程序项目可见。 | ListBase | |
|
调整对象大小。 | UIComponent | |
|
更改现有子项在显示对象容器中的位置。 | DisplayObjectContainer | |
|
设置一个布局约束值的方式，与设置此组件的约束样式的方式相同。 | UIComponent | |
|
设置当前状态。 | UIComponent | |
|
设置此组件的焦点。 | UIComponent | |
|
设置元素在屏幕上进行绘制时所用的坐标。 | UIComponent | |
|
设置元素的布局大小。 | UIComponent | |
|
设置用于相对于其同级组件计算组件的布局大小和位置的转换 Matrix。 | UIComponent | |
|
设置用于计算组件相对于其同级组件的布局大小和位置的转换 Matrix3D。 | UIComponent | |
|
设置循环操作动态属性的可用性。 | Object | |
|
对此组件实例设置样式属性。 | UIComponent | |
|
当 visible 属性发生更改时调用。 | UIComponent | |
|
在鼠标指针下方显示拖放指示符表示允许拖放操作以及项目的放置位置。 | ListBase | |
|
允许用户拖动指定的 Sprite。 | Sprite | |
|
使用户可以在启用触摸的设备上拖动指定的 Sprite。 | Sprite | |
|
对源起于此对象的所有 MovieClip 递归停止时间轴执行。 | DisplayObjectContainer | |
|
结束 startDrag() 方法。 | Sprite | |
|
结束 startTouchDrag() 方法，用于启用触摸的设备。 | Sprite | |
|
检测对样式属性的更改。 | UIComponent | |
|
首次初始化组件样式时，Flex 会调用 stylesInitialized() 方法。 | UIComponent | |
| [静态]
阻止对使用 callLater() 排队的方法进行背景处理，直到调用 resumeBackgroundProcessing() 为止。 | UIComponent | |
|
交换两个指定子对象的 Z 轴顺序（从前到后顺序）。 | DisplayObjectContainer | |
|
在子级列表中两个指定的索引位置，交换子对象的 Z 轴顺序（前后顺序）。 | DisplayObjectContainer | |
|
返回此对象的字符串表示形式，其格式设置遵守区域设置特定的约定。 | Object | |
| [覆盖]
返回一个字符串，用于指示此对象在应用程序的 DisplayObject 层次结构中所处的位置。 | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
用于更新转换的旋转、缩放和平移的一种实用程序方法，同时保留某个特定点，该点是在组件自己的坐标空间中指定的，且在父项的坐标空间中是固定的。 | UIComponent | |
|
一种实用程序方法，用于将以该对象的本地坐标指定的点转换为在该对象父坐标中的相应位置。 | UIComponent | |
|
如果对应于特定数据项目的项呈示器需要移动到控件中项呈示器的正常位置之外，则将作为数据更改效果的一部分由 UnconstrainItemAction 效果调用。 | ListBase | |
|
验证子项的位置和大小，并绘制其他可视内容。 | UIComponent | |
|
验证并更新此对象的属性和布局，如果需要的话重绘对象。 | UIComponent | |
|
由布局逻辑用于通过调用 commitProperties() 方法来验证组件的属性。 | UIComponent | |
|
如果使用此 ILayoutManagerClient 调用 LayoutManager.invalidateSize() 方法，随后在测量时调用了 validateSize() 方法，则验证组件的度量大小。 | UIComponent | |
|
处理分配给此组件的验证程序调度的 valid 和 invalid 事件。 | UIComponent | |
|
返回指定对象的原始值。 | Object | |
|
返回一个框 Matrix，在绘制垂直渐变时可以将其作为 rot 参数传递给 drawRoundRect()。 | UIComponent | |
|
检查是否用此 EventDispatcher 对象或其任何祖代为指定事件类型注册了事件侦听器。 | EventDispatcher | |
受保护的方法
| 方法 | 由以下参数定义 | ||
|---|---|---|---|
|
作为拖放操作的一部分，将所选项目添加到 DragSource 对象。 | ListBase | |
|
将呈示器添加到循环使用的呈示器列表，使其不可见并清除对该呈示器的引用。 | ListBase | |
|
从用于存储对行的引用的数组开头添加一个空白行。 | ListBase | |
|
调整焦点矩形。 | UIComponent | |
|
从 updateDisplayList() 方法中调用，用以调整 listContent 的大小和位置。 | ListBase | |
|
提交计算的矩阵，该矩阵是基于布局矩阵以及 flash displayObject 的转换的转换偏移量而构建的。 | UIComponent | |
|
设置应用选择指示符的效果。 | ListBase | |
|
这是一个内部方法，供 Flex 框架用于支持 Dissolve 效果。 | UIComponent | |
|
在执行拖放操作时计算拖放指示符的 y 位置。 | ListBase | |
|
确定是否可以跳过对 measure() 方法的调用。 | UIComponent | |
|
创建子对象后执行任何最终处理。 | UIComponent | |
|
清除给定 Sprite 中的尖号指示符。 | ListBase | |
|
清除给定 Sprite 中的加亮指示符。 | ListBase | |
|
删除所有选定、加亮显示和尖号指示符。 | ListBase | |
|
清除所选项目组，并移除表示那些项目的选定状态的所有图形。 | ListBase | |
|
清空 visibleData 哈希表。 | ListBase | |
|
当数据发生更改时，处理从数据提供程序中调度的 CollectionEvent。 | ListBase | |
| [覆盖]
根据是否已显式设置 columnCountcolumnWidth、rowHeight 和 rowCount 等属性来计算列宽、行高以及行数和列数。 | ListBase | |
|
根据行数、列数以及可查看的行和列配置 ScrollBar。 | ListBase | |
|
通过调用 ObjectUtil.copy() 方法为此对象制作一个深层副本，然后通过调用 UIDUtil.createUID() 方法用一个新值替代该副本的 uid 属性（如果存在）。 | ListBase | |
|
按照选择时的顺序复制所选项目。 | ListBase | |
|
为此组件创建边框。 | ScrollControlBase | |
| [覆盖]
创建对象作为此 ListBase 的子对象，在这种情况下为将容纳所有项呈示器的 listContent 对象。 | ListBase | |
|
根据所用的嵌入字体使用上下文创建新对象。 | UIComponent | |
|
使用给定的 moduleFactory 创建对象。 | UIComponent | |
|
循环使用不再需要的行，并删除其指示符。 | ListBase | |
|
更新属性时调度 PropertyChangeEvent 的 Helper 方法。 | UIComponent | |
|
处理 DragEvent.DRAG_COMPLETE 事件。 | ListBase | |
|
处理 DragEvent.DRAG_DROP 事件。 | ListBase | |
|
处理 DragEvent.DRAG_ENTER 事件。 | ListBase | |
|
处理 DragEvent.DRAG_EXIT 事件。 | ListBase | |
|
处理 DragEvent.DRAG_OVER 事件。 | ListBase | |
|
Interval 函数，用于在鼠标位于列表上方或下方时上下滚动列表。 | ListBase | |
|
dragStart 事件的默认处理函数。 | ListBase | |
| drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
使用指定的颜色在给定的 Sprite 中采用指定的位置、宽度和高度绘制尖号指示符。 | ListBase | |
| drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
使用指定的颜色在给定的 Sprite 中采用指定的位置、宽度和高度绘制加亮指示符。 | ListBase | |
| drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
绘制带有指示符（加亮显示的或选中的）或尖号的呈示器。 | ListBase | |
在指定的位置以指定高度绘制行背景。 | List | ||
|
绘制行中所有交替行的颜色、边框和背景。 | ListBase | |
| drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
使用指定的颜色在给定的 Sprite 中采用指定的位置、宽度和高度绘制选择指示符。 | ListBase | |
停止编辑数据提供程序中的项目。 | List | ||
|
尝试在数据提供程序中查找下一个以 eventCode 参数中的字符开头的项目。 | ListBase | |
|
在数据更改效果运行完毕后，通过恢复原始集合和迭代器并移除此效果使用的所有缓存值进行清理。 | ListBase | |
|
基于 caretIndex 和 anchorIndex 属性设置所选项目。 | ListBase | |
|
当 UIComponent 对象获得焦点时调用的事件处理函数。 | UIComponent | |
|
当 UIComponent 对象失去焦点时调用的事件处理函数。 | UIComponent | |
|
检索已创建但当前未使用的项呈示器。 | ListBase | |
|
给定索引处数据提供程序项目所在的列。 | ListBase | |
|
给定索引处数据提供程序项目所在的行。 | ListBase | |
|
对于组件的某些不常使用的高级布局功能，初始化其实现和存储。 | UIComponent | |
|
完成对此组件的初始化。 | UIComponent | |
|
初始化此组件的辅助功能代码。 | UIComponent | |
|
当数据提供程序中发生更改时应用数据更改效果。 | ListBase | |
|
此对象影响其布局时（includeInLayout 为 true），使父代大小和显示列表失效的 Helper 方法。 | UIComponent | |
|
通常由包含 UITextField 对象的组件覆盖，其中 UITextField 对象获取焦点。 | UIComponent | |
|
如果项呈示器不再根据列表的布局算法定位，则返回 true，尽管由于调用 unconstrainRenderer() 方法正在运行数据更改效果。 | ListBase | |
|
返回一个包含项呈示器的 columnIndex 和 rowIndex 的点。 | ListBase | |
|
确定数据提供程序项目的 UID。 | ListBase | |
|
为 keyDown 事件调用的事件处理函数。 | UIComponent | |
|
为 keyUp 事件调用的事件处理函数。 | UIComponent | |
|
通过设置此控件边框的位置和大小来响应大小更改。 | ScrollControlBase | |
在建议的位置使用建议的尺寸放置项目编辑器实例。 | List | ||
创建新的 ListData 实例并根据输入数据提供程序项目填充字段。 | List | ||
| makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
创建足够的行和列以填充左侧、顶部、右侧和底部描述的区域。 | ListBase | |
| [覆盖]
根据 rowCount、columnCount、rowHeight 和 columnWidth 属性计算组件的度量宽度和高度。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_CLICK 事件。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_DOUBLE_CLICK 事件。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_DOWN 事件。 | ListBase | |
|
确定哪种项呈示器位于鼠标下方。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_MOVE 事件。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_OUT 事件。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_OVER 事件。 | ListBase | |
|
处理列表中所有鼠标目标（包括呈示器）的 MouseEvent.MOUSE_DOWN 事件。 | ListBase | |
| [覆盖]
通过更改滚动位置处理 mouseWheel 事件。 | ListBase | |
|
水平移动所选项目并加亮指示符。 | ListBase | |
|
垂直移动所选项目并加亮指示符。 | ListBase | |
|
垂直移动行，并更新 rowInfo 记录。 | ListBase | |
|
沿水平方向移动所选项目，以响应用户使用向左键或向右键以及功能键（如 Shift 和 Ctrl 键）选择项目的操作。 | ListBase | |
|
沿垂直方向移动所选项目，以响应用户使用向上键或向下键以及功能键（如 Shift 和 Ctrl 键）选择项目的操作。 | ListBase | |
|
准备集合事件的数据效果。 | ListBase | |
|
当呈示器发生更改时，updateDisplayList() 方法将调用此方法，用以删除现有的项呈示器并清理各种缓存结构。 | ListBase | |
|
更新 visibleData 哈希表中的键。 | ListBase | |
|
从用于存储对行的引用的数组中删除一行。 | ListBase | |
|
清理数据提供程序中给定项目的选项亮显及其他关联图形。 | ListBase | |
|
构建 UIComponent 时将调用此方法，并且每当 ResourceManager 调度“change”事件用于指示本地化资源已经过某种更改时，都会再次调用此方法。 | UIComponent | |
|
从用于存储对行的引用的数组开头删除请求的行数。 | ListBase | |
|
确定此组件中的空间是否足以显示给定的滚动条。 | ScrollControlBase | |
|
scroll 事件的默认事件处理函数。 | ScrollControlBase | |
|
调整呈示器以响应滚动位置的更改。 | ListBase | |
|
返回给定滚动位置第一个可见行和列处的项目的数据提供程序索引。 | ListBase | |
|
调整呈示器以响应滚动位置的更改。 | ListBase | |
|
当由于页面错误而导致寻找失败时的默认故障处理函数。 | ListBase | |
|
当由于页面错误而导致寻找失败时的默认结果处理函数。 | ListBase | |
|
搜索位置，并在必要时处理 ItemPendingError。 | ListBase | |
| selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
如果使用鼠标单击提供的项呈示器，并且键盘功能键处于给定状态，则更新所选项目组。 | ListBase | |
|
设置 rowCount 属性不会导致 invalidation，也不会设置将永久锁定行数的 explicitRowCount 属性。 | ListBase | |
|
设置 rowHeight 属性不会导致 invalidation，也不会设置将永久锁定行高的 explicitRowHeight。 | ListBase | |
|
使 ScrollControlBase 基于传递的参数显示或隐藏滚动条。 | ScrollControlBase | |
|
在水平方向和垂直方向上，指定转换拉伸因子。 | UIComponent | |
|
移动引用多行的数组中的某一行。 | ListBase | |
|
当状态改变以检查状态特定的样式是否应用到此组件时，会调用此方法。 | UIComponent | |
|
确定所请求的行集的高度。 | ListBase | |
|
从用于存储对行的引用的数组末端删除所有剩余行。 | ListBase | |
|
如果项呈示器可见，则根据其 UID 进行查找。 | ListBase | |
| [覆盖]
当可显示的项目数发生更改时添加或移除项呈示器。 | ListBase | |
|
刷新所有行。 | ListBase | |
事件
| 事件 | 摘要 | 由以下参数定义 | ||
|---|---|---|---|---|
| [广播事件] Flash Player 或 AIR 应用程序获得操作系统焦点并变为活动状态时将调度此事件。 | EventDispatcher | ||
| 当组件通过使用 addChild()、addChildAt()、addElement() 或 addElementAt() 方法作为内容子项添加到容器后调度。 | UIComponent | ||
| 将显示对象添加到显示列表中时调度。 | DisplayObject | ||
| 在将显示对象直接添加到舞台显示列表或将包含显示对象的子树添加至舞台显示列表中时调度。 | DisplayObject | ||
| 当用户操作导致 selectedIndex 或 selectedItem 属性发生变化时调度此事件。 | ListBase | ||
| 当用户从文本上下文菜单中选择“清除”（或“删除”）时调度。 | InteractiveObject | ||
| 用户在同一 InteractiveObject 上按下并释放用户指针设备的主按钮时调度。 | InteractiveObject | ||
| 当用户手势触发 AIR 应用程序中与此交互式对象相关联的上下文菜单时调度。 | InteractiveObject | ||
| 在用户为复制操作激活特定于平台的加速键组合或从文本上下文菜单中选择“复制”时调度。 | InteractiveObject | ||
| 当组件完成其构建、属性处理、测量、布置和绘制时调度。 | UIComponent | ||
| 视图状态更改后调度。 | UIComponent | ||
| 在 currentState 属性更改后但视图状态更改前调度。 | UIComponent | ||
| 在用户为剪切操作激活特定于平台的加速键组合或从文本上下文菜单中选择“剪切”时调度。 | InteractiveObject | ||
| 当 data 属性更改时进行调度。 | ListBase | ||
| [广播事件] Flash Player 或 AIR 应用程序失去操作系统焦点并变为非活动状态时将调度此事件。 | EventDispatcher | ||
| 如果 InteractiveObject 的 doubleClickEnabled 标志设置为 true，当用户在该对象上快速连续按下两次并释放指针设备的主按钮时调度。 | InteractiveObject | ||
| 在拖动操作完成时（将拖动的数据放到放置目标时或在没有执行放置操作的情况下结束拖放操作时）由拖动启动器（作为要拖动的数据源的组件）调度。 | UIComponent | ||
| 用户在放置目标上释放鼠标时由放置目标调度。 | UIComponent | ||
| 当用户在拖动操作过程中将鼠标移动到某个组件所处的位置时，由该组件调度。 | UIComponent | ||
| 用户在组件外拖动但没有将数据放置到目标时，由组件调度。 | UIComponent | ||
| 在拖动操作期间，当用户在鼠标位于组件上方的情况下移动鼠标时，由组件调度。 | UIComponent | ||
| 启动拖动操作时，由拖动启动器调度。 | UIComponent | ||
| 在一个效果结束后调度。 | UIComponent | ||
| 在即将开始播放效果前调度。 | UIComponent | ||
| 在停止某个效果（仅当对该效果调用 stop() 时发生）之后调度。 | UIComponent | ||
| [播放事件] 播放头进入新帧时调度。 | DisplayObject | ||
| 在组件已进入视图状态之后调度。 | UIComponent | ||
| [广播事件] 播放头退出当前帧时调度。 | DisplayObject | ||
| 在组件即将退出视图状态之前调度。 | UIComponent | ||
| 显示对象获得焦点后调度。 | InteractiveObject | ||
| 显示对象失去焦点后调度。 | InteractiveObject | ||
| [广播事件] 在帧显示对象的构造函数运行之后但在帧脚本运行之前调度。 | DisplayObject | ||
| 当用户使用 InteractiveObject 实例沿触摸面边缘创建接触点时调度（如在 Siri Remote for Apple TV 上沿触摸面边缘轻击）。有些设备也可能将这种接触解释为多个触摸事件的组合。 | InteractiveObject | ||
| 当用户在启用触摸设备上的同一 InteractiveObject 实例上按下两个接触点时（例如，在配有触摸屏的移动电话或平板电脑上的显示对象上按下和释放两个手指）调度。 | InteractiveObject | ||
| 当用户在启用触摸的设备上的 InteractiveObject 实例上移动接触点时（例如，在配有触摸屏的移动电话或平板电脑上的显示对象上从左向右移动手指）调度。 | InteractiveObject | ||
| 当用户在接触点处使用 InteractiveObject 实例执行旋转手势时（例如，将两个手指放在屏幕上，然后在配有触摸屏的移动电话或平板电脑上的显示对象上旋转这两个手指）调度。 | InteractiveObject | ||
| 当用户在接触点处使用 InteractiveObject 实例执行滑动手势（例如，在配有触摸屏的移动电话或平板电脑上用三根手指触摸屏幕，然后在一个显示对象上平行移动这三根手指）时调度。 | InteractiveObject | ||
| 当用户使用 InteractiveObject 实例创建接触点，然后点击启用触屏的设备时（例如，将几个手指放在显示对象上以打开菜单，然后点击一个手指在配有触摸屏的移动电话或平板电脑上选择一个菜单项）调度。 | InteractiveObject | ||
| 当用户在接触点处使用 InteractiveObject 实例执行缩放手势操作时（例如，将两个手指放在屏幕上，然后在配有触摸屏的移动电话或平板电脑上的显示对象上快速分开手指）调度。 | InteractiveObject | ||
| 当对象的状态从可见变为不可见时调度。 | UIComponent | ||
| 此事件被调度到任何支持使用 IME 进行内联输入的客户端应用程序 | InteractiveObject | ||
| 当组件完成构建并设置了所有初始化属性后调度。 | UIComponent | ||
| 当组件由 Validator 监控且未通过验证时调度。 | UIComponent | ||
| 当用户单击控件中的某个项目时调度此事件。 | ListBase | ||
| 当用户双击控件中的某个项目时调度此事件。 | ListBase | ||
| 当设置了 editedItemPosition 属性且项目可编辑时调度。 | List | |||
| 当用户在某个项目上释放鼠标按键时、切换到 List 或 List 内部时，或通过任何其他方式尝试编辑项目时调度。 | List | |||
| 当项目编辑会话由于任何原因结束时调度。 | List | |||
| 当项呈示器获得焦点时调度。在下列情况下项呈示器可能获得焦点：当用户单击 List 控件中的某个项目或者使用键盘导航到该项目时。 | List | |||
| 当项呈示器失去焦点时调度。在下列情况下项呈示器可能会失去焦点：用户单击 List 控件中的其他项目或在列表外部单击时，或使用键盘导航到 List 控件中的其他项目或导航到 List 控件外部时。 | List | |||
| 当用户将鼠标指针移出控件中的某个项目时调度此事件。 | ListBase | ||
| 当用户将鼠标指针滚至控件中的某个项目时调度此方法。 | ListBase | ||
| 用户按下某个键时调度。 | InteractiveObject | ||
| 用户尝试使用键盘导航更改焦点时调度。 | InteractiveObject | ||
| 用户释放某个键时调度。 | InteractiveObject | ||
| 当用户在同一 InteractiveObject 上按下并释放用户指针设备的中间按钮时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上按下指针设备的中间按钮时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上释放指针设备按钮时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上按下指针设备按钮时调度。 | InteractiveObject | ||
| 当用户在使用 PopUpManager 打开的某个组件外部单击时，从该组件调度。 | UIComponent | ||
| 用户尝试使用指针设备更改焦点时调度。 | InteractiveObject | ||
| 用户移动 InteractiveObject 上的指针设备时调度。 | InteractiveObject | ||
| 用户将指针设备从 InteractiveObject 实例上移开时调度。 | InteractiveObject | ||
| 用户将指针设备移动到 InteractiveObject 实例上时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上释放指针设备按钮时调度。 | InteractiveObject | ||
| 当鼠标滚轮滚动到 InteractiveObject 实例上时调度。 | InteractiveObject | ||
| 当用户使用鼠标滚轮滚动到使用 PopUpManager 打开的某个组件外部时，从该组件调度。 | UIComponent | ||
| 移动对象后调度。 | UIComponent | ||
| 当用户释放拖动手势时由拖动启动器 InteractiveObject 调度。 | InteractiveObject | ||
| 在将拖动对象放置到目标上且已通过对 DragManager.acceptDragDrop() 的调用接受该放置操作时，由目标 InteractiveObject 调度。 | InteractiveObject | ||
| 当拖动手势进入其边界时由 InteractiveObject 调度。 | InteractiveObject | ||
| 当拖动手势离开其边界时由 InteractiveObject 调度。 | InteractiveObject | ||
| 当拖动手势保持在其边界内时，由 InteractiveObject 持续调度。 | InteractiveObject | ||
| 在拖动操作开始时由在 DragManager.doDrag() 调用中指定为拖动启动器的 InteractiveObject 调度。 | InteractiveObject | ||
| 在拖动操作期间由在 DragManager.doDrag() 调用中指定为拖动启动器的 InteractiveObject 调度。 | InteractiveObject | ||
| 在用户为粘贴操作激活特定于平台的加速键组合或从文本上下文菜单中选择“粘贴”时调度。 | InteractiveObject | ||
| 在组件初始化序列开始时调度。 | UIComponent | ||
| 当用户将活动笔针放低经过屏幕的邻近检测阈值上时调度。 | InteractiveObject | ||
| 当用户将活动笔针抬高放在屏幕的邻近检测阈值上时调度。 | InteractiveObject | ||
| 当用户将活动笔针移动到屏幕上但仍保留在邻近检测阈值中时调度。 | InteractiveObject | ||
| 当用户直接将活动笔针从此 InteractiveObject 上移开但仍保留在屏幕的邻近检测阈值中时调度。 | InteractiveObject | ||
| 当用户直接将活动笔针移动到此 InteractiveObject 上但仍保留在屏幕的邻近检测阈值中时调度。 | InteractiveObject | ||
| 当用户从此 InteractiveObject 及其任一子项中移开而仍保留在屏幕的邻近检测阈值中时调度。 | InteractiveObject | ||
| 当用户将活动笔针从显示列表中子项的对象树中滑过此 InteractiveObject 时（而仍保留在屏幕的邻近检测阈值中）时调度。 | InteractiveObject | ||
| 在用户首先在 InteractiveObject 实例上按下按钮，然后将指针设备移离 InteractiveObject 实例，释放指针设备上的按钮时调度。 | InteractiveObject | ||
| 当组件通过使用 removeChild()、removeChildAt()、removeElement() 或 removeElementAt() 方法作为内容子项从容器中删除后调度。 | UIComponent | ||
| 将要从显示列表中删除显示对象时调度。 | DisplayObject | ||
| 在从显示列表中直接删除显示对象或删除包含显示对象的子树时调度。 | DisplayObject | ||
| [广播事件] 将要更新和呈现显示列表时调度。 | DisplayObject | ||
| 在调整组件大小时调度。 | UIComponent | ||
| 当用户在同一 InteractiveObject 上按下并释放用户指针设备的右按钮时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上按下指针设备按钮时调度。 | InteractiveObject | ||
| 当用户在 InteractiveObject 实例上释放指针设备按钮时调度。 | InteractiveObject | ||
| 用户将指针设备从 InteractiveObject 实例上移开时调度。 | InteractiveObject | ||
| 用户将指针设备移动到 InteractiveObject 实例上时调度。 | InteractiveObject | ||
| 当滚动内容时调度。 | ScrollControlBase | ||
| 在用户为全选操作激活特定于平台的加速键组合或从文本上下文菜单中选择“全选”时调度。 | InteractiveObject | ||
| 当对象的状态从不可见变为可见时调度。 | UIComponent | ||
| 在放开软键盘之后立即调度。 | InteractiveObject | ||
| 在放开软键盘之前立即调度。 | InteractiveObject | ||
| 在隐藏软键盘之后立即调度。 | InteractiveObject | ||
| 在组件进入新状态且切换到该状态的状态转换动画已经播放完时调度。 | UIComponent | ||
| 在组件中断转换到当前状态从而切换到新状态时调度。 | UIComponent | ||
| 对象的 tabChildren 标志值发生更改时调度。 | InteractiveObject | ||
| 对象的 tabEnabled 标志发生更改时调度。 | InteractiveObject | ||
| 对象的 tabIndex 属性值发生更改时调度。 | InteractiveObject | ||
| 当用户输入一个或多个文本字符时调度。 | InteractiveObject | ||
| 要创建 ToolTip 时由组件调度。 | UIComponent | ||
| 已隐藏组件的 ToolTip 并要将其放弃时由组件调度。 | UIComponent | ||
| 要隐藏组件的 ToolTip 时由组件调度。 | UIComponent | ||
| 要显示组件的 ToolTip 时由组件调度。 | UIComponent | ||
| 显示组件的 ToolTip 时由组件调度。 | UIComponent | ||
| 用户将鼠标移动到设置了 toolTip 属性的组件上方后，由该组件调度。 | UIComponent | ||
| 当用户第一次触摸启用触摸的设备时（例如，用手指触摸配有触摸屏的移动电话或平板）调度。 | InteractiveObject | ||
| 当用户移除与启用触摸的设备的接触时（例如，将手指从配有触摸屏的移动电话或平板电脑上抬起）调度。 | InteractiveObject | ||
| 不可撤消事件，在组件结束响应 touch 交互用户操作时由组件调度。 | UIComponent | ||
| 不可撤消事件，在组件开始响应 touch 交互用户操作时由组件调度。 | UIComponent | ||
| 可撤消事件，在组件试图响应 touch 交互用户操作时由组件调度。 | UIComponent | ||
| 当用户触碰设备时进行调度，而且会连续调度，直到接触点被删除。 | InteractiveObject | ||
| 当用户将接触点从启用触摸的设备上的 InteractiveObject 实例移开时（例如，在配有触摸屏的移动电话或平板电脑上，将手指从一个显示对象拖到另一个显示对象）调度。 | InteractiveObject | ||
| 当用户在启用触摸的设备的 InteractiveObject 实例上移动接触点时（例如，在配有触摸屏的移动电话或平板电脑上，将手指从显示对象外的一点拖动到显示对象上的一点）调度。 | InteractiveObject | ||
| 当用户移动接触点，使其远离启用触摸的设备上的 InteractiveObject 实例时（例如，在配有触摸屏的移动电话或平板电脑上将一个手指从显示对象上的一点移动到显示对象外的一点）调度。 | InteractiveObject | ||
| 当用户在启用触摸的设备的 InteractiveObject 实例上移动接触点时（例如，在配有触摸屏的移动电话或平板电脑上，将手指从显示对象外的一点拖动到显示对象上的一点）调度。 | InteractiveObject | ||
| 当用户在启用触摸设备上的已启动接触的同一 InteractiveObject 实例上抬起接触点时（例如，在配有触摸屏的移动电话或平板的显示对象上的某一点处按下并释放手指）调度。 | InteractiveObject | ||
| 当调用了对象的 commitProperties()、measure() 和 updateDisplayList() 方法后调度（如果需要）。 | UIComponent | ||
| 当组件由 Validator 监控并且成功通过验证时调度。 | UIComponent | ||
| 当以编程方式或通过用户交互更改值时调度。 | UIComponent | ||
效果
| 效果 | 说明 | 由以下参数定义 | ||
|---|---|---|---|---|
| 触发事件: added 将组件作为子项添加到 Container 时播放。 | UIComponent | ||
| 触发事件: creationComplete 创建组件时播放。 | UIComponent | ||
| 触发事件: focusIn 组件获得键盘焦点时播放。 | UIComponent | ||
| 触发事件: focusOut 组件失去键盘焦点时播放。 | UIComponent | ||
| 触发事件: hide 组件变为不可见时播放。 | UIComponent | ||
itemsChangeEffect | 触发事件: itemsChange 当控件的数据提供程序发生更改时播放的数据效果。 默认情况下，List 控件不使用数据效果。对于 List 控件，将使用 DefaultListEffect 类的实例配置数据效果。 | List | ||
| 触发事件: mouseDown 用户在组件上方按下鼠标按键时播放。 | UIComponent | ||
| 触发事件: mouseUp 用户在组件上方释放鼠标按键时播放。 | UIComponent | ||
| 触发事件: move 移动组件时播放。 | UIComponent | ||
| 触发事件: removed 从 Container 中删除组件时播放。 | UIComponent | ||
| 触发事件: resize 调整组件大小时播放。 | UIComponent | ||
| 触发事件: rollOut 用户将鼠标指针滚离组件上方时播放。 | UIComponent | ||
| 触发事件: rollOver 用户将鼠标指针滚动到组件上方时播放。 | UIComponent | ||
| 触发事件: show 组件变为可见时播放。 | UIComponent | ||
属性详细信息
editable | 属性 |
editedItemPosition | 属性 |
editedItemPosition:Object| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
正在编辑的数据提供程序项目的项呈示器的列索引和行索引（如果有）。
此 Object 包含 columnIndex 和 rowIndex 这两个字段，分别是项目的从零开始的列索引和项目索引。对于 List 控件，columnIndex 属性始终为 0；例如：{columnIndex:0, rowIndex:3}。
设置此属性会将项目滚动到视图中，并会调度 itemEditBegin 事件以打开指定项目上的项目编辑器。
此属性可用作数据绑定的源。修改此属性后，将调度 itemFocusIn 事件。
实现
public function get editedItemPosition():Object public function set editedItemPosition(value:Object):voideditedItemRenderer | 属性 |
editedItemRenderer:IListItemRenderer [只读] | 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
对当前正在编辑的项目所属的 DataGrid 控件中项呈示器的引用。
在 itemEditBegin 和 itemEditEnd 事件的事件侦听器中，您可以使用 editedItemRenderer.data 属性访问所编辑的项目的当前值。
实现
public function get editedItemRenderer():IListItemRenderereditorDataField | 属性 |
public var editorDataField:String = "text"| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器的属性名称，其中包含列表项目的新数据。例如，默认的 itemEditor 为 TextInput，因此 editorDataField 属性的默认值为 "text"，它指定了 TextInput 控件的 text 属性。
editorHeightOffset | 属性 |
public var editorHeightOffset:Number = 0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器相对于项呈示器大小的高度（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。
在显示编辑器的同时更改这些值对当前编辑器没有任何影响，但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorUsesEnterKey | 属性 |
public var editorUsesEnterKey:Boolean = false| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指示项目编辑器是否使用 Enter 键的标志。如果将此属性设置为 true，则项目编辑器将使用 Enter 键，并且 List 不会查找 Enter 键并移动编辑器进行响应。
在显示编辑器的同时更改此值对当前编辑器没有任何影响，但会影响下一个打开编辑器的项呈示器。
默认值为 false。
editorWidthOffset | 属性 |
public var editorWidthOffset:Number = 0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器相对于项呈示器大小的宽度（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。
在显示编辑器的同时更改这些值对当前编辑器没有任何影响，但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorXOffset | 属性 |
public var editorXOffset:Number = 0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器左上角相对于项目左上角的 x 位置（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。
在显示编辑器的同时更改这些值对当前编辑器没有任何影响，但会影响下一个打开编辑器的项呈示器。
默认值为 0。
editorYOffset | 属性 |
public var editorYOffset:Number = 0| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
项目编辑器左上角相对于项目左上角的 y 位置（以像素为单位）。使用此属性可以使编辑器与项呈示器产生几个像素的重叠，以补偿编辑器周围的边框。
在显示编辑器的同时更改这些值对当前编辑器没有任何影响，但会影响下一个打开编辑器的项呈示器。
默认值为 0。
enableIME | 属性 |
imeMode | 属性 |
imeMode:String| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指定 IME（输入法编辑器）模式。IME 使用户能够用中文、日文和韩文输入文本。Flex 在该控件获得焦点时设置指定的 IME 模式，并在该控件丢失焦点时将其设置回先前的值。
flash.system.IMEConversionMode 类定义此属性的有效值的常量。您还可以指定 null 不指定任何 IME 模式。
默认值为 null。
实现
public function get imeMode():String public function set imeMode(value:String):void相关 API 元素
itemEditor | 属性 |
public var itemEditor:IFactory| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
如果将 editable 属性设置为 true，则为用于控件的项目编辑器的类工厂。
默认值为 new ClassFactory(mx.controls.TextInput)。
itemEditorInstance | 属性 |
public var itemEditorInstance:IListItemRenderer| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
对项目编辑器的当前活动实例（如果有）的引用。
若要在编辑项目时访问项目编辑器实例和新项目值，则应使用 itemEditorInstance 属性。只有在执行 itemEditBegin 事件的事件侦听器之后，itemEditorInstance 属性才有效。因此，您通常只从 itemEditEnd 事件的事件侦听器中访问 itemEditorInstance 属性。
itemEditor 属性定义项目编辑器的类，从而定义项目编辑器实例的数据类型。
不要以 MXML 方式设置此属性。
measuringObjects | 属性 |
protected var measuringObjects:Dictionary| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
工厂设置的度量对象的缓存
rendererIsEditor | 属性 |
public var rendererIsEditor:Boolean = false| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
指定项呈示器是否同时也是项目编辑器。如果此属性为 true，Flex 将忽略 itemEditor 属性。
默认值为 false。
构造函数详细信息
List | () | 构造函数 |
public function List()| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
构造函数。
方法详细信息
createItemEditor | () | 方法 |
public function createItemEditor(colIndex:int, rowIndex:int):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
使用由 itemEditor 属性指定的编辑器在 editedItemPosition 为项呈示器创建项目编辑器。
此方法将编辑器实例设置为 itemEditorInstance 属性。
您只能从 itemEditBegin 事件的事件侦听器中调用此方法。若要在其他时间创建编辑器，请设置 editedItemPosition 属性以生成 itemEditBegin 事件。
参数
colIndex:int — 列索引。对于 List 控件，Flex 将此属性的值设置为 0。
| |
rowIndex:int — 要编辑的项目的数据提供程序中的索引。
|
createItemRenderer | () | 方法 |
override public function createItemRenderer(data:Object):IListItemRenderer| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
获取适当的呈示器，如果未指定呈示器，则使用默认呈示器。
参数
data:Object — 从中创建项呈示器的对象。
|
IListItemRenderer — 呈示器。
|
destroyItemEditor | () | 方法 |
public function destroyItemEditor():void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
关闭当前在某个项目上打开的项目编辑器。通常，只能从 itemEditEnd 事件的事件侦听器中调用此方法，但在这之前需要调用 preventDefault() 方法阻止执行默认的事件侦听器。
drawRowBackground | () | 方法 |
protected function drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
在指定的位置以指定高度绘制行背景。这样，将创建一个 Shape 作为输入 Sprite 的子项，并使用相应的颜色对其进行填充。此方法还使用 backgroundAlpha 样式属性设置来确定背景颜色的透明度。
参数
s:Sprite — 一个 Sprite，其中的显示对象包含该行的图形。
| |
rowIndex:int — 行在所显示的一组行中的索引。最顶端可见行（不包括标题）的行索引为 0。此索引用于跟踪绘制背景所使用的对象，以便某一特定行能够重用同一显示对象，即使该行呈示的项目的索引发生了更改时也是如此。
| |
y:Number — 建议的背景 y 位置。
| |
height:Number — 建议的指示符高度。
| |
color:uint — 建议的指示符颜色。
| |
dataIndex:int — 数据提供程序中该行的项目的索引。例如，这可用于为第 10 个项目设置不同的颜色。
|
endEdit | () | 方法 |
protected function endEdit(reason:String):Boolean| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
停止编辑数据提供程序中的项目。当用户完成项目编辑后，控件将调用此方法。它将调度 itemEditEnd 事件以启动以下过程：将编辑的数据从 itemEditorInstance 复制到数据提供程序，并隐藏 itemEditorInstance。
参数
reason:String — 定义事件原因的常量（例如“CANCELLED”、“NEW_ROW”或“OTHER”）。该值必须是 ListEventReason 类的成员。
|
Boolean — 如果没有调用 preventDefault()，则返回 true。否则为 false。
|
相关 API 元素
isItemEditable | () | 方法 |
layoutEditor | () | 方法 |
makeListData | () | 方法 |
protected function makeListData(data:Object, uid:String, rowNum:int):BaseListData| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
创建新的 ListData 实例并根据输入数据提供程序项目填充字段。
参数
data:Object — 用于填充 ListData 的数据提供程序项目。
| |
uid:String — 该项目的 UID。
| |
rowNum:int — 数据提供程序中项目的索引。
|
BaseListData — 新构建的 ListData 对象。
|
事件详细信息
itemEditBegin | 事件 |
事件对象类型:
属性 ListEvent.type =
mx.events.ListEvent属性 ListEvent.type =
mx.events.ListEvent.ITEM_EDIT_BEGIN| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当设置了 editedItemPosition 属性且项目可编辑时调度。
itemEditBegin 事件定义事件对象的 type 属性的值，指示准备编辑的项目。
此事件的默认侦听器执行下列操作：
- 通过调用
createItemEditor()方法来创建项目编辑器对象。 - 将
data属性从项目复制到编辑器。默认情况下，项目编辑器对象是 TextInput 控件的实例。您可以使用 list 控件的itemEditor属性指定自定义项目编辑器类。 - 设置 list 控件的
itemEditorInstance属性，以引用项目编辑器实例。
您可以为此事件编写事件侦听器以修改传递到项目编辑器的数据。例如，您可以修改项目编辑器使用的数据、数据格式或其他信息。
您还可以创建事件侦听器以指定用于编辑项目的项目编辑器。例如，您可能有两个不同的项目编辑器。在事件侦听器中，您可以通过执行下列操作检查要编辑的数据或其他信息，并打开相应的项目编辑器：
- 调用
preventDefault()以阻止 Flex 在默认事件侦听器中调用createItemEditor()方法。 - 将
itemEditor属性设置为相应编辑器。 - 调用
createItemEditor()方法。
事件对象的属性有下列值：
| 属性 | 值 |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | 与事件相关联的列的从零开始的索引。 |
currentTarget | 用于定义处理该事件的事件侦听器的对象。例如，如果您使用 myButton.addEventListener() 注册某个事件侦听器，则 myButton 为 currentTarget 的值。 |
itemRenderer | 所编辑的项目的项呈示器。 |
reason | null |
rowIndex | 与事件相关联的项目的从零开始的索引。 |
target | 调度该事件的 Object；它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。 |
类型 | ListEvent.ITEM_EDIT_BEGIN |
itemEditBeginning | 事件 |
事件对象类型:
属性 ListEvent.type =
mx.events.ListEvent属性 ListEvent.type =
mx.events.ListEvent.ITEM_EDIT_BEGINNING| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当用户在某个项目上释放鼠标按键时、切换到 List 或 List 内部时，或通过任何其他方式尝试编辑项目时调度。
ListEvent.ITEM_EDIT_BEGINNING 常量可为itemEditBeginning 事件定义 ListEvent 对象的 type 属性的值，指示用已户准备编辑某个项目，例如，通过在该项目上释放鼠标按键。
此事件的默认侦听器将 List.editedItemPosition 属性设置为具有焦点的项目，这可启动项目编辑会话。
您通常可以为此事件编写自己的事件侦听器，以禁止编辑特定项目。在为此事件自己编写的事件侦听器内调用 preventDefault() 方法可以阻止默认侦听器执行。
事件对象的属性有下列值：
| 属性 | 值 |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | 与事件相关联的列的从零开始的索引。 |
currentTarget | 用于定义处理该事件的事件侦听器的对象。例如，如果您使用 myButton.addEventListener() 注册某个事件侦听器，则 myButton 为 currentTarget 的值。 |
itemRenderer | 要编辑的项目的项呈示器。如果此事件由键盘生成，则此属性为 null，因为要编辑的项目可能未在屏幕范围内显示。 |
reason | null |
rowIndex | 与事件相关联的项目的从零开始的索引。 |
target | 调度该事件的 Object；它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。 |
类型 | ListEvent.ITEM_EDIT_BEGIN |
itemEditEnd | 事件 |
事件对象类型:
属性 ListEvent.type =
mx.events.ListEvent属性 ListEvent.type =
mx.events.ListEvent.ITEM_EDIT_END| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当项目编辑会话由于任何原因结束时调度。
ListEvent.ITEM_EDIT_END 常量可为itemEditEnd 事件定义 ListEvent 对象的 type 属性值，指示编辑会话结束。
列表组件具有针对此事件的默认处理函数，此程序将数据从项目编辑器复制到 list 控件的数据提供程序。默认事件侦听器执行下列操作：
- 使用 list 控件的
editorDataField属性来确定包含新数据的项目编辑器的属性，并使用这些新数据更新数据提供程序项目。因为默认项目编辑器是 TextInput 控件，所以editorDataField属性的默认值为"text"，以指定 TextInput 的text属性包含新项目数据。 - 调用
destroyItemEditor()方法以关闭项目编辑器。
通常，您可以为此事件编写事件侦听器，以执行下列操作：
- 在事件侦听器中，您可以修改编辑器为列表组件返回的数据。例如，您可以在将数据返回到 list 控件之前重新设置其格式。默认情况下，项目编辑器只可以返回一个值。如果希望返回多个值，必须为
itemEditEnd事件编写事件侦听器。 - 在事件侦听器中，您可以检查项目编辑器中输入的数据。如果数据不正确，可以调用
preventDefault()方法阻止 Flex 将新数据传递回 list 控件和关闭编辑器。
事件对象的属性有下列值：
| 属性 | 值 |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | 与事件相关联的列的从零开始的索引。 |
currentTarget | 用于定义处理该事件的事件侦听器的对象。例如，如果您使用 myButton.addEventListener() 注册某个事件侦听器，则 myButton 为 currentTarget 的值。 |
itemRenderer | 已编辑的项目的项呈示器。 |
reason | 定义事件原因的常量。该值必须是 ListEventReson 类的成员。 |
rowIndex | 与事件相关联的项目的从零开始的索引。 |
target | 调度该事件的 Object；它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。 |
类型 | ListEvent.ITEM_EDIT_END |
itemFocusIn | 事件 |
事件对象类型:
属性 ListEvent.type =
mx.events.ListEvent属性 ListEvent.type =
mx.events.ListEvent.ITEM_FOCUS_IN| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当项呈示器获得焦点时调度。在下列情况下项呈示器可能获得焦点：当用户单击 List 控件中的某个项目或者使用键盘导航到该项目时。仅当列表项目可编辑时调度。
ListEvent.ITEM_FOCUS_IN 常量可为itemFocusIn 事件定义 ListEvent 对象的 type 属性的值，指示项目已获得焦点。
事件对象的属性有下列值：
| 属性 | 值 |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | 与事件相关联的列的从零开始的索引。 |
currentTarget | 用于定义处理该事件的事件侦听器的对象。例如，如果您使用 myButton.addEventListener() 注册某个事件侦听器，则 myButton 为 currentTarget 的值。 |
itemRenderer | 所编辑的项目的项目编辑器实例。 |
reason | null |
rowIndex | 与事件相关联的项目的从零开始的索引。 |
target | 调度该事件的 Object；它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。 |
类型 | ListEvent.ITEM_FOCUS_IN |
itemFocusOut | 事件 |
事件对象类型:
属性 ListEvent.type =
mx.events.ListEvent属性 ListEvent.type =
mx.events.ListEvent.ITEM_FOCUS_OUT| 语言版本: | ActionScript 3.0 |
| 产品版本: | Flex 3 |
| 运行时版本: | Flash Player 9, AIR 1.1 |
当项呈示器失去焦点时调度。在下列情况下项呈示器可能会失去焦点：用户单击 List 控件中的其他项目或在列表外部单击时，或使用键盘导航到 List 控件中的其他项目或导航到 List 控件外部时。仅当列表项目可编辑时调度。
ListEvent.ITEM_FOCUS_OUT 常量可为itemFocusOut 事件定义 ListEvent 对象的 type 属性的值，指示项目已失去焦点。
事件对象的属性有下列值：
| 属性 | 值 |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | 与事件相关联的列的从零开始的索引。 |
currentTarget | 用于定义处理该事件的事件侦听器的对象。例如，如果您使用 myButton.addEventListener() 注册某个事件侦听器，则 myButton 为 currentTarget 的值。 |
itemRenderer | 正在编辑的项目的项目编辑器实例。 |
reason | null |
rowIndex | 与事件相关联的项目的从零开始的索引。 |
target | 调度该事件的 Object；它不一定是侦听该事件的 Object。使用 currentTarget 属性始终可以访问侦听事件的 Object。 |
类型 | ListEvent.ITEM_FOCUS_OUT |
示例 如何使用本示例
SimpleList.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- Simple example to demonstrate the Halo List Control -->
<s:Application xmlns:fx="http://ns.adobe.com/mxml/2009"
xmlns:s="library://ns.adobe.com/flex/spark"
xmlns:mx="library://ns.adobe.com/flex/mx">
<fx:Script>
<![CDATA[
[Bindable]
public var selectedListItem:Object;
]]>
</fx:Script>
<fx:Declarations>
<fx:Model id="mystates">
<states>
<state label="Alabama" data="AL"/>
<state label="Alaska" data="AK"/>
<state label="Arizona" data="AZ"/>
<state label="Arkansas" data="AR"/>
<state label="California" data="CA"/>
<state label="Colorado" data="CO"/>
<state label="Connecticut" data="CT"/>
</states>
</fx:Model>
</fx:Declarations>
<s:Panel title="Halo List Control Example"
width="75%" height="75%"
horizontalCenter="0" verticalCenter="0">
<s:VGroup left="10" right="10" top="10" bottom="10">
<s:Label text="Select a state to see its abbreviation."/>
<mx:List id="source" width="100%" color="blue"
dataProvider="{mystates.state}"
change="selectedListItem = List(event.currentTarget).selectedItem"/>
<s:VGroup width="100%">
<s:Label text="Selected State: {selectedListItem.label}"/>
<s:Label text="State abbreviation: {selectedListItem.data}"/>
</s:VGroup>
</s:VGroup>
</s:Panel>
</s:Application>
Tue Jun 12 2018, 11:04 AM Z