A copy of the value normally stored in the collection property used while running data changes effects. This value should be null when a data change effect is not running.

A copy of the value normally stored in the iterator property used while running data changes effects.

A flag that indicates whether drag-selection is enabled. Drag-selection is the ability to select an item by dragging into it as opposed to normal selection where you can't have the mouse button down when you mouse over the item you want to select. This feature is used in ComboBox dropdowns to support pressing the mouse button when the mouse is over the dropdown button, and then dragging the mouse into the dropdown to select an item.

The default value is false.

A flag that indicates whether you can allow more than one item to be selected at the same time. If true, users can select multiple items. There is no option to disallow discontiguous selection. Standard complex selection options are always in effect (shift-click, control-click).

The default value is false.

A bookmark to the item that is the anchor. A bookmark allows the component to quickly seek to a position in the collection of items. This property is used when selecting a set of items between the anchor and the caret or highlighted item, and when finding the selected item after a Sort or Filter is applied.

The offset of the item in the data provider that is the selection anchor point.

See also

The effect that plays when changes occur in the data provider for the control. Set the effect by setting the dataChangeEffect style.

A bookmark to the item under the caret. A bookmark allows the component to quickly seek to a position in the collection of items.

The offset of the item in the data provider that is at the selection caret point.

See also

The DisplayObject that contains the graphics that indicate which renderer is the caret.

The renderer for the item under the caret. In the selection model, there is an anchor, a caret and a highlighted item. When the mouse is being used for selection, the item under the mouse is highlighted as the mouse rolls over the item. When the mouse is clicked with no modifier keys (Shift or Control), the set of selected items is cleared and the item under the highlight is selected and becomes the anchor. The caret is unused in mouse selection.

If there is an anchor and another item is selected while using the Shift key, the old set of selected items is cleared, and all items between the item and the anchor are selected. Clicking items while using the Control key toggles the selection of individual items and does not move the anchor.

When selecting items using the keyboard, if the arrow keys are used with no modifier keys, the old selection is cleared and the new item is selected and becomes the anchor and the caret, and a caret indicator is shown around the selection highlight.

If the user uses arrow keys with the Shift key, the old selection is cleared and the items between the anchor and the new item are selected. The caret moves to the new item.

If arrow keys are used with the Control key, just the caret moves. The user can use the Space key to toggle selection of the item under the caret.

The UID of the item under the caret.

An ICollectionView that represents the data provider. When you set the dataProvider property, Flex wraps the data provider as necessary to support the ICollectionView interface and sets this property to the result. The AdvancedListBase class then uses this property to access data in the provider. When you get the dataProvider property, Flex returns this value.

The number of columns to be displayed in a TileList control or items in a HorizontalList control. For the data grids, specifies the number of visible columns.

Note: Setting this property has no effect on a DataGrid control, which bases the number of columns on the control width and the individual column widths.

The default value is 4.

The width of the control's columns. This property is used by TileList and HorizontalList controls; It has no effect on data grid controls, where you set the individual column widths.

The default value is 50.

The item in the data provider this component should render when this component is used as an item renderer or item editor. The list class sets this property on each renderer or editor and the component displays the data. ListBase-derived classes support this property for complex situations like having a List of DataGrids or a DataGrid where one column is a List.

The list classes use the listData property in addition to the data property to determine what to display. If the list class is in a DataGrid it expects the dataField property of the column to map to a property in the data and sets selectedItem value to that property. If it is in a List or TileList control, it expects the labelField property of the list to map to a property in the data, and sets selectedItem value to that property. Otherwise it sets the selectedItem to the data itself.

This property uses the data provider but does not set it. In all cases, you must set the data provider in some other way.

You do not set this property in MXML.

This property can be used as the source for data binding.

See also

A flag that indicates that the a data change effect has just completed. The component usually responds by cleaning up various internal data structures on the next updateDisplayList() call.

A dictionary mapping item renderers to the ItemWrappers used to supply their data. Only applicable if a data effect is running.

