| Package | mx.controls |
| Class | public class List |
| Inheritance | List  ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IIMESupport |
| Subclasses | EmbossedList, FileSystemList, Menu, Tree |
| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
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. |
Show MXML Syntax
Hide MXML SyntaxThe <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
More examples
Creating a List control
Using a label function
Vertically aligning text in List control rows
Setting variable row height and wrapping List text
Alternating row colors in a List control
Using a custom item renderer
Specifying an icon to the List control
Creating an MX item renderer and item editor
Creating MX drop-in item renderers and item editors
Creating MX inline item renderers and editors
Creating MX item renderers and item editor components
Creating an MX item renderer in ActionScript
Working with MX item renderers
Example: Using an item renderer with an MX List control
Creating an editable cell in MX
Returning data from an MX item editor
Sizing and positioning an MX item editor
Creating an MX item editor that responds to the Enter key
MX item editor examples
Examples using MX item editors with the list-based controls
Example: Using a custom item editor with an MX List control
Using a label function
Vertically aligning text in List control rows
Setting variable row height and wrapping List text
Alternating row colors in a List control
Using a custom item renderer
Specifying an icon to the List control
Creating an MX item renderer and item editor
Creating MX drop-in item renderers and item editors
Creating MX inline item renderers and editors
Creating MX item renderers and item editor components
Creating an MX item renderer in ActionScript
Working with MX item renderers
Example: Using an item renderer with an MX List control
Creating an editable cell in MX
Returning data from an MX item editor
Sizing and positioning an MX item editor
Creating an MX item editor that responds to the Enter key
MX item editor examples
Examples using MX item editors with the list-based controls
Example: Using a custom item editor with an MX List control
Learn more
MX List control
List control user interaction
About MX item renderers
About the MX item renderer and item editor life cycle
Using MX cell editing events
Using drag-and-drop with list-based controls
Dragging and dropping between different list-based controls
Manually adding drag-and-drop support
Example: Handling drag and drop events in a list-based control
Drag and drop examples
List control user interaction
About MX item renderers
About the MX item renderer and item editor life cycle
Using MX cell editing events
Using drag-and-drop with list-based controls
Dragging and dropping between different list-based controls
Manually adding drag-and-drop support
Example: Handling drag and drop events in a list-based control
Drag and drop examples
Related API Elements
Public Properties
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation)
for this InteractiveObject instance. | InteractiveObject | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object. | DisplayObject | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | ListBase | |
| alpha : Number
Indicates the alpha transparency value of the object specified. | DisplayObject | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use. | DisplayObject | |
| blendShader : Shader [write-only]
Sets a shader that is used for blending the foreground and background. | DisplayObject | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| buttonMode : Boolean
Specifies the button mode of this sprite. | Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the
display object. | DisplayObject | |
| cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when
cacheAsBitmap is set to true. | DisplayObject | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control. | ListBase | |
| columnWidth : Number
The width of the control's columns. | ListBase | |
| constructor : Object
A reference to the class object or constructor function for a given object instance. | Object | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| contextMenu : NativeMenu
Specifies the context menu associated with this object. | InteractiveObject | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor. | ListBase | |
| dataProvider : Object
Set of data to be viewed. | ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | ListBase | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation. | ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | ListBase | |
| dropTarget : DisplayObject [read-only]
Specifies the display object over which the sprite is being dragged, or on
which the sprite was dropped. | Sprite | |
| 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 | |
| filters : Array
An indexed array that contains each filter object currently associated with the display object. | DisplayObject | |
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| focusRect : Object
Specifies whether this object displays a focus rectangle. | InteractiveObject | |
| graphics : Graphics [read-only]
Specifies the Graphics object that belongs to this sprite where vector
drawing commands can occur. | Sprite | |
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| hitArea : Sprite
Designates another sprite to serve as the hit area for a sprite. | Sprite | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | ListBase | |
| id : String
ID of the component. | UIComponent | |
| 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 | |
| loaderInfo : LoaderInfo [read-only]
Returns a LoaderInfo object containing information about loading the file
to which this display object belongs. | DisplayObject | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| mask : DisplayObject
The calling display object is masked by the specified mask object. | DisplayObject | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property. | ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | ListBase | |
| metaData : Object
Obtains the meta data object of the DisplayObject instance if meta data was stored alongside the
the instance of this DisplayObject in the SWF file through a PlaceObject4 tag. | DisplayObject | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled. | DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages. | InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| mouseX : Number [read-only]
Indicates the x coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| mouseY : Number [read-only]
Indicates the y coordinate of the mouse or user input device position, in pixels. | DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject. | DisplayObject | |
| needsSoftKeyboard : Boolean
Specifies whether a virtual keyboard (an on-screen, software keyboard) should display
when this InteractiveObject instance receives focus. | InteractiveObject | |
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| nullItemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| numChildren : int [read-only]
Returns the number of children of this object. | DisplayObjectContainer | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color. | DisplayObject | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| 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 | |
| root : DisplayObject [read-only]
For a display object in a loaded SWF file, the root property is the
top-most display object in the portion of the display list's tree structure represented by that SWF file. | DisplayObject | |
| rotation : Number [override]
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation. | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container. | UIComponent | |
| rowCount : int
Number of rows to be displayed. | ListBase | |
| rowHeight : Number
The height of the rows in pixels. | ListBase | |
| scale9Grid : Rectangle
The current scaling grid that is in effect. | DisplayObject | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollRect : Rectangle
The scroll rectangle bounds of the display object. | DisplayObject | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | ListBase | |
| selectedIndex : int
The index in the data provider of the selected item. | ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items. | ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider. | ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider. | ListBase | |
| selectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property
against items in the data provider. | ListBase | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows. | ListBase | |
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| softKeyboard : String
Controls the appearance of the soft keyboard. | InteractiveObject | |
| softKeyboardInputAreaOfInterest : Rectangle
Defines the area that should remain on-screen when a soft keyboard is displayed (not available on iOS). | InteractiveObject | |
| soundTransform : flash.media:SoundTransform
Controls sound within this sprite. | Sprite | |
| stage : Stage [read-only]
The Stage of the display object. | DisplayObject | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabChildren : Boolean
Determines whether the children of the object are tab enabled. | DisplayObjectContainer | |
| tabEnabled : Boolean
Specifies whether this object is in the tab order. | InteractiveObject | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file. | InteractiveObject | |
| textSnapshot : flash.text:TextSnapshot [read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance. | DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : flash.geom:Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| useHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls
over a sprite in which the buttonMode property is set to true. | Sprite | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | ListBase | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | ListBase | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
Indicates the z coordinate position along the z-axis of the DisplayObject
instance relative to the 3D parent container. | UIComponent | |
Protected Properties
| 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 | |
Public Methods
| Method | Defined By | ||
|---|---|---|---|
List()
Constructor. | List | ||
|
Adds a child DisplayObject instance to this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Adds a child DisplayObject instance to this DisplayObjectContainer
instance. | DisplayObjectContainer | |
|
Adds an item renderer if a data change effect is running. | ListBase | |
| addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener
receives notification of an event. | EventDispatcher | |
|
Adds a non-visual style client to this component instance. | UIComponent | |
|
Indicates whether the security restrictions
would cause any display objects to be omitted from the list returned by calling
the DisplayObjectContainer.getObjectsUnderPoint() method
with the specified point point. | DisplayObjectContainer | |
|
Returns the index where the dropped items should be added
to the drop target. | ListBase | |
|
Queues a function to be called later. | UIComponent | |
|
Deletes a style property from this component instance. | UIComponent | |
|
Determines whether the specified display object is a child of the DisplayObjectContainer instance or
the instance itself. | DisplayObjectContainer | |
|
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
|
Converts a Point object from content to local coordinates. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
|
Returns a set of properties that identify the child within
this container. | UIComponent | |
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | List | ||
[override]
Get the appropriate renderer, using the default renderer if none is specified. | List | ||
|
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
|
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
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 | |
| [override]
Dispatches an event into the event flow. | UIComponent | |
|
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
|
Called by the effect instance when it stops playing on the component. | UIComponent | |
|
Called by the effect instance when it starts playing on the component. | UIComponent | |
|
Ends all currently playing effects on the component. | UIComponent | |
|
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
|
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | |
|
Called after printing is complete. | UIComponent | |
|
Provides the automation object at the specified index. | UIComponent | |
|
Provides the automation object list . | UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object. | DisplayObject | |
|
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
|
Returns the child display object instance that exists at the specified index. | DisplayObjectContainer | |
|
Returns the child display object that exists with the specified name. | DisplayObjectContainer | |
|
Returns the index position of a child DisplayObject instance. | DisplayObjectContainer | |
|
Finds the type selectors for this UIComponent instance. | UIComponent | |
|
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
|
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
|
Gets the object that currently has focus. | UIComponent | |
|
Return the appropriate factory, using the default factory if none specified. | ListBase | |
|
Returns the element's layout height. | UIComponent | |
|
Returns the element's layout width. | UIComponent | |
|
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
|
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
|
Returns the layout transform Matrix3D for this element. | UIComponent | |
|
Returns the element's maximum height. | UIComponent | |
|
Returns the element's maximum width. | UIComponent | |
|
Returns the element's minimum height. | UIComponent | |
|
Returns the element's minimum width. | UIComponent | |
|
Returns an array of objects that lie under the specified point and are children
(or grandchildren, and so on) of this DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Returns the element's preferred height. | UIComponent | |
|
Returns the element's preferred width. | UIComponent | |
|
Returns a rectangle that defines the boundary of the display object,
based on the coordinate system defined by the targetCoordinateSpace
parameter, excluding any strokes on shapes. | DisplayObject | |
|
Returns true or false
to indicates whether the effect should play on the target. | ListBase | |
|
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
|
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
|
Converts a Point object from global to content coordinates. | UIComponent | |
|
Converts the point object from the Stage (global) coordinates
to the display object's (local) coordinates. | DisplayObject | |
|
Converts a two-dimensional point from the Stage (global) coordinates to a
three-dimensional display object's (local) coordinates. | DisplayObject | |
|
Returns true if currentCSSState is not null. | UIComponent | |
|
Checks whether the EventDispatcher object has any listeners registered for a specific type
of event. | EventDispatcher | |
|
Indicates whether an object has a specified property defined. | Object | |
|
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | |
|
Evaluates the bounding box of the display object to see if it overlaps or intersects with the
bounding box of the obj display object. | DisplayObject | |
|
Evaluates the display object to see if it overlaps or intersects with the
point specified by the x and y parameters. | DisplayObject | |
|
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
|
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | |
|
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | |
|
Initializes the internal structure of this component. | UIComponent | |
|
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
|
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
|
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
|
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
|
Refresh all rows on the next update. | ListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
Determines if the item renderer for a data provider item
is editable. | List | ||
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | |
|
Determines if the item renderer for a data provider item
is selectable. | ListBase | |
|
Determines if the item renderer for a data provider item
is selected. | ListBase | |
|
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | |
|
Determines if an item is being displayed by a renderer. | ListBase | |
|
Indicates whether an instance of the Object class is in the prototype chain of the object specified
as the parameter. | Object | |
|
Determines whether a renderer contains (or owns) a display object. | ListBase | |
|
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | |
|
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | |
|
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | |
|
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | |
|
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | |
|
Converts a three-dimensional point of the three-dimensional display
object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates. | DisplayObject | |
|
Converts a Point object from local to content coordinates. | UIComponent | |
|
Converts the point object from the display object's (local) coordinates to the
Stage (global) coordinates. | DisplayObject | |
|
Returns true if cssState matches currentCSSState. | UIComponent | |
|
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
|
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | |
|
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
|
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | |
|
Moves the component to a specified position within its parent. | UIComponent | |
|
Propagates style changes to the children. | UIComponent | |
|
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
|
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
|
Prepares an IFlexDisplayObject for printing. | UIComponent | |
|
Indicates whether the specified property exists and is enumerable. | Object | |
|
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
|
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
|
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes a child DisplayObject from the specified index position in the child list of
the DisplayObjectContainer. | DisplayObjectContainer | |
|
Removes all child DisplayObject instances from the child list of the DisplayObjectContainer instance. | DisplayObjectContainer | |
|
Removes an item renderer if a data change effect is running. | ListBase | |
|
Removes a listener from the EventDispatcher object. | EventDispatcher | |
|
Removes a non-visual style client from this component instance. | UIComponent | |
|
Replays the specified event. | UIComponent | |
|
Raises a virtual keyboard. | InteractiveObject | |
|
Resolves a child by using the id provided. | UIComponent | |
| [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
|
Ensures that the data provider item at the given index is visible. | ListBase | |
|
Sizes the object. | UIComponent | |
|
Changes the position of an existing child in the display object container. | DisplayObjectContainer | |
|
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
|
Set the current state. | UIComponent | |
|
Sets the focus to this component. | UIComponent | |
|
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
|
Sets the layout size of the element. | UIComponent | |
|
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
|
Sets the availability of a dynamic property for loop operations. | Object | |
|
Sets a style property on this component instance. | UIComponent | |
|
Called when the visible property changes. | UIComponent | |
|
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | |
|
Lets the user drag the specified sprite. | Sprite | |
|
Lets the user drag the specified sprite on a touch-enabled device. | Sprite | |
|
Recursively stops the timeline execution of all MovieClips rooted at this object. | DisplayObjectContainer | |
|
Ends the startDrag() method. | Sprite | |
|
Ends the startTouchDrag() method, for use with touch-enabled devices. | Sprite | |
|
Detects changes to style properties. | UIComponent | |
|
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
|
Swaps the z-order (front-to-back order) of the two specified child objects. | DisplayObjectContainer | |
|
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the
child list. | DisplayObjectContainer | |
|
Returns the string representation of this object, formatted according to locale-specific conventions. | Object | |
| [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
|
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
|
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | |
|
Validates the position and size of children and draws other
visuals. | UIComponent | |
|
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
|
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
|
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
|
Returns the primitive value of the specified object. | Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type. | EventDispatcher | |
Protected Methods
| Method | Defined By | ||
|---|---|---|---|
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation. | ListBase | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it. | ListBase | |
|
Add a blank row to the beginning of the arrays that store references to the rows. | ListBase | |
|
Adjust the focus rectangle. | UIComponent | |
|
Called from the updateDisplayList() method to adjust the size and position of
listContent. | ListBase | |
|
Commits the computed matrix built from the combination of the layout
matrix and the transform offsets to the flash displayObject's transform. | UIComponent | |
|
Sets up the effect for applying the selection indicator. | ListBase | |
|
This is an internal method used by the Flex framework
to support the Dissolve effect. | UIComponent | |
|
Calculates the y position of the drop indicator
when performing a drag-and-drop operation. | ListBase | |
|
Determines if the call to the measure() method can be skipped. | UIComponent | |
|
Performs any final processing after child objects are created. | UIComponent | |
|
Clears the caret indicator into the given Sprite. | ListBase | |
|
Clears the highlight indicator in the given Sprite. | ListBase | |
|
Removes all selection and highlight and caret indicators. | ListBase | |
|
Clears the set of selected items and removes all graphics
depicting the selected state of those items. | ListBase | |
|
Empty the visibleData hash table. | ListBase | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes. | ListBase | |
| [override]
Calculates the column width and row height and number of rows and
columns based on whether properties like columnCount
columnWidth, rowHeight and
rowCount were explicitly set. | ListBase | |
|
Configures the ScrollBars based on the number of rows and columns and
viewable rows and columns. | ListBase | |
|
Makes a deep copy of the object by calling the
ObjectUtil.copy() method, and replaces
the copy's uid property (if present) with a
new value by calling the UIDUtil.createUID() method. | ListBase | |
|
Copies the selected items in the order that they were selected. | ListBase | |
|
Creates the border for this component. | ScrollControlBase | |
| [override]
Creates objects that are children of this ListBase; in this case,
the listContent object that will hold all the item
renderers. | ListBase | |
|
Creates a new object using a context
based on the embedded font being used. | UIComponent | |
|
Creates the object using a given moduleFactory. | UIComponent | |
|
Recycle a row that is no longer needed, and remove its indicators. | ListBase | |
|
Helper method for dispatching a PropertyChangeEvent
when a property is updated. | UIComponent | |
|
Handles DragEvent.DRAG_COMPLETE events. | ListBase | |
|
Handles DragEvent.DRAG_DROP events. | ListBase | |
|
Handles DragEvent.DRAG_ENTER events. | ListBase | |
|
Handles DragEvent.DRAG_EXIT events. | ListBase | |
|
Handles DragEvent.DRAG_OVER events. | ListBase | |
|
Interval function that scrolls the list up or down
if the mouse goes above or below the list. | ListBase | |
|
The default handler for the dragStart event. | ListBase | |
| drawCaretIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the caret indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | |
| drawHighlightIndicator(indicator:Sprite, x:Number, y:Number, width:Number, height:Number, color:uint, itemRenderer:IListItemRenderer):void
Draws the highlight indicator into the given Sprite
at the position, width and height specified using the
color specified. | ListBase | |
| drawItem(item:IListItemRenderer, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws the renderer with indicators
that it is highlighted, selected, or the caret. | ListBase | |
Draws a row background
at the position and height specified. | List | ||
|
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 | |
Stops the editing of an item in the data provider. | List | ||
|
Tries to find the next item in the data provider that
starts with the character in the eventCode parameter. | ListBase | |
|
Cleans up after a data change effect has finished running
by restoring the original collection and iterator and removing
any cached values used by the effect. | ListBase | |
|
Sets selected items based on the caretIndex and
anchorIndex properties. | ListBase | |
|
The event handler called when a UIComponent object gets focus. | UIComponent | |
|
The event handler called when a UIComponent object loses focus. | UIComponent | |
|
Retrieves an already-created item renderer not currently in use. | ListBase | |
|
The column for the data provider item at the given index. | ListBase | |
|
The row for the data provider item at the given index. | ListBase | |
|
Initializes the implementation and storage of some of the less frequently
used advanced layout features of a component. | UIComponent | |
|
Finalizes the initialization of this component. | UIComponent | |
|
Initializes this component's accessibility code. | UIComponent | |
|
Initiates a data change effect when there have been changes
in the data provider. | ListBase | |
|
Helper method to invalidate parent size and display list if
this object affects its layout (includeInLayout is true). | UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus. | UIComponent | |
|
Returns true if an item renderer is no longer being positioned
by the list's layout algorithm while a data change effect is
running as a result of a call to the unconstrainRenderer() method. | ListBase | |
|
Returns a Point containing the columnIndex and rowIndex of an
item renderer. | ListBase | |
|
Determines the UID for a data provider item. | ListBase | |
|
The event handler called for a keyDown event. | UIComponent | |
|
The event handler called for a keyUp event. | UIComponent | |
|
Responds to size changes by setting the positions and sizes
of this control's borders. | ScrollControlBase | |
Positions the item editor instance at the suggested position
with the suggested dimensions. | List | ||
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 | |
| [override]
Calculates the measured width and height of the component based
on the rowCount,
columnCount, rowHeight and
columnWidth properties. | ListBase | |
|
Handles MouseEvent.MOUSE_CLICK events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any
mouse targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Determines which item renderer is under the mouse. | ListBase | |
|
Handles MouseEvent.MOUSE_MOVE events from any mouse
targets contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OUT events from any mouse targets
contained in the list including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_OVER events from any mouse
targets contained in the list, including the renderers. | ListBase | |
|
Handles MouseEvent.MOUSE_DOWN events from any mouse
targets contained in the list including the renderers. | ListBase | |
| [override]
Handles mouseWheel events by changing scroll positions. | ListBase | |
|
Move the selection and highlight indicators horizontally. | ListBase | |
|
Move the selection and highlight indicators vertically. | ListBase | |
|
Move a row vertically, and update the rowInfo record. | ListBase | |
|
Moves the selection in a horizontal direction in response
to the user selecting items using the left arrow or right arrow
keys and modifiers such as the Shift and Ctrl keys. | ListBase | |
|
Moves the selection in a vertical direction in response
to the user selecting items using the up arrow or down arrow
Keys and modifiers such as the Shift and Ctrl keys. | ListBase | |
|
Prepares the data effect for the collection event. | ListBase | |
|
Called by the updateDisplayList() method to remove existing item renderers
and clean up various caching structures when the renderer changes. | ListBase | |
|
Update the keys in the visibleData hash table. | ListBase | |
|
Remove a row from the arrays that store references to the row. | ListBase | |
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider. | ListBase | |
|
This method is called when a UIComponent is constructed,
and again whenever the ResourceManager dispatches
a "change" Event to indicate
that the localized resources have changed in some way. | UIComponent | |
|
Remove the requested number of rows from the beginning of the
arrays that store references to the rows. | ListBase | |
|
Determines if there is enough space in this component to display
a given scrollbar. | ScrollControlBase | |
|
Default event handler for the scroll event. | ScrollControlBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
Returns the data provider index for the item at the first visible
row and column for the given scroll positions. | ListBase | |
|
Adjusts the renderers in response to a change
in scroll position. | ListBase | |
|
The default failure handler when a seek fails due to a page fault. | ListBase | |
|
The default result handler when a seek fails due to a page fault. | ListBase | |
|
Seek to a position, and handle an ItemPendingError if necessary. | ListBase | |
| selectItem(item:IListItemRenderer, shiftKey:Boolean, ctrlKey:Boolean, transition:Boolean = true):Boolean
Updates the set of selected items given that the item renderer provided
was clicked by the mouse and the keyboard modifiers are in the given
state. | ListBase | |
|
Sets the rowCount property without causing
invalidation or setting the explicitRowCount
property, which permanently locks in the number of rows. | ListBase | |
|
Sets the rowHeight property without causing invalidation or
setting of explicitRowHeight which
permanently locks in the height of the rows. | ListBase | |
|
Causes the ScrollControlBase to show or hide scrollbars based
on the parameters passed in. | ScrollControlBase | |
|
Specifies a transform stretch factor in the horizontal and vertical direction. | UIComponent | |
|
Shift a row in the arrays that reference rows. | ListBase | |
|
This method is called when a state changes to check whether
state-specific styles apply to this component. | UIComponent | |
|
Determine the height of the requested set of rows. | ListBase | |
|
Remove all remaining rows from the end of the
arrays that store references to the rows. | ListBase | |
|
Find an item renderer based on its UID if it is visible. | ListBase | |
| [override]
Adds or removes item renderers if the number of displayable items
changed. | ListBase | |
|
Refreshes all rows. | ListBase | |
Events
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| [broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active. | EventDispatcher | ||
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when a display object is added to the display list. | DisplayObject | ||
| Dispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained. | DisplayObject | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | ||
| Dispatched when the user selects 'Clear' (or 'Delete') from the text context menu. | InteractiveObject | ||
| Dispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu. | InteractiveObject | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu. | InteractiveObject | ||
| Dispatched when the data property changes. | ListBase | ||
| [broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive. | EventDispatcher | ||
| Dispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true. | InteractiveObject | ||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| [broadcast event] Dispatched when the playhead is exiting the current frame. | DisplayObject | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| [broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run. | DisplayObject | ||
| Dispatched when the user creates a point of contact along the edge of the touch surface with an InteractiveObject instance, (such as tapping along the edge of the touch surface on Siri Remote for Apple TV) Some devices might also interpret this contact as a combination of several touch events, as well. | InteractiveObject | ||
| Dispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a finger from left to right over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| This event is dispatched to any client app that supports inline input with an IME | InteractiveObject | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
| Dispatched when the 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 when the user presses a key. | InteractiveObject | ||
| Dispatched when the user attempts to change focus by using keyboard navigation. | InteractiveObject | ||
| Dispatched when the user releases a key. | InteractiveObject | ||
| Dispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the middle pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched when the user attempts to change focus by using a pointer device. | InteractiveObject | ||
| Dispatched when a user moves the pointing device while it is over an InteractiveObject. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched by the drag initiator InteractiveObject when the user releases the drag gesture. | InteractiveObject | ||
| Dispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop(). | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture enters its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject when a drag gesture leaves its boundary. | InteractiveObject | ||
| Dispatched by an InteractiveObject continually while a drag gesture remains within its boundary. | InteractiveObject | ||
| Dispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call. | InteractiveObject | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu. | InteractiveObject | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the user lowers an active stylus past the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user lifts an active stylus above the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over the screen while remaining within the proximity detection threshold. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus directly above this InteractiveObject while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus away from this InteractiveObject and any of its children while remaining within the proximity detection threshold of the screen. | InteractiveObject | ||
| Dispatched when the user moves an active stylus over this InteractiveObject from outside the object's tree of descendents in the display list (while remaining within the proximity detection threshold of the screen). | InteractiveObject | ||
| Dispatched when a user releases the button on the pointing device after the user first pressed the button over an InteractiveObject instance and then moved the pointing device off of the InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when a display object is about to be removed from the display list. | DisplayObject | ||
| Dispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained. | DisplayObject | ||
| [broadcast event] Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject. | InteractiveObject | ||
| Dispatched when a user presses the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device away from an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the user moves a pointing device over an InteractiveObject instance. | InteractiveObject | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when the user activates the platform-specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu. | InteractiveObject | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched immediately after the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately before the soft keyboard is raised. | InteractiveObject | ||
| Dispatched immediately after the soft keyboard is lowered. | InteractiveObject | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched when the value of the object's tabChildren flag changes. | InteractiveObject | ||
| Dispatched when the object's tabEnabled flag changes. | InteractiveObject | ||
| Dispatched when the value of the object's tabIndex property changes. | InteractiveObject | ||
| Dispatched when a user enters one or more characters of text. | InteractiveObject | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| Dispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when the user touches the device, and is continuously dispatched until the point of contact is removed. | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outside the display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen). | InteractiveObject | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
Styles
Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.
Common Styles
Spark Theme Styles
Halo Theme Styles
Effects
| 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 | ||
Public Constants
Property Detail
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.
Implementation
public function get editable():Boolean public function set editable(value:Boolean):voideditedItemPosition | 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. When this property is modified, it dispatches the itemFocusIn event.
Implementation
public function get editedItemPosition():Object public function set editedItemPosition(value:Object):voideditedItemRenderer | 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.
Implementation
public function get editedItemRenderer():IListItemRenderereditorDataField | 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.
Implementation
public function get enableIME():BooleanimeMode | 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.
Implementation
public function get imeMode():String public function set imeMode(value:String):voidRelated API Elements
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).
More examples
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.
Constructor Detail
List | () | Constructor |
public function List()| Language Version: | ActionScript 3.0 |
| Product Version: | Flex 3 |
| Runtime Versions: | Flash Player 9, AIR 1.1 |
Constructor.
Method Detail
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.
|
Related API Elements
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.
|
Event Detail
itemEditBegin | Event |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
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:
- Creates an item editor object via a call to the
createItemEditor()method. - Copies the
dataproperty from the item to the editor. By default, the item editor object is an instance of the TextInput control. You use theitemEditorproperty of the list control to specify a custom item editor class. - Set the
itemEditorInstanceproperty 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:
- Call
preventDefault()to stop Flex from calling thecreateItemEditor()method as part of the default event listener. - Set the
itemEditorproperty to the appropriate editor. - Call the
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 |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
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 |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
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:
- Uses the
editorDataFieldproperty 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 theeditorDataFieldproperty is"text", to specify that thetextproperty of the TextInput contains the new item data. - Calls the
destroyItemEditor()method to close the item editor.
You typically write an event listener for this event to perform the following actions:
- In your event listener, you can modify the data returned by the editor
to the list component. For example, you can reformat the data before returning
it to the list control. By default, an item editor can only return a single value.
You must write an event listener for the
itemEditEndevent if you want to return multiple values. - In your event listener, you can examine the data entered into the item editor.
If the data is incorrect, you can call the
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 |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
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 |
Event Object Type:
property ListEvent.type =
mx.events.ListEventproperty ListEvent.type =
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 |
Examples How to use this example
SimpleList.mxml
<?xml version="1.0" encoding="utf-8"?>
<!-- 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>
Mon Apr 10 2017, 12:28 PM -07:00