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

Language Reference only
Filters: AIR 32.0 and earlier, Flash Player 32.0 and earlier, Flash Lite 4
Flex 4.6 and earlier, Flash Pro CS6 and earlier
Hide Filters
fl.controls 

SelectableList  - AS3 Flash

Packagesx

Top Level
adobe.utils
air.desktop
air.net
air.update
air.update.events
coldfusion.air
coldfusion.air.errors
coldfusion.air.events
coldfusion.service
coldfusion.service.events
coldfusion.service.mxml
com.adobe.acm.solutions.authoring.domain.extensions
com.adobe.acm.solutions.ccr.domain.extensions
com.adobe.consulting.pst.vo
com.adobe.dct.component
com.adobe.dct.component.datadictionary
com.adobe.dct.component.datadictionaryElement
com.adobe.dct.component.dataElementsPanel
com.adobe.dct.component.toolbars
com.adobe.dct.event
com.adobe.dct.exp
com.adobe.dct.model
com.adobe.dct.service
com.adobe.dct.service.provider
com.adobe.dct.transfer
com.adobe.dct.util
com.adobe.dct.view
com.adobe.ep.taskmanagement.domain
com.adobe.ep.taskmanagement.event
com.adobe.ep.taskmanagement.filter
com.adobe.ep.taskmanagement.services
com.adobe.ep.taskmanagement.util
com.adobe.ep.ux.attachmentlist.component
com.adobe.ep.ux.attachmentlist.domain
com.adobe.ep.ux.attachmentlist.domain.events
com.adobe.ep.ux.attachmentlist.domain.renderers
com.adobe.ep.ux.attachmentlist.skin
com.adobe.ep.ux.attachmentlist.skin.renderers
com.adobe.ep.ux.content.event
com.adobe.ep.ux.content.factory
com.adobe.ep.ux.content.handlers
com.adobe.ep.ux.content.managers
com.adobe.ep.ux.content.model.asset
com.adobe.ep.ux.content.model.preview
com.adobe.ep.ux.content.model.relation
com.adobe.ep.ux.content.model.search
com.adobe.ep.ux.content.model.toolbar
com.adobe.ep.ux.content.search
com.adobe.ep.ux.content.services
com.adobe.ep.ux.content.services.load
com.adobe.ep.ux.content.services.permissions
com.adobe.ep.ux.content.services.preview
com.adobe.ep.ux.content.services.providers
com.adobe.ep.ux.content.services.query
com.adobe.ep.ux.content.services.relationships
com.adobe.ep.ux.content.services.search.lccontent
com.adobe.ep.ux.content.services.version
com.adobe.ep.ux.content.view
com.adobe.ep.ux.content.view.components.activate
com.adobe.ep.ux.content.view.components.grid
com.adobe.ep.ux.content.view.components.grid.hover
com.adobe.ep.ux.content.view.components.grid.hover.component
com.adobe.ep.ux.content.view.components.grid.renderers
com.adobe.ep.ux.content.view.components.relationships
com.adobe.ep.ux.content.view.components.review
com.adobe.ep.ux.content.view.components.search.renderers
com.adobe.ep.ux.content.view.components.searchpod
com.adobe.ep.ux.content.view.components.toolbar
com.adobe.ep.ux.content.view.components.toolbar.controlRenderers
com.adobe.ep.ux.content.view.components.version
com.adobe.ep.ux.documentsubmit.component
com.adobe.ep.ux.documentsubmit.domain
com.adobe.ep.ux.documentsubmit.skin
com.adobe.ep.ux.taskaction.component
com.adobe.ep.ux.taskaction.domain
com.adobe.ep.ux.taskaction.domain.events
com.adobe.ep.ux.taskaction.skin
com.adobe.ep.ux.taskdetails.component
com.adobe.ep.ux.taskdetails.domain
com.adobe.ep.ux.taskdetails.skin
com.adobe.ep.ux.tasklist.component
com.adobe.ep.ux.tasklist.domain
com.adobe.ep.ux.tasklist.skin
com.adobe.ep.ux.webdocumentviewer.domain
com.adobe.exm.expression
com.adobe.exm.expression.error
com.adobe.exm.expression.event
com.adobe.exm.expression.impl
com.adobe.fiber.runtime.lib
com.adobe.fiber.services
com.adobe.fiber.services.wrapper
com.adobe.fiber.styles
com.adobe.fiber.util
com.adobe.fiber.valueobjects
com.adobe.gravity.binding
com.adobe.gravity.context
com.adobe.gravity.flex.bundleloader
com.adobe.gravity.flex.progress
com.adobe.gravity.flex.serviceloader
com.adobe.gravity.framework
com.adobe.gravity.init
com.adobe.gravity.service.bundleloader
com.adobe.gravity.service.logging
com.adobe.gravity.service.manifest
com.adobe.gravity.service.progress
com.adobe.gravity.tracker
com.adobe.gravity.ui
com.adobe.gravity.utility
com.adobe.gravity.utility.async
com.adobe.gravity.utility.error
com.adobe.gravity.utility.events
com.adobe.gravity.utility.factory
com.adobe.gravity.utility.flex.async
com.adobe.gravity.utility.logging
com.adobe.gravity.utility.message
com.adobe.gravity.utility.sequence
com.adobe.gravity.utility.url
com.adobe.guides.control
com.adobe.guides.domain
com.adobe.guides.i18n
com.adobe.guides.spark.components.skins
com.adobe.guides.spark.components.skins.mx
com.adobe.guides.spark.headers.components
com.adobe.guides.spark.headers.skins
com.adobe.guides.spark.layouts.components
com.adobe.guides.spark.layouts.skins
com.adobe.guides.spark.navigators.components
com.adobe.guides.spark.navigators.renderers
com.adobe.guides.spark.navigators.skins
com.adobe.guides.spark.util
com.adobe.guides.spark.wrappers.components
com.adobe.guides.spark.wrappers.skins
com.adobe.guides.submit
com.adobe.icc.dc.domain
com.adobe.icc.dc.domain.factory
com.adobe.icc.editors.events
com.adobe.icc.editors.handlers
com.adobe.icc.editors.managers
com.adobe.icc.editors.model
com.adobe.icc.editors.model.config
com.adobe.icc.editors.model.el
com.adobe.icc.editors.model.el.operands
com.adobe.icc.editors.model.el.operators
com.adobe.icc.enum
com.adobe.icc.external.dc
com.adobe.icc.obj
com.adobe.icc.services
com.adobe.icc.services.category
com.adobe.icc.services.config
com.adobe.icc.services.download
com.adobe.icc.services.export
com.adobe.icc.services.external
com.adobe.icc.services.formbridge
com.adobe.icc.services.fragmentlayout
com.adobe.icc.services.layout
com.adobe.icc.services.letter
com.adobe.icc.services.locator
com.adobe.icc.services.module
com.adobe.icc.services.render
com.adobe.icc.services.submit
com.adobe.icc.services.user
com.adobe.icc.token
com.adobe.icc.vo
com.adobe.icc.vo.render
com.adobe.icomm.assetplacement.controller
com.adobe.icomm.assetplacement.controller.utils
com.adobe.icomm.assetplacement.data
com.adobe.icomm.assetplacement.model
com.adobe.livecycle.assetmanager.client
com.adobe.livecycle.assetmanager.client.event
com.adobe.livecycle.assetmanager.client.handler
com.adobe.livecycle.assetmanager.client.managers
com.adobe.livecycle.assetmanager.client.model
com.adobe.livecycle.assetmanager.client.model.cms
com.adobe.livecycle.assetmanager.client.service
com.adobe.livecycle.assetmanager.client.service.search
com.adobe.livecycle.assetmanager.client.service.search.cms
com.adobe.livecycle.assetmanager.client.utils
com.adobe.livecycle.content
com.adobe.livecycle.rca.model
com.adobe.livecycle.rca.model.constant
com.adobe.livecycle.rca.model.document
com.adobe.livecycle.rca.model.participant
com.adobe.livecycle.rca.model.reminder
com.adobe.livecycle.rca.model.stage
com.adobe.livecycle.rca.service
com.adobe.livecycle.rca.service.core
com.adobe.livecycle.rca.service.core.delegate
com.adobe.livecycle.rca.service.process
com.adobe.livecycle.rca.service.process.delegate
com.adobe.livecycle.rca.token
com.adobe.livecycle.ria.security.api
com.adobe.livecycle.ria.security.service
com.adobe.mosaic.layouts
com.adobe.mosaic.layouts.dragAndDrop
com.adobe.mosaic.layouts.interfaces
com.adobe.mosaic.mxml
com.adobe.mosaic.om.constants
com.adobe.mosaic.om.events
com.adobe.mosaic.om.impl
com.adobe.mosaic.om.interfaces
com.adobe.mosaic.skinning
com.adobe.mosaic.sparklib.editors
com.adobe.mosaic.sparklib.optionMenu
com.adobe.mosaic.sparklib.scrollableMenu
com.adobe.mosaic.sparklib.scrollableMenu.skins
com.adobe.mosaic.sparklib.tabLayout
com.adobe.mosaic.sparklib.tabLayout.events
com.adobe.mosaic.sparklib.tabLayout.layouts
com.adobe.mosaic.sparklib.tabLayout.skins
com.adobe.mosaic.sparklib.text
com.adobe.mosaic.sparklib.util
com.adobe.solutions.acm.authoring.presentation
com.adobe.solutions.acm.authoring.presentation.actionbar
com.adobe.solutions.acm.authoring.presentation.common
com.adobe.solutions.acm.authoring.presentation.events
com.adobe.solutions.acm.authoring.presentation.fragment
com.adobe.solutions.acm.authoring.presentation.letter
com.adobe.solutions.acm.authoring.presentation.letter.data
com.adobe.solutions.acm.authoring.presentation.preview
com.adobe.solutions.acm.authoring.presentation.rte
com.adobe.solutions.acm.ccr.presentation
com.adobe.solutions.acm.ccr.presentation.contentcapture
com.adobe.solutions.acm.ccr.presentation.contentcapture.events
com.adobe.solutions.acm.ccr.presentation.contentcapture.preview
com.adobe.solutions.acm.ccr.presentation.datacapture
com.adobe.solutions.acm.ccr.presentation.datacapture.renderers
com.adobe.solutions.acm.ccr.presentation.pdf
com.adobe.solutions.exm
com.adobe.solutions.exm.authoring
com.adobe.solutions.exm.authoring.components.controls
com.adobe.solutions.exm.authoring.components.toolbars
com.adobe.solutions.exm.authoring.domain
com.adobe.solutions.exm.authoring.domain.expression
com.adobe.solutions.exm.authoring.domain.impl
com.adobe.solutions.exm.authoring.domain.method
com.adobe.solutions.exm.authoring.domain.variable
com.adobe.solutions.exm.authoring.enum
com.adobe.solutions.exm.authoring.events
com.adobe.solutions.exm.authoring.model
com.adobe.solutions.exm.authoring.renderer
com.adobe.solutions.exm.authoring.view
com.adobe.solutions.exm.expression
com.adobe.solutions.exm.impl
com.adobe.solutions.exm.impl.method
com.adobe.solutions.exm.method
com.adobe.solutions.exm.mock
com.adobe.solutions.exm.mock.method
com.adobe.solutions.exm.runtime
com.adobe.solutions.exm.runtime.impl
com.adobe.solutions.exm.variable
com.adobe.solutions.prm.constant
com.adobe.solutions.prm.domain
com.adobe.solutions.prm.domain.factory
com.adobe.solutions.prm.domain.impl
com.adobe.solutions.prm.domain.manager
com.adobe.solutions.prm.presentation.asset
com.adobe.solutions.prm.presentation.constant
com.adobe.solutions.prm.presentation.document
com.adobe.solutions.prm.presentation.event
com.adobe.solutions.prm.presentation.file
com.adobe.solutions.prm.presentation.project
com.adobe.solutions.prm.presentation.team
com.adobe.solutions.prm.presentation.util
com.adobe.solutions.prm.service
com.adobe.solutions.prm.services.impl
com.adobe.solutions.prm.vo
com.adobe.solutions.rca.constant
com.adobe.solutions.rca.domain
com.adobe.solutions.rca.domain.common
com.adobe.solutions.rca.domain.factory
com.adobe.solutions.rca.domain.impl
com.adobe.solutions.rca.domain.impl.manager
com.adobe.solutions.rca.domain.manager
com.adobe.solutions.rca.presentation
com.adobe.solutions.rca.presentation.comment
com.adobe.solutions.rca.presentation.constant
com.adobe.solutions.rca.presentation.event
com.adobe.solutions.rca.presentation.gantt
com.adobe.solutions.rca.presentation.gantt.ruler
com.adobe.solutions.rca.presentation.template
com.adobe.solutions.rca.presentation.template.audit
com.adobe.solutions.rca.presentation.template.definition
com.adobe.solutions.rca.presentation.template.documents
com.adobe.solutions.rca.presentation.template.stages
com.adobe.solutions.rca.presentation.util
com.adobe.solutions.rca.service
com.adobe.solutions.rca.services.impl
com.adobe.solutions.rca.vo
com.adobe.solutions.rca.vo.um
com.adobe.viewsource
fl.accessibility
fl.containers
fl.controls
fl.controls.dataGridClasses
fl.controls.listClasses
fl.controls.progressBarClasses
fl.core
fl.data
fl.display
fl.events
fl.ik
fl.lang
fl.livepreview
fl.managers
fl.motion
fl.motion.easing
fl.rsl
fl.text
fl.transitions
fl.transitions.easing
fl.video
flash.accessibility
flash.concurrent
flash.crypto
flash.data
flash.desktop
flash.display
flash.display3D
flash.display3D.textures
flash.errors
flash.events
flash.external
flash.filesystem
flash.filters
flash.geom
flash.globalization
flash.html
flash.media
flash.net
flash.net.dns
flash.net.drm
flash.notifications
flash.permissions
flash.printing
flash.profiler
flash.sampler
flash.security
flash.sensors
flash.system
flash.text
flash.text.engine
flash.text.ime
flash.ui
flash.utils
flash.xml
flashx.textLayout
flashx.textLayout.compose
flashx.textLayout.container
flashx.textLayout.conversion
flashx.textLayout.edit
flashx.textLayout.elements
flashx.textLayout.events
flashx.textLayout.factory
flashx.textLayout.formats
flashx.textLayout.operations
flashx.textLayout.utils
flashx.undo
ga.controls
ga.layouts
ga.model
ga.uiComponents
ga.util
ga.views
ga.wrappers
lc.foundation
lc.foundation.domain
lc.foundation.events
lc.foundation.ui
lc.foundation.util
lc.preloader
lc.procmgmt
lc.procmgmt.commands
lc.procmgmt.domain
lc.procmgmt.events
lc.procmgmt.formbridge
lc.procmgmt.impl
lc.procmgmt.ui.attachments
lc.procmgmt.ui.controls
lc.procmgmt.ui.controls.card
lc.procmgmt.ui.controls.renderer
lc.procmgmt.ui.help
lc.procmgmt.ui.layout
lc.procmgmt.ui.presentationmodel
lc.procmgmt.ui.process
lc.procmgmt.ui.search
lc.procmgmt.ui.startpoint
lc.procmgmt.ui.task
lc.procmgmt.ui.task.form
lc.procmgmt.ui.task.form.commands
lc.procmgmt.ui.tracking
mx.accessibility
mx.automation
mx.automation.air
mx.automation.delegates
mx.automation.delegates.advancedDataGrid
mx.automation.delegates.charts
mx.automation.delegates.containers
mx.automation.delegates.controls
mx.automation.delegates.controls.dataGridClasses
mx.automation.delegates.controls.fileSystemClasses
mx.automation.delegates.core
mx.automation.delegates.flashflexkit
mx.automation.events
mx.binding
mx.binding.utils
mx.charts
mx.charts.chartClasses
mx.charts.effects
mx.charts.effects.effectClasses
mx.charts.events
mx.charts.renderers
mx.charts.series
mx.charts.series.items
mx.charts.series.renderData
mx.charts.styles
mx.collections
mx.collections.errors
mx.containers
mx.containers.accordionClasses
mx.containers.dividedBoxClasses
mx.containers.errors
mx.containers.utilityClasses
mx.controls
mx.controls.advancedDataGridClasses
mx.controls.dataGridClasses
mx.controls.listClasses
mx.controls.menuClasses
mx.controls.olapDataGridClasses
mx.controls.scrollClasses
mx.controls.sliderClasses
mx.controls.textClasses
mx.controls.treeClasses
mx.controls.videoClasses
mx.core
mx.core.windowClasses
mx.data
mx.data.crypto
mx.data.errors
mx.data.events
mx.data.messages
mx.data.mxml
mx.data.offline.errors
mx.data.utils
mx.effects
mx.effects.easing
mx.effects.effectClasses
mx.events
mx.filters
mx.flash
mx.formatters
mx.geom
mx.graphics
mx.graphics.codec
mx.graphics.shaderClasses
mx.logging
mx.logging.errors
mx.logging.targets
mx.managers
mx.messaging
mx.messaging.channels
mx.messaging.config
mx.messaging.errors
mx.messaging.events
mx.messaging.management
mx.messaging.messages
mx.modules
mx.netmon
mx.olap
mx.olap.aggregators
mx.preloaders
mx.printing
mx.resources
mx.rpc
mx.rpc.events
mx.rpc.http
mx.rpc.http.mxml
mx.rpc.livecycle
mx.rpc.mxml
mx.rpc.remoting
mx.rpc.remoting.mxml
mx.rpc.soap
mx.rpc.soap.mxml
mx.rpc.wsdl
mx.rpc.xml
mx.skins
mx.skins.halo
mx.skins.spark
mx.skins.wireframe
mx.skins.wireframe.windowChrome
mx.states
mx.styles
mx.utils
mx.validators
org.osmf.containers
org.osmf.display
org.osmf.elements
org.osmf.events
org.osmf.layout
org.osmf.logging
org.osmf.media
org.osmf.metadata
org.osmf.net
org.osmf.net.dvr
org.osmf.net.httpstreaming
org.osmf.net.metrics
org.osmf.net.qos
org.osmf.net.rtmpstreaming
org.osmf.net.rules
org.osmf.traits
org.osmf.utils
spark.accessibility
spark.automation.delegates
spark.automation.delegates.components
spark.automation.delegates.components.gridClasses
spark.automation.delegates.components.mediaClasses
spark.automation.delegates.components.supportClasses
spark.automation.delegates.skins.spark
spark.automation.events
spark.collections
spark.components
spark.components.calendarClasses
spark.components.gridClasses
spark.components.mediaClasses
spark.components.supportClasses
spark.components.windowClasses
spark.core
spark.effects
spark.effects.animation
spark.effects.easing
spark.effects.interpolation
spark.effects.supportClasses
spark.events
spark.filters
spark.formatters
spark.formatters.supportClasses
spark.globalization
spark.globalization.supportClasses
spark.layouts
spark.layouts.supportClasses
spark.managers
spark.modules
spark.preloaders
spark.primitives
spark.primitives.supportClasses
spark.skins
spark.skins.mobile
spark.skins.mobile.supportClasses
spark.skins.spark
spark.skins.spark.mediaClasses.fullScreen
spark.skins.spark.mediaClasses.normal
spark.skins.spark.windowChrome
spark.skins.wireframe
spark.skins.wireframe.mediaClasses
spark.skins.wireframe.mediaClasses.fullScreen
spark.transitions
spark.utils
spark.validators
spark.validators.supportClasses
xd.core.axm.enterprise.view.components
xd.core.axm.enterprise.view.skins
xd.core.axm.view.components
xd.core.axm.view.components.support

