ActionScript® 3.0 Reference for the Adobe® Flash® Platform
Home  |  Show Packages and Classes List |  Packages  |  Classes  |  What's New  |  Index  |  Appendixes
fl.controls 

List  - AS3 Flash

Packagefl.controls
Classpublic class List
InheritanceList Inheritance SelectableList Inheritance BaseScrollPane Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

The List component displays list-based information and is ideally suited for the display of arrays of information.

The List component consists of items, rows, and a data provider, which are described as follows:

  • Item: An ActionScript object that usually contains a descriptive label property and a data property that stores the data associated with that item.
  • Row: A component that is used to display the item.
  • Data provider: A component that models the items that the List component displays.

By default, the List component uses the CellRenderer class to supply the rows in which list items are displayed. You can create these rows programmatically; this is usually done by subclassing the CellRenderer class. The CellRenderer class implements the ICellRenderer interface, which provides the set of properties and methods that the List component uses to manipulate its rows and to send data and state information to each row for display. This includes information about data sizing and selection.

The List component provides methods that act on its data provider--for example, the addItem() and removeItem() methods. You can use these and other methods to manipulate the data of any array that exists in the same frame as a List component and then broadcast the changes to multiple views. If a List component is not provided with an external data provider, these methods automatically create an instance of a data provider and expose it through the List.dataProvider property. The List component renders each row by using a Sprite that implements the ICellRenderer interface. To specify this renderer, use the List.cellRenderer property. You can also build an Array instance or get one from a server and use it as a data model for multiple lists, combo boxes, data grids, and so on.

View the examples



Public Properties
 PropertyDefined By
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 InheritedallowMultipleSelection : Boolean
Gets a Boolean value that indicates whether more than one list item can be selected at a time.
SelectableList
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 Inherited    cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
 InheriteddataProvider : DataProvider
Gets or sets the data model of the list of items to be viewed.
SelectableList
 InheriteddoubleClickEnabled : Boolean
Specifies whether the object receives doubleClick events.
InteractiveObject
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritedenabled : Boolean
Gets or sets a value that indicates whether the component can accept user interaction.
UIComponent
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 InheritedfocusEnabled : Boolean
Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedfocusManager : IFocusManager
Gets or sets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 Inheritedheight : Number
[override] Gets or sets the height of the component, in pixels.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalLineScrollSize : Number
Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.
BaseScrollPane
 InheritedhorizontalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb on the horizontal scroll bar when the scroll bar track is pressed.
BaseScrollPane
 InheritedhorizontalScrollBar : ScrollBar
[read-only] Gets a reference to the horizontal scroll bar.
BaseScrollPane
 InheritedhorizontalScrollPolicy : String
Gets or sets a value that indicates the state of the horizontal scroll bar.
BaseScrollPane
 InheritedhorizontalScrollPosition : Number
Gets or sets a value that describes the horizontal position of the horizontal scroll bar in the scroll pane, in pixels.
BaseScrollPane
  iconField : String
Gets or sets the item field that provides the icon for the item.
List
  iconFunction : Function
Gets or sets the function to be used to obtain the icon for the item.
List
  labelField : String
Gets or sets the name of the field in the dataProvider object to be displayed as the label for the TextInput field and drop-down list.
List
  labelFunction : Function
Gets or sets the function to be used to obtain the label for the item.
List
 Inheritedlength : uint
[read-only] Gets the number of items in the data provider.
SelectableList
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 InheritedmaxHorizontalScrollPosition : Number
[override] Gets or sets the number of pixels that the list scrolls to the right when the horizontalScrollPolicy property is set to ScrollPolicy.ON.
SelectableList
 InheritedmaxVerticalScrollPosition : Number
[read-only] Gets the maximum vertical scroll position for the current content, in pixels.
BaseScrollPane
 InheritedmetaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the the instance of this DisplayObject in the SWF file through a PlaceObject4 tag.
DisplayObject
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Gets or sets a value that indicates whether the component can receive focus after the user clicks it.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
 InheritedneedsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.
