| Package | mx.controls |
| Class | public class List |
| Inheritance | List  ListBase ScrollControlBase UIComponent FlexSprite Sprite DisplayObjectContainer InteractiveObject DisplayObject EventDispatcher Object |
| Implements | IIMESupport |
| Subclasses | EmbossedList, Menu, Tree |
allowMultipleSelection property.
MXML Syntax
Hide MXML Syntax
The <mx:List> tag inherits all the tag attributes
of its superclass, and adds the following tag attributes:
Show MXML Syntax
<mx:List
Properties
editable="false|true"
editedItemPosition="No default"
editorDataField="text"
editorHeightOffset="0"
editorUsesEnterKey="false|true"
editorWidthOffset="0"
editorXOffset="0"
editorYOffset="0"
imeMode="null"
itemEditor="TextInput"
itemEditorInstance="Current item editor"
rendererIsEditor="false|true"
Styles
backgroundDisabledColor="0xDDDDDD"
Events
itemEditBegin="No default"
itemEditEnd="No default"
itemEditBeginning="No default"
itemFocusIn="No default"
itemFocusOut="No default"
/>
Default MXML PropertydataProvider
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
| DisplayObject | |
| 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 | |
| automationName : String
| UIComponent | |
| automationTabularData : Object
[read-only]
| 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 | |
| baselinePosition : Number
[read-only]
The baseline position for the control.
| List | ||
| blendMode : String
A value from the BlendMode class that specifies which blend mode to use.
| DisplayObject | |
| borderMetrics : EdgeMetrics
[read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom.
| ScrollControlBase | |
| buttonMode : Boolean
Specifies the button mode of this sprite.
| Sprite | |
| cacheAsBitmap : Boolean
If set to true, Flash Player caches an internal bitmap representation of the
display object.
| 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 : ContextMenu
Specifies the context menu associated with this object.
| InteractiveObject | |
| currentState : String
The current view state of the component.
| 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 | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance.
| UIComponent | |
| document : Object
A reference to the document object associated with this UIComponent.
| UIComponent | |
| doubleClickEnabled : Boolean
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 = false
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 | |
| errorString : String
The text that will be 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
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMaxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| explicitMinWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| 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 | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when clicked on.
| 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 | |
| height : Number
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 | |
| 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 | |
| isDocument : Boolean
[read-only]
Determines whether this UIComponent instance is a document object,
that is, whether it is at the top of the hierarchy of a Flex
application, MXML component, or ActionScript component.
| 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 | |
| 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 | |
| lockedColumnCount : int
The index of the first column in the control that scrolls.
| ListBase | |
| lockedRowCount : int
The index of the first row in the control that scrolls.
| ListBase | |
| mask : DisplayObject
The calling display object is masked by the specified mask object.
| DisplayObject | |
| maxHeight : Number
Number that specifies the maximum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
| ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
| ScrollControlBase | |
| maxWidth : Number
Number that specifies the maximum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels.
| UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels.
| UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels.
| UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels.
| UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used.
| ListBase | |
| minHeight : Number
Number that specifies the minimum height of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| minWidth : Number
Number that specifies the minimum width of the component,
in pixels, in the component's coordinates.
| UIComponent | |
| moduleFactory : IFlexModuleFactory | UIComponent | |
| mouseChildren : Boolean
Determines whether or not the children of the object are mouse enabled.
| DisplayObjectContainer | |
| mouseEnabled : Boolean
Specifies whether this object receives mouse messages.
| InteractiveObject | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
| UIComponent | |
| mouseX : Number
[read-only]
Indicates the x coordinate of the mouse position, in pixels.
| DisplayObject | |
| mouseY : Number
[read-only]
Indicates the y coordinate of the mouse position, in pixels.
| DisplayObject | |
| name : String
Indicates the instance name of the DisplayObject.
| DisplayObject | |
| 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 | |
| numAutomationChildren : int
[read-only]
| UIComponent | |
| numChildren : int
[read-only]
Returns the number of children of this object.
| DisplayObjectContainer | |
| opaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
| DisplayObject | |
| owner : DisplayObjectContainer
The owner of this UIComponent.
| UIComponent | |
| parent : DisplayObjectContainer
[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
Number that specifies the height of a component as a percentage
of its parent's size.
| UIComponent | |
| percentWidth : Number
Number that specifies the width of a component as a percentage
of its parent's size.
| UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens.
| UIComponent | |
| prototype : Object
[static]
A reference to the prototype object of a class or function object.
| Object | |
| 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 | |
| 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
Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
| DisplayObject | |
| 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
Number that specifies the horizontal scaling factor.
| UIComponent | |
| scaleY : Number
Number that specifies the vertical scaling percentage.
| 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 | |
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows.
| ListBase | |
| showInAutomationHierarchy : Boolean
| UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged.
| ScrollControlBase | |
| soundTransform : 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 | |
| styleName : Object
The class style used by this component.
| 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 | |
| tabIndex : int
Specifies the tab ordering of objects in a SWF file.
| InteractiveObject | |
| textSnapshot : TextSnapshot
[read-only]
Returns a TextSnapshot object for this DisplayObjectContainer instance.
| DisplayObjectContainer | |
| toolTip : String
Text to display in the ToolTip.
| UIComponent | |
| transform : Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
| DisplayObject | |
| 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 mouse 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 | |
| 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
Controls the visibility of this UIComponent.
| UIComponent | |
| width : Number
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
Number that specifies the component's horizontal position,
in pixels, within its parent container.
| UIComponent | |
| y : Number
Number that specifies the component's vertical position,
in pixels, within its parent container.
| UIComponent | |
| 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 | |
|
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 | |
|
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 | |
|
| UIComponent | |
|
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property.
| List | ||
|
| UIComponent | |
|
| 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 | |
| UIComponent | ||
|
Shows or hides the focus indicator around this component.
| UIComponent | |
|
drawRoundRect(x:Number, y:Number, width:Number, height:Number, cornerRadius:Object = null, color:Object = null, alpha:Object = null, gradientMatrix:Matrix = null, gradientType:String = "linear", gradientRatios:Array = null, hole:Object = null):void
Programatically 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 the data bindings into this UIComponent object.
| UIComponent | |
|
Finds an item in the list based on a string
and moves the selection to it.
| ListBase | |
|
Called after printing is complete.
| UIComponent | |
|
| UIComponent | |
|
Returns a rectangle that defines the area of the display object relative to the coordinate system
of the targetCoordinateSpace object.
| DisplayObject | |
|
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 | |
|
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 | |
|
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 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 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 | |
|
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 | |
|
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed.
| ListBase | |
|
Evaluates the display object to see if it overlaps or intersects with 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 | |
|
Refresh all rows on next update.
| ListBase | |
|
Marks a component so that its commitProperties()
method gets called during a later screen update.
| UIComponent | |
|
Marks a component so that its measure()
method gets called during a later screen update.
| UIComponent | |
|
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or
or under the caret via keyboard navigation).
| ListBase | |
|
Determines if the item renderer for a data provider item
is selected.
| 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 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 | |
|
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 may 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 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 | |
|
Propagate 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, register 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 a listener from the EventDispatcher object.
| EventDispatcher | |
|
| UIComponent | |
|
| 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 | |
|
Set the current state.
| UIComponent | |
|
Sets the focus to this component.
| 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 | |
|
Ends the startDrag() method.
| 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 a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application.
| FlexSprite | |
|
| 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 | |
|
| UIComponent | |
|
Handles both the valid and invalid events from a
validator assigned to this component.
| UIComponent | |
|
Returns the primitive value of the specified object.
| Object | |
|
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient.
| UIComponent | |
|
Checks whether an event listener is registered with this EventDispatcher object or any of
its ancestors for the specified event type.
| EventDispatcher | |
| Method | Defined By | ||
|---|---|---|---|
|
Adds the selected items to the DragSource object as part of a
drag-and-drop operation.
| ListBase | |
|
Adds a renderer to the recycled renderer list,
making it invisible and cleaning up references to it.
| ListBase | |
|
Adjust the focus rectangle.
| 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 | |
|
Performs any final processing after child objects are created.
| UIComponent | |
|
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 | |
|
Handles CollectionEvents dispatched from the data provider
as the data changes.
| ListBase | |
|
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 copy of the selected items in the order they were
selected.
| ListBase | |
|
Creates the border for this component.
| ScrollControlBase | |
|
Create objects that are children of this ListBase, in this case
the listContent object that will hold all the item
renderers.
| ListBase | |
|
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 | |
|
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 | |
|
The column for the data provider item at the given index.
| ListBase | |
|
The row for the data provider item at the given index.
| ListBase | |
|
Finalizes the initialization of this component.
| UIComponent | |
|
Initializes this component's accessibility code.
| UIComponent | |
|
Typically overridden by components containing UITextField objects,
where the UITextField object gets focus.
| UIComponent | |
|
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 | |
|
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 | |
|
Handles mouseWheel events by changing scroll positions.
| 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 | |
|
Cleans up selection highlights and other associated graphics
for a given item in the data provider.
| ListBase | |
|
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 | |
|
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 | |
|
Adds or removes item renderers if the number of displayable items
changed.
| ListBase | |
|
Refreshes all rows now.
| ListBase | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when Flash Player 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() or addChildAt() 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 a user presses and releases the main button of the user's pointing device over the same InteractiveObject. | 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 data property changes. | ListBase | ||
| Dispatched when Flash Player loses operating 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 after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched when the playhead is entering a new frame. | DisplayObject | ||
| Dispatched after the component has returned to the root view state. | UIComponent | ||
| Dispatched before the component exits from the root view state. | UIComponent | ||
| Dispatched after a display object gains focus. | InteractiveObject | ||
| Dispatched after a display object loses focus. | InteractiveObject | ||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
| Dispatched when the editedItemPosition property is set and the item can be edited. | List | |||
| Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item. | List | |||
| Dispatched when an item editing session is ending for any reason. | List | |||
| Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. | List | |||
| Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. | List | |||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | ListBase | ||
| Dispatched when the user rolls the mouse pointer over an item in the control. | ListBase | ||
| Dispatched 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 the pointing device button over an InteractiveObject instance in the Flash Player window. | 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 in the Flash Player window. | InteractiveObject | ||
| Dispatched when a user releases the pointing device button over an InteractiveObject instance in the Flash Player window. | InteractiveObject | ||
| Dispatched when a mouse wheel is spun over an InteractiveObject instance in the Flash Player window. | 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 at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild() or removeChildAt() 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 | ||
| Dispatched when the display list is about to be updated and rendered. | DisplayObject | ||
| Dispatched when the component is resized. | UIComponent | ||
| 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 an object's state changes from invisible to visible. | 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 by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and will 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 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 | ||
| baselinePosition | property |
baselinePosition:Number [read-only] The baseline position for the control. If there are any items in the list, the baseline position is computed based on the baseline position of item renderer. The baseline position is the y-coordinate of the first line of text of the component.
public function get baselinePosition():Number
| editable | property |
public var editable:Boolean = false
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.
| editedItemPosition | property |
editedItemPosition:Object [read-write] The column and row index of the item renderer for the data provider item being edited, if any.
This Object has two fields, columnIndex and
rowIndex,
the zero-based column and item indexes of the item.
For a List control, the columnIndex property is always 0;
for example: {columnIndex:0, rowIndex:3}.
Setting this property scrolls the item into view and
dispatches the itemEditBegin event to
open an item editor on the specified item,
This property can be used as the source for data binding.
public function get editedItemPosition():Object
public function set editedItemPosition(value:Object):void
| editedItemRenderer | property |
editedItemRenderer:IListItemRenderer [read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
From within an event listener for the itemEditBegin
and itemEditEnd events,
you can access the current value of the item being edited
using the editedItemRenderer.data property.
public function get editedItemRenderer():IListItemRenderer
| editorDataField | property |
public var editorDataField:String = "text"
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
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
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
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
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
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.
| imeMode | property |
imeMode:String [read-write] Specifies the IME (input method editor) mode. The IME enables users to enter text in Chinese, Japanese, and Korean. Flex sets the specified IME mode when the control gets focus, and sets it back to the previous value when the control loses focus.
The flash.system.IMEConversionMode class defines constants for the
valid values for this property.
You can also specify null to specify no IME.
The default value is null.
public function get imeMode():String
public function set imeMode(value:String):void
See also
| itemEditor | property |
public var itemEditor:IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true.
The default value is new ClassFactory(mx.controls.TextInput).
| itemEditorInstance | property |
public var itemEditorInstance:IListItemRenderer
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.
| rendererIsEditor | property |
public var rendererIsEditor:Boolean = false
Specifies whether the item renderer is also an item
editor. If this property is true, Flex
ignores the itemEditor property.
The default value is false.
| List | () | Constructor |
public function List()
Constructor.
| createItemEditor | () | method |
public function createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property.
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.
|
| destroyItemEditor | () | method |
public function destroyItemEditor():void
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
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
Stops the editing of an item in the data provider.
When the user finished editing an item, the control calls this method.
It dispatches the itemEditEnd event to start the process
of copying the edited data from
the itemEditorInstance to the data provider and hiding the
itemEditorInstance.
Parameters
reason:String — A constant defining the reason for the event
(such as "CANCELLED", "NEW_ROW", or "OTHER").
The value must be a member of the ListEventReason class.
|
Boolean — Returns true if preventDefault() is not called.
Otherwise, false.
|
See also
| layoutEditor | () | method |
protected function layoutEditor(x:int, y:int, w:int, h:int):void
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
Creates a new ListData instance and populates the fields based on the input data provider item.
Parameters
data:Object — The data provider item used to populate the ListData.
|
|
uid:String — The UID for the item.
|
|
rowNum:int — The index of the item in the data provider.
|
BaseListData — A newly constructed ListData object.
|
| itemEditBegin | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_BEGIN
Dispatched when the editedItemPosition property is set
and the item can be edited.
type property of the event object for a
itemEditBegin event, which indicates that an
item is ready to be edited.
The default listener for this event performs the following actions:
createItemEditor() method.data property
from the item to the editor. By default, the item editor object is an instance
of the TextInput control. You use the itemEditor property of the
list control to specify a custom item editor class.itemEditorInstance property of the list control
to reference the item editor instance.You can write an event listener for this event to modify the data passed to the item editor. For example, you might modify the data, its format, or other information used by the item editor.
You can also create an event listener to specify the item editor used to edit the item. For example, you might have two different item editors. Within the event listener you can examine the data to be edited or other information, and open the appropriate item editor by doing the following:
preventDefault() to stop Flex from calling
the createItemEditor() method as part
of the default event listener.itemEditor property to the appropriate editor.createItemEditor() method.The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer for the item that is being edited. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_EDIT_BEGIN |
| itemEditBeginning | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_BEGINNING
Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item.
The ListEvent.ITEM_EDIT_BEGINNING constant defines the value of thetype property of the ListEvent object for a
itemEditBeginning event, which indicates that the user has
prepared to edit an item, for example, by releasing the mouse button
over the item.
The default listener for this event sets the List.editedItemPosition
property to the item that has focus, which starts the item editing session.
You typically write your own event listener for this event to
disallow editing of a specific item or items.
Calling the preventDefault() method from within your own
event listener for this event prevents the default listener from executing.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer for the item that will be edited. This property is null if this event is generated by keyboard, as the item to be edited may be off-screen. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_EDIT_BEGIN |
| itemEditEnd | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_EDIT_END
Dispatched when an item editing session is ending for any reason.
The ListEvent.ITEM_EDIT_END constant defines the value of thetype property of the ListEvent object for a
itemEditEnd event, which indicates that an edit
session is ending.
The list components have a default handler for this event that copies the data from the item editor to the data provider of the list control. The default event listener performs the following actions:
editorDataField property of the list control to determine
the property of the item editor containing the new data and updates
the data provider item with that new data. Since the default item editor
is the TextInput control, the default value of the editorDataField property
is "text", to specify that the text property of the
TextInput contains the new item data.destroyItemEditor() method to close the item editor.You typically write an event listener for this event to perform the following actions:
itemEditEnd event
if you want to return multiple values.preventDefault() method
to stop Flex from passing the new data back to the list control and from closing
the editor. The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item renderer for the item that was edited. |
reason | A constant defining the reason for the event.
The value must be a member of the ListEventReson class. |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_EDIT_BEGIN |
| itemFocusIn | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_FOCUS_IN
Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. Only dispatched if the list item is editable.
The ListEvent.ITEM_FOCUS_IN constant defines the value of thetype property of the ListEvent object for an
itemFocusIn event, which indicates that an item
has received the focus.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item editor instance for the item that is being edited. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_FOCUS_IN |
| itemFocusOut | Event |
mx.events.ListEvent
mx.events.ListEvent.ITEM_FOCUS_OUT
Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. Only dispatched if the list item is editable.
The ListEvent.ITEM_FOCUS_OUT constant defines the value of thetype property of the ListEvent object for an
itemFocusOut event, which indicates that an item
has lost the focus.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
columnIndex | The zero-based index of the column associated with the event. |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
itemRenderer | The item editor instance for the item that was being edited. |
reason | null |
rowIndex | The zero-based index of the item associated with the event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
Type | ListEvent.ITEM_FOCUS_OUT |
<?xml version="1.0"?>
<!-- Simple example to demonstrate the List Control -->
<mx:Application xmlns:mx="http://www.adobe.com/2006/mxml">
<mx:Script>
<![CDATA[
[Bindable]
public var selectedItem:Object;
]]>
</mx:Script>
<mx: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>
</mx:Model>
<mx:Panel title="List Control Example" height="75%" width="75%"
paddingTop="10" paddingBottom="10" paddingLeft="10" paddingRight="10">
<mx:Label text="Select a state to see its abbreviation."/>
<mx:List id="source" width="100%" color="blue"
dataProvider="{mystates.state}"
change="this.selectedItem=List(event.target).selectedItem"/>
<mx:VBox width="100%">
<mx:Label text="Selected State: {selectedItem.label}"/>
<mx:Label text="State abbreviation: {selectedItem.data}"/>
</mx:VBox>
</mx:Panel>
</mx:Application>
Send me an e-mail when comments are added to this page | Comment Report
Current page: http://livedocs.adobe.com/livecycle/es/sdkHelp/common/langref/mx/controls/List.html