Language Elements

Global Constants
Global Functions
Operators
Statements, Keywords & Directives
Special Types

Appendixes

What's New
Compiler Errors
Compiler Warnings
Run-Time Errors
Migrating to ActionScript 3
Supported Character Sets
MXML Only Tags
Motion XML Elements
Timed Text Tags
List of deprecated elements
Accessibility Implementation Constants
How to Use ActionScript Examples
Legal notices
Packagefl.controls
Classpublic class SelectableList
InheritanceSelectableList Inheritance BaseScrollPane Inheritance UIComponent Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object
Implements IFocusManagerComponent
Subclasses DataGrid, List, TileList

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

The SelectableList is the base class for all list-based components--for example, the List, TileList, DataGrid, and ComboBox components. This class provides methods and properties that are used for the rendering and layout of rows, and to set scroll bar styles and data providers.

Note: This class does not create a component; it is exposed only so that it can be extended.

Related API Elements



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
  allowMultipleSelection : 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
  dataProvider : 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
  length : 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
  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
 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
[read-only] Gets the number of rows that are at least partially visible in the list.
SelectableList
 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
  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
 Inherited    softKeyboard : String
Controls the appearance of the soft keyboard.
InteractiveObject
 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 SelectableList instance.
SelectableList
 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
  
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
 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
  
