mx.controls
Class List
Direct Known Subclasses
           mx.controls.DataGrid, mx.controls.Tree

class List
extends mx.controls.listclasses.ScrollSelectList

The List control displays a vertical list of single-line items. Its functionality is very similar to that of the SELECT form element in HTML. It usually contains a vertical scroll bar, used to access all items in the list. An optional horizontal scroll bar lets users view items when the full width of the list items is unlikely to fit. The user can select one or more items from the list.

MXML Syntax

The <mx:List> tag inherits all the properties of its parent classes, and the following properties: 

 <mx:List
   alternatingRowColors="No default."
   rollOverColor="No default."
   selectionColor="No default."
   selectionEasing="No default."
   change="Event handler; no default."
   itemRollOver="Event handler; no default."
   itemRollOut="Event handler; no default."
   scroll="Event handler; no default." 
 />

See Also
mx.controls.listclasses.ScrollSelectList;


Methods

Methods inherited from class mx.controls.listclasses.ScrollSelectList
calculateWidths  setPropertiesAt 

Methods inherited from class mx.core.ScrollView
setScrollProperties  getViewMetrics  createChild 

Methods inherited from class mx.core.View
init  draw  createChild  getChildAt  getChildIndex  setChildIndex  destroyAllChildren  destroyChild  destroyChildAt  getViewMetrics 

Methods inherited from class mx.core.UIComponent
getFocus  setFocus  getFocusManager 

Methods inherited from class mx.core.UIObject
createAccessibilityImplementation  measure  doLater  cancelAllDoLaters  invalidate  invalidateStyle  invalidateProperties  invalidateSize  redraw  move  setSize  setSizeNoLayout  drawRect  fillRect  destroyLabel  createClassObject  createEmptyObject  destroyObject  getStyle  setMask  swapDepths 


Properties
staticversion:String  
ComponentVersion is for internal use only.
      dataProvider:Object  
Array of simple types or objects to populate the List control.

Properties inherited from class mx.controls.listclasses.ScrollSelectList
dragEnabled  dataProvider  addItemAt  addItem  removeItemAt  removeAll  replaceItemAt  sortItemsBy  sortItems  getLength  getItemAt  value  selectedIndex  selectedIndices  selectedItems  selectedItem  selectable  multipleSelection  dropIndicatorSkin  rowHeight  rowCount  cellRenderer  labelField  labelFunction  iconField  iconFunction 

Properties inherited from class mx.core.ScrollView
version  className  hScrollPolicy  vScrollPolicy  hPosition  vPosition  maxVPosition  maxHPosition 

Properties inherited from class mx.core.View
version  className  numChildren 

Properties inherited from class mx.core.UIComponent
version  enabled  tabIndex 

Properties inherited from class mx.core.UIObject
version  nestLevel  dispatchEvent  addEventListener  handleEvent  removeEventListener  kStretch  styleName  className  setStyle  parentApplication  isDocument  parentDocument  documentDescriptor  descriptor  instanceIndices  repeaterIndices  getRepeaterItem  id  width  height  x  y  minHeight  minWidth  preferredHeight  preferredWidth  maxHeight  maxWidth  widthFlex  heightFlex  visible  scaleX  scaleY  alpha  depth  mouseX  mouseY  toolTip  baselinePosition 


Effects

Effects inherited from class mx.core.UIComponent
showEffect  hideEffect  focusInEffect  focusOutEffect 

Effects inherited from class mx.core.UIObject
creationCompleteEffect  moveEffect  resizeEffect  mouseDownEffect  mouseOverEffect  mouseOutEffect  mouseUpEffect 


Events

Events inherited from class: mx.controls.listclasses.ScrollSelectList
change  itemRollOver  itemRollOut 

Events inherited from class: mx.core.ScrollView
scroll 

Events inherited from class: mx.core.View
childCreated  childIndexChanged  childDestroyed 

Events inherited from class: mx.core.UIComponent
focusIn  focusOut  keyDown  keyUp  show  hide  valid  invalid  valueCommitted 

Events inherited from class: mx.core.UIObject
initialize  creationComplete  resize  move  draw  load  unload  mouseDown  mouseUp  mouseMove  mouseOver  mouseOut  mouseDownSomewhere  mouseUpSomewhere  mouseMoveSomewhere  mouseChangeSomewhere  effectStart  effectEnd  dragBegin  dragComplete  dragEnter  dragOver  dragExit  dragDrop 


Styles
alternatingRowColors Type: Array   CSS Inheritance: yes
Colors for rows in an alternating pattern. Value can be an array of two of more colors.
rollOverColor Type: Number   Format: Color   CSS Inheritance: yes
Color of the background when the user rolls over the link. The default value is #0EFFD6.
selectionColor Type: Number   Format: Color   CSS Inheritance: yes
Color of the background when the user selects the link. The default value is #0DFFC1.
selectionEasing Type: String   CSS Inheritance: no
Reference to an easing equation (function) used for controlling programmating tweening.
textDisabledColor Type: Number   Format: Color   CSS Inheritance: yes
The default value is #0FFFFF.
textRollOverColor Type: Number   Format: Color   CSS Inheritance: yes
The default value is #02B333C.
textSelectedColor Type: Number   Format: Color   CSS Inheritance: yes
The default value is #005F33.

Styles inherited from class mx.core.UIComponent
backgroundColor  backgroundDisabledColor  backgroundImage  backgroundAlpha  backgroundSize  barColor  borderCapColor  borderColor  buttonColor  borderStyle  disabledColor  errorColor  highlightColor  lineHeight  modalTransparency  scrollTrackColor  shadowColor  shadowCapColor  symbolColor  symbolBackgroundColor  symbolBackgroundDisabledColor  symbolBackgroundPressedColor  symbolDisabledColor  themeColor 

Styles inherited from class mx.core.UIObject
color  fontFamily  fontSize  fontStyle  fontWeight  textAlign  textDecoration  textIndent  marginLeft  marginRight  horizontalGap  verticalGap 


Property Detail

dataProvider

dataProvider:Object  

Array of simple types or objects to populate the List control.

version

static version:String  

ComponentVersion is for internal use only.