InteractiveObject
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 Inheritedparent : DisplayObjectContainer
[read-only] Indicates the DisplayObjectContainer object that contains this display object.
DisplayObject
 Inheritedroot : 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
 Inheritedrotation : Number
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
DisplayObject
 InheritedrotationX : Number
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationY : Number
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
 InheritedrotationZ : Number
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
DisplayObject
  rowCount : uint
[override] Gets or sets the number of rows that are at least partially visible in the list.
List
  rowHeight : Number
Gets or sets the height of each row in the list, in pixels.
List
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 InheritedscaleX : Number
[override] Multiplies the current width of the component by a scale factor.
UIComponent
 InheritedscaleY : Number
[override] Multiplies the current height of the component by a scale factor.
UIComponent
 InheritedscaleZ : Number
Indicates the depth scale (percentage) of an object as applied from the registration point of the object.
DisplayObject
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 Inheritedselectable : Boolean
Gets or sets a Boolean value that indicates whether the items in the list can be selected.
SelectableList
 InheritedselectedIndex : int
Gets or sets the index of the item that is selected in a single-selection list.
SelectableList
 InheritedselectedIndices : Array
Gets or sets an array that contains the items that were selected from a multiple-selection list.
SelectableList
 InheritedselectedItem : Object
Gets or sets the item that was selected from a single-selection list.
SelectableList
 InheritedselectedItems : Array
Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.
SelectableList
 InheritedsoftKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).
InteractiveObject
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 InheriteduseBitmapScrolling : Boolean
When set to true, the cacheAsBitmap property for the scrolling content is set to true; when set to false this value is turned off.
BaseScrollPane
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 InheritedverticalLineScrollSize : Number
Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.
BaseScrollPane
 InheritedverticalPageScrollSize : Number
Gets or sets the count of pixels by which to move the scroll thumb on the vertical scroll bar when the scroll bar track is pressed.
BaseScrollPane
 InheritedverticalScrollBar : ScrollBar
[read-only] Gets a reference to the vertical scroll bar.
BaseScrollPane
 InheritedverticalScrollPolicy : String
Gets or sets a value that indicates the state of the vertical scroll bar.
BaseScrollPane
 InheritedverticalScrollPosition : Number
Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.
BaseScrollPane
 Inheritedvisible : Boolean
[override] Gets or sets a value that indicates whether the current component instance is visible.
UIComponent
 Inheritedwidth : Number
[override] Gets or sets the width of the component, in pixels.
UIComponent
 Inheritedx : Number