clearRendererStyle(name:String, column:int = -1):void
Clears a style that is set on the renderers in the list.
SelectableList
  
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
  
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
 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
  
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.
SelectableList
 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
  
Invalidates a specific item renderer.
SelectableList
  
Invalidates the renderer for the item at the specified index.
SelectableList
  
Invalidates the whole list, forcing the list items to be redrawn.
SelectableList
  
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
  
Retrieves the ICellRenderer for a given item object, if there is one.
SelectableList
  
Retrieves the string that the renderer displays for the given data object based on the label properties of the object.
SelectableList
 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
  
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
  
Removes the specified item from the list.
SelectableList
  
Removes the item at the specified index position.
SelectableList
  
Replaces the item at the specified index location with another item.
SelectableList
 Inherited
Raises a virtual keyboard.
InteractiveObject
  
scrollToIndex(newCaretIndex:int):void
Scrolls the list to the item at the specified index.
SelectableList
  
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
  
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
  
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
 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
  Dispatched 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 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
 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
  Dispatched when the user clicks an item in the component.SelectableList
  Dispatched when the user clicks an item in the component twice in rapid succession.SelectableList
  Dispatched when the user rolls the pointer off of an item in the component.SelectableList
  Dispatched 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
  Dispatched when the user rolls the pointer off of the component.SelectableList
  Dispatched when the user rolls the pointer over the component.SelectableList
  Dispatched 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
  
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. The default value is fl.contols.listClasses.CellRenderer.
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. The default value is null.
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. The default value is null.
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
  
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. The default value is List_skin.
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

