| Package | mx.controls.listClasses |
| Class | public class ListBase |
| Inheritance | ListBase  ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IDataRenderer, IFocusManagerComponent, IListItemRenderer, IDropInListItemRenderer, IEffectTargetHost |
| Subclasses | DataGridBase, List, TileBase |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
dataProvider property
and displayed via item renderers.
In a model/view architecture, the ListBase-derived class represents the view, and the dataProvider object represents the model.
MXML Syntax
Show MXML Syntax
Hide MXML SyntaxThe ListBase class inherits all of the tag properties of its superclasses, and adds the following tag properties:
<mx:tagname
Properties
allowDragSelection="false|true"
allowMultipleSelection="false|true"
columnCount="4"
columnWidth="NaN"
dataProvider="null"
dataTipField="label"
dataTipFunction="null"
dragEnabled="false|true"
dragMoveEnabled="false|true"
dropEnabled="false|true"
iconField="null"
iconFunction="null"
itemRenderer="null"
labelField="label"
labelFunction="null"
menuSelectionMode="false|true"
offscreenExtraRowsOrColumns="0"
rowCount="-1"
rowHeight="NaN"
selectable="true|false"
selectedIndex="-1"
selectedIndices="null"
selectedItem="null"
selectedItems="null"
showDataTips="false|true"
variableRowHeight="false|true"
wordWrap="false|true"
Styles
alternatingItemColors="undefined"
itemsChangeEffect="undefined"
dropIndicatorSkin="ListDropIndicator"
focusAlpha="0.5"
focusRoundedCorners="tl tr bl br"
paddingBottom="2"
paddingLeft="2"
paddingRight="0"
paddingTop="2"
rollOverColor="0xEEFEE6"
selectionColor="0x7FCEFF"
selectionDisabledColor="0xDDDDDD"
selectionDuration="250"
selectionEasingFunction="undefined"
textRollOverColor="0x2B333C"
textSelectedColor="0x2B333C"
useRollOver="true|false"
verticalAlign="top|middle|bottom"
Events
change="No default"
dataChange="No default"
itemClick="No default"
itemDoubleClick="No default"
itemRollOut="No default"
itemRollOver="No default"
/>
Related API Elements
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | ListBase | ||
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | ListBase | ||
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control. | ListBase | ||
| columnWidth : Number
The width of the control's columns. | ListBase | ||
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor. | ListBase | ||
| dataProvider : Object
Set of data to be viewed. | ListBase | ||
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | ListBase | ||
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | ListBase | ||
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | ListBase | ||
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation. | ListBase | ||
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | ListBase | ||
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | ListBase | ||
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | ListBase | ||
| id : String
ID of the component. | UIComponent | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemRenderer : IFactory
The custom item renderer for the control. | ListBase | ||
| labelField : String
The name of the field in the data provider items to display as the label. | ListBase | ||
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | ListBase | ||
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| listData : BaseListData
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. | ListBase | ||
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released. | ScrollControlBase | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property. | ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | ListBase | ||
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| nullItemRenderer : IFactory
The custom item renderer for the control. | ListBase | ||
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | ||
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| rowCount : int
Number of rows to be displayed. | ListBase | ||
| rowHeight : Number
The height of the rows in pixels. | ListBase | ||
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | ListBase | ||
| selectedIndex : int
The index in the data provider of the selected item. | ListBase | ||
| selectedIndices : Array
An array of indices in the data provider of the selected items. | ListBase | ||
| selectedItem : Object
A reference to the selected item in the data provider. | ListBase | ||
| selectedItems : Array
An array of references to the selected items in the data provider. | ListBase | ||
| selectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property
against items in the data provider. | ListBase | ||
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows. | ListBase | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | ListBase | ||
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | ListBase | ||
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | ListBase | ||
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
| Property | Defined By | ||
|---|---|---|---|
| actualCollection : ICollectionView
A copy of the value normally stored in collection
used while running data changes effects. | ListBase | ||
| actualIterator : IViewCursor
A copy of the value normally stored in iterator
used while running data changes effects. | ListBase | ||
| allowItemSizeChangeNotification : Boolean [write-only]
If false, renderers cannot invalidate size of List. | ListBase | ||
| anchorBookmark : CursorBookmark
A bookmark to the item that is the anchor. | ListBase | ||
| anchorIndex : int = -1
The offset of the item in the data provider that is the selection
anchor point. | ListBase | ||
| border : IFlexDisplayObject
The border object. | ScrollControlBase | |
| cachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data
provider for the control, set through the itemsChangeEffect
style. | ListBase | ||
| caretBookmark : CursorBookmark
A bookmark to the item under the caret. | ListBase | ||
| caretIndex : int = -1
The offset of the item in the data provider that is the selection
caret point. | ListBase | ||
| caretIndicator : Sprite
The DisplayObject that contains the graphics that indicate
which renderer is the caret. | ListBase | ||
| caretItemRenderer : IListItemRenderer
The renderer for the item under the caret. | ListBase | ||
| caretUID : String
The UID of the item under the caret. | ListBase | ||
| collection : ICollectionView
An ICollectionView that represents the data provider. | ListBase | ||
| currentCSSState : String [read-only]
The state to be used when matching CSS pseudo-selectors. | UIComponent | |
| dataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has
just completed. | ListBase | ||
| dataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers
used to supply their data. | ListBase | ||
| defaultColumnCount : int = 4
The default number of columns to display. | ListBase | ||
| defaultRowCount : int = 4
The default number of rows to display. | ListBase | ||
| dragImage : IUIComponent [read-only]
Gets an instance of a class that displays the visuals
during a drag and drop operation. | ListBase | ||
| dragImageOffsets : Point [read-only]
Gets the offset of the drag image for drag and drop. | ListBase | ||
| explicitColumnCount : int = -1
The column count requested by explicitly setting the
columnCount property. | ListBase | ||
| explicitColumnWidth : Number
The column width requested by explicitly setting the
columnWidth. | ListBase | ||
| explicitRowCount : int = -1
The row count requested by explicitly setting
rowCount. | ListBase | ||
| explicitRowHeight : Number
The row height requested by explicitly setting
rowHeight. | ListBase | ||
| factoryMap : Dictionary
A map of item renderers by factory. | ListBase | ||
| freeItemRenderers : Array
A stack of unused item renderers. | ListBase | ||
| freeItemRenderersByFactory : Dictionary
A map of free item renderers by factory. | ListBase | ||
| hasComplexLayoutMatrix : Boolean [read-only]
Returns true if the UIComponent has any non-translation (x,y) transform properties. | UIComponent | |
| highlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates
which renderer is highlighted. | ListBase | ||
| highlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret. | ListBase | ||
| highlightUID : String
The UID of the item that is current rolled over or under the caret. | ListBase | ||
| horizontalScrollBar : ScrollBar
The horizontal scroll bar. | ScrollControlBase | |
| itemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth
and rowHeight properties need to be calculated. | ListBase | ||
| itemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed. | ListBase | ||
| iterator : IViewCursor
The main IViewCursor used to fetch items from the
data provider and pass the items to the renderers. | ListBase | ||
| iteratorValid : Boolean = true
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). | ListBase | ||
| keySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by
a page fault. | ListBase | ||
| lastDropIndex : int
The most recently calculated index where the drag item
should be added to the drop target. | ListBase | ||
| lastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault. | ListBase | ||
| listContent : ListBaseContentHolder
An internal display object that parents all of the item renderers,
selection and highlighting indicators and other supporting graphics. | ListBase | ||
| listContentStyleFilters : Object [read-only]
The set of styles to pass from the ListBase to the listContent. | ListBase | ||
| listItems : Array [read-only]
An Array of Arrays that contains
the itemRenderer instances that render each data provider item. | ListBase | ||
| maskShape : Shape
The mask. | ScrollControlBase | |
| modifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous
data provider state to facilitate running data change effects. | ListBase | ||
| offscreenExtraColumns : int = 0
The target number of extra columns of item renderers used in the
layout of the control. | ListBase | ||
| offscreenExtraColumnsLeft : int = 0
The number of offscreen columns currently to the left of the
leftmost visible column. | ListBase | ||
| offscreenExtraColumnsRight : int = 0
The number of offscreen columns currently to the right of the
right visible column. | ListBase | ||
| offscreenExtraRows : int = 0
The target number of extra rows of item renderers to be used in
the layout of the control. | ListBase | ||
| offscreenExtraRowsBottom : int = 0
The number of offscreen rows currently below the bottom visible
item renderer. | ListBase | ||
| offscreenExtraRowsOrColumnsChanged : Boolean = false
A flag indicating that the number of offscreen rows or columns
may have changed. | ListBase | ||
| offscreenExtraRowsTop : int = 0
The number of offscreen rows currently above the topmost visible
row. | ListBase | ||
| rendererChanged : Boolean = false
A flag that indicates that the renderer changed. | ListBase | ||
| reservedItemRenderers : Object
A hash map of currently unused item renderers that may be
used again in the near future. | ListBase | ||
| resourceManager : IResourceManager [read-only]
A reference to the object which manages
all of the application's localized resources. | UIComponent | |
| rowInfo : Array [read-only]
An array of ListRowInfo objects that cache row heights and
other tracking information for the rows in listItems. | ListBase | ||
| rowMap : Object
A hash map of item renderers to their respective ListRowInfo object. | ListBase | ||
| runDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated
the next time the display is updated. | ListBase | ||
| runningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running. | ListBase | ||
| scrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of
scrollbars. | ScrollControlBase | |
| selectedData : Object
A hash table of ListBaseSelectionData objects that track which
items are currently selected. | ListBase | ||
| selectionIndicators : Object
A hash table of selection indicators. | ListBase | ||
| selectionLayer : Sprite
The layer in listContent where all selection
and highlight indicators are drawn. | ListBase | ||
| selectionTweens : Object
A hash table of selection tweens. | ListBase | ||
| showCaret : Boolean
A flag that indicates whether to show caret. | ListBase | ||
| unconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject
to the layout algorithms of the list. | ListBase | ||
| unscaledHeight : Number [read-only]
A convenience method for determining the unscaled height
of the component. | UIComponent | |
| unscaledWidth : Number [read-only]
A convenience method for determining the unscaled width
of the component
All of a component's drawing and child layout should be done
within a bounding rectangle of this width, which is also passed
as an argument to updateDisplayList(). | UIComponent | |
| verticalScrollBar : ScrollBar
The vertical scroll bar. | ScrollControlBase | |
| visibleData : Object [read-only]
A hash table of data provider item renderers currently in view. | ListBase | ||
| wordWrapChanged : Boolean = false
A flag that indicates whether the value of the wordWrap
property has changed since the last time the display list was updated. | ListBase | ||
| Method | Defined By | ||
|---|---|---|---|
ListBase()
Constructor. | ListBase | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
Adds an item renderer if a data change effect is running. | ListBase | ||
| 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 | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
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 | |
Returns the index where the dropped items should be added
to the drop target. | ListBase | ||
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
Creates an item renderer given the data object. | ListBase | ||
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | ||
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
Return the appropriate factory, using the default factory if none specified. | ListBase | ||
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
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 | |
Returns true or false
to indicates whether the effect should play on the target. | ListBase | ||
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | ||
|
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 | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | ||
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | ||
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
Refresh all rows on the next update. | ListBase | ||
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | ||
Determines if the item renderer for a data provider item
is selectable. | ListBase | ||
Determines if the item renderer for a data provider item
is selected. | ListBase | ||
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | ||
Determines if an item is being displayed by a renderer. | ListBase | ||
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
Determines whether a renderer contains (or owns) a display object. | ListBase | ||
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | ||
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | ||
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | ||
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | ||
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | ||
|
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 | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | ||
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | ||
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
Removes an item renderer if a data change effect is running. | ListBase | ||
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
Ensures that the data provider item at the given index is visible. | ListBase | ||
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | ||
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | ||
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | ListBase | ||
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | ListBase | ||
Add a blank row to the beginning of the arrays that store references to the rows. | ListBase | ||
|
Adjust the focus rectangle. | UIComponent | |
Called from the updateDisplayList() method to adjust the size and position of
listContent. | ListBase | ||
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
Sets up the effect for applying the selection indicator. | ListBase | ||
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | ListBase | ||
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
Clears the caret indicator into the given Sprite. | ListBase | ||
Clears the highlight indicator in the given Sprite. | ListBase | ||
Removes all selection and highlight and caret indicators. | ListBase | ||
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | ListBase | ||
Empty the visibleData hash table. | ListBase | ||
Handles CollectionEvents dispatched from the data provider
as the data changes. | ListBase | ||
[override]
Calculates the column width and row height and number of rows and
columns based on whether properties like columnCount
columnWidth, rowHeight and
rowCount were explicitly set. | ListBase | ||
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | ListBase | ||
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method. | ListBase | ||
Copies the selected items in the order that they were selected. | ListBase | ||
|
Creates the border for this component. | ScrollControlBase | |
[override]
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. | ListBase | ||
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
Recycle a row that is no longer needed, and remove its indicators. | ListBase | ||
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
Handles DragEvent.DRAG_COMPLETE events. | ListBase | ||
Handles DragEvent.DRAG_DROP events. | ListBase | ||
Handles DragEvent.DRAG_ENTER events. | ListBase | ||
Handles DragEvent.DRAG_EXIT events. | ListBase | ||
Handles DragEvent.DRAG_OVER events. | ListBase | ||
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | ListBase | ||
The default handler for the dragStart event. | ListBase | ||
drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | ||
drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | ||
drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators
that it is highlighted, selected, or the caret. | ListBase | ||
Draws any alternating row colors, borders and backgrounds for the rows. | ListBase | ||
drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the selection indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | ||
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | ListBase | ||
Cleans up after a data change effect has finished running
by restoring the original collection and iterator and removing
any cached values used by the effect. | ListBase | ||
Sets selected items based on the caretIndex and
anchorIndex properties. | ListBase | ||
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
Retrieves an already-created item renderer not currently in use. | ListBase | ||
The column for the data provider item at the given index. | ListBase | ||
The row for the data provider item at the given index. | ListBase | ||
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
Initiates a data change effect when there have been changes
in the data provider. | ListBase | ||
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
Returns true if an item renderer is no longer being positioned
by the list's layout algorithm while a data change effect is
running as a result of a call to the unconstrainRenderer() method. | ListBase | ||
Returns a Point containing the columnIndex and rowIndex of an
item renderer. | ListBase | ||
Determines the UID for a data provider item. | ListBase | ||
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | |
makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point
Make enough rows and columns to fill the area
described by left, top, right, bottom. | ListBase | ||
[override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | ListBase | ||
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | ||
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | ||
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | ||
Determines which item renderer is under the mouse. | ListBase | ||
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | ||
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | ||
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | ||
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | ||
[override]
Handles mouseWheel events by changing scroll positions. | ListBase | ||
Move the selection and highlight indicators horizontally. | ListBase | ||
Move the selection and highlight indicators vertically. | ListBase | ||
Move a row vertically, and update the rowInfo record. | ListBase | ||
Moves the selection in a horizontal direction in response
to the user selecting items using the left arrow or right arrow
keys and modifiers such as the Shift and Ctrl keys. | ListBase | ||
Moves the selection in a vertical direction in response
to the user selecting items using the up arrow or down arrow
Keys and modifiers such as the Shift and Ctrl keys. | ListBase | ||
Prepares the data effect for the collection event. | ListBase | ||
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes. | ListBase | ||
Update the keys in the visibleData hash table. | ListBase | ||
Remove a row from the arrays that store references to the row. | ListBase | ||
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | ListBase | ||
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
Remove the requested number of rows from the beginning of the
arrays that store references to the rows. | ListBase | ||
|
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
|
Default event handler for the scroll event. | ScrollControlBase | |
Adjusts the renderers in response to a change
in scroll position. | ListBase | ||
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | ListBase | ||
Adjusts the renderers in response to a change
in scroll position. | ListBase | ||
The default failure handler when a seek fails due to a page fault. | ListBase | ||
The default result handler when a seek fails due to a page fault. | ListBase | ||
Seek to a position, and handle an ItemPendingError if necessary. | ListBase | ||
selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided
was clicked by the mouse and the keyboard modifiers are in the given
state. | ListBase | ||
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | ListBase | ||
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | ListBase | ||
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
Shift a row in the arrays that reference rows. | ListBase | ||
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
Determine the height of the requested set of rows. | ListBase | ||
Remove all remaining rows from the end of the
arrays that store references to the rows. | ListBase | ||
Find an item renderer based on its UID if it is visible. | ListBase | ||
[override]
Adds or removes item renderers if the number of displayable items
changed. | ListBase | ||
Refreshes all rows. | ListBase | ||
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | |||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | ListBase | |||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | |||
| Dispatched when the user double-clicks on an item in the control. | ListBase | |||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | ListBase | |||
| Dispatched when the user rolls the mouse pointer over an item in the control. | ListBase | |||
| Dispatched when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
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.
| Style | Description | Defined By | ||
|---|---|---|---|---|
alternatingItemColors | Type: Array Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The colors to use for the backgrounds of the items in the list. The value is an array of one or more colors. The backgrounds of the list items alternate among the colors in the array. For DataGrid controls, all items in a row have the same background color, and each row's background color is determined from the array of colors. For the TileList control, which uses a single list to populate a two-dimensional display, the style can result in a checkerboard appearance, stripes, or other patterns based on the number of columns and rows and the number of colors specified. TileList cycles through the colors, placing the individual item background colors according to the layout direction. If you have an even number of colors and an even number of columns for a TileList layed out horizontally, you will get striping. If the number of columns is an odd number, you will get a checkerboard pattern. The default value is undefined. | ListBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Bounding box style. | ScrollControlBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The directionality of the text displayed by the component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of text in the component if it is disabled. | ScrollControlBase | ||
dropIndicatorSkin | Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The skin to use to indicate where a dragged item can be dropped. When a ListBase-derived component is a potential drop target in a drag-and-drop operation, a call to the showDropFeedback()
method makes an instance of this class and positions it one pixel above
the itemRenderer for the item where, if the drop occurs, is the item after
the dropped item.
The default value is mx.controls.listClasses.ListDropIndicator. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Color of the component highlight when validation fails. | UIComponent | ||
| Type: Number CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies the alpha transparency value of the focus skin. | ScrollControlBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Blend mode used by the focus rectangle. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Specifies which corners of the focus rectangle should be rounded. | ScrollControlBase | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the antiAliasType property of internal TextFields. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the gridFitType property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the sharpness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Sets the thickness property of internal TextFields that represent text in Flex controls. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is boldface. | ScrollControlBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Style name for horizontal scrollbar. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 2.5 The primary interaction mode for this component. | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.1 Runtime Versions: Flash10, AIR 1.5 Specifies the desired layout direction of a component. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Additional vertical space between lines of text. | ScrollControlBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area. | UIComponent | ||
| Type: Number CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of additional pixels to appear between each character. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The locale of the text displayed by this component. | ScrollControlBase | ||
paddingBottom | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of pixels between the bottom of the row and the bottom of the renderer in the row. The default value is 2. | ListBase | ||
paddingLeft | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's left border and the left edge of its content area. The default value is 0. The default value for a Button control in the Halo theme is 10 and in the Spark theme is 6. The default value for the ComboBox control is 5. The default value for the Form container is 16. The default value for the Tree control is 2. | ListBase | ||
paddingRight | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Number of pixels between the component's right border and the right edge of its content area. The default value is 0. The default value for a Button control in the Halo theme is 10 and in the Spark theme is 6. The default value for the ComboBox control is 5. The default value for the Form container is 16. | ListBase | ||
paddingTop | Type: Number Format: Length CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The number of pixels between the top of the row and the top of the renderer in the row. The default value is 2. | ListBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area. | UIComponent | ||
rollOverColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The color of the background of a renderer when the user rolls over it. The default value for the Halo theme is 0xB2E1FF.
The default value for the Spark theme is 0xCEDBEF.
| ListBase | ||
selectionColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The color of the background of a renderer when the user selects it. The default value for the Halo theme is 0x7FCEFF.
The default value for the Spark theme is 0xA8C6EE.
| ListBase | ||
selectionDisabledColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The color of the background of a renderer when the component is disabled. The default value is 0xDDDDDD. | ListBase | ||
selectionDuration | Type: Number Format: Time CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The duration of the selection effect. When an item is selected an effect plays as the background is colored. Set to 0 to disable the effect. The default value is 250. | ListBase | ||
selectionEasingFunction | Type: Function CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The easingFunction for the selection effect. When an item is selected an effect plays as the background is colored. The default is a linear fade in of the color. An easingFunction can be used for controlling the selection effect. The default value is undefined. | ListBase | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error border or skin when this component is invalid | UIComponent | ||
| Type: Boolean CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 4.5 Runtime Versions: Flash10, AIR 1.5 Show the error tip when this component is invalid and the user rolls over it | UIComponent | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Determines whether the text is underlined. | ScrollControlBase | ||
| Type: Class CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 4 Runtime Versions: Flash10, AIR 1.5 The class implementing IUITextField that is used by this component to render text. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase | ||
textRollOverColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The color of the text of a renderer when the user rolls over a it. The default value for the Halo theme is 0x2B333C.
The default value for the Spark theme is 0x000000.
| ListBase | ||
textSelectedColor | Type: uint Format: Color CSS Inheritance: Yes Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The color of the text of a renderer when the user selects it. The default value for the Halo theme is 0x2B333C.
The default value for the Spark theme is 0x000000.
| ListBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area. | UIComponent | ||
useRollOver | Type: Boolean CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 A flag that controls whether items are highlighted as the mouse rolls over them. If true, rows are highlighted as the mouse rolls over them.
If false, rows are highlighted only when selected.
The default value is true. | ListBase | ||
verticalAlign | Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical alignment of a renderer in a row. Possible values are "top", "middle",
and "bottom".
The DataGrid positions the renderers in a row based on this style
and the paddingTop and paddingBottom styles.
if the item in the columns for a row have different heights
Other list classes do not use verticalAlign but
the item renderers can examine this style property
and adjust their layout based on it.
The default value is "top". | ListBase | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 The vertical distance in pixels from the center of the component's content area to the center of the component. | UIComponent | ||
| Type: String CSS Inheritance: No Language Version: ActionScript 3.0 Product Version: Flex 3 Runtime Versions: Flash9, AIR 1.1 Style name for vertical scrollbar. | ScrollControlBase | ||
actualCollection | property |
protected var actualCollection:ICollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A copy of the value normally stored in collection
used while running data changes effects. This value should be
null when a data change effect is not running.
actualIterator | property |
protected var actualIterator:IViewCursor| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A copy of the value normally stored in iterator
used while running data changes effects.
allowDragSelection | property |
public var allowDragSelection:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 then dragging the mouse into the dropdown to select an item.
The default value is false.
allowItemSizeChangeNotification | property |
allowMultipleSelection | property |
allowMultipleSelection:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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, Ctrl-click).
The default value is false.
Implementation
public function get allowMultipleSelection():Boolean public function set allowMultipleSelection(value:Boolean):voidanchorBookmark | property |
protected var anchorBookmark:CursorBookmark| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
anchorIndex | property |
protected var anchorIndex:int = -1| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset of the item in the data provider that is the selection anchor point.
cachedItemsChangeEffect | property |
protected var cachedItemsChangeEffect:IEffect = null| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style.
caretBookmark | property |
protected var caretBookmark:CursorBookmark| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A bookmark to the item under the caret. A bookmark allows the component to quickly seek to a position in the collection of items.
caretIndex | property |
protected var caretIndex:int = -1| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The offset of the item in the data provider that is the selection caret point.
Related API Elements
caretIndicator | property |
protected var caretIndicator:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The DisplayObject that contains the graphics that indicate which renderer is the caret.
caretItemRenderer | property |
protected var caretItemRenderer:IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 Ctrl), 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 Ctrl 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 Ctrl key, just the caret moves. The user can use the Space key to toggle selection of the item under the caret.
caretUID | property |
protected var caretUID:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The UID of the item under the caret.
collection | property |
protected var collection:ICollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 ListBase class then uses this property to access
data in the provider.
When you get the dataProvider property,
Flex returns this value.
columnCount | property |
columnCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of columns to be displayed in a TileList control or items in a HorizontalList control. For the DataGrid it is 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.
Implementation
public function get columnCount():int public function set columnCount(value:int):voidcolumnWidth | property |
columnWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The width of the control's columns. This property is used by TileList and HorizontalList controls; It has no effect on DataGrid controls, where you set the individual DataGridColumn widths.
The default value is 50.
Implementation
public function get columnWidth():Number public function set columnWidth(value:Number):voiddata | property |
data:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the dataChange event.
Implementation
public function get data():Object public function set data(value:Object):voidRelated API Elements
dataEffectCompleted | property |
protected var dataEffectCompleted:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
dataItemWrappersByRenderer | property |
protected var dataItemWrappersByRenderer:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A dictionary mapping item renderers to the ItemWrappers used to supply their data. Only applicable if a data effect is running.
dataProvider | property |
dataProvider:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the collectionChange event.
Implementation
public function get dataProvider():Object public function set dataProvider(value:Object):voidRelated API Elements
dataTipField | property |
dataTipField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the dataTipFieldChanged event.
Implementation
public function get dataTipField():String public function set dataTipField(value:String):voiddataTipFunction | property |
dataTipFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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, as the following example shows:
myDataTipFunction(item:Object):String
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the dataTipFunctionChanged event.
Implementation
public function get dataTipFunction():Function public function set dataTipFunction(value:Function):voiddefaultColumnCount | property |
protected var defaultColumnCount:int = 4| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 columnCount based on size or content.
The default value is 4.
defaultRowCount | property |
protected var defaultRowCount:int = 4| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 rowCount based on size or content.
The default value is 4.
dragEnabled | property |
dragEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get dragEnabled():Boolean public function set dragEnabled(value:Boolean):voiddragImage | property |
dragImage:IUIComponent [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Gets an instance of a class that displays the visuals during a drag and drop operation.
The default value is mx.controls.listClasses.ListItemDragProxy.
Implementation
protected function get dragImage():IUIComponentdragImageOffsets | property |
dragMoveEnabled | property |
dragMoveEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get dragMoveEnabled():Boolean public function set dragMoveEnabled(value:Boolean):voiddropEnabled | property |
dropEnabled:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
Implementation
public function get dropEnabled():Boolean public function set dropEnabled(value:Boolean):voidexplicitColumnCount | property |
protected var explicitColumnCount:int = -1| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The column count requested by explicitly setting the
columnCount property.
explicitColumnWidth | property |
protected var explicitColumnWidth:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The column width requested by explicitly setting the
columnWidth.
explicitRowCount | property |
protected var explicitRowCount:int = -1| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The row count requested by explicitly setting
rowCount.
explicitRowHeight | property |
protected var explicitRowHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The row height requested by explicitly setting
rowHeight.
factoryMap | property |
protected var factoryMap:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A map of item renderers by factory. This property is a Dictionary indexed by itemRenderers where the values are IFactory.
freeItemRenderers | property |
protected var freeItemRenderers:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
freeItemRenderersByFactory | property |
protected var freeItemRenderersByFactory:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A map of free item renderers by factory. This property is a Dictionary indexed by factories where the values are Dictionaries of itemRenderers.
highlightIndicator | property |
protected var highlightIndicator:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The DisplayObject that contains the graphics that indicates which renderer is highlighted.
highlightItemRenderer | property |
protected var highlightItemRenderer:IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The renderer that is currently rolled over or under the caret.
highlightUID | property |
protected var highlightUID:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The UID of the item that is current rolled over or under the caret.
iconField | property |
iconField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the iconFieldChanged event.
Implementation
public function get iconField():String public function set iconField(value:String):voidiconFunction | property |
iconFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. This property is ignored by DataGrid.
The iconFunction takes a single argument which is the item in the data provider and returns a Class, as the following example shows:
iconFunction(item:Object):Class
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the iconFunctionChanged event.
Implementation
public function get iconFunction():Function public function set iconFunction(value:Function):voiditemRenderer | property |
itemRenderer:IFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. The TileList and HorizontalList class use TileListItemRenderer, The List class uses ListItemRenderer. The DataGrid class uses DataGridItemRenderer from DataGridColumn.
Implementation
public function get itemRenderer():IFactory public function set itemRenderer(value:IFactory):voidMore examples
itemsNeedMeasurement | property |
protected var itemsNeedMeasurement:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the columnWidth
and rowHeight properties need to be calculated.
This property is set if a style changes that can affect the
measurements of the renderer, or if the data provider is changed.
itemsSizeChanged | property |
protected var itemsSizeChanged:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
iterator | property |
protected var iterator:IViewCursor| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The main IViewCursor 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.
iteratorValid | property |
protected var iteratorValid:Boolean = true| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
keySelectionPending | property |
protected var keySelectionPending:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
labelField | property |
labelField:String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the labelFieldChanged event.
Implementation
public function get labelField():String public function set labelField(value:String):voidlabelFunction | property |
labelFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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 DataGrid and DataGridColumn 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. When this property is modified, it dispatches the labelFunctionChanged event.
Implementation
public function get labelFunction():Function public function set labelFunction(value:Function):voidlastDropIndex | property |
protected var lastDropIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The most recently calculated index where the drag item should be added to the drop target.
lastSeekPending | property |
protected var lastSeekPending:ListBaseSeekPending| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
listContent | property |
protected var listContent:ListBaseContentHolder| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
listContentStyleFilters | property |
listData | property |
listData:BaseListData| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. When this property is modified, it dispatches the dataChange event.
Implementation
public function get listData():BaseListData public function set listData(value:BaseListData):voidRelated API Elements
listItems | property |
listItems:Array [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An Array of Arrays that contains the itemRenderer instances that render each data provider item. This is a two-dimensional row major array (array of rows that are arrays of columns).
Implementation
protected function get listItems():ArraymenuSelectionMode | property |
public var menuSelectionMode:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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.
modifiedCollectionView | property |
protected var modifiedCollectionView:ModifiedCollectionView| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
nullItemRenderer | property |
nullItemRenderer:IFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. The TileList and HorizontalList class use TileListItemRenderer, The List class uses ListItemRenderer. The DataGrid class uses DataGridItemRenderer from DataGridColumn.
Implementation
public function get nullItemRenderer():IFactory public function set nullItemRenderer(value:IFactory):voidoffscreenExtraColumns | property |
protected var offscreenExtraColumns:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The target number of extra columns of item renderers used in the
layout of the control. Half of these columns are created to
the left of the visible onscreen columns; half are created
to the right.
Typically this property will be set indirectly when you set the
offscreenExtraRowsOrColumns property.
The default value is 0.
offscreenExtraColumnsLeft | property |
protected var offscreenExtraColumnsLeft:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of offscreen columns currently to the left of the
leftmost visible column.
This value will be <= offscreenExtraColumns / 2.
The default value is 0.
offscreenExtraColumnsRight | property |
protected var offscreenExtraColumnsRight:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of offscreen columns currently to the right of the
right visible column.
This value will be <= offscreenExtraColumns / 2.
The default value is 0.
offscreenExtraRows | property |
protected var offscreenExtraRows:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The target number of extra rows of item renderers to be used in
the layout of the control. Half of these rows are created
above the visible onscreen rows; half are created below.
Typically this property is set indirectly when you set the
offscreenExtraRowsOrColumns property.
The default value is 0.
offscreenExtraRowsBottom | property |
protected var offscreenExtraRowsBottom:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of offscreen rows currently below the bottom visible
item renderer. This value will be <= offscreenExtraRows / 2.
The default value is 0.
offscreenExtraRowsOrColumns | property |
offscreenExtraRowsOrColumns:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The target number of extra rows or columns of item renderers to be used in the layout of the control. Half of these rows/columns are created above or to the left of the visible onscreen rows/columns; half are created below or to the right.
Whether rows or columns are created is dependent on the control and its
properties. Generally rows will be used, except for TileBase components
where direction is set to TileBaseDirection.VERTICAL.
In that case, columns are created.
You set this property to a non-zero value primarily when applying data effects to the List or TileList controls. Changes that affect the data provider element corresponding to the currently visible items, or changes that affect the data provider element for the specified number of items before or after the visible items, trigger the data effect. Data provider elements outside this range may not be animated perfectly by the data effect.
This property is useful because data effects work by first determining a 'before' layout of the list-based control, then determining an 'after' layout, and finally setting the properties of the effect to create an animation from the before layout to the after layout. Since many effects cause currently invisible items to become visible, or currently visible items to become invisible, this property configures the control to create the offscreen item renderers so that they already exist when the data effect plays.
A reasonable value for this property might be the number of rows visible onscreen. Setting it to a very large value may cause performance problems when used with a data provider that contains a large number of elements.
The default value is 0.
Implementation
public function get offscreenExtraRowsOrColumns():int public function set offscreenExtraRowsOrColumns(value:int):voidoffscreenExtraRowsOrColumnsChanged | property |
protected var offscreenExtraRowsOrColumnsChanged:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag indicating that the number of offscreen rows or columns may have changed.
offscreenExtraRowsTop | property |
protected var offscreenExtraRowsTop:int = 0| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The number of offscreen rows currently above the topmost visible
row. This value will be <= offscreenExtraRows / 2.
It is used when computing the relationship of listItems and
rowInfo Arrays to items in the data provider (in conjunction
with verticalScrollPosition property).
The default value is 0.
rendererChanged | property |
protected var rendererChanged:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates that the renderer changed.
The component usually responds by destroying all existing renderers
and redrawing all of the renderers on the next
updateDisplayList() call.
reservedItemRenderers | property |
protected var reservedItemRenderers:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash map of currently unused item renderers that may be used again in the near future. Used when running data effects. The map is indexed by the data provider item's UID.
rowCount | property |
rowCount:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Number of rows to be displayed. If the height of the component has been explicitly set, this property might not have any effect.
For a DataGrid control, the rowCount property does
not include the header row.
The default value is 4.
Implementation
public function get rowCount():int public function set rowCount(value:int):voidrowHeight | property |
rowHeight:Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The height of the rows in pixels.
Unless the variableRowHeight property is
true, all rows are the same height.
If not specified, the row height is based on
the font size and other properties of the renderer.
Implementation
public function get rowHeight():Number public function set rowHeight(value:Number):voidrowInfo | property |
rowMap | property |
protected var rowMap:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash map of item renderers to their respective ListRowInfo object. The ListRowInfo object is indexed by the DisplayObject name of the item renderer.
runDataEffectNextUpdate | property |
protected var runDataEffectNextUpdate:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates if a data effect should be initiated the next time the display is updated.
runningDataEffect | property |
protected var runningDataEffect:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag indicating if a data change effect is currently running.
selectable | property |
selectable:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the list shows selected items
as selected.
If true, the control supports selection.
The Menu class, which subclasses ListBase, sets this property to
false by default, because it doesn't show the chosen
menu item as selected.
The default value is true.
Implementation
public function get selectable():Boolean public function set selectable(value:Boolean):voidselectedData | property |
protected var selectedData:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash table of ListBaseSelectionData objects that track which items are currently selected. The table is indexed by the UID of the items.
Related API Elements
selectedIndex | property |
selectedIndex:int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The index in the data provider of the selected item.
The default value is -1 (no selected item).
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedIndex():int public function set selectedIndex(value:int):voidselectedIndices | property |
selectedIndices:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of indices in the data provider of the selected items. The items are in the reverse order that the user selected the items.
The default value is [ ].
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedIndices():Array public function set selectedIndices(value:Array):voidselectedItem | property |
selectedItem:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A reference to the selected item in the data provider.
The default value is null.
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedItem():Object public function set selectedItem(value:Object):voidselectedItems | property |
selectedItems:Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
An array of references to the selected items in the data provider. The items are in the reverse order that the user selected the items.
The default value is [ ].
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get selectedItems():Array public function set selectedItems(value:Array):voidselectedItemsCompareFunction | property |
selectedItemsCompareFunction:Function| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 4 |
| Runtime Versions: | Flash Player 9, AIR 1.5 |
A function used to compare items in the selectedItems property
against items in the data provider.
If there is a match, the item in the data provider
becomes part of the selection.
By default, or if selectedItemsCompareFunction is set to null,
the default comparision function is used, which uses
strict equality (===).
Note that earlier releases of
Flex used simple equality (==) so there could be behavioral
differences in certain cases.
A common compare function might simply compare UIDs of objects
or test that a particular property matches.
The compare function takes two arguments.
The first argument is the object in the data provider.
The second argument is an object in selectedItems property.
The function returns true if the data provider item should be selected.
myCompareFunction(itemInDataProvider:Object, itemInSelectedItems):Boolean
The default value is null, which uses strict equality.
This property can be used as the source for data binding. When this property is modified, it dispatches the selectedItemsCompareFunctionChanged event.
Implementation
public function get selectedItemsCompareFunction():Function public function set selectedItemsCompareFunction(value:Function):voidselectionIndicators | property |
protected var selectionIndicators:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash table of selection indicators. This table allows the component to quickly find and remove the indicators when the set of selected items is cleared. The table is indexed by the item's UID.
selectionLayer | property |
protected var selectionLayer:Sprite| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The layer in listContent where all selection
and highlight indicators are drawn.
selectionTweens | property |
protected var selectionTweens:Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash table of selection tweens. This allows the component to quickly find and clean up any tweens in progress if the set of selected items is cleared. The table is indexed by the item's UID.
showCaret | property |
protected var showCaret:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether to show caret.
This property is usually set
to false when mouse activity is detected and set back to
true when the keyboard is used for selection.
showDataTips | property |
showDataTips:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether dataTips are displayed for text in the rows.
If true, dataTips are displayed. DataTips
are tooltips designed to show the text that is too long for the row.
If you set a dataTipFunction, dataTips are shown regardless of whether the
text is too long for the row.
The default value is false.
This property can be used as the source for data binding. When this property is modified, it dispatches the showDataTipsChanged event.
Implementation
public function get showDataTips():Boolean public function set showDataTips(value:Boolean):voidunconstrainedRenderers | property |
protected var unconstrainedRenderers:Dictionary| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash map of item renderers that are not subject to the layout algorithms of the list.
value | property |
value:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The selected item, or the data or label field of the selected item. If the selected item is a Number or String the value is the item. If the item is an object, the value is the data property if it exists, or the label property if it exists.
Note: Using selectedItem is often preferable. This
property exists for backward compatibility with older applications.
This property can be used as the source for data binding. When this property is modified, it dispatches the valueCommit event.
Implementation
public function get value():ObjectvariableRowHeight | property |
variableRowHeight:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the individual rows can have different
height. This property is ignored by TileList and HorizontalList.
If true, individual rows can have different height values.
The default value is false.
Implementation
public function get variableRowHeight():Boolean public function set variableRowHeight(value:Boolean):voidvisibleData | property |
visibleData:Object [read-only] | Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A hash table of data provider item renderers currently in view. The table is indexed by the data provider item's UID and is used to quickly get the renderer used to display a particular item.
Implementation
protected function get visibleData():ObjectwordWrap | property |
wordWrap:Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether text in the row should be word wrapped.
If true, enables word wrapping for text in the rows.
Only takes effect if the variableRowHeight property is also
true.
The default value is false.
Implementation
public function get wordWrap():Boolean public function set wordWrap(value:Boolean):voidwordWrapChanged | property |
protected var wordWrapChanged:Boolean = false| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
A flag that indicates whether the value of the wordWrap
property has changed since the last time the display list was updated.
This property is set when you change the wordWrap
property value, and is reset
to false by the updateDisplayList() method.
The component usually responds by re-applying the data items to all of
the renderers on the next updateDisplayList() call.
This is different from itemsSizeChanged because it further indicates
that re-applying the data items to the renderers may not invalidate them
since the only thing that changed was whether or not the renderer should
factor in wordWrap into its size calculations.
ListBase | () | Constructor |
public function ListBase()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
addDataEffectItem | () | method |
public function addDataEffectItem(item:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds an item renderer if a data change effect is running. The item renderer should correspond to a recently added data item in the data provider's collection that isn't yet being displayed.
This function will be called by an AddItemAction
effect as part of a data change effect to specify the point
at which a data item added to a collection begins to be displayed
by the control using an item renderer.
Parameters
item:Object — The item renderer to add to the control's layout.
|
addDragData | () | method |
protected function addDragData(dragSource:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds the selected items to the DragSource object as part of a drag-and-drop operation. Override this method to add other data to the drag source.
Parameters
dragSource:Object — The DragSource object to which to add the data.
|
addToFreeItemRenderers | () | method |
protected function addToFreeItemRenderers(item:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it. If a data effect is running, the renderer is reserved for future use for that data. Otherwise it is added to the general freeItemRenderers stack.
Parameters
item:IListItemRenderer — The renderer to add.
|
addToRowArrays | () | method |
protected function addToRowArrays():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Add a blank row to the beginning of the arrays that store references to the rows.
adjustListContent | () | method |
protected function adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called from the updateDisplayList() method to adjust the size and position of
listContent.
Parameters
unscaledWidth:Number (default = -1)scaleX property of the component.
| |
unscaledHeight:Number (default = -1)scaleY property of the component.
|
applySelectionEffect | () | method |
protected function applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets up the effect for applying the selection indicator. The default is a basic alpha tween.
Parameters
indicator:Sprite — A Sprite that contains the graphics depicting selection.
| |
uid:String — The UID of the item being selected which can be used to index
into a table and track more than one selection effect.
| |
itemRenderer:IListItemRenderer — The item renderer that is being shown as selected.
|
calculateDropIndex | () | method |
public function calculateDropIndex(event:DragEvent = null):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index where the dropped items should be added to the drop target.
Parameters
event:DragEvent (default = null)null the
method should return the dropIndex value from the
last valid event.
|
int — Index where the dropped items should be added.
|
calculateDropIndicatorY | () | method |
protected function calculateDropIndicatorY(rowCount:Number, rowNum:int):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
Parameters
rowCount:Number — The number of visible rows in the control.
| |
rowNum:int — The row number in the control where the drop indicator should appear.
|
Number — The y axis coordinate of the drop indicator.
|
clearCaretIndicator | () | method |
protected function clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the caret indicator into the given Sprite.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
for that make a renderer look highlighted.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
clearHighlightIndicator | () | method |
protected function clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the highlight indicator in the given Sprite.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
for that make a renderer look highlighted.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
clearIndicators | () | method |
protected function clearIndicators():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes all selection and highlight and caret indicators.
clearSelected | () | method |
protected function clearSelected(transition:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Clears the set of selected items and removes all graphics depicting the selected state of those items.
Parameters
transition:Boolean (default = false)true if the graphics should
have a fadeout effect.
|
clearVisibleData | () | method |
protected function clearVisibleData():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Empty the visibleData hash table.
collectionChangeHandler | () | method |
protected function collectionChangeHandler(event:Event):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles CollectionEvents dispatched from the data provider as the data changes. Updates the renderers, selected indices and scrollbars as needed.
Parameters
event:Event — The CollectionEvent.
|
commitProperties | () | method |
override protected function commitProperties():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the column width and row height and number of rows and
columns based on whether properties like columnCount
columnWidth, rowHeight and
rowCount were explicitly set.
Related API Elements
configureScrollBars | () | method |
protected function configureScrollBars():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns.
This method is called from the updateDisplayList() method
after the rows and columns have been updated.
The method should figures out what parameters to pass into the
setScrollBarProperties() method to properly set up the ScrollBars.
copyItemWithUID | () | method |
protected function copyItemWithUID(item:Object):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method.
This method is used for a drag and drop copy.
Parameters
item:Object — The item to copy.
|
Object — The copy of the object.
|
Related API Elements
copySelectedItems | () | method |
protected function copySelectedItems(useDataField:Boolean = true):Array| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Copies the selected items in the order that they were selected.
Parameters
useDataField:Boolean (default = true)true if the array should
be filled with the actual items or false
if the array should be filled with the indexes of the items.
|
Array — An array of selected items.
|
createChildren | () | method |
override protected function createChildren():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. The item renderers are not created immediately, but later
when the updateDisplayList() method is called.
createItemRenderer | () | method |
public function createItemRenderer(data:Object):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Creates an item renderer given the data object.
Parameters
data:Object — data object.
|
IListItemRenderer — The item renderer.
|
destroyRow | () | method |
protected function destroyRow(i:int, numCols:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Recycle a row that is no longer needed, and remove its indicators.
Parameters
i:int — The index of the row to remove.
| |
numCols:int — The number of columns in the row.
|
dragCompleteHandler | () | method |
protected function dragCompleteHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles DragEvent.DRAG_COMPLETE events. This method
removes the item from the data provider.
Parameters
event:DragEvent — The DragEvent object.
|
dragDropHandler | () | method |
protected function dragDropHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles DragEvent.DRAG_DROP events. This method hides
the drop feedback by calling the hideDropFeedback() method.
If the action is a COPY,
then this method makes a deep copy of the object
by calling the ObjectUtil.copy() method,
and replaces the copy's uid property (if present)
with a new value by calling the UIDUtil.createUID() method.
Parameters
event:DragEvent — The DragEvent object.
|
Related API Elements
dragEnterHandler | () | method |
protected function dragEnterHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles DragEvent.DRAG_ENTER events. This method
determines if the DragSource object contains valid elements and uses
the showDropFeedback() method to set up the UI feedback.
Parameters
event:DragEvent — The DragEvent object.
|
dragExitHandler | () | method |
protected function dragExitHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles DragEvent.DRAG_EXIT events. This method hides
the UI feeback by calling the hideDropFeedback() method.
Parameters
event:DragEvent — The DragEvent object.
|
dragOverHandler | () | method |
protected function dragOverHandler(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles DragEvent.DRAG_OVER events. This method
determines if the DragSource object contains valid elements and uses
the showDropFeedback() method to set up the UI feeback.
Parameters
event:DragEvent — The DragEvent object.
|
dragScroll | () | method |
protected function dragScroll():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Interval function that scrolls the list up or down if the mouse goes above or below the list.
dragStartHandler | () | method |
drawCaretIndicator | () | method |
protected function drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the caret indicator into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
for that make a renderer look highlighted.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
drawHighlightIndicator | () | method |
protected function drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the highlight indicator into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
for that make a renderer look highlighted.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
drawItem | () | method |
protected function drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the renderer with indicators that it is highlighted, selected, or the caret.
Parameters
item:IListItemRenderer — The renderer.
| |
selected:Boolean (default = false)true if the renderer should be drawn in
its selected state.
| |
highlighted:Boolean (default = false)true if the renderer should be drawn in
its highlighted state.
| |
caret:Boolean (default = false)true if the renderer should be drawn as if
it is the selection caret.
| |
transition:Boolean (default = false)true if the selection state should fade in
via an effect.
|
drawRowBackgrounds | () | method |
protected function drawRowBackgrounds():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws any alternating row colors, borders and backgrounds for the rows.
drawSelectionIndicator | () | method |
protected function drawSelectionIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Draws the selection indicator into the given Sprite at the position, width and height specified using the color specified.
Parameters
indicator:Sprite — A Sprite that should contain the graphics
for that make a renderer look highlighted.
| |
x:Number — The suggested x position for the indicator.
| |
y:Number — The suggested y position for the indicator.
| |
width:Number — The suggested width for the indicator.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
itemRenderer:IListItemRenderer — The item renderer that is being highlighted.
|
findKey | () | method |
protected function findKey(eventCode:int):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter.
You can override this to do fancier typeahead lookups. The search
starts at the selectedIndex location; if it reaches
the end of the data provider it starts over from the beginning.
Parameters
eventCode:int — The key that was pressed on the keyboard.
|
Boolean — true if a match was found.
|
findString | () | method |
public function findString(str:String):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Finds an item in the list based on a String,
and moves the selection to it. The search
starts at the selectedIndex location; if it reaches
the end of the data provider it starts over from the beginning.
For a DataGrid control, by default this method searches
the first column in the control.
To search a different column, set the sort property
of the collection used to populate the control to the specific field
or fields that you want to search.
Each field corresponds to a single column of the control.
Parameters
str:String — The String to match.
|
Boolean — true if a match is found.
|
Related API Elements
finishDataChangeEffect | () | method |
protected function finishDataChangeEffect(event:EffectEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Cleans up after a data change effect has finished running by restoring the original collection and iterator and removing any cached values used by the effect. This method is called by the Flex framework; you do not need to call it from your code.
Parameters
event:EffectEvent — The EffectEvent.
|
finishKeySelection | () | method |
protected function finishKeySelection():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets selected items based on the caretIndex and
anchorIndex properties.
Called by the keyboard selection handlers
and by the updateDisplayList() method in case the
keyboard selection handler received a page fault while scrolling to get more items.
getItemRendererFactory | () | method |
public function getItemRendererFactory(data:Object):IFactory| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Return the appropriate factory, using the default factory if none specified.
Parameters
data:Object — The data to be presented by the item renderer.
|
IFactory — if data is null, the default item renderer,
otherwise it returns the custom item renderer.
|
getRendererSemanticValue | () | method |
public function getRendererSemanticValue(target:Object, semanticProperty:String):Object| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true or false
to indicates whether the effect should play on the target.
The EffectTargetFilter class calls this method when you set
the filter property on a data effect.
For example, you set filter property
to addItem or removeItem.
Parameters
target:Object — An item renderer
| |
semanticProperty:String — The semantic property of the renderer
whose value will be returned.
|
Object — true or false
to indicates whether the effect should play on the target.
|
getReservedOrFreeItemRenderer | () | method |
protected function getReservedOrFreeItemRenderer(data:Object):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Retrieves an already-created item renderer not currently in use. If a data effect is running, it first tries to retrieve from the reservedItemRenderers map. Otherwise (or if no reserved renderer is found) it retrieves from the freeItemRenderers stack.
Parameters
data:Object — The data to be presented by the item renderer.
|
IListItemRenderer — An already-created item renderer not currently in use.
|
hideDropFeedback | () | method |
public function hideDropFeedback(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Hides the drop indicator under the mouse pointer that indicates that a drag and drop operation is allowed.
Parameters
event:DragEvent — A DragEvent object that contains information about the
mouse location.
|
indexToColumn | () | method |
protected function indexToColumn(index:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The column for the data provider item at the given index.
Parameters
index:int — The offset into the data provider.
|
int — The column the item would be displayed at in the component;
-1 if not displayable in listContent container.
|
indexToItemRenderer | () | method |
public function indexToItemRenderer(index:int):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Get an item renderer for the index of an item in the data provider, if one exists. Because item renderers only exist for items within the set of viewable rows, you cannot use this method for items that are not visible.
Parameters
index:int — The offset into the data provider for an item.
|
IListItemRenderer — The item renderer that is displaying the item, or
null if the item is not currently displayed.
|
indexToRow | () | method |
protected function indexToRow(index:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The row for the data provider item at the given index.
Parameters
index:int — The offset into the data provider.
|
int — The row the item would be displayed at in the component;
-1 if not displayable in listContent container.
|
indicesToIndex | () | method |
public function indicesToIndex(rowIndex:int, colIndex:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Computes the offset into the data provider of the item at colIndex, rowIndex. The 9th row 3rd column in a TileList could be different items in the data provider based on the direction the tiles are laid out and the number of rows and columns in the TileList.
Parameters
rowIndex:int — The 0-based index of the row, including rows
scrolled off the top. Thus, if verticalScrollPosition
is 2 then the first visible row has a rowIndex of 2.
| |
colIndex:int — The 0-based index of the column, including
columns scrolled off the left. If
horizontalScrollPosition is 2 then the first column
on the left has a columnIndex of 2.
|
int — The offset into the data provider.
|
initiateDataChangeEffect | () | method |
protected function initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Initiates a data change effect when there have been changes in the data provider.
Parameters
unscaledWidth:Number — The width of the control before external sizings are applied.
| |
unscaledHeight:Number — The height of the control before external sizings are applied.
|
invalidateList | () | method |
public function invalidateList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Refresh all rows on the next update.
isItemHighlighted | () | method |
public function isItemHighlighted(data:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation).
Parameters
data:Object — The data provider item.
|
Boolean — true if the item is highlighted.
|
isItemSelectable | () | method |
public function isItemSelectable(data:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the item renderer for a data provider item is selectable.
Parameters
data:Object — The data provider item.
|
Boolean — true if the item is selectable.
|
isItemSelected | () | method |
public function isItemSelected(data:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the item renderer for a data provider item is selected.
Parameters
data:Object — The data provider item.
|
Boolean — true if the item is selected.
|
isItemShowingCaret | () | method |
public function isItemShowingCaret(data:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation.
Parameters
data:Object — The data provider item.
|
Boolean — true if the item under the caret
|
isItemVisible | () | method |
public function isItemVisible(item:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines if an item is being displayed by a renderer.
Parameters
item:Object — A data provider item.
|
Boolean — true if the item is being displayed.
|
isRendererUnconstrained | () | method |
protected function isRendererUnconstrained(item:Object):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns true if an item renderer is no longer being positioned
by the list's layout algorithm while a data change effect is
running as a result of a call to the unconstrainRenderer() method.
Parameters
item:Object — An item renderer.
|
Boolean — true if an item renderer is no longer being positioned
by the list's layout algorithm.
|
itemRendererContains | () | method |
public function itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines whether a renderer contains (or owns) a display object. Ownership means that the display object isn't actually parented by the renderer but is associated with it in some way. Popups should be owned by the renderers so that activity in the popup is associated with the renderer and not seen as activity in another component.
Parameters
renderer:IListItemRenderer — The renderer that might contain or own the
display object.
| |
object:DisplayObject — The display object that might be associated with the
renderer.
|
Boolean — true if the display object is contained
or owned by the renderer.
|
itemRendererToIndex | () | method |
public function itemRendererToIndex(itemRenderer:IListItemRenderer):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the index of the item in the data provider of the item being rendered by this item renderer. Because item renderers only exist for items that are within the set of viewable rows, you cannot use this method for items that are not visible.
Parameters
itemRenderer:IListItemRenderer — The item renderer that is displaying the
item for which you want to know the data provider index.
|
int — The index of the item in the data provider.
|
itemRendererToIndices | () | method |
protected function itemRendererToIndices(item:IListItemRenderer):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns a Point containing the columnIndex and rowIndex of an item renderer. Because item renderers are only created for items within the set of viewable rows, you cannot use this method to get the indices for items that are not visible. Also note that item renderers are recycled so the indices you get for an item may change if that item renderer is reused to display a different item. Usually, this method is called during mouse and keyboard handling when the set of data displayed by the item renderers hasn't yet changed.
Parameters
item:IListItemRenderer — An item renderer.
|
Point — A Point. The x property is the columnIndex
and the y property is the rowIndex.
|
itemToDataTip | () | method |
public function itemToDataTip(data:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties. If the method cannot convert the parameter to a string, it returns a single space.
For use by developers creating subclasses of ListBase or its children. Not used by application developers.
Parameters
data:Object — Object to be rendered.
|
String — String displayable string based on the data.
|
itemToIcon | () | method |
public function itemToIcon(data:Object):Class| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties. The field in the item can return a string as long as that string represents the name of a class in the application. The field in the item can also be a string that is the name of a variable in the document that holds the class for the icon.
Parameters
data:Object — The item from which to extract the icon class.
|
Class — The icon for the item, as a class reference or
null if none.
|
itemToItemRenderer | () | method |
public function itemToItemRenderer(item:Object):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the item renderer for a given item in the data provider,
if there is one. Since item renderers only exist for items
that are within the set of viewable rows, this method
returns null if the item is not visible.
For DataGrid, this will return the first column's renderer.
Parameters
item:Object — The data provider item.
|
IListItemRenderer — The item renderer or null if the item is not
currently displayed.
|
itemToLabel | () | method |
public function itemToLabel(data:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties. If the method cannot convert the parameter to a string, it returns a single space.
Parameters
data:Object — Object to be rendered.
|
String — The string to be displayed based on the data.
|
itemToUID | () | method |
protected function itemToUID(data:Object):String| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines the UID for a data provider item. All items in a data provider must either have a unique ID (UID) or one will be generated and associated with it. This means that you cannot have an object or scalar value appear twice in a data provider.
For example, the following data provider is not supported because the value "foo" appears twice and the UID for a string is the string itself:
var sampleDP:Array = ["foo", "bar", "foo"]
Simple dynamic objects can appear twice if they are two separate instances. The following is supported because each of the instances will be given a different UID because they are different objects:
var sampleDP:Array = [{label: "foo"}, {label: "foo"}]
Note that the following is not supported because the same instance appears twice.
var foo:Object = {label: "foo"};
sampleDP:Array = [foo, foo];
Parameters
data:Object — The data provider item.
|
String — The UID as a string.
|
makeRowsAndColumns | () | method |
protected function makeRowsAndColumns(left:Number, top:Number, right:Number, bottom:Number, firstColumn:int, firstRow:int, byCount:Boolean = false, rowsNeeded:uint = 0):Point| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Make enough rows and columns to fill the area
described by left, top, right, bottom.
Renderers are created and inserted into the listItems
array starting at (firstColumn, firstRow)(
and moving downwards.
If byCount and rowsNeeded are specified,
then just make that many rows and ignore the bottom
and right parameters.
Parameters
left:Number — Horizontal pixel offset of area to fill.
| |
top:Number — Vertical pixel offset of area to fill.
| |
right:Number — Horizontal pixel offset of area to fill
(from left side of component).
| |
bottom:Number — Vertical pixel offset of area to fill
(from top of component).
| |
firstColumn:int — Offset into listItems to store
the first renderer to be created.
| |
firstRow:int — Offset into listItems to store
the first renderer to be created.
| |
byCount:Boolean (default = false)rowsNeeded number of rows
and ignore bottom parameter.
| |
rowsNeeded:uint (default = 0)byCount
is true.
|
Point — A Point containing the number of rows and columns created.
|
measure | () | method |
override protected function measure():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties.
Related API Elements
measureHeightOfItems | () | method |
public function measureHeightOfItems(index:int = -1, count:int = 0):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items.
This method is not implemented in the ListBase class and must be implemented in the child class.
A negative index value can be used to specify
that the height calculation includes any headers.
Parameters
index:int (default = -1) | |
count:int (default = 0) |
Number — the sum of the height of the measured items.
|
measureWidthOfItems | () | method |
public function measureWidthOfItems(index:int = -1, count:int = 0):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Measures a set of items from the data provider using the current item renderer and returns the maximum width found. This method is used to calculate the width of the component. The various ListBase-derived classes have slightly different implementations. DataGrid measures its columns instead of data provider items, and TileList just measures the first item and assumes all items are the same size.
This method is not implemented in the ListBase class and must be implemented in the child class.
A negative index value can be used to specify
that the width calculation includes any headers.
Parameters
index:int (default = -1) | |
count:int (default = 0) |
Number — The widest of the measured items.
|
mouseClickHandler | () | method |
protected function mouseClickHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. This method
determines which renderer was clicked
and dispatches a ListEvent.ITEM_CLICK event.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseDoubleClickHandler | () | method |
protected function mouseDoubleClickHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers.
This method determines which renderer was clicked
and dispatches a ListEvent.ITEM_DOUBLE_CLICK event.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseDownHandler | () | method |
protected function mouseDownHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. This method
finds the renderer that was pressed and prepares to receive
a MouseEvent.MOUSE_UP event.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseEventToItemRenderer | () | method |
protected function mouseEventToItemRenderer(event:MouseEvent):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determines which item renderer is under the mouse. Item renderers can be made of multiple mouse targets, or have visible areas that are not mouse targets. This method checks both targets and position to determine which item renderer the mouse is over from the user's perspective, which can differ from the information provided by the mouse event.
Parameters
event:MouseEvent — A MouseEvent that contains the position of
the mouse and the object it is over.
|
IListItemRenderer — The item renderer the mouse is over or
null if none.
|
mouseMoveHandler | () | method |
protected function mouseMoveHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. This method
watches for a gesture that constitutes the beginning of a
drag drop and send a DragEvent.DRAG_START event.
It also checks to see if the mouse is over a non-target area of a
renderer so that Flex can try to make it look like that renderer was
the target.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseOutHandler | () | method |
protected function mouseOutHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. This method
finds out which renderer the mouse has left and removes the highlights.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseOverHandler | () | method |
protected function mouseOverHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers.
This method finds out which renderer the mouse is over
and shows it as highlighted.
The list classes also call this from a
MouseEvent.MOUSE_MOVE event.
This event is used to detect movement in non-target areas of the
renderers and in padded areas around the renderers.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseUpHandler | () | method |
protected function mouseUpHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. This method
finds the renderer that was pressed and prepares to receive
a MouseEvent.MOUSE_UP event.
Parameters
event:MouseEvent — The MouseEvent object.
|
mouseWheelHandler | () | method |
override protected function mouseWheelHandler(event:MouseEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Handles mouseWheel events by changing scroll positions.
This is a copy of the version in the ScrollControlBase class,
modified to change the horizontalScrollPosition if the target is run horizontally.
Parameters
event:MouseEvent — The MouseEvent object.
|
Related API Elements
moveIndicatorsHorizontally | () | method |
protected function moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Move the selection and highlight indicators horizontally.
Parameters
uid:String — UID used to find the indicators.
| |
moveBlockDistance:Number — The distance to move horizontally.
|
moveIndicatorsVertically | () | method |
protected function moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Move the selection and highlight indicators vertically.
Parameters
uid:String — UID used to find the indicators.
| |
moveBlockDistance:Number — The distance to move vertically.
|
moveRowVertically | () | method |
protected function moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Move a row vertically, and update the rowInfo record.
Parameters
i:int — The index of the row.
| |
numCols:int — The number of columns in the row.
| |
moveBlockDistance:Number — The distance to move.
|
moveSelectionHorizontally | () | method |
protected function moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves the selection in a horizontal direction in response
to the user selecting items using the left arrow or right arrow
keys and modifiers such as the Shift and Ctrl keys. This method
might change the horizontalScrollPosition,
verticalScrollPosition, and caretIndex
properties, and call the finishKeySelection() method
to update the selection.
Not implemented in ListBase because the default list is single column and therefore does not scroll horizontally.
Parameters
code:uint — The key that was pressed (for example, Keyboard.LEFT).
| |
shiftKey:Boolean — true if the Shift key was held down when
the keyboard key was pressed.
| |
ctrlKey:Boolean — true if the Ctrl key was held down when
the keyboard key was pressed.
|
moveSelectionVertically | () | method |
protected function moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Moves the selection in a vertical direction in response
to the user selecting items using the up arrow or down arrow
Keys and modifiers such as the Shift and Ctrl keys. This method
might change the horizontalScrollPosition,
verticalScrollPosition, and caretIndex
properties, and call the finishKeySelection() method
to update the selection.
Parameters
code:uint — The key that was pressed (for example, Keyboard.DOWN).
| |
shiftKey:Boolean — true if the Shift key was held down when
the keyboard key was pressed.
| |
ctrlKey:Boolean — true if the Ctrl key was held down when
the keyboard key was pressed.
|
prepareDataEffect | () | method |
protected function prepareDataEffect(ce:CollectionEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Prepares the data effect for the collection event.
Parameters
ce:CollectionEvent — The collection event.
|
purgeItemRenderers | () | method |
protected function purgeItemRenderers():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes.
reKeyVisibleData | () | method |
protected function reKeyVisibleData():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Update the keys in the visibleData hash table.
removeDataEffectItem | () | method |
public function removeDataEffectItem(item:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Removes an item renderer if a data change effect is running.
The item renderer must correspond to data that has already
been removed from the data provider collection.
This function will be called by a RemoveItemAction
effect as part of a data change effect to specify the point
at which a data item ceases to displayed by the control using
an item renderer.
Parameters
item:Object — The item renderer to remove from the control's layout.
|
removeFromRowArrays | () | method |
removeIndicators | () | method |
protected function removeIndicators(uid:String):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Cleans up selection highlights and other associated graphics for a given item in the data provider.
Parameters
uid:String — The UID of the data provider item.
|
restoreRowArrays | () | method |
protected function restoreRowArrays(modDeltaPos:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Remove the requested number of rows from the beginning of the arrays that store references to the rows.
Parameters
modDeltaPos:int — The number of rows to remove.
|
scrollHorizontally | () | method |
protected function scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adjusts the renderers in response to a change in scroll position.
The list classes attempt to optimize scrolling
when the scroll position has changed by less than
the number of visible rows. In that situation
some rows are unchanged and just need to be moved,
other rows are removed and then new rows are added.
If the scroll position changes too much, all old rows are removed
and new rows are added by calling the makeRowsAndColumns()
method for the entire viewable area.
Not implemented in ListBase because the default list is single column and therefore doesn't scroll horizontally.
Parameters
pos:int — The new scroll position.
| |
deltaPos:int — The change in position. This value is always a positive number.
| |
scrollUp:Boolean — true if scroll position is getting smaller.
|
scrollPositionToIndex | () | method |
protected function scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Returns the data provider index for the item at the first visible row and column for the given scroll positions.
Parameters
horizontalScrollPosition:int — The horizontalScrollPosition
property value corresponding to the scroll position.
| |
verticalScrollPosition:int — The verticalScrollPosition
property value corresponding to the scroll position.
|
int — The data provider index.
|
scrollToIndex | () | method |
public function scrollToIndex(index:int):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Ensures that the data provider item at the given index is visible.
If the item is visible, the verticalScrollPosition
property is left unchanged even if the item is not the first visible
item. If the item is not currently visible, the
verticalScrollPosition
property is changed make the item the first visible item, unless there
aren't enough rows to do so because the
verticalScrollPosition value is limited by the
maxVerticalScrollPosition property.
Parameters
index:int — The index of the item in the data provider.
|
Boolean — true if verticalScrollPosition changed.
|
scrollVertically | () | method |
protected function scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adjusts the renderers in response to a change in scroll position.
The list classes attempt to optimize scrolling
when the scroll position has changed by less than
the number of visible rows. In that situation
some rows are unchanged and just need to be moved,
other rows are removed and then new rows are added.
If the scroll position changes too much, all old rows are removed
and new rows are added by calling the makeRowsAndColumns()
method for the entire viewable area.
Parameters
pos:int — The new scroll position.
| |
deltaPos:int — The change in position. This value is always a positive number.
| |
scrollUp:Boolean — true if the scroll position is getting smaller.
|
seekPendingFailureHandler | () | method |
protected function seekPendingFailureHandler(data:Object, info:ListBaseSeekPending):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default failure handler when a seek fails due to a page fault.
Parameters
data:Object — The data that caused the error.
| |
info:ListBaseSeekPending — Data about a seek operation that was interrupted by an ItemPendingError error.
|
seekPendingResultHandler | () | method |
protected function seekPendingResultHandler(data:Object, info:ListBaseSeekPending):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
The default result handler when a seek fails due to a page fault. This method checks to see if it has the most recent page fault result: if not it simply exits; if it does, it sets the iterator to the correct position.
Parameters
data:Object — The data that caused the error.
| |
info:ListBaseSeekPending — Data about a seek operation that was interrupted by an ItemPendingError error.
|
seekPositionSafely | () | method |
protected function seekPositionSafely(index:int):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Seek to a position, and handle an ItemPendingError if necessary.
Parameters
index:int — Index into the collection.
|
Boolean — false if an ItemPendingError is thrown.
|
selectItem | () | method |
protected function selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Updates the set of selected items given that the item renderer provided was clicked by the mouse and the keyboard modifiers are in the given state. This method also updates the display of the item renderers based on their updated selected state.
Parameters
item:IListItemRenderer — The item renderer that was clicked.
| |
shiftKey:Boolean — true if the Shift key was held down when
the mouse was clicked.
| |
ctrlKey:Boolean — true if the Ctrl key was held down when
the mouse was clicked.
| |
transition:Boolean (default = true)true if the graphics for the selected
state should be faded in using an effect.
|
Boolean — true if the set of selected items changed.
Clicking on an already-selected item does not always change the set
of selected items.
|
setRowCount | () | method |
protected function setRowCount(v:int):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows.
Parameters
v:int — The row count.
|
setRowHeight | () | method |
protected function setRowHeight(v:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows.
Parameters
v:Number — The row height, in pixels.
|
shiftRow | () | method |
protected function shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Shift a row in the arrays that reference rows.
Parameters
oldIndex:int — Old index in the arrays.
| |
newIndex:int — New index in the arrays.
| |
numCols:int — The number of columns in the row.
| |
shiftItems:Boolean — true if we actually move the item. false if we simply change the item's rowIndex.
|
showDropFeedback | () | method |
public function showDropFeedback(event:DragEvent):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Displays a drop indicator under the mouse pointer to indicate that a drag and drop operation is allowed and where the items will be dropped.
Parameters
event:DragEvent — A DragEvent object that contains information as to where
the mouse is.
|
sumRowHeights | () | method |
protected function sumRowHeights(startRowIdx:int, endRowIdx:int):Number| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Determine the height of the requested set of rows.
Parameters
startRowIdx:int — The index of first row.
| |
endRowIdx:int — The index of last row.
|
Number — The total height of the rows.
|
truncateRowArrays | () | method |
UIDToItemRenderer | () | method |
protected function UIDToItemRenderer(uid:String):IListItemRenderer| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Find an item renderer based on its UID if it is visible.
Parameters
uid:String — The UID of the item.
|
IListItemRenderer — The item renderer.
|
unconstrainRenderer | () | method |
public function unconstrainRenderer(item:Object):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control.
The control does not attempt to position the item render for the
duration of the effect.
Parameters
item:Object — The item renderer that is a target of the effect.
|
updateDisplayList | () | method |
override protected function updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Adds or removes item renderers if the number of displayable items changed. Refreshes the item renderers if they might have changed. Applies the selection if it was changed programmatically.
Parameters
unscaledWidth:Number — Specifies the width of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleX property of the component.
| |
unscaledHeight:Number — Specifies the height of the component, in pixels,
in the component's coordinates, regardless of the value of the
scaleY property of the component.
|
Related API Elements
updateList | () | method |
protected function updateList():void| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Refreshes all rows. Calling this method can require substantial processing, because it completely redraws all renderers in the list and does not return until complete.
change | Event |
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the selectedIndex or selectedItem property
changes as a result of user interaction.
type property of the ListEvent object for a
change event, which indicates that selection
changed as a result of user interaction.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer that was clicked. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.CHANGE |
dataChange | Event |
mx.events.FlexEventproperty FlexEvent.type =
mx.events.FlexEvent.DATA_CHANGE| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the data property changes.
When you use a component as an item renderer,
the data property contains the data to display.
You can listen for this event and update the component
when the data property changes.
FlexEvent.DATA_CHANGE constant defines the value of the
type property of the event object for a dataChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
itemClick | Event |
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_CLICK| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the user clicks on an item in the control.
The ListEvent.ITEM_CLICK constant defines the value of thetype property of the ListEvent object for an
itemClick event, which indicates that the
user clicked the mouse over a visual item in the control.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer that was clicked. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_CLICK |
itemDoubleClick | Event |
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_DOUBLE_CLICK| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the user double-clicks on an item in the control.
The ListEvent.ITEM_DOUBLE_CLICK constant defines the value of thetype property of the ListEvent object for an
itemDoubleClick event, which indicates that the
user double clicked the mouse over a visual item in the control.
To receive itemDoubleClick events, you must set the component's
doubleClickEnabled property to true.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer that was double clicked. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_DOUBLE_CLICK |
itemRollOut | Event |
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_ROLL_OUT| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the user rolls the mouse pointer out of an item in the control.
The ListEvent.ITEM_ROLL_OUT constant defines the value of thetype property of the ListEvent object for an
itemRollOut event, which indicates that the user rolled
the mouse pointer out of a visual item in the control.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer that was rolled out. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_ROLL_OUT |
itemRollOver | Event |
mx.events.ListEventproperty ListEvent.type =
mx.events.ListEvent.ITEM_ROLL_OVER| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Dispatched when the user rolls the mouse pointer over an item in the control.
The ListEvent.ITEM_ROLL_OVER constant defines the value of thetype property of the ListEvent object for an
itemRollOver event, which indicates that the user rolled
the mouse pointer over a visual item in the control.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer that was rolled over. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_ROLL_OVER |
Thu Dec 6 2018, 01:12 PM -08:00