[override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.
UIComponent
 Inheritedy : Number
[override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.
UIComponent
 Inheritedz : Number
Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
DisplayObject
Public Methods
 MethodDefined By
  
Creates a new List component instance.
List
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Appends an item to the end of the list of items.
SelectableList
 Inherited
addItemAt(item:Object, index:uint):void
Inserts an item into the list at the specified index location.
SelectableList
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
clearRendererStyle(name:String, column:int = -1):void
Clears a style that is set on the renderers in the list.
SelectableList
 Inherited
Clears the currently selected item in the list and sets the selectedIndex property to -1.
SelectableList
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Dispatches an event into the event flow.
EventDispatcher
 Inherited
Shows or hides the focus indicator on this component.
UIComponent
 Inherited
Initiates an immediate draw operation, without invalidating everything as invalidateNow does.
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 Inherited
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 Inherited
Retrieves the object that currently has focus.
UIComponent
 Inherited
Retrieves the item at the specified index.
SelectableList
 Inherited
getNextIndexAtLetter(firstLetter:String, startIndex:int = -1):int
Returns the index of the next item in the dataProvider in which the label's first character matches a specified string character.
SelectableList
 Inherited
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 Inherited
getRendererStyle(name:String, column:int = -1):Object
Retrieves a style that is set on the renderers in the list.
SelectableList
 Inherited
Retrieves a style property that is set in the style lookup chain of the component.
UIComponent
  
[static] Retrieves the default style map for the current component.
List
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
invalidate(property:String, callLater:Boolean = true):void
Marks a property as invalid and redraws the component on the next frame unless otherwise specified.
UIComponent
 Inherited
Invalidates a specific item renderer.
SelectableList
 Inherited
Invalidates the renderer for the item at the specified index.
SelectableList
 Inherited
Invalidates the whole list, forcing the list items to be redrawn.
SelectableList
 Inherited
Checks whether the specified item is selected in the list.
SelectableList
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
Retrieves the ICellRenderer for a given item object, if there is one.
SelectableList
  
[override] Retrieves the string that the renderer displays for the given data object based on the labelField and labelFunction properties.
List
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
[static] Merges the styles from multiple classes into one object.
UIComponent
 Inherited
Moves the component to the specified position within its parent.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
 Inherited
Removes all items from the list.
SelectableList
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Removes the specified item from the list.
SelectableList
 Inherited
Removes the item at the specified index position.
SelectableList
 Inherited
Replaces the item at the specified index location with another item.
SelectableList
 Inherited
Raises a virtual keyboard.
InteractiveObject
  
scrollToIndex(newCaretIndex:int):void
[override] Scrolls the list to the item at the specified index.
List
 Inherited
Scrolls the list to the item at the location indicated by the current value of the selectedIndex property.
SelectableList
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 Inherited
Sets the focus to this component.
UIComponent
 Inherited
Sets the availability of a dynamic property for loop operations.
Object
 Inherited
setRendererStyle(name:String, style:Object, column:uint = 0):void
Sets a style on the renderers in the list.
SelectableList
 Inherited
setSize(width:Number, height:Number):void
Sets the component to the specified width and height.
UIComponent
 Inherited
setStyle(style:String, value:Object):void
Sets a style property on this component instance.
UIComponent
 Inherited
sortItems(... sortArgs):*
Sorts the elements of the current data provider.
SelectableList
 Inherited
sortItemsOn(field:String, options:Object = null):*
Sorts the elements of the current data provider by one or more of its fields.
SelectableList
 Inherited
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Recursively stops the timeline execution of all MovieClips rooted at this object.
DisplayObjectContainer
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
Returns the string representation of the specified object.
Object
 Inherited
Validates and updates the properties and layout of this object, redrawing it if necessary.
UIComponent
 Inherited
Returns the primitive value of the specified object.
Object
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
Protected Methods
 MethodDefined By
 Inherited
Returns the specified style for a component, considering all styles set on the global level, component level and instance level.
UIComponent
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 InheritedDispatched when a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when a different item is selected in the list.SelectableList
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 Inherited
    contextMenu
Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched after the component visibility changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 InheritedDispatched when the user clicks an item in the component.SelectableList
 InheritedDispatched when the user clicks an item in the component twice in rapid succession.SelectableList
 InheritedDispatched when the user rolls the pointer off of an item in the component.SelectableList
 InheritedDispatched when the user rolls the pointer over an item in the component.SelectableList
 InheritedDispatched when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 InheritedDispatched after the component is moved.UIComponent
 InheritedDispatched by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 InheritedDispatched when the user lowers an active stylus past the proximity detection threshold of the screen.InteractiveObject
 Inherited
    proximityEnd
Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.InteractiveObject
 Inherited
    proximityOut
Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen.InteractiveObject
 InheritedDispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen).InteractiveObject
 InheritedDispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance.InteractiveObject
 InheritedDispatched when a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched after the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user rolls the pointer off of the component.SelectableList
 InheritedDispatched when the user rolls the pointer over the component.SelectableList
 InheritedDispatched when the user scrolls horizontally or vertically.SelectableList
 InheritedDispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched after the component visibility changes from invisible to visible.UIComponent
 InheritedDispatched immediately after the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately before the soft keyboard is raised.InteractiveObject
 InheritedDispatched immediately after the soft keyboard is lowered.InteractiveObject
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
Styles

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The class that provides the cell renderer for each item in the component.
SelectableList
 InheritedType: Number Format: Length
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The padding that separates the border of the list from its contents, in pixels.
SelectableList
 InheritedType: Number
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The alpha value to set the list to when the enabled property is false.
SelectableList
 InheritedType: flash.text.TextFormat
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The TextFormat object to use to render the component label when the button is disabled.
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the down arrow button of the scroll bar when it is disabled.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the down arrow button of the scroll bar when you click the arrow button.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the down arrow button of the scroll bar when the mouse pointer is over the arrow button.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the down arrow button of the scroll bar.
BaseScrollPane
 InheritedType: Number Format: Length
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The padding that separates the outside boundaries of the component from the outside edges of the focus indicator, in pixels.
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin to be used to display focus indicators.
UIComponent
 InheritedType: Number Format: Time
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The number of milliseconds to wait after the buttonDown event is first dispatched before sending a second buttonDown event.
BaseScrollPane
 InheritedType: Number Format: Time
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The interval, in milliseconds, between buttonDown events that are dispatched after the delay that is specified by the repeatDelay style.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The class that provides the skin for the background of the component.
SelectableList
 InheritedType: flash.text.TextFormat
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The TextFormat object to use to render the component label.
UIComponent
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin that is used to indicate the disabled state of the thumb.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the thumb of the scroll bar when you click the thumb.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the icon for the thumb of the scroll bar.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the thumb of the scroll bar when the mouse pointer is over the thumb.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin used for the thumb of the scroll bar.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin that is used to indicate a disabled track.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin that is used to indicate the down state of a disabled skin.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin that is used to indicate the mouseover state for the scroll track.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

The skin used to indicate the mouse up state for the scroll track.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the up arrow button of the scroll bar when it is disabled.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the up arrow button of the scroll bar when you click the arrow button.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the up arrow button of the scroll bar when the mouse pointer is over the arrow button.
BaseScrollPane
 InheritedType: Class
Language Version: ActionScript 3.0  Product Version: Flash CS3  Runtime Versions: Flash9.0.28.0, AIR 1.0

Name of the class to use as the skin for the up arrow button of the scroll bar.
BaseScrollPane
Public Constants
 ConstantDefined By
 Inheritedversion : String = "3.0.3.1"
The version number of the components.
UIComponent
Property Detail

iconField

property
iconField:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the item field that provides the icon for the item.

Note: The iconField is not used if the iconFunction property is set to a callback function.

The default value is "icon".



Implementation
    public function get iconField():String
    public function set iconField(value:String):void

Example  ( How to use this example )
The following example creates a list with an icon for each item. A symbol named RedBox must exist in the library and have "Export for ActionScript" toggled in its symbol properties:
import fl.data.DataProvider;
import fl.controls.List;

var dp:DataProvider = new DataProvider();
dp.addItem( { iconSource:RedBox, label:"Item 1" } );
dp.addItem( { iconSource:RedBox, label:"Item 2" } );
dp.addItem( { iconSource:RedBox, label:"Item 3" } );

var list:List = new List();
list.iconField = "iconSource";
list.dataProvider = dp;
addChild(list);

iconFunction

property 
iconFunction:Function

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the function to be used to obtain the icon for the item.

Note: The iconField is not used if the iconFunction property is set to a callback function.

The default value is null.



Implementation
    public function get iconFunction():Function
    public function set iconFunction(value:Function):void

Example  ( How to use this example )
The following example uses the iconFunction property to provide an icon to a limited number of items in a list. A symbol named RedBox must exist in the library and have "Export for ActionScript" toggled in its symbol properties for this example to function correctly:
import fl.data.DataProvider;
import fl.controls.List;

var dp:DataProvider = new DataProvider();
dp.addItem( { label:"Item 1" } );
dp.addItem( { label:"Item 2" } );
dp.addItem( { label:"Item 3" } );

var list:List = new List();
list.iconFunction = determineIcon;
list.dataProvider = dp;
addChild(list);

function determineIcon(item:Object):String {
    if(item.label == "Item 2") {
        return "RedBox";
    }
    else {
        return null;
    }
}

labelField

property 
labelField:String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the name of the field in the dataProvider object to be displayed as the label for the TextInput field and drop-down list.

By default, the component displays the label property of each dataProvider item. If the dataProvider items do not contain a label property, you can set the labelField property to use a different property.

Note: The labelField property is not used if the labelFunction property is set to a callback function.

The default value is "label".



Implementation
    public function get labelField():String
    public function set labelField(value:String):void

Related API Elements


Example  ( How to use this example )
The following example displays each item in a list with the abbreviatedLabel property rather than the default label property:
import fl.data.DataProvider;
import fl.controls.List;

var dp:DataProvider = new DataProvider();
dp.addItem( { abbreviatedLabel:"NY", label:"New York" } );
dp.addItem( { abbreviatedLabel:"CA", label:"California" } );
dp.addItem( { abbreviatedLabel:"WA", label:"Washington" } );
dp.addItem( { abbreviatedLabel:"CT", label:"Connecticut" } );
dp.addItem( { abbreviatedLabel:"VT", label:"Vermont" } );

var list:List = new List();
list.setSize(40,100);
list.labelField = "abbreviatedLabel"
list.dataProvider = dp;
addChild(list);

labelFunction

property 
labelFunction:Function

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the function to be used to obtain the label for the item.

By default, the component displays the label property for a dataProvider item. But some data sets may not have a label field or may not have a field whose value can be used as a label without modification. For example, a given data set might store full names but maintain them in lastName and firstName fields. In such a case, this property could be used to set a callback function that concatenates the values of the lastName and firstName fields into a full name string to be displayed.

Note: The labelField property is not used if the labelFunction property is set to a callback function.

The default value is null.



Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void

Example  ( How to use this example )
This example sets the labelFunction property of a list to a function that formats the string to be displayed in each cell:
import fl.data.DataProvider;
import fl.controls.List;

var myDataProvider:DataProvider = new DataProvider();
myDataProvider.addItem({name:"User A", price:0.43});
myDataProvider.addItem({name:"User B", price:0.34});

var users:List = new List();
users.dataProvider = myDataProvider;
users.labelFunction = myLabelFunction;
addChild(users);

function myLabelFunction(item:Object):String {
    return  item.name + " ($" + item.price.toFixed(2) + ")";
}

rowCount

property 
rowCount:uint[override]

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the number of rows that are at least partially visible in the list.



Implementation
    override public function get rowCount():uint
    override public function set rowCount(value:uint):void

Example  ( How to use this example )
This example sets the size of a list and determines the number of potentially visible rows by tracing the rowCount property:

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
The following example sets the size of a List component using the rowCount based on the current value of a slider:

import fl.controls.Slider;
import fl.controls.List;
import fl.data.DataProvider;
import fl.events.SliderEvent;

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

var mySlider:Slider = new Slider();
mySlider.move(10, 10);
mySlider.tickInterval = 1;
mySlider.snapInterval = 1;
mySlider.minimum = 2;
mySlider.maximum = 9;
mySlider.liveDragging = true;
mySlider.addEventListener(SliderEvent.CHANGE, changeHandler);
addChild(mySlider);

var myList:List = new List();
myList.dataProvider = dp;
myList.move(mySlider.x, mySlider.y + 20);
myList.setSize(100, 50);
addChild(myList);

function changeHandler(event:SliderEvent):void {
    myList.rowCount = event.value;
}

rowHeight

property 
rowHeight:Number

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Gets or sets the height of each row in the list, in pixels.

The default value is 20.



Implementation
    public function get rowHeight():Number
    public function set rowHeight(value:Number):void
Constructor Detail

List

()Constructor
public function List()

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Creates a new List component instance.

Method Detail

getStyleDefinition

()method
public static function getStyleDefinition():Object

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Retrieves the default style map for the current component. The style map contains the type that is appropriate for the component, depending on the style that the component uses. For example, the disabledTextFormat style contains a value of null or a TextFormat object. You can use these styles and call setStyle() on the current component. The following code overrides the default disabledTextFormat style on the specified component:

componentInstance.setStyle("disabledTextFormat", new TextFormat());

Returns
Object — Default styles object.

Related API Elements


Example  ( How to use this example )

The following example creates a style browser for several component classes:
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;
}