allowMultipleSelection

property
allowMultipleSelection:Boolean

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

Gets a Boolean value that indicates whether more than one list item can be selected at a time. A value of true indicates that multiple selections can be made at one time; a value of false indicates that only one item can be selected at one time.

The default value is false.



Implementation
    public function get allowMultipleSelection():Boolean
    public function set allowMultipleSelection(value:Boolean):void

Related API Elements


Example  ( How to use this example )
The following example creates a new List instance and traces the selectedIndex and selectedIndices properties when the selected items in the list change:
import fl.controls.List;
import fl.data.DataProvider;

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

var dp:DataProvider = new DataProvider(items);

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

function changeHandler(event:Event):void {
    var lst:List = event.currentTarget as List;
    trace("change:");
    trace("\t" + "selectedIndex:", lst.selectedIndex);
    trace("\t" + "selectedIndices:", lst.selectedIndices);
    trace("\t" + "Number selected items:", lst.selectedIndices.length);
}

dataProvider

property 
dataProvider:DataProvider

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

Gets or sets the data model of the list of items to be viewed. A data provider can be shared by multiple list-based components. Changes to the data provider are immediately available to all components that use it as a data source.

The default value is null.



Implementation
    public function get dataProvider():DataProvider
    public function set dataProvider(value:DataProvider):void