Set of data to be viewed. This property lets you use most types of objects as data providers. If you set the dataProvider property to an Array, it will be converted to an ArrayCollection. If you set the property to an XML object, it will be converted into an XMLListCollection with only one item. If you set the property to an XMLList, it will be converted to an XMLListCollection. If you set the property to an object that implements the IList or ICollectionView interface, the object will be used directly.

As a consequence of the conversions, when you get the dataProvider property, it will always be an ICollectionView, and therefore not necessarily be the type of object you used to you set the property. This behavior is important to understand if you want to modify the data in the data provider: changes to the original data may not be detected, but changes to the ICollectionView object that you get back from the dataProvider property will be detected.

The default value is null.

This property can be used as the source for data binding.

See also

Name of the field in the data provider items to display as the data tip. By default, the list looks for a property named label on each item and displays it. However, if the data objects do not contain a label property, you can set the dataTipField property to use a different property in the data object. An example would be "FullName" when viewing a set of people's names retrieved from a database.

The default value is null.

This property can be used as the source for data binding.

User-supplied function to run on each item to determine its dataTip. By default, the list looks for a property named label on each data provider item and displays it. However, some items do not have a label property nor do they have another property that can be used for displaying in the rows. An example is a data set that has lastName and firstName fields, but you want to display full names. You can supply a dataTipFunction that finds the appropriate fields and return a displayable string. The dataTipFunction is also good for handling formatting and localization.

The dataTipFunction takes a single argument which is the item in the data provider and returns a String:

The default value is null.

This property can be used as the source for data binding.

The default number of columns to display. This value is used if the calculation for the number of columns results in a value less than 1 when trying to calculate the column count based on size or content.

The default value is 4.

The default number of rows to display. This value is used if the calculation for the number of columns results in a value less than 1 when trying to calculate the row count based on size or content.

The default value is 4.

A flag that indicates whether you can drag items out of this control and drop them on other controls. If true, dragging is enabled for the control. If the dropEnabled property is also true, you can drag items and drop them within this control to reorder the items.

The default value is false.

An instance of a class that displays the visuals during a drag and drop operation.

The default value is mx.controls.listClasses.ListItemDragProxy.

The offset of the drag image for drag and drop.

A flag that indicates whether items can be moved instead of just copied from the control as part of a drag-and-drop operation. If true, and the dragEnabled property is true, items can be moved. Often the data provider cannot or should not have items removed from it, so a MOVE operation should not be allowed during drag-and-drop.

The default value is false.

A flag that indicates whether dragged items can be dropped onto the control.

If you set this property to true, the control accepts all data formats, and assumes that the dragged data matches the format of the data in the data provider. If you want to explicitly check the data format of the data being dragged, you must handle one or more of the drag events, such as dragOver, and call the DragEvent's preventDefault() method to customize the way the list class accepts dropped data.

When you set dropEnabled to true, Flex automatically calls the showDropFeedback() and hideDropFeedback() methods to display the drop indicator.

The default value is false.

The column count requested by explicitly setting the columnCount property.

The column width requested by explicitly setting the columnWidth.

The row count requested by explicitly setting rowCount.

The row height requested by explicitly setting rowHeight.

A stack of unused item renderers. Most list classes recycle renderers they've already created as they scroll out of the displayable area; doing so saves time during scrolling. The recycled renderers are stored here.

The DisplayObject that contains the graphics that indicates which renderer is highlighted.

The renderer that is currently rolled over or under the caret.

The UID of the item that is current rolled over or under the caret.

The name of the field in the data provider object that determines what to display as the icon. By default, the list class does not try to display icons with the text in the rows. However, by specifying an icon field, you can specify a graphic that is created and displayed as an icon in the row. This property is ignored by DataGrid.

The renderers will look in the data provider object for a property of the name supplied as the iconField. If the value of the property is a Class, it will instantiate that class and expect it to be an instance of an IFlexDisplayObject. If the value of the property is a String, it will look to see if a Class exists with that name in the application, and if it can't find one, it will also look for a property on the document with that name and expect that property to map to a Class.

