| Appendixes | Conventions | Frames
| Package | mx.controls |
| Class | public class List |
| Inheritance | List  ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IIMESupport |
| Subclasses | FileSystemList, Menu, Tree |
allowMultipleSelection property.
The List control has the following default sizing characteristics:
| Characteristic | Description |
|---|---|
| Default size | Wide enough to fit the widest label in the first seven visible items (or all visible items in the list, if there are less than seven); seven rows high, where each row is 20 pixels high. |
| Minimum size | 0 pixels. |
| Maximum size | 5000 by 5000. |
Hide MXML Syntax
The <mx:List> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<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"
/>
Default MXML PropertydataProvider
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| activeEffects : Array
[read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances.
| UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
| ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time.
| ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified.
| DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality.
| UIComponent | |
| automationName : String
Name that can be used as an identifier for this object.
| UIComponent | |
| automationTabularData : Object
[read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data.
| UIComponent | |
| automationValue : Array
[read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application.
| UIComponent | |
| baselinePosition : Number
[read-only]
The y-coordinate of the baseline
of the first line of text of the component.
| UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom.
| ScrollControlBase | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player or Adobe AIR caches an internal bitmap representation of the
display object.
| DisplayObject | |
| cacheHeuristic : Boolean
[write-only]
Used by Flex to suggest bitmap caching for the object.
| UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object.
| UIComponent | |
| className : String
[read-only]
The name of this instance's class, such as "Button".
| UIComponent | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control.
| ListBase | |
| columnWidth : Number
The width of the control's columns.
| ListBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance.
| Object | |
| contentMouseX : Number
[read-only]
Returns the x position of the mouse, in the content coordinate system.
| UIComponent | |
| contentMouseY : Number
[read-only]
Returns the y position of the mouse, in the content coordinate system.
| UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| currentState : String
The current view state of the component.
| UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers.
| UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor.
| ListBase | |
| dataProvider : Object
Set of data to be viewed.
| ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip.
| ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
| ListBase | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
Specifies whether the UIComponent object receives doubleClick events.
| UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls.
| ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation.
| ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control.
| ListBase | |
| dropTarget : DisplayObject
[read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped.
| Sprite | |
| editable : Boolean = false
A flag that indicates whether or not the user can edit
items in the data provider.
| List | ||
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any.
| List | ||
| editedItemRenderer : IListItemRenderer
[read-only]
A reference to the item renderer
in the DataGrid control whose item is currently being edited.
| List | ||
| editorDataField : String = "text"
The name of the property of the item editor that contains the new
data for the list item.
| List | ||
| editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer.
| List | ||
| editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key.
| List | ||
| editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer.
| List | ||
| editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | ||
| editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item.
| List | ||
| enabled : Boolean
Whether the component can accept user interaction.
| UIComponent | |
| errorString : String
The text that will be displayed by a component's error tip when a
component is monitored by a Validator and validation fails.
| UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object.
| DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
| UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
| UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers.
| UIComponent | |
| focusPane : Sprite
The focus pane associated with this object.
| UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle.
| InteractiveObject | |
| graphics : Graphics
[read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur.
| Sprite | |
| height : Number
Number that specifies the height of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
| Sprite | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method.
| ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge.
| ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon.
| ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon.
| ListBase | |
| id : String
ID of the component.
| UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode.
| List | ||
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container.
| UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles.
| UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required).
| UIComponent | |
| instanceIndex : int
[read-only]
The index of a repeated component.
| UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document.
| UIComponent | |
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up.
| UIComponent | |
| itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true.
| List | ||
| itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor,
if it exists.
| List | ||
| itemRenderer : IFactory
The custom item renderer for the control.
| ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label.
| ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label.
| ListBase | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the additional data from the list control.
| ListBase | |
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released.
| ScrollControlBase | |
| loaderInfo : LoaderInfo
[read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs.
| DisplayObject | |
| mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
| ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
| ScrollControlBase | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used.
| ListBase | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory
The moduleFactory that is used to create TextFields in the correct SWF context.
| UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| nestLevel : int
Depth of this object in the containment hierarchy.
| UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
| UIComponent | |
| nullItemRenderer : IFactory
The custom item renderer for the control.
| ListBase | |
| numAutomationChildren : int
[read-only]
The number of automation children this container has.
| UIComponent | |
| numChildren : int
[read-only]
Returns the number of children of this object.
| DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control.
| ListBase | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
[read-only]
The parent container or component for this component.
| UIComponent | |
| parentApplication : Object
[read-only]
A reference to the Application object that contains this UIComponent
instance.
| UIComponent | |
| parentDocument : Object
[read-only]
A reference to the parent document object for this UIComponent.
| UIComponent | |
| percentHeight : Number
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor.
| List | ||
| repeater : IRepeater
[read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent.
| UIComponent | |
| repeaterIndex : int
[read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent.
| UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent.
| UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent.
| UIComponent | |
| root : DisplayObject
[read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file.
| DisplayObject | |
| rotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| rowCount : int
Number of rows to be displayed.
| ListBase | |
| rowHeight : Number
The height of the rows in pixels.
| ListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect.
| DisplayObject | |
| scaleX : Number
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling factor.
| UIComponent | |
| screen : Rectangle
[read-only]
Returns an object that contains the size and position of the base
drawing surface for this object.
| UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object.
| DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
| ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected.
| ListBase | |
| selectedIndex : int
The index in the data provider of the selected item.
| ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items.
| ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider.
| ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider.
| ListBase | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows.
| ListBase | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy.
| UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged.
| ScrollControlBase | |
| soundTransform : SoundTransform
Controls sound within this sprite.
| Sprite | |
| stage : Stage
[read-only]
The Stage of the display object.
| DisplayObject | |
| states : Array
The view states that are defined for this component.
| UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
| UIComponent | |
| styleName : Object
The class style used by this component.
| UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component.
| UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled.
| DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order.
| InteractiveObject | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
| textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs.
| UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object.
| UIComponent | |
| uid : String
A unique identifier for the object.
| UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required).
| UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the mouse rolls
over a sprite in which the buttonMode property is set to true.
| Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component.
| UIComponent | |
| value : Object
[read-only]
The selected item, or the data or label field of the selected item.
| ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height.
| ListBase | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method.
| ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge.
| ScrollControlBase | |
| viewMetrics : EdgeMetrics
[read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible.
| ScrollControlBase | |
| visible : Boolean
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
Number that specifies the width of the component, in pixels,
in the parent's coordinates.
| UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
| ListBase | |
| x : Number
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| Property | Defined By | ||
|---|---|---|---|
| actualCollection : ICollectionView
A copy of the value normally stored in collection
used while running data changes effects.
| ListBase | |
| |||