length

property 
length:uint  [read-only]

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

Gets the number of items in the data provider.



Implementation
    public function get length():uint

Example  ( How to use this example )
The following example creates a List component instance and sets the rowCount property to the current number of items in the list:
import fl.controls.List;

var myList:List = new List();
myList.addItem({label:"Item A"});
myList.addItem({label:"Item B"});
myList.addItem({label:"Item C"});
myList.addItem({label:"Item D"});
myList.rowCount = myList.length;
myList.move(10, 10);
addChild(myList);

maxHorizontalScrollPosition

property 
maxHorizontalScrollPosition:Number[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 pixels that the list scrolls to the right when the horizontalScrollPolicy property is set to ScrollPolicy.ON.



Implementation
    override public function get maxHorizontalScrollPosition():Number
    override public function set maxHorizontalScrollPosition(value:Number):void

Related API Elements

rowCount

property 
rowCount:uint  [read-only]

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

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

Note: This property must be overridden in any class that extends SelectableList.

The default value is 0.



Implementation
    public function get rowCount():uint

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

selectable

property 
selectable:Boolean

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

Gets or sets a Boolean value that indicates whether the items in the list can be selected. A value of true indicates that the list items can be selected; a value of false indicates that they cannot be.

The default value is true.



Implementation
    public function get selectable():Boolean
    public function set selectable(value:Boolean):void

Related API Elements

selectedIndex

property 
selectedIndex:int

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

Gets or sets the index of the item that is selected in a single-selection list. A single-selection list is a list in which only one item can be selected at a time.

A value of -1 indicates that no item is selected; if multiple selections are made, this value is equal to the index of the item that was selected last in the group of selected items.

When ActionScript is used to set this property, the item at the specified index replaces the current selection. When the selection is changed programmatically, a change event object is not dispatched.



Implementation
    public function get selectedIndex():int
    public function set selectedIndex(value:int):void

Related API Elements


Example  ( How to use this example )
This example traces the label and row index of any item in a list that was clicked:
import fl.controls.List;
import fl.data.DataProvider;

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

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

function announceClickedItem(e:Event):void {
    trace("You have clicked: " + list.selectedItem.label + " in row " + list.selectedIndex);
}

selectedIndices

property 
selectedIndices:Array

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

Gets or sets an array that contains the items that were selected from a multiple-selection list.

To replace the current selection programmatically, you can make an explicit assignment to this property. You can clear the current selection by setting this property to an empty array or to a value of undefined. If no items are selected from the list of items, this property is undefined.

The sequence of values in the array reflects the order in which the items were selected from the multiple-selection list. For example, if you click the second item from the list, then the third item, and finally the first item, this property contains an array of values in the following sequence: [1,2,0].



Implementation
    public function get selectedIndices():Array
    public function set selectedIndices(value:Array):void

Related API Elements

selectedItem

property 
selectedItem:Object

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 that was selected from a single-selection list. For a multiple-selection list in which multiple items are selected, this property contains the item that was selected last.

If no selection is made, the value of this property is null.



Implementation
    public function get selectedItem():Object
    public function set selectedItem(value:Object):void

Related API Elements


Example  ( How to use this example )
This example traces the label and row index of any item in a list that was clicked:
import fl.controls.List;
import fl.data.DataProvider;

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

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

function announceClickedItem(e:Event):void {
    trace("You have clicked: " + list.selectedItem.label + " in row " + list.selectedIndex);
}

selectedItems

property 
selectedItems:Array

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

Gets or sets an array that contains the objects for the items that were selected from the multiple-selection list.

For a single-selection list, the value of this property is an array containing the one selected item. In a single-selection list, the allowMultipleSelection property is set to false.



Implementation
    public function get selectedItems():Array
    public function set selectedItems(value:Array):void

Related API Elements


Example  ( How to use this example )
The following example creates to List component instances and copies the selected items from list A to list B:
import fl.controls.List;
import fl.data.DataProvider;

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

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

function changeHandler(event:Event):void {
    if (listA.selectedItems.length > 0) {
        listB.dataProvider = new DataProvider(listA.selectedItems);
    }
}
Constructor Detail

SelectableList

()Constructor
public function SelectableList()

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

Creates a new SelectableList instance.

Method Detail

addItem

()method
public function addItem(item:Object):void

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

Appends an item to the end of the list of items.

An item should contain label and data properties; however, items that contain other properties can also be added to the list. By default, the label property of an item is used to display the label of the row; the data property is used to store the data of the row.

Parameters

item:Object — The item to be added to the data provider.

Related API Elements

addItemAt

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

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

Inserts an item into the list at the specified index location. The indices of items at or after the specified index location are incremented by 1.

Parameters

item:Object — The item to be added to the list.
 
index:uint — The index at which to add the item.


Throws
RangeError — The specified index is less than 0 or greater than or equal to the length of the data provider.

Related API Elements

clearRendererStyle

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

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

Clears a style that is set on the renderers in the list.

Parameters

name:String — The name of the style to be cleared.
 
column:int (default = -1)

Related API Elements

clearSelection

()method 
public function clearSelection():void

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

Clears the currently selected item in the list and sets the selectedIndex property to -1.


Example  ( How to use this example )

The following example creates a List component instance and clears the currently selected list items when a Button component is clicked:
import fl.controls.Button;
import fl.controls.List;
import fl.data.DataProvider;

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

var dp:DataProvider = new DataProvider(data);

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

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

function clickHandler(event:MouseEvent):void {
    trace("selectedIndex (before):", myList.selectedIndex);
    myList.clearSelection();
    trace("selectedIndex (after):", myList.selectedIndex);
}

getItemAt

()method 
public function getItemAt(index:uint):Object

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

Retrieves the item at the specified index.

Parameters

index:uint — The index of the item to be retrieved.

Returns
Object — The object at the specified index location.

Throws
RangeError — The specified index is less than 0 or greater than or equal to the length of the data provider.

getNextIndexAtLetter

()method 
public function getNextIndexAtLetter(firstLetter:String, startIndex:int = -1):int

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

Returns the index of the next item in the dataProvider in which the label's first character matches a specified string character. If the search reaches the end of the dataProvider without searching all the items, it will loop back to the start. The search does not include the startIndex.

Parameters

firstLetter:String — The string character to search for
 
startIndex:int (default = -1) — The index in the dataProvider to start at.

Returns
int — The index of the next item in the dataProvider.

getRendererStyle

()method 
public function getRendererStyle(name:String, column:int = -1):Object

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

Retrieves a style that is set on the renderers in the list.

Parameters

name:String — The name of the style to be retrieved.
 
column:int (default = -1) — The value of the style to be retrieved.

Returns
Object

Related API Elements

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

invalidateItem

()method 
public function invalidateItem(item:Object):void

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

Invalidates a specific item renderer.

Parameters

item:Object — The item in the data provider to invalidate.

Related API Elements

invalidateItemAt

()method 
public function invalidateItemAt(index:uint):void

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

Invalidates the renderer for the item at the specified index.

Parameters

index:uint — The index of the item in the data provider to invalidate.

Related API Elements

invalidateList

()method 
public function invalidateList():void

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

Invalidates the whole list, forcing the list items to be redrawn.

Related API Elements

isItemSelected

()method 
public function isItemSelected(item:Object):Boolean

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

Checks whether the specified item is selected in the list.

Parameters

item:Object — The item to check.

Returns
Boolean — This method returns true if the specified item is selected; otherwise, if the specified item has a value of null or is not included in the list, this method returns false.

itemToCellRenderer

()method 
public function itemToCellRenderer(item:Object):ICellRenderer

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

Retrieves the ICellRenderer for a given item object, if there is one. This method always returns null.

Parameters

item:Object — The item in the data provider.

Returns
ICellRenderer — A value of null.

Example  ( How to use this example )

The following example demonstrates how to acquire the cell renderer for an item that is selected within a list:
import fl.controls.List;
import fl.controls.listClasses.ListData;
import fl.controls.listClasses.CellRenderer;
import fl.events.ListEvent;

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

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

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

    trace("You have selected row: " + listData.row);
}