The default value is null.

This property can be used as the source for data binding.

A user-supplied function to run on each item to determine its icon. By default the list does not try to display icons with the text in the rows. However, by specifying an icon function, you can specify a Class for a graphic that will be created and displayed as an icon in the row.

The iconFunction takes a single argument which is the item in the data provider and returns a Class. Shown below is the signature of the function:

iconFunction(item:Object):Class

The default value is null.

This property can be used as the source for data binding.

The custom item renderer for the control. You can specify a drop-in, inline, or custom item renderer.

The default item renderer depends on the component class. For example, the AdvancedDataGrid class uses AdvancedDataGridItemRenderer.

A flag that indicates whether the columnWidth and rowHeight properties need to be calculated. This property is set to true if a style changes that can affect the measurements of the renderer, or if the data provider is changed.

A flag that indicates that the size of the renderers may have changed. The component usually responds by re-applying the data items to all of the renderers on the next updateDisplayList() call. There is an assumption that re-applying the items will invalidate the item renderers and cause them to re-measure.

The main IViewCursor instance used to fetch items from the data provider and pass the items to the renderers. At the end of any sequence of code, it must always be positioned at the topmost visible item being displayed.

A flag that indicates that a page fault as occurred and that the iterator's position is not valid (not positioned at the topmost item being displayed). If the component gets a page fault (an ItemPending error), it sets iteratorValid to false. Code that normally handles the rendering of items checks this flag and does not run until the page of data comes in from the server.

A flag that indicates if keyboard selection was interrupted by a page fault. The component responds by suspending the rendering of items until the page of data arrives. The finishKeySelection() method will be called when the paged data arrives

The name of the field in the data provider items to display as the label. By default the list looks for a property named label on each item and displays it. However, if the data objects do not contain a label property, you can set the labelField property to use a different property in the data object. An example would be "FullName" when viewing a set of people names fetched from a database.

The default value is "label".

This property can be used as the source for data binding.

A user-supplied function to run on each item to determine its label. By default, the list looks for a property named label on each data provider item and displays it. However, some data sets do not have a label property nor do they have another property that can be used for displaying. An example is a data set that has lastName and firstName fields but you want to display full names.

You can supply a labelFunction that finds the appropriate fields and returns a displayable string. The labelFunction is also good for handling formatting and localization.

For most components, the label function takes a single argument which is the item in the data provider and returns a String.

      myLabelFunction(item:Object):String

The method signature for the data grid classes is:

      myLabelFunction(item:Object, column:DataGridColumn):String

where item contains the DataGrid item object, and column specifies the DataGrid column.

The default value is null.

This property can be used as the source for data binding.

The most recently calculated index where the drag item should be added to the drop target.

The most recent seek that caused a page fault. If there are multiple page faults, only the most recent one is of interest, as that is where to position the iterator and start rendering rows again.

An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics. This is roughly equivalent to the contentPane in the Container class, and is used for managing scrolling.

When a component is used as a drop-in item renderer or drop-in item editor, Flex initializes the listData property of the component with the additional data from the list control. The component can then use the listData property and the data property to display the appropriate information as a drop-in item renderer or drop-in item editor.

You do not set this property in MXML or ActionScript; Flex sets it when the component is used as a drop-in item renderer or drop-in item editor.

This property can be used as the source for data binding.

See also

An Array of Arrays that contains the item renderer instances that render each data provider item. This is a two-dimensional row major Array (Array of rows that are Arrays of columns).

The index of the first column in the control that scrolls, where the first column is at an index of 0. Columns with indexes that are lower than this value remain fixed in view. This property is not supported by all list classes.

The default value is 0.

The index of the first row in the control that scrolls, where the first row is at an index of 0. Rows above this one remain fixed in view.

The default value is 0.

A flag that indicates whether menu-style selection should be used. In a Menu, dragging from one renderer into another selects the new one and un-selects the old.

The collection view that temporarily preserves previous data provider state to facilitate running data change effects.

The number of columns that are currently not visible.

The default value is 0.