itemToLabel

()method 
override public function itemToLabel(item:Object):String

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Retrieves the string that the renderer displays for the given data object based on the labelField and labelFunction properties.

Note: The labelField is not used if the labelFunction property is set to a callback function.

Parameters

item:Object — The object to be rendered.

Returns
String — The string to be displayed based on the data.

Example  ( How to use this example )

The following example demonstrates how to determine the label of a list item when the mouse hovers over it:
import fl.controls.List;
import fl.data.DataProvider;
import fl.events.ListEvent;

var myDataProvider:DataProvider = new DataProvider();
myDataProvider.addItem({label:"Carrot", price:0.43});
myDataProvider.addItem({label:"Tomato", price:0.34});
myDataProvider.addItem({label:"Blueberry", price:0.72});
myDataProvider.addItem({label:"Turnip", price:0.24});

var myList:List = new List();
myList.setSize(300,80);
myList.dataProvider = myDataProvider;
myList.labelFunction = myLabelFunction;
myList.addEventListener(ListEvent.ITEM_ROLL_OVER, announceLabel);
addChild(myList);

function myLabelFunction(item:Object):String {
    return item.label + " - Current price: ($" + item.price.toFixed(2) + ")";
}

function announceLabel(e:ListEvent):void {
    var list:List = e.target as List;
    var item:Object = e.item;
    trace("Label: " + item.label);
    trace("Label displayed: " + list.itemToLabel(item));
}

