List

Package	fl.controls
Class	public class List
Inheritance	List SelectableList BaseScrollPane UIComponent Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher 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

Hide Inherited Public Properties

Show Inherited Public Properties

	Property		Defined By
		accessibilityImplementation : AccessibilityImplementation The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.	InteractiveObject
		accessibilityProperties : AccessibilityProperties The current accessibility options for this display object.	DisplayObject
		allowMultipleSelection : Boolean Gets a Boolean value that indicates whether more than one list item can be selected at a time.	SelectableList
		alpha : Number Indicates the alpha transparency value of the object specified.	DisplayObject
		blendMode : String A value from the BlendMode class that specifies which blend mode to use.	DisplayObject
		blendShader : Shader [write-only] Sets a shader that is used for blending the foreground and background.	DisplayObject
		buttonMode : Boolean Specifies the button mode of this sprite.	Sprite
		cacheAsBitmap : Boolean If set to true, Flash runtimes cache an internal bitmap representation of the display object.	DisplayObject
		cacheAsBitmapMatrix : Matrix If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.	DisplayObject
		constructor : Object A reference to the class object or constructor function for a given object instance.	Object
		contextMenu : NativeMenu Specifies the context menu associated with this object.	InteractiveObject
		dataProvider : DataProvider Gets or sets the data model of the list of items to be viewed.	SelectableList
		doubleClickEnabled : Boolean Specifies whether the object receives doubleClick events.	InteractiveObject
		dropTarget : DisplayObject [read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.	Sprite
		enabled : Boolean Gets or sets a value that indicates whether the component can accept user interaction.	UIComponent
		filters : Array An indexed array that contains each filter object currently associated with the display object.	DisplayObject
		focusEnabled : Boolean Gets or sets a Boolean value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		focusManager : IFocusManager Gets or sets the FocusManager that controls focus for this component and its peers.	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 [override] Gets or sets the height of the component, in pixels.	UIComponent
		hitArea : Sprite Designates another sprite to serve as the hit area for a sprite.	Sprite
		horizontalLineScrollSize : Number Gets or sets a value that describes the amount of content to be scrolled, horizontally, when a scroll arrow is clicked.	BaseScrollPane
		horizontalPageScrollSize : 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
		horizontalScrollBar : ScrollBar [read-only] Gets a reference to the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPolicy : String Gets or sets a value that indicates the state of the horizontal scroll bar.	BaseScrollPane
		horizontalScrollPosition : 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
		length : uint [read-only] Gets the number of items in the data provider.	SelectableList
		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
		maxHorizontalScrollPosition : 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
		maxVerticalScrollPosition : Number [read-only] Gets the maximum vertical scroll position for the current content, in pixels.	BaseScrollPane
		metaData : 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
		mouseChildren : Boolean Determines whether or not the children of the object are mouse, or user input device, enabled.	DisplayObjectContainer
		mouseEnabled : Boolean Specifies whether this object receives mouse, or other user input, messages.	InteractiveObject
		mouseFocusEnabled : Boolean Gets or sets a value that indicates whether the component can receive focus after the user clicks it.	UIComponent
		mouseX : Number [read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.	DisplayObject
		mouseY : Number [read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.	DisplayObject
		name : String Indicates the instance name of the DisplayObject.	DisplayObject
		needsSoftKeyboard : Boolean Specifies whether a virtual keyboard (an on-screen, software keyboard) should display when this InteractiveObject instance receives focus.	InteractiveObject
		numChildren : int [read-only] Returns the number of children of this object.	DisplayObjectContainer
		opaqueBackground : Object Specifies whether the display object is opaque with a certain background color.	DisplayObject
		parent : DisplayObjectContainer [read-only] Indicates the DisplayObjectContainer object that contains this display object.	DisplayObject
		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
		rotationX : Number Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationY : Number Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.	DisplayObject
		rotationZ : 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
		scale9Grid : Rectangle The current scaling grid that is in effect.	DisplayObject
		scaleX : Number [override] Multiplies the current width of the component by a scale factor.	UIComponent
		scaleY : Number [override] Multiplies the current height of the component by a scale factor.	UIComponent
		scaleZ : Number Indicates the depth scale (percentage) of an object as applied from the registration point of the object.	DisplayObject
		scrollRect : Rectangle The scroll rectangle bounds of the display object.	DisplayObject
		selectable : Boolean Gets or sets a Boolean value that indicates whether the items in the list can be selected.	SelectableList
		selectedIndex : int Gets or sets the index of the item that is selected in a single-selection list.	SelectableList
		selectedIndices : Array Gets or sets an array that contains the items that were selected from a multiple-selection list.	SelectableList
		selectedItem : Object Gets or sets the item that was selected from a single-selection list.	SelectableList
		selectedItems : Array Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.	SelectableList
		softKeyboard : String Controls the appearance of the soft keyboard.	InteractiveObject
		softKeyboardInputAreaOfInterest : Rectangle Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS).	InteractiveObject
		soundTransform : flash.media:SoundTransform Controls sound within this sprite.	Sprite
		stage : Stage [read-only] The Stage of the display object.	DisplayObject
		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 : flash.text:TextSnapshot [read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.	DisplayObjectContainer
		transform : flash.geom:Transform An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.	DisplayObject
		useBitmapScrolling : 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
		useHandCursor : 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
		verticalLineScrollSize : Number Gets or sets a value that describes how many pixels to scroll vertically when a scroll arrow is clicked.	BaseScrollPane
		verticalPageScrollSize : 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
		verticalScrollBar : ScrollBar [read-only] Gets a reference to the vertical scroll bar.	BaseScrollPane
		verticalScrollPolicy : String Gets or sets a value that indicates the state of the vertical scroll bar.	BaseScrollPane
		verticalScrollPosition : Number Gets or sets a value that describes the vertical position of the vertical scroll bar in the scroll pane, in pixels.	BaseScrollPane
		visible : Boolean [override] Gets or sets a value that indicates whether the current component instance is visible.	UIComponent
		width : Number [override] Gets or sets the width of the component, in pixels.	UIComponent
		x : Number [override] Gets or sets the x coordinate that represents the position of the component along the x axis within its parent container.	UIComponent
		y : Number [override] Gets or sets the y coordinate that represents the position of the component along the y axis within its parent container.	UIComponent
		z : Number Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.	DisplayObject

Public Methods

Hide Inherited Public Methods

Show Inherited Public Methods

	Method		Defined By
		List() Creates a new List component instance.	List
		addChild(child:DisplayObject):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		addChildAt(child:DisplayObject, index:int):DisplayObject Adds a child DisplayObject instance to this DisplayObjectContainer instance.	DisplayObjectContainer
		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
		addItem(item:Object):void Appends an item to the end of the list of items.	SelectableList
		addItemAt(item:Object, index:uint):void Inserts an item into the list at the specified index location.	SelectableList
		areInaccessibleObjectsUnderPoint(point:Point):Boolean 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
		clearRendererStyle(name:String, column:int = -1):void Clears a style that is set on the renderers in the list.	SelectableList
		clearSelection():void Clears the currently selected item in the list and sets the selectedIndex property to -1.	SelectableList
		clearStyle(style:String):void Deletes a style property from this component instance.	UIComponent
		contains(child:DisplayObject):Boolean Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.	DisplayObjectContainer
		dispatchEvent(event:Event):Boolean Dispatches an event into the event flow.	EventDispatcher
		drawFocus(focused:Boolean):void Shows or hides the focus indicator on this component.	UIComponent
		drawNow():void Initiates an immediate draw operation, without invalidating everything as invalidateNow does.	UIComponent
		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
		getChildAt(index:int):DisplayObject Returns the child display object instance that exists at the specified index.	DisplayObjectContainer
		getChildByName(name:String):DisplayObject Returns the child display object that exists with the specified name.	DisplayObjectContainer
		getChildIndex(child:DisplayObject):int Returns the index position of a child DisplayObject instance.	DisplayObjectContainer
		getFocus():InteractiveObject Retrieves the object that currently has focus.	UIComponent
		getItemAt(index:uint):Object Retrieves the item at the specified index.	SelectableList
		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
		getObjectsUnderPoint(point:Point):Array Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.	DisplayObjectContainer
		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
		getRendererStyle(name:String, column:int = -1):Object Retrieves a style that is set on the renderers in the list.	SelectableList
		getStyle(style:String):Object Retrieves a style property that is set in the style lookup chain of the component.	UIComponent
		getStyleDefinition():Object [static] Retrieves the default style map for the current component.	List
		globalToLocal(point:Point):Point Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.	DisplayObject
		globalToLocal3D(point:Point):Vector3D Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.	DisplayObject
		hasEventListener(type:String):Boolean Checks whether the EventDispatcher object has any listeners registered for a specific type of event.	EventDispatcher
		hasOwnProperty(name:String):Boolean Indicates whether an object has a specified property defined.	Object
		hitTestObject(obj:DisplayObject):Boolean 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
		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
		invalidate(property:String, callLater:Boolean = true):void Marks a property as invalid and redraws the component on the next frame unless otherwise specified.	UIComponent
		invalidateItem(item:Object):void Invalidates a specific item renderer.	SelectableList
		invalidateItemAt(index:uint):void Invalidates the renderer for the item at the specified index.	SelectableList
		invalidateList():void Invalidates the whole list, forcing the list items to be redrawn.	SelectableList
		isItemSelected(item:Object):Boolean Checks whether the specified item is selected in the list.	SelectableList
		isPrototypeOf(theClass:Object):Boolean Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.	Object
		itemToCellRenderer(item:Object):ICellRenderer Retrieves the ICellRenderer for a given item object, if there is one.	SelectableList
		itemToLabel(item:Object):String [override] Retrieves the string that the renderer displays for the given data object based on the labelField and labelFunction properties.	List
		local3DToGlobal(point3d:Vector3D):Point 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
		localToGlobal(point:Point):Point Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.	DisplayObject
		mergeStyles(... list):Object [static] Merges the styles from multiple classes into one object.	UIComponent
		move(x:Number, y:Number):void Moves the component to the specified position within its parent.	UIComponent
		propertyIsEnumerable(name:String):Boolean Indicates whether the specified property exists and is enumerable.	Object
		removeAll():void Removes all items from the list.	SelectableList
		removeChild(child:DisplayObject):DisplayObject Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeChildAt(index:int):DisplayObject Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.	DisplayObjectContainer
		removeChildren(beginIndex:int = 0, endIndex:int = 0x7fffffff):void Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance.	DisplayObjectContainer
		removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void Removes a listener from the EventDispatcher object.	EventDispatcher
		removeItem(item:Object):Object Removes the specified item from the list.	SelectableList
		removeItemAt(index:uint):Object Removes the item at the specified index position.	SelectableList
		replaceItemAt(item:Object, index:uint):Object Replaces the item at the specified index location with another item.	SelectableList
		requestSoftKeyboard():Boolean Raises a virtual keyboard.	InteractiveObject
		scrollToIndex(newCaretIndex:int):void [override] Scrolls the list to the item at the specified index.	List
		scrollToSelected():void Scrolls the list to the item at the location indicated by the current value of the selectedIndex property.	SelectableList
		setChildIndex(child:DisplayObject, index:int):void Changes the position of an existing child in the display object container.	DisplayObjectContainer
		setFocus():void Sets the focus to this component.	UIComponent
		setPropertyIsEnumerable(name:String, isEnum:Boolean = true):void Sets the availability of a dynamic property for loop operations.	Object
		setRendererStyle(name:String, style:Object, column:uint = 0):void Sets a style on the renderers in the list.	SelectableList
		setSize(width:Number, height:Number):void Sets the component to the specified width and height.	UIComponent
		setStyle(style:String, value:Object):void Sets a style property on this component instance.	UIComponent
		sortItems(... sortArgs):* Sorts the elements of the current data provider.	SelectableList
		sortItemsOn(field:String, options:Object = null):* Sorts the elements of the current data provider by one or more of its fields.	SelectableList
		startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite.	Sprite
		startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void Lets the user drag the specified sprite on a touch-enabled device.	Sprite
		stopAllMovieClips():void Recursively stops the timeline execution of all MovieClips rooted at this object.	DisplayObjectContainer
		stopDrag():void Ends the startDrag() method.	Sprite
		stopTouchDrag(touchPointID:int):void Ends the startTouchDrag() method, for use with touch-enabled devices.	Sprite
		swapChildren(child1:DisplayObject, child2:DisplayObject):void Swaps the z-order (front-to-back order) of the two specified child objects.	DisplayObjectContainer
		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
		toLocaleString():String Returns the string representation of this object, formatted according to locale-specific conventions.	Object
		toString():String Returns the string representation of the specified object.	Object
		validateNow():void Validates and updates the properties and layout of this object, redrawing it if necessary.	UIComponent
		valueOf():Object Returns the primitive value of the specified object.	Object
		willTrigger(type:String):Boolean Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.	EventDispatcher

Protected Methods

Hide Inherited Protected Methods

Show Inherited Protected Methods

	Method		Defined By
		getStyleValue(name:String):Object Returns the specified style for a component, considering all styles set on the global level, component level and instance level.	UIComponent

Events

Click for more information on events

Hide Inherited Events

Show Inherited Events

	Summary	Defined By
activate	[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.	EventDispatcher
added	Dispatched when a display object is added to the display list.	DisplayObject
addedToStage	Dispatched 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
change	Dispatched when a different item is selected in the list.	SelectableList
clear	Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu.	InteractiveObject
click	Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.	InteractiveObject
contextMenu	Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.	InteractiveObject
copy	Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.	InteractiveObject
cut	Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.	InteractiveObject
deactivate	[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.	EventDispatcher
doubleClick	Dispatched 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
enterFrame	[broadcast event] Dispatched when the playhead is entering a new frame.	DisplayObject
exitFrame	[broadcast event] Dispatched when the playhead is exiting the current frame.	DisplayObject
focusIn	Dispatched after a display object gains focus.	InteractiveObject
focusOut	Dispatched after a display object loses focus.	InteractiveObject
frameConstructed	[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.	DisplayObject
gestureDirectionalTap	Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well.	InteractiveObject
gestureLongPress	Dispatched 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
gesturePan	Dispatched 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
gestureRotate	Dispatched 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
gestureSwipe	Dispatched 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
gestureTap	Dispatched 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
gestureZoom	Dispatched 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
hide	Dispatched after the component visibility changes from visible to invisible.	UIComponent
imeStartComposition	This event is dispatched to any client app that supports inline input with an IME	InteractiveObject
itemClick	Dispatched when the user clicks an item in the component.	SelectableList
itemDoubleClick	Dispatched when the user clicks an item in the component twice in rapid succession.	SelectableList
itemRollOut	Dispatched when the user rolls the pointer off of an item in the component.	SelectableList
itemRollOver	Dispatched when the user rolls the pointer over an item in the component.	SelectableList
keyDown	Dispatched when the user presses a key.	InteractiveObject
keyFocusChange	Dispatched when the user attempts to change focus by using keyboard navigation.	InteractiveObject
keyUp	Dispatched when the user releases a key.	InteractiveObject
middleClick	Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.	InteractiveObject
middleMouseDown	Dispatched when a user presses the middle pointing device button over an InteractiveObject instance.	InteractiveObject
middleMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseFocusChange	Dispatched when the user attempts to change focus by using a pointer device.	InteractiveObject
mouseMove	Dispatched when a user moves the pointing device while it is over an InteractiveObject.	InteractiveObject
mouseOut	Dispatched when the user moves a pointing device away from an InteractiveObject instance.	InteractiveObject
mouseOver	Dispatched when the user moves a pointing device over an InteractiveObject instance.	InteractiveObject
mouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
mouseWheel	Dispatched when a mouse wheel is spun over an InteractiveObject instance.	InteractiveObject
move	Dispatched after the component is moved.	UIComponent
nativeDragComplete	Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture.	InteractiveObject
nativeDragDrop	Dispatched 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
nativeDragEnter	Dispatched by an InteractiveObject when a drag gesture enters its boundary.	InteractiveObject
nativeDragExit	Dispatched by an InteractiveObject when a drag gesture leaves its boundary.	InteractiveObject
nativeDragOver	Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary.	InteractiveObject
nativeDragStart	Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
nativeDragUpdate	Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.	InteractiveObject
paste	Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.	InteractiveObject
proximityBegin	Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen.	InteractiveObject
proximityEnd	Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen.	InteractiveObject
proximityMove	Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold.	InteractiveObject
proximityOut	Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityOver	Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen.	InteractiveObject
proximityRollOut	Dispatched 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
proximityRollOver	Dispatched 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
releaseOutside	Dispatched 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
removed	Dispatched when a display object is about to be removed from the display list.	DisplayObject
removedFromStage	Dispatched 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
render	[broadcast event] Dispatched when the display list is about to be updated and rendered.	DisplayObject
resize	Dispatched after the component is resized.	UIComponent
rightClick	Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.	InteractiveObject
rightMouseDown	Dispatched when a user presses the pointing device button over an InteractiveObject instance.	InteractiveObject
rightMouseUp	Dispatched when a user releases the pointing device button over an InteractiveObject instance.	InteractiveObject
rollOut	Dispatched when the user rolls the pointer off of the component.	SelectableList
rollOver	Dispatched when the user rolls the pointer over the component.	SelectableList
scroll	Dispatched when the user scrolls horizontally or vertically.	SelectableList
selectAll	Dispatched 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
show	Dispatched after the component visibility changes from invisible to visible.	UIComponent
softKeyboardActivate	Dispatched immediately after the soft keyboard is raised.	InteractiveObject
softKeyboardActivating	Dispatched immediately before the soft keyboard is raised.	InteractiveObject
softKeyboardDeactivate	Dispatched immediately after the soft keyboard is lowered.	InteractiveObject
tabChildrenChange	Dispatched when the value of the object's tabChildren flag changes.	InteractiveObject
tabEnabledChange	Dispatched when the object's tabEnabled flag changes.	InteractiveObject
tabIndexChange	Dispatched when the value of the object's tabIndex property changes.	InteractiveObject
textInput	Dispatched when a user enters one or more characters of text.	InteractiveObject
touchBegin	Dispatched 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
touchEnd	Dispatched 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
touchMove	Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed.	InteractiveObject
touchOut	Dispatched 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
touchOver	Dispatched 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
touchRollOut	Dispatched 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
touchRollOver	Dispatched 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
touchTap	Dispatched 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

Click for more information on styles

Hide Inherited Styles

Show Inherited Styles

	Description	Defined By
cellRenderer	Type: 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
contentPadding	Type: 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
disabledAlpha	Type: 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
disabledTextFormat	Type: 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
downArrowDisabledSkin	Type: 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
downArrowDownSkin	Type: 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
downArrowOverSkin	Type: 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
downArrowUpSkin	Type: 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
focusRectPadding	Type: 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
focusRectSkin	Type: 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
repeatDelay	Type: 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
repeatInterval	Type: 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
skin	Type: 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
textFormat	Type: 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
thumbDisabledSkin	Type: 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
thumbDownSkin	Type: 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
thumbIcon	Type: 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
thumbOverSkin	Type: 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
thumbUpSkin	Type: 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
trackDisabledSkin	Type: 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
trackDownSkin	Type: 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
trackOverSkin	Type: 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
trackUpSkin	Type: 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
upArrowDisabledSkin	Type: 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
upArrowDownSkin	Type: 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
upArrowOverSkin	Type: 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
upArrowUpSkin	Type: 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

Hide Inherited Public Constants

Show Inherited Public Constants

	Constant		Defined By
		version : 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:

Copy

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:

Copy

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

labelFunction

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:

Copy

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:

Copy

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:

Copy


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:

Copy


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

()

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:

Copy

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

Returns

Object — Default styles object.

Related API Elements

fl.core.UIComponent.getStyle()
fl.core.UIComponent.setStyle()
fl.managers.StyleManager

Example ( How to use this example )

The following example creates a style browser for several component classes:

Copy

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:

Copy

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.

Examples How to use this example

ListExample.as

This example demonstrates how to create a List and populate other List instances with its selections.

Add the List, Button, and Label classes to the library.
Save this code as ListExample.as in the same directory as your FLA.
Set the DocumentClass in the FLA to ListExample.

Copy

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);
        }
    }
}

[an error occurred while processing this directive]

Legal Notices | Online Privacy Policy

List - AS3 Flash

Classes x

iconField

iconFunction

labelField

labelFunction

rowCount

rowHeight

List

getStyleDefinition

itemToLabel

scrollToIndex