itemToLabel

()method 
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 label properties of the object. This method is intended to be overwritten in sub-components. For example, List has a labelField and a labelFunction to derive the label.

Parameters

item:Object

Returns
String

removeAll

()method 
public function removeAll():void

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

Removes all items from the list.

removeItem

()method 
public function removeItem(item:Object):Object

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

Removes the specified item from the list.

Parameters

item:Object — The item to be removed.

Returns
Object — The item that was removed.

Throws
RangeError — The item could not be found.

Related API Elements

removeItemAt

()method 
public function removeItemAt(index:uint):Object

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

Removes the item at the specified index position. The indices of items after the specified index location are decremented by 1.

Parameters

index:uint — The index of the item in the data provider to be removed.

Returns
Object — The item that was removed.

Related API Elements

replaceItemAt

()method 
public function replaceItemAt(item:Object, index:uint):Object

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

Replaces the item at the specified index location with another item. This method modifies the data provider of the List component. If the data provider is shared with other components, the data that is provided to those components is also updated.

Parameters

item:Object — The item to replace the item at the specified index location.
 
index:uint — The index position of the item to be replaced.

Returns
Object — The item that was replaced.

Throws
RangeError — The specified index is less than 0 or greater than or equal to the length of the data provider.

Related API Elements

scrollToIndex