scrollToIndex

()method 
override public function scrollToIndex(newCaretIndex:int):void

Language Version: ActionScript 3.0
Product Version: Flash CS3
Runtime Versions: Flash Player 9.0.28.0, AIR 1.0

Scrolls the list to the item at the specified index. If the index is out of range, the scroll position does not change.

Parameters

newCaretIndex:int — The index location to scroll to.
ListExample.as

This example demonstrates how to create a List and populate other List instances with its selections.
  1. Add the List, Button, and Label classes to the library.
  2. Save this code as ListExample.as in the same directory as your FLA.
  3. Set the DocumentClass in the FLA to ListExample.
package
{
    import flash.display.Sprite
    
    public class ListExample extends Sprite
    {
        import flash.events.*;
        import fl.data.DataProvider;
        import fl.controls.List
        import fl.controls.Label
        import fl.controls.Button
        
        private var clearButton:Button;
        private var availableItems:List;
        private var selectedItemList:List;
        private var selectedItemsList:List;

        public function ListExample() {
            createComponents();
            setupComponents();
        }

        private function setupComponents():void {
            var dp:Array = new Array();
            var i:uint;
            var count:uint = availableItems.rowCount * 2;
            
            for (i = 0; i < count; i++) {
                dp.push({label:"Item " + i});
            }
            
            availableItems.allowMultipleSelection = true;
            availableItems.dataProvider = new DataProvider(dp);
            availableItems.addEventListener(Event.CHANGE, updateLists);
            clearButton.addEventListener(MouseEvent.CLICK, clearHandler);            
        }
        
        private function clearHandler(event:MouseEvent):void {
            availableItems.clearSelection();
            // clear data providers
            selectedItemList.dataProvider = new DataProvider();
            selectedItemsList.dataProvider = new DataProvider();
        }
        
        private function updateLists(e:Event):void {
            selectedItemList.dataProvider = availableItems.selectedItem ? new DataProvider([availableItems.selectedItem]) : new DataProvider();
            selectedItemsList.dataProvider = new DataProvider(availableItems.selectedItems);
        }

        private function createComponents():void {
            clearButton = new Button();
            availableItems = new List();
            selectedItemList = new List();
            selectedItemsList = new List();
            var availableItemsLabel:Label = new Label();
            var selectedItemListLabel:Label = new Label();
            var selectedItemsListLabel:Label = new Label();
            
            clearButton.move(10,142);
            availableItems.move(10,32);
            selectedItemList.move(120,32);
            selectedItemsList.move(230,32);
            availableItemsLabel.move(10,10);
            selectedItemListLabel.move(120,10);
            selectedItemsListLabel.move(230,10);
            
            clearButton.label = "Clear Selection"
            availableItemsLabel.text = "Available Items";
            selectedItemListLabel.text = "Selected Item";
            selectedItemsListLabel.text = "All Selected Items";
            
            addChild(clearButton);
            addChild(availableItems);
            addChild(selectedItemList);
            addChild(selectedItemsList);
            addChild(availableItemsLabel);
            addChild(selectedItemListLabel);
            addChild(selectedItemsListLabel);
        }
    }
}