Package | mx.controls |
Class | public class List |
Inheritance | List ListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite |
Implements | IIMESupport |
Subclasses | FileSystemList, Menu, Tree |
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Starting with Flex 4.0, Apache recommends that you use the spark.components.List class as an alternative to this class. |
allowMultipleSelection
property.
The List control has the following default sizing characteristics:
Characteristic | Description |
---|---|
Default size | Wide enough to fit the widest label in the first seven visible items (or all visible items in the list, if there are less than seven); seven rows high, where each row is 20 pixels high. |
Minimum size | 0 pixels. |
Maximum size | 5000 by 5000. |
The <mx:List>
tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
<mx:List Properties editable="false|true" editedItemPosition="No default" editorDataField="text" editorHeightOffset="0" editorUsesEnterKey="false|true" editorWidthOffset="0" editorXOffset="0" editorYOffset="0" imeMode="null" itemEditor="TextInput" itemEditorInstance="Current item editor" rendererIsEditor="false|true" Styles backgroundDisabledColor="0xDDDDDD" Events itemEditBegin="No default" itemEditEnd="No default" itemEditBeginning="No default" itemFocusIn="No default" itemFocusOut="No default" />
Default MXML PropertydataProvider
See also
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 | ||
accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 | ||
editable : Boolean
A flag that indicates whether or not the user can edit
items in the data provider. | List | ||
editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any. | List | ||
editedItemRenderer : IListItemRenderer [read-only]
A reference to the item renderer
in the DataGrid control whose item is currently being edited. | List | ||
editorDataField : String = text
The name of the property of the item editor that contains the new
data for the list item. | List | ||
editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer. | List | ||
editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key. | List | ||
editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer. | List | ||
editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | List | ||
editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | List | ||
enabled : Boolean
Whether the component can accept user interaction. | UIComponent | ||
enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | List | ||
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 | ||
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 | ||
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 | ||
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 | ||
imeMode : String
Specifies the IME (input method editor) mode. | List | ||
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 | ||
itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true. | List | ||
itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor,
if it exists. | List | ||
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 | ||
maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | ||
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 | ||
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 | ||
mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | ||
MXMLDescriptor : Array [read-only] | UIComponent | ||
MXMLProperties : Array [read-only] | UIComponent | ||
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 | ||
offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | ||
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 : 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 | ||
rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor. | List | ||
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 | ||
rotation : Number [override] | 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]
| UIComponent | ||
rowCount : int
Number of rows to be displayed. | ListBase | ||
rowHeight : Number
The height of the rows in pixels. | ListBase | ||
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 | ||
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 | ||
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 | ||
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 | ||
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 : 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 | ||
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]
| 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 | ||
measuringObjects : Dictionary
cache of measuring objects by factory
| List | ||
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 | ||
---|---|---|---|
List()
Constructor. | List | ||
addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running. | ListBase | ||
addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | ||
calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added
to the drop target. | ListBase | ||
callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | ||
clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | ||
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | ||
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | ||
createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | ||
createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | ||
createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | List | ||
createItemRenderer(data:Object):IListItemRenderer [override]
Get the appropriate renderer, using the default renderer if none is specified. | List | ||
createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | ||
destroyItemEditor():void
Closes an item editor that is currently open on an item. | List | ||
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | ||
dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | ||
drawFocus(isFocused:Boolean):void
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 | ||
effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | ||
effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | ||
endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | ||
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | ||
findString(str:String):Boolean
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | ||
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | ||
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | ||
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | ||
getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | ||
getAutomationChildren():Array
Provides the automation object list . | UIComponent | ||
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | ||
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | ||
getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | ||
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | ||
getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | ||
getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | ||
getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | ||
getItemRendererFactory(data:Object):IFactory
Return the appropriate factory, using the default factory if none specified. | ListBase | ||
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | ||
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | ||
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | ||
getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | ||
getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | ||
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | ||
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | ||
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | ||
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | ||
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | ||
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | ||
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false
to indicates whether the effect should play on the target. | ListBase | ||
getRepeaterItem(whichRepeater:int = -1):Object
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 | ||
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | ||
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | ||
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | ||
hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | ||
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | ||
hideDropFeedback(event:DragEvent):void
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | ||
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | ||
indexToItemRenderer(index:int):IListItemRenderer
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | ||
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | ||
initialize():void
Initializes the internal structure of this component. | UIComponent | ||
initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | ||
invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | ||
invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | ||
invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | ||
invalidateList():void
Refresh all rows on the next update. | ListBase | ||
invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | ||
invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | ||
isItemEditable(data:Object):Boolean
Determines if the item renderer for a data provider item
is editable. | List | ||
isItemHighlighted(data:Object):Boolean
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 | ||
isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item
is selectable. | ListBase | ||
isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item
is selected. | ListBase | ||
isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | ||
isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer. | ListBase | ||
itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object. | ListBase | ||
itemRendererToIndex(itemRenderer:IListItemRenderer):int
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | ||
itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | ||
itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | ||
itemToItemRenderer(item:Object):IListItemRenderer
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | ||
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | ||
localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | ||
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | ||
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | ||
measureHeightOfItems(index:int = -1, count:int = 0):Number
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 | ||
measureHTMLText(htmlText:String):TextLineMetrics
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 | ||
measureText(text:String):TextLineMetrics
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 | ||
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | ||
move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | ||
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | ||
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | ||
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | ||
prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | ||
regenerateStyleCache(recursive:Boolean):void
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 | ||
registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | ||
removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running. | ListBase | ||
removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | ||
replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | ||
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | ||
resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | ||
scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible. | ListBase | ||
setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | ||
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | ||
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | ||
setFocus():void
Sets the focus to this component. | UIComponent | ||
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | ||
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | ||
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | ||
setMXMLDescriptor(value:Array):void | UIComponent | ||
setMXMLProperties(value:Array):void | UIComponent | ||
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | ||
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | ||
showDropFeedback(event:DragEvent):void
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 | ||
styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | ||
stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | ||
suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | ||
toString():String [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 | ||
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
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 | ||
unconstrainRenderer(item:Object):void
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 | ||
validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | ||
validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | ||
validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | ||
validateSize(recursive:Boolean = false):void
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 | ||
validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | ||
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent |
Method | Defined By | ||
---|---|---|---|
addDragData(dragSource:Object):void
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | ListBase | ||
addMXMLChildren(comps:Array):void | UIComponent | ||
addToFreeItemRenderers(item:IListItemRenderer):void
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | ListBase | ||
addToRowArrays():void
Add a blank row to the beginning of the arrays that store references to the rows. | ListBase | ||
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle. | UIComponent | ||
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
Called from the updateDisplayList() method to adjust the size and position of
listContent. | ListBase | ||
applyComputedMatrix():void
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | ||
applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void
Sets up the effect for applying the selection indicator. | ListBase | ||
attachOverlay():void
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | ||
calculateDropIndicatorY(rowCount:Number, rowNum:int):Number
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | ListBase | ||
canSkipMeasurement():Boolean
Determines if the call to the measure() method can be skipped. | UIComponent | ||
childrenCreated():void
Performs any final processing after child objects are created. | UIComponent | ||
clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the caret indicator into the given Sprite. | ListBase | ||
clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the highlight indicator in the given Sprite. | ListBase | ||
clearIndicators():void
Removes all selection and highlight and caret indicators. | ListBase | ||
clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | ListBase | ||
clearVisibleData():void
Empty the visibleData hash table. | ListBase | ||
collectionChangeHandler(event:Event):void
Handles CollectionEvents dispatched from the data provider
as the data changes. | ListBase | ||
commitProperties():void [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 | ||
configureScrollBars():void
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | ListBase | ||
copyItemWithUID(item:Object):Object
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 | ||
copySelectedItems(useDataField:Boolean = true):Array
Copies the selected items in the order that they were selected. | ListBase | ||
createBorder():void
Creates the border for this component. | ScrollControlBase | ||
createChildren():void [override]
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. | ListBase | ||
createInFontContext(classObj:Class):Object
Creates a new object using a context
based on the embedded font being used. | UIComponent | ||
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory. | UIComponent | ||
destroyRow(i:int, numCols:int):void
Recycle a row that is no longer needed, and remove its indicators. | ListBase | ||
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | ||
dragCompleteHandler(event:DragEvent):void
Handles DragEvent.DRAG_COMPLETE events. | ListBase | ||
dragDropHandler(event:DragEvent):void
Handles DragEvent.DRAG_DROP events. | ListBase | ||
dragEnterHandler(event:DragEvent):void
Handles DragEvent.DRAG_ENTER events. | ListBase | ||
dragExitHandler(event:DragEvent):void
Handles DragEvent.DRAG_EXIT events. | ListBase | ||
dragOverHandler(event:DragEvent):void
Handles DragEvent.DRAG_OVER events. | ListBase | ||
dragScroll():void
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | ListBase | ||
dragStartHandler(event:DragEvent):void
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 | ||
drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void
Draws a row background
at the position and height specified. | List | ||
drawRowBackgrounds():void
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 | ||
endEdit(reason:String):Boolean
Stops the editing of an item in the data provider. | List | ||
findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | ListBase | ||
finishDataChangeEffect(event:EffectEvent):void
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 | ||
finishKeySelection():void
Sets selected items based on the caretIndex and
anchorIndex properties. | ListBase | ||
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus. | UIComponent | ||
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus. | UIComponent | ||
generateMXMLAttributes(data:Array):void | UIComponent | ||
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void | UIComponent | ||
generateMXMLObject(document:Object, data:Array):Object | UIComponent | ||
getReservedOrFreeItemRenderer(data:Object):IListItemRenderer
Retrieves an already-created item renderer not currently in use. | ListBase | ||
indexToColumn(index:int):int
The column for the data provider item at the given index. | ListBase | ||
indexToRow(index:int):int
The row for the data provider item at the given index. | ListBase | ||
initAdvancedLayoutFeatures():void
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | ||
initializationComplete():void
Finalizes the initialization of this component. | UIComponent | ||
initializeAccessibility():void
Initializes this component's accessibility code. | UIComponent | ||
initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
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 | ||
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | ||
isRendererUnconstrained(item:Object):Boolean
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 | ||
itemRendererToIndices(item:IListItemRenderer):Point
Returns a Point containing the columnIndex and rowIndex of an
item renderer. | ListBase | ||
itemToUID(data:Object):String
Determines the UID for a data provider item. | ListBase | ||
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event. | UIComponent | ||
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event. | UIComponent | ||
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | ||
layoutEditor(x:int, y:int, w:int, h:int):void
Positions the item editor instance at the suggested position
with the suggested dimensions. | List | ||
makeListData(data:Object, uid:String, rowNum:int):BaseListData
Creates a new ListData instance and populates the fields based on
the input data provider item. | List | ||
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 | ||
measure():void [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | ListBase | ||
mouseClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | ||
mouseDoubleClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | ||
mouseDownHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | ||
mouseEventToItemRenderer(event:MouseEvent):IListItemRenderer
Determines which item renderer is under the mouse. | ListBase | ||
mouseMoveHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | ||
mouseOutHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | ||
mouseOverHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | ||
mouseUpHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | ||
mouseWheelHandler(event:MouseEvent):void [override]
Handles mouseWheel events by changing scroll positions. | ListBase | ||
moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators horizontally. | ListBase | ||
moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically. | ListBase | ||
moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void
Move a row vertically, and update the rowInfo record. | ListBase | ||
moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
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 | ||
moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
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 | ||
prepareDataEffect(ce:CollectionEvent):void
Prepares the data effect for the collection event. | ListBase | ||
purgeItemRenderers():void
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes. | ListBase | ||
reKeyVisibleData():void
Update the keys in the visibleData hash table. | ListBase | ||
removeFromRowArrays(i:int):void
Remove a row from the arrays that store references to the row. | ListBase | ||
removeIndicators(uid:String):void
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | ListBase | ||
resourcesChanged():void
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 | ||
restoreRowArrays(modDeltaPos:int):void
Remove the requested number of rows from the beginning of the
arrays that store references to the rows. | ListBase | ||
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | ||
scrollHandler(event:Event):void
Default event handler for the scroll event. | ScrollControlBase | ||
scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change
in scroll position. | ListBase | ||
scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | ListBase | ||
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change
in scroll position. | ListBase | ||
seekPendingFailureHandler(data:Object, info:ListBaseSeekPending):void
The default failure handler when a seek fails due to a page fault. | ListBase | ||
seekPendingResultHandler(data:Object, info:ListBaseSeekPending):void
The default result handler when a seek fails due to a page fault. | ListBase | ||
seekPositionSafely(index:int):Boolean
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 | ||
setRowCount(v:int):void
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | ListBase | ||
setRowHeight(v:Number):void
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | ListBase | ||
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | ||
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | ||
shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void
Shift a row in the arrays that reference rows. | ListBase | ||
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | ||
sumRowHeights(startRowIdx:int, endRowIdx:int):Number
Determine the height of the requested set of rows. | ListBase | ||
truncateRowArrays(numRows:int):void
Remove all remaining rows from the end of the
arrays that store references to the rows. | ListBase | ||
UIDToItemRenderer(uid:String):IListItemRenderer
Find an item renderer based on its UID if it is visible. | ListBase | ||
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void [override]
Adds or removes item renderers if the number of displayable items
changed. | ListBase | ||
updateList():void
Refreshes all rows. | ListBase |
Event | Summary | Defined By | ||
---|---|---|---|---|
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 the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | |||
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 data property changes. | ListBase | |||
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 | |||
Dispatched after the component has entered a view state. | UIComponent | |||
Dispatched just before the component exits a view state. | UIComponent | |||
Dispatched when an object's state changes from visible to invisible. | UIComponent | |||
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 editedItemPosition property is set and the item can be edited. | List | |||
Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item. | List | |||
Dispatched when an item editing session is ending for any reason. | List | |||
Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. | List | |||
Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. | List | |||
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 from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | |||
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 at the beginning of the component initialization sequence. | UIComponent | |||
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 the component is resized. | UIComponent | |||
Dispatched when the content is scrolled. | ScrollControlBase | |||
Dispatched when an object's state changes from invisible to visible. | UIComponent | |||
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 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 | |||
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 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 |
Effect | Description | Defined By | ||
---|---|---|---|---|
Triggering Event: added Played when the component is added as a child to a Container. | UIComponent | |||
Triggering Event: creationComplete Played when the component is created. | UIComponent | |||
Triggering Event: focusIn Played when the component gains keyboard focus. | UIComponent | |||
Triggering Event: focusOut Played when the component loses keyboard focus. | UIComponent | |||
Triggering Event: hide Played when the component becomes invisible. | UIComponent | |||
itemsChangeEffect | Triggering Event: itemsChange The data effect to play when a change occur to the control's data provider. By default, the List control does not use a data effect. For the List control, use an instance of the the DefaultListEffect class to configure the data effect. | List | ||
Triggering Event: mouseDown Played when the user presses the mouse button while over the component. | UIComponent | |||
Triggering Event: mouseUp Played when the user releases the mouse button while over the component. | UIComponent | |||
Triggering Event: move Played when the component is moved. | UIComponent | |||
Triggering Event: removed Played when the component is removed from a Container. | UIComponent | |||
Triggering Event: resize Played when the component is resized. | UIComponent | |||
Triggering Event: rollOut Played when the user rolls the mouse so it is no longer over the component. | UIComponent | |||
Triggering Event: rollOver Played when the user rolls the mouse over the component. | UIComponent | |||
Triggering Event: show Played when the component becomes visible. | UIComponent |
editable | property |
editable:Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
A flag that indicates whether or not the user can edit
items in the data provider.
If true
, the item renderers in the control are editable.
The user can click on an item renderer to open an editor.
The default value is false
.
public function get editable():Boolean
public function set editable(value:Boolean):void
editedItemPosition | property |
editedItemPosition:Object
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The column and row index of the item renderer for the data provider item being edited, if any.
This Object has two fields, columnIndex
and
rowIndex
,
the zero-based column and item indexes of the item.
For a List control, the columnIndex
property is always 0;
for example: {columnIndex:0, rowIndex:3}
.
Setting this property scrolls the item into view and
dispatches the itemEditBegin
event to
open an item editor on the specified item,
This property can be used as the source for data binding.
public function get editedItemPosition():Object
public function set editedItemPosition(value:Object):void
editedItemRenderer | property |
editedItemRenderer:IListItemRenderer
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
A reference to the item renderer in the DataGrid control whose item is currently being edited.
From within an event listener for the itemEditBegin
and itemEditEnd
events,
you can access the current value of the item being edited
using the editedItemRenderer.data
property.
public function get editedItemRenderer():IListItemRenderer
editorDataField | property |
public var editorDataField:String = text
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The name of the property of the item editor that contains the new
data for the list item.
For example, the default itemEditor
is
TextInput, so the default value of the editorDataField
property is
"text"
, which specifies the text
property of the
the TextInput control.
editorHeightOffset | property |
public var editorHeightOffset:Number = 0
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The height of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.
Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
The default value is 0
.
editorUsesEnterKey | property |
public var editorUsesEnterKey: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 item editor uses Enter key.
If this property is set to true
, the item editor uses the Enter key and the
List will not look for the Enter key and move the editor in
response.
Changing this value while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
The default value is false
.
editorWidthOffset | property |
public var editorWidthOffset:Number = 0
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The width of the item editor, in pixels, relative to the size of the item renderer. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.
Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
The default value is 0
.
editorXOffset | property |
public var editorXOffset:Number = 0
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The x location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.
Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
The default value is 0
.
editorYOffset | property |
public var editorYOffset:Number = 0
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The y location of the upper-left corner of the item editor, in pixels, relative to the upper-left corner of the item. This property can be used to make the editor overlap the item renderer by a few pixels to compensate for a border around the editor.
Changing these values while the editor is displayed will have no effect on the current editor, but will affect the next item renderer that opens an editor.
The default value is 0
.
enableIME | property |
enableIME:Boolean
[read-only] Language Version : | ActionScript 3.0 |
Product Version : | Flex 4 |
Runtime Versions : | Flash Player 10, AIR 1.5 |
A flag that indicates whether the IME should be enabled when the component receives focus. If there is an editor, it will set enableIME accordingly.
public function get enableIME():Boolean
imeMode | property |
imeMode:String
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets focus, and sets it back to the previous value when the control loses focus.
The flash.system.IMEConversionMode class defines constants for the
valid values for this property.
You can also specify null
to specify no IME.
The default value is null
.
public function get imeMode():String
public function set imeMode(value:String):void
See also
itemEditor | property |
public var itemEditor:IFactory
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
The class factory for the item editor to use for the control, if the
editable
property is set to true
.
The default value is new ClassFactory(mx.controls.TextInput)
.
itemEditorInstance | property |
public var itemEditorInstance:IListItemRenderer
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
A reference to the currently active instance of the item editor, if it exists.
To access the item editor instance and the new item value when an
item is being edited, you use the itemEditorInstance
property. The itemEditorInstance
property
is not valid until after the event listener for
the itemEditBegin
event executes. Therefore, you typically
only access the itemEditorInstance
property from within
the event listener for the itemEditEnd
event.
The itemEditor
property defines the
class of the item editor
and, therefore, the data type of the item editor instance.
You do not set this property in MXML.
measuringObjects | property |
protected var measuringObjects:Dictionary
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
cache of measuring objects by factory
rendererIsEditor | property |
public var rendererIsEditor:Boolean = false
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Specifies whether the item renderer is also an item
editor. If this property is true
, Flex
ignores the itemEditor
property.
The default value is false
.
List | () | Constructor |
public function List()
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Constructor.
createItemEditor | () | method |
public function createItemEditor(colIndex:int, rowIndex:int):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Creates the item editor for the item renderer at the
editedItemPosition
using the editor
specified by the itemEditor
property.
This method sets the editor instance as the
itemEditorInstance
property.
You can call this method only from within the event listener
for the itemEditBegin
event. To create an editor
at other times, set the editedItemPosition
property
to generate the itemEditBegin
event.
Parameters
colIndex:int — The column index. Flex sets the value of this property to 0 for a List control.
| |
rowIndex:int — The index in the data provider of the item to be
edited.
|
createItemRenderer | () | method |
override public function createItemRenderer(data:Object):IListItemRenderer
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Get the appropriate renderer, using the default renderer if none is specified.
Parameters
data:Object — The object from which the item renderer is created.
|
IListItemRenderer — The renderer.
|
destroyItemEditor | () | method |
public function destroyItemEditor():void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Closes an item editor that is currently open on an item.
You typically call this method only from within the event listener
for the itemEditEnd
event, after
you call the preventDefault()
method to prevent
the default event listener from executing.
drawRowBackground | () | method |
protected function drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Draws a row background
at the position and height specified. This creates a Shape as a
child of the input Sprite and fills it with the appropriate color.
This method also uses the backgroundAlpha
style property
setting to determine the transparency of the background color.
Parameters
s:Sprite — A Sprite that will contain a display object
that contains the graphics for that row.
| |
rowIndex:int — The row's index in the set of displayed rows. The
header does not count; the top most visible row has a row index of 0.
This is used to keep track of the objects used for drawing
backgrounds so that a particular row can reuse the same display object
even though the index of the item that the row is rendering has changed.
| |
y:Number — The suggested y position for the background.
| |
height:Number — The suggested height for the indicator.
| |
color:uint — The suggested color for the indicator.
| |
dataIndex:int — The index of the item for that row in the
data provider. For example, this can be used to color the 10th item differently.
|
endEdit | () | method |
protected function endEdit(reason:String):Boolean
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Stops the editing of an item in the data provider.
When the user finished editing an item, the control calls this method.
It dispatches the itemEditEnd
event to start the process
of copying the edited data from
the itemEditorInstance
to the data provider and hiding the
itemEditorInstance
.
Parameters
reason:String — A constant defining the reason for the event
(such as "CANCELLED", "NEW_ROW", or "OTHER").
The value must be a member of the ListEventReason class.
|
Boolean — Returns true if preventDefault() is not called.
Otherwise, false .
|
See also
isItemEditable | () | method |
public function isItemEditable(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 editable.
Parameters
data:Object — The data provider item
|
Boolean — true if the item is editable
|
layoutEditor | () | method |
protected function layoutEditor(x:int, y:int, w:int, h:int):void
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Positions the item editor instance at the suggested position with the suggested dimensions. The Tree control overrides this method and adjusts the position to compensate for indentation of the renderer.
Parameters
x:int — The suggested x position for the indicator.
| |
y:int — The suggested y position for the indicator.
| |
w:int — The suggested width for the indicator.
| |
h:int — The suggested height for the indicator.
|
makeListData | () | method |
protected function makeListData(data:Object, uid:String, rowNum:int):BaseListData
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Creates a new ListData instance and populates the fields based on the input data provider item.
Parameters
data:Object — The data provider item used to populate the ListData.
| |
uid:String — The UID for the item.
| |
rowNum:int — The index of the item in the data provider.
|
BaseListData — A newly constructed ListData object.
|
itemEditBegin | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_BEGIN
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the editedItemPosition
property is set
and the item can be edited.
type
property of the event object for a
itemEditBegin
event, which indicates that an
item is ready to be edited.
The default listener for this event performs the following actions:
createItemEditor()
method.data
property
from the item to the editor. By default, the item editor object is an instance
of the TextInput control. You use the itemEditor
property of the
list control to specify a custom item editor class.itemEditorInstance
property of the list control
to reference the item editor instance.You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.
You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:
preventDefault()
to stop Flex from calling
the createItemEditor()
method as part
of the default event listener.itemEditor
property to the appropriate editor.createItemEditor()
method.The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | true |
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 for the item that is being edited. |
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_EDIT_BEGIN |
itemEditBeginning | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_BEGINNING
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item.
The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of thetype
property of the ListEvent object for a
itemEditBeginning
event, which indicates that the user has
prepared to edit an item, for example, by releasing the mouse button
over the item.
The default listener for this event sets the List.editedItemPosition
property to the item that has focus, which starts the item editing session.
You typically write your own event listener for this event to
disallow editing of a specific item or items.
Calling the preventDefault()
method from within your own
event listener for this event prevents the default listener from executing.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | true |
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 for the item that will be edited. This property is null if this event is generated by keyboard, as the item to be edited may be off-screen. |
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_EDIT_BEGIN |
itemEditEnd | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_END
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when an item editing session is ending for any reason.
The ListEvent.ITEM_EDIT_END constant defines the value of thetype
property of the ListEvent object for a
itemEditEnd
event, which indicates that an edit
session is ending.
The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:
editorDataField
property of the list control to determine
the property of the item editor containing the new data and updates
the data provider item with that new data. Since the default item editor
is the TextInput control, the default value of the editorDataField
property
is "text"
, to specify that the text
property of the
TextInput contains the new item data.destroyItemEditor()
method to close the item editor.You typically write an event listener for this event to perform the following actions:
itemEditEnd
event
if you want to return multiple values.preventDefault()
method
to stop Flex from passing the new data back to the list control and from closing
the editor. The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | true |
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 for the item that was edited. |
reason | A constant defining the reason for the event.
The value must be a member of the ListEventReson class. |
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_EDIT_END |
itemFocusIn | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_FOCUS_IN
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. Only dispatched if the list item is editable.
The ListEvent.ITEM_FOCUS_IN constant defines the value of thetype
property of the ListEvent object for an
itemFocusIn
event, which indicates that an item
has received the focus.
The properties of the event object have the following values:
Property | Value |
---|---|
bubbles | false |
cancelable | true |
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 editor instance for the item that is being edited. |
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_FOCUS_IN |
itemFocusOut | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_FOCUS_OUT
Language Version : | ActionScript 3.0 |
Product Version : | Flex 3 |
Runtime Versions : | Flash Player 9, AIR 1.1 |
Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. Only dispatched if the list item is editable.
The ListEvent.ITEM_FOCUS_OUT constant defines the value of thetype
property of the ListEvent object for an
itemFocusOut
event, which indicates that an item
has lost the focus.
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 editor instance for the item that was being edited. |
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_FOCUS_OUT |
<?xml version="1.0" encoding="utf-8"?> <!-- Licensed to the Apache Software Foundation (ASF) under one or more contributor license agreements. See the NOTICE file distributed with this work for additional information regarding copyright ownership. The ASF licenses this file to You under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License. --> <!-- Simple example to demonstrate the Halo List Control --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <fx:Script> <![CDATA[ [Bindable] public var selectedListItem:Object; ]]> </fx:Script> <fx:Declarations> <fx:Model id="mystates"> <states> <state label="Alabama" data="AL"/> <state label="Alaska" data="AK"/> <state label="Arizona" data="AZ"/> <state label="Arkansas" data="AR"/> <state label="California" data="CA"/> <state label="Colorado" data="CO"/> <state label="Connecticut" data="CT"/> </states> </fx:Model> </fx:Declarations> <s:Panel title="Halo List Control Example" width="75%" height="75%" horizontalCenter="0" verticalCenter="0"> <s:VGroup left="10" right="10" top="10" bottom="10"> <s:Label text="Select a state to see its abbreviation."/> <mx:List id="source" width="100%" color="blue" dataProvider="{mystates.state}" change="selectedListItem = List(event.currentTarget).selectedItem"/> <s:VGroup width="100%"> <s:Label text="Selected State: {selectedListItem.label}"/> <s:Label text="State abbreviation: {selectedListItem.data}"/> </s:VGroup> </s:VGroup> </s:Panel> </s:Application>