()method 
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.

scrollToSelected

()method 
public function scrollToSelected():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 location indicated by the current value of the selectedIndex property.

Related API Elements

setRendererStyle

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

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

Sets a style on the renderers in the list.

Parameters

name:String — The name of the style to be set.
 
style:Object — The value of the style to be set.
 
column:uint (default = 0)

Related API Elements


Example  ( How to use this example )

The following example creates a List component and uses the setRendererStyle() method to apply a text format to the list items:
import fl.controls.List;

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

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

The following example creates a DataGrid component and uses the setRendererStyle() method to apply a text format to the list items:
import fl.controls.DataGrid;

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

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

The following example creates a TileList component and uses the setRendererStyle() method to apply a text format to the list items:
import fl.controls.TileList;

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

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

The following example creates a ComboBox component and uses the setRendererStyle() method to apply a text format to the list items:
import fl.controls.ComboBox;

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

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

sortItems

()method 
public function sortItems(... sortArgs):*

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

Sorts the elements of the current data provider. This method performs a sort based on the Unicode values of the elements. ASCII is a subset of Unicode.

Parameters

... sortArgs — The arguments against which to sort.

Returns
* — The return value depends on whether any parameters are passed to this method. For more information, see the Array.sort() method. Note that this method returns 0 when the sortArgs parameter is set to Array.UNIQUESORT.

Related API Elements

sortItemsOn

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

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

Sorts the elements of the current data provider by one or more of its fields.

Parameters

field:String — The field on which to sort.
 
options:Object (default = null) — Sort arguments that are used to override the default sort behavior. Separate two or more arguments with the bitwise OR (|) operator.

