| Package | org.apache.flex.html |
| Class | public class List |
| Inheritance | List  ListBase UIBase HTMLElementWrapper flash.display.Sprite |
| Implements | IItemRendererProvider |
| Subclasses | ButtonBar, ChartBase, List, SimpleList, Tree |
| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
| Property | Defined By | ||
|---|---|---|---|
 | $height : Number [read-only]
Retrieve the low-level bounding box height. | UIBase | |
| $width : Number [read-only]
Retrieve the low-level bounding box width. | UIBase | |
| beads : Array
The array property that is used to add additional
beads to an MXML tag. | UIBase | |
| className : String
The classname. | UIBase | |
| dataProvider : Object
The data being display by the List. | List | ||
| element : IFlexJSElement [read-only]
Each IUIBase has an element that is actually added to
the platform's display list DOM. | UIBase | |
| explicitHeight : Number
The explicitly set width (as opposed to measured width
or percentage width). | UIBase | |
| explicitWidth : Number
The explicitly set width (as opposed to measured width
or percentage width). | UIBase | |
| hasItemRenderer : Boolean [read-only]
Returns whether or not the itemRenderer property has been set. | List | ||
| height : Number [override]
The height of the component. | UIBase | |
| id : String
An id property for MXML documents. | UIBase | |
| itemRenderer : IFactory
The class or factory used to display each item. | List | ||
| labelField : String
The name of field within the data used for display. | List | ||
| measurementBead : IMeasurementBead [read-only]
A measurement bead, if one exists. | UIBase | |
| model : Object
An IBeadModel that serves as the data model for the component. | UIBase | |
| numElements : int [read-only]
The number of elements in the parent. | UIBase | |
| percentHeight : Number
The requested percentage height this component
should have in the parent container. | UIBase | |
| percentWidth : Number
The requested percentage width this component
should have in the parent container. | UIBase | |
| presentationModel : IListPresentationModel [read-only]
The presentation model for the list. | List | ||
| rollOverIndex : int
The index of the item currently below the pointer. | List | ||
| rowHeight : Number
The default height of each cell in every column
| List | ||
| selectedIndex : int
The index of the currently selected item. | List | ||
| selectedItem : Object
The item currently selected. | List | ||
| style : Object
The object that contains
"styles" and other associated
name-value pairs. | UIBase | |
| topMostEventDispatcher : IEventDispatcher [read-only]
The top most event dispatcher. | UIBase | |
| typeNames : String
A list of type names. | UIBase | |
| view : IBeadView
An IBeadView that serves as the view for the component. | UIBase | |
| width : Number [override]
The width of the component. | UIBase | |
| Method | Defined By | ||
|---|---|---|---|
List()
constructor. | List | ||
| [override]
Add a bead to the strand. | UIBase | |
| addedToParent():void
The method called when added to a parent. | UIBase | |
| addElement(c:Object, dispatchEvent:Boolean = true):void
Add a component to the parent. | UIBase | |
| addElementAt(c:Object, index:int, dispatchEvent:Boolean = true):void
Add a component to the parent. | UIBase | |
| getBeadByType(classOrInterface:Class):IBead
Find a bead on the strand. | UIBase | |
| getElementAt(index:int):Object
Get a component from the parent. | UIBase | |
| getElementIndex(c:Object):int
Gets the index of this subcomponent. | UIBase | |
| isHeightSizedToContent():Boolean | UIBase | |
| isWidthSizedToContent():Boolean | UIBase | |
|
Remove a bead from the strand. | UIBase | |
| removeElement(c:Object, dispatchEvent:Boolean = true):void
Remove a component from the parent. | UIBase | |
| setHeight(value:Number, noEvent:Boolean = false):void | UIBase | |
| setWidth(value:Number, noEvent:Boolean = false):void | UIBase | |
| setWidthAndHeight(newWidth:Number, newHeight:Number, noEvent:Boolean = false):void | UIBase | |
| setX(value:Number):void | UIBase | |
| setY(value:Number):void | UIBase | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| The change event is dispatched whenever the list's selection changes. | List | |||
| Set a different class for click events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Indicates that the initialization of the list is complete. | List | |||
| Set a different class for mouseDown events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for mouseMove events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for mouseOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for mouseOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for mouseUp events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for rollOut events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| Set a different class for rollOver events so that there aren't dependencies on the flash classes on the JS side. | UIBase | ||
| dataProvider | property |
Hide Inherited Public Properties
Show Inherited Public PropertiesdataProvider:Object| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The data being display by the List.
public function get dataProvider():Object public function set dataProvider(value:Object):void| hasItemRenderer | property |
hasItemRenderer:Boolean [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
Returns whether or not the itemRenderer property has been set.
public function get hasItemRenderer():BooleanSee also
| itemRenderer | property |
itemRenderer:IFactory| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The class or factory used to display each item.
public function get itemRenderer():IFactory public function set itemRenderer(value:IFactory):void| labelField | property |
labelField:String| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The name of field within the data used for display. Each item of the data should have a property with this name.
public function get labelField():String public function set labelField(value:String):void| presentationModel | property |
presentationModel:IListPresentationModel [read-only] | Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The presentation model for the list.
public function get presentationModel():IListPresentationModel| rollOverIndex | property |
rollOverIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The index of the item currently below the pointer.
public function get rollOverIndex():int public function set rollOverIndex(value:int):void| rowHeight | property |
rowHeight:Number| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The default height of each cell in every column
public function get rowHeight():Number public function set rowHeight(value:Number):void| selectedIndex | property |
selectedIndex:int| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The index of the currently selected item. Changing this value also changes the selectedItem property.
public function get selectedIndex():int public function set selectedIndex(value:int):void| selectedItem | property |
selectedItem:Object| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The item currently selected. Changing this value also changes the selectedIndex property.
public function get selectedItem():Object public function set selectedItem(value:Object):void| List | () | Constructor |
public function List()| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
constructor.
| change | Event |
org.apache.flex.events.Event| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
The change event is dispatched whenever the list's selection changes.
| initComplete | Event |
org.apache.flex.events.Event| Language Version : | ActionScript 3.0 |
| Product Version : | FlexJS 0.0 |
| Runtime Versions : | Flash Player 10.2, AIR 2.6 |
Indicates that the initialization of the list is complete.