Returns
* — The return value depends on whether any parameters are passed to this method. For more information, see the Array.sortOn() method. Note that this method returns 0 when the sortOption parameter is set to Array.UNIQUESORT.

Related API Elements


Example  ( How to use this example )

The following example sorts a list based on a value in the data provider using the sortItemsOn() method:
import fl.controls.List;
import fl.data.DataProvider;

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

var dp:DataProvider = new DataProvider(players);

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

function myLabelFunction(item:Object):String {
    return item.name + " (" + Number(item.avg).toFixed(3) + ")";
}
Event Detail

change

Event
Event Object Type: flash.events.Event
property Event.type = flash.events.Event.CHANGE

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

Dispatched when a different item is selected in the list.

The Event.CHANGE constant defines the value of the type property of a change event object.

This event has the following properties:

PropertyValue
bubblestrue
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the Event object with an event listener.
targetThe object that has had its value modified. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.

itemClick

Event  
Event Object Type: fl.events.ListEvent
property ListEvent.type = fl.events.ListEvent.ITEM_CLICK

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

Dispatched when the user clicks an item in the component.

The click event is dispatched before the value of the component is changed. To identify the row and column that were clicked, use the properties of the event object; do not use the selectedIndex and selectedItem properties.

Defines the value of the type property of an itemClick event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

itemDoubleClick

Event  
Event Object Type: fl.events.ListEvent
property ListEvent.type = fl.events.ListEvent.ITEM_DOUBLE_CLICK

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

Dispatched when the user clicks an item in the component twice in rapid succession. Unlike the click event, the doubleClick event is dispatched after the selectedIndex of the component is changed.

Defines the value of the type property of an itemDoubleClick event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelabletrue
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

itemRollOut

Event  
Event Object Type: fl.events.ListEvent
property ListEvent.type = fl.events.ListEvent.ITEM_ROLL_OUT

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

Dispatched when the user rolls the pointer off of an item in the component.

Defines the value of the type property of an itemRollOut event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

Related API Elements

itemRollOver

Event  
Event Object Type: fl.events.ListEvent
property ListEvent.type = fl.events.ListEvent.ITEM_ROLL_OVER

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

Dispatched when the user rolls the pointer over an item in the component.

Defines the value of the type property of an itemRollOver event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
columnIndexThe zero-based index of the column that contains the renderer.
currentTargetThe object that is actively processing the event object with an event listener.
indexThe zero-based index in the DataProvider that contains the renderer.
itemA reference to the data that belongs to the renderer.
rowIndexThe zero-based index of the row that contains the renderer.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.

Related API Elements

rollOut

Event  
Event Object Type: flash.events.MouseEvent
property MouseEvent.type = flash.events.MouseEvent.ROLL_OUT

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

Dispatched when the user rolls the pointer off of the component.

Defines the value of the type property of a rollOut event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device now points.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.

Related API Elements

rollOver

Event  
Event Object Type: flash.events.MouseEvent
property MouseEvent.type = flash.events.MouseEvent.ROLL_OVER

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

Dispatched when the user rolls the pointer over the component.

Defines the value of the type property of a rollOver event object.

This event has the following properties:

PropertyValue
altKeytrue if the Alt key is active (Windows).
bubblesfalse
buttonDowntrue if the primary mouse button is pressed; false otherwise.
cancelablefalse; there is no default behavior to cancel.
commandKeytrue on the Mac if the Command key is active; false if it is inactive. Always false on Windows.
controlKeytrue if the Ctrl or Control key is active; false if it is inactive.
ctrlKeytrue on Windows or Linux if the Ctrl key is active. true on Mac if either the Ctrl key or the Command key is active. Otherwise, false.
currentTargetThe object that is actively processing the Event object with an event listener.
relatedObjectThe display list object to which the pointing device was pointing.
localXThe horizontal coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
localYThe vertical coordinate at which the event occurred relative to the containing sprite, if mouse locking is disabled.
movementXThe change in horizontal coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
movementYThe change in vertical coordinates of the mouse position since the last mouse event, if mouse locking is enabled.
shiftKeytrue if the Shift key is active; false if it is inactive.
stageXThe horizontal coordinate at which the event occurred in global stage coordinates.
stageYThe vertical coordinate at which the event occurred in global stage coordinates.
targetThe InteractiveObject instance under the pointing device. The target is not always the object in the display list that registered the event listener. Use the currentTarget property to access the object in the display list that is currently processing the event.

Related API Elements

scroll

Event  
Event Object Type: fl.events.ScrollEvent
property ScrollEvent.type = fl.events.ScrollEvent.SCROLL

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

Dispatched when the user scrolls horizontally or vertically.

Defines the value of the type property of a scroll event object.

This event has the following properties:

PropertyValue
bubblesfalse
cancelablefalse; there is no default behavior to cancel.
currentTargetThe object that is actively processing the event object with an event listener.
delta1; a value that indicates how much scrolling was done.
directionvertical; the direction of the ScrollBar.
position0; the position of the Scrollbar thumb after it was moved.
targetThe object that dispatched the event. The target is not always the object listening for the event. Use the currentTarget property to access the object that is listening for the event.