Packagemx.controls
Classpublic class FileSystemList
InheritanceFileSystemList Inheritance List Inheritance ListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance flash.display.Sprite

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The FileSystemList control lets you display the contents of a single file system directory, in a list format.

To change the displayed data, rather than using the dataProvider property, you set the directory property. The control then automatically populates the dataProvider property by enumerating the contents of that directory. You should not set the dataProvider yourself.

You set the directory property to a File instance, as the following example shows:

    <mx:FileSystemList directory="{File.desktopDirectory}"/>

You can set the enumerationMode property to specify whether to show files, subdirectories, or both. There are three ways to show both: directories first, files first, or intermixed.

You can set the extensions property to filter the displayed items so that only files with the specified extensions appear. The showHidden determines whether the control displays files and subdirectories that the operating system normally hides. You can specify an additional filterFunction to perform custom filtering, and a nameCompareFunction to perform custom sorting.

Because AIR does not support file system notifications, this control does not automatically refresh if a file or subdirectory is created, deleted, moved, or renamed; in other words, it can display an out-of-date view of the file system. However, you can call refresh() to re-enumerate the current directory. You could, for example, choose to do this when you have performed a file operation that you know causes the control's view to become out-of-date, or when the user deactivates and reactivates your application.

You can use the showIcons property to show or hide icons, and the showExtensions property to show or hide file extensions.

The control provides two methods, findItem() and findIndex(), which you can use to search the displayed files and subdirectories to find the one with a specified nativePath.

Two properties, selectedPath and selectedPaths, work similarly to selectedItem and selectedItems or selectedIndex and selectedIndices, but let you specify the selection via nativePath strings. These are very useful if you need to display a directory with particular items preselected, since in this case you don't yet have the File items that the control will create when it enumerates the directory, and you don't know what their indices will be.

The control allows the user to navigate to other directories using the mouse or keyboard. The user can try to change the directory by double-clicking a subdirectory, by pressing Enter or Ctrl-Down when a subdirectory is selected, by pressing Ctrl-Up when the control isn't displaying the COMPUTER directory, by pressing Ctrl-Left when there is a "previous" directory to navigate back to, or by pressing Ctrl-Right when there is a "next" directory to navigate forward to. If the user attempts to change the directory being displayed, the control dispatches a cancelable directoryChanging event. If you don't cancel this event by calling event.preventDefault(), the control displays the contents of the new directory and the directory property changes. Whenever the directory property changes, for any reason, the controls dispatches a directoryChange event to let you know.

In order to support "Up" and "Down" controls, the FileSystemList has canNavigateUp and canNavigateDown properties and navigateUp() and navigateDown() methods. There is also a navigateTo() for navigating to an arbitrary directory.

The control keeps track of the directories to which the user has navigated, in order to make it easy for you to support "Back" and "Forward" controls. For more information, see the backHistory, forwardHistory, canNavigateBack, and canNavigateForward properties, and the navigateBack() and navigateForward() methods.

Note: The icons displayed for each item are generic file and directory icons which you can set using the fileIcon and directoryIcon styles. Flex's list-based controls currently support displaying only embedded icons, not icons read at runtime. Therefore the actual file system icons displayed in the operating system are not displayed in a FileSystemList, even though they are accessible in AIR via the icon property of a File.

MXML SyntaxexpandedHide MXML Syntax

The <mx:FileSystemList> tag inherits all of the tag attributes of its superclass and adds the following tag attributes:

  <mx:FileSystemList
    Properties
    directory="null"
    enumerationMode="directoriesFirst"
    extensions="null"
    filterFunction="null"
    nameCompareFunction="null"
    selectedPath="null"
    selectedPaths="null"
    showExtensions="true"
    showHidden="false"
    showIcons="true"
 
    Styles
    directoryIcon="TreeNodeIcon"
    fileIcon="TreeNodeIcon"
 
    Events
    directoryChange="No default"
    directoryChanging="No default"
    fileChoose="No default"
  />
  

Default MXML PropertydataProvider

See also

flash.filesystem.File


Public Properties
 PropertyDefined By
 InheritedaccessibilityDescription : String
A convenience accessor for the description property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityEnabled : Boolean
A convenience accessor for the silent property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityShortcut : String
A convenience accessor for the shortcut property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedactiveEffects : Array
[read-only] The list of effects that are currently playing on the component, as an Array of EffectInstance instances.
UIComponent
 InheritedallowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled.
ListBase
 InheritedallowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be selected at the same time.
ListBase
 InheritedautomationDelegate : Object
The delegate object that handles the automation-related functionality.
UIComponent
 InheritedautomationEnabled : Boolean
[read-only] True if this component is enabled for automation, false otherwise.
UIComponent
 InheritedautomationName : String
Name that can be used as an identifier for this object.
UIComponent
 InheritedautomationOwner : DisplayObjectContainer
[read-only] The owner of this component for automation purposes.
UIComponent
 InheritedautomationParent : DisplayObjectContainer
[read-only] The parent of this component for automation purposes.
UIComponent
 InheritedautomationTabularData : Object
[read-only] An implementation of the IAutomationTabularData interface, which can be used to retrieve the data.
UIComponent
 InheritedautomationValue : 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
 InheritedautomationVisible : Boolean
[read-only] True if this component is visible for automation, false otherwise.
UIComponent
  AIR-only backHistory : Array
[read-only] An Array of File objects representing directories to which the user can navigate backward.
FileSystemList
 Inheritedbaseline : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 Inheritedbottom : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedcacheHeuristic : Boolean
[write-only] Used by Flex to suggest bitmap caching for the object.
UIComponent
 InheritedcachePolicy : String
Specifies the bitmap caching policy for this object.
UIComponent
  AIR-only canNavigateBack : Boolean
[read-only] A flag which is true if there is at least one directory in the history list to which the user can navigate backward.
FileSystemList
  AIR-only canNavigateDown : Boolean
[read-only] A flag which is true if the user can navigate down into a selected directory.
FileSystemList
  AIR-only canNavigateForward : Boolean
[read-only] A flag which is true if there is at least one directory in the history list to which the user can navigate forward.
FileSystemList
  AIR-only canNavigateUp : Boolean
[read-only] A flag which is true if the user can navigate up to a parent directory.
FileSystemList
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 InheritedcolumnCount : int
The number of columns to be displayed in a TileList control or items in a HorizontalList control.
ListBase
 InheritedcolumnWidth : Number
The width of the control's columns.
ListBase
 InheritedcontentMouseX : Number
[read-only] Returns the x position of the mouse, in the content coordinate system.
UIComponent
 InheritedcontentMouseY : Number
[read-only] Returns the y position of the mouse, in the content coordinate system.
UIComponent
 InheritedcurrentState : String
The current view state of the component.
UIComponent
 InheritedcursorManager : ICursorManager
[read-only] Gets the CursorManager that controls the cursor for this component and its peers.
UIComponent
 Inheriteddata : Object
The item in the data provider this component should render when this component is used as an item renderer or item editor.
ListBase
 InheriteddataProvider : Object
Set of data to be viewed.
ListBase
 InheriteddataTipField : String
Name of the field in the data provider items to display as the data tip.
ListBase
 InheriteddataTipFunction : Function
User-supplied function to run on each item to determine its dataTip.
ListBase
 Inheriteddepth : Number
Determines the order in which items inside of containers are rendered.
UIComponent
 Inheriteddescriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used by the createComponentFromDescriptor() method to create this UIComponent instance.
UIComponent
 InheriteddesignLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual element.
UIComponent
  AIR-only directory : File
The directory whose contents this control displays.
FileSystemList
 Inheriteddocument : Object
A reference to the document object associated with this UIComponent.
UIComponent
 InheriteddoubleClickEnabled : Boolean
[override] Specifies whether the UIComponent object receives doubleClick events.
UIComponent
 InheriteddragEnabled : Boolean
A flag that indicates whether you can drag items out of this control and drop them on other controls.
ListBase
 InheriteddragMoveEnabled : 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
 InheriteddropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the control.
ListBase
 Inheritededitable : Boolean
A flag that indicates whether or not the user can edit items in the data provider.
List
 InheritededitedItemPosition : Object
The column and row index of the item renderer for the data provider item being edited, if any.
List
 InheritededitedItemRenderer : IListItemRenderer
[read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
List
 InheritededitorDataField : String = text
The name of the property of the item editor that contains the new data for the list item.
List
 InheritededitorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the item renderer.
List
 InheritededitorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key.
List
 InheritededitorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the item renderer.
List
 InheritededitorXOffset : 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
 InheritededitorYOffset : 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
 Inheritedenabled : Boolean
Whether the component can accept user interaction.
UIComponent
 InheritedenableIME : Boolean
[read-only] A flag that indicates whether the IME should be enabled when the component receives focus.
List
  AIR-only enumerationMode : String
A String specifying whether this control displays only files, only subdirectories, or both.
FileSystemList
 InheritederrorString : String
The text that displayed by a component's error tip when a component is monitored by a Validator and validation fails.
UIComponent
 InheritedexplicitHeight : Number
Number that specifies the explicit height of the component, in pixels, in the component's coordinates.
UIComponent
 InheritedexplicitMaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitMinWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedexplicitWidth : Number
Number that specifies the explicit width of the component, in pixels, in the component's coordinates.
UIComponent
  AIR-only extensions : Array
An Array of extensions specifying which files can be displayed in this control.
FileSystemList
  AIR-only filterFunction : Function
A callback Function that you can use to perform additional filtering, after the enumerationMode and extensions properties have been applied, to determine which files and subdirectories are displayed and which are hidden.
FileSystemList
 InheritedflexContextMenu : IFlexContextMenu
The context menu for this UIComponent.
UIComponent
 InheritedfocusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to.
UIComponent
 InheritedfocusManager : IFocusManager
Gets the FocusManager that controls focus for this component and its peers.
UIComponent
 InheritedfocusPane : Sprite
The focus pane associated with this object.
UIComponent
  AIR-only forwardHistory : Array
[read-only] An Array of File objects representing directories to which the user can navigate forward.
FileSystemList
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contains true if the element has 3D Matrix.
UIComponent
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhorizontalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedhorizontalScrollPolicy : 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
 InheritedhorizontalScrollPosition : Number
The offset into the content from the left edge.
ScrollControlBase
 InheritediconField : String
The name of the field in the data provider object that determines what to display as the icon.
ListBase
 InheritediconFunction : Function
A user-supplied function to run on each item to determine its icon.
ListBase
 Inheritedid : String
ID of the component.
UIComponent
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
List
 InheritedincludeInLayout : Boolean
Specifies whether this component is included in the layout of the parent container.
UIComponent
 InheritedinheritingStyles : Object
The beginning of this component's chain of inheriting styles.
UIComponent
 Inheritedinitialized : 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
 InheritedinstanceIndex : int
[read-only] The index of a repeated component.
UIComponent
 InheritedinstanceIndices : Array
An Array containing the indices required to reference this UIComponent object from its parent document.
UIComponent
 Inheritedis3D : Boolean
[read-only] Contains true when the element is in 3D.
UIComponent
 InheritedisDocument : Boolean
[read-only] Contains true if this UIComponent instance is a document object.
UIComponent
 InheritedisPopUp : Boolean
Set to true by the PopUpManager to indicate that component has been popped up.
UIComponent
 InheriteditemEditor : IFactory
The class factory for the item editor to use for the control, if the editable property is set to true.
List
 InheriteditemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor, if it exists.
List
 InheriteditemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritedlabelField : String
The name of the field in the data provider items to display as the label.
ListBase
 InheritedlabelFunction : Function
A user-supplied function to run on each item to determine its label.
ListBase
 InheritedlayoutMatrix3D : Matrix3D
[write-only] The transform matrix that is used to calculate a component's layout relative to its siblings.
UIComponent
 Inheritedleft : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedlistData : 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
 InheritedliveScrolling : 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
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 InheritedmaxHeight : Number
The maximum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedmaxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property.
ScrollControlBase
 InheritedmaxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property.
ScrollControlBase
 InheritedmaxWidth : Number
The maximum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmeasuredHeight : Number
The default height of the component, in pixels.
UIComponent
 InheritedmeasuredMinHeight : Number
The default minimum height of the component, in pixels.
UIComponent
 InheritedmeasuredMinWidth : Number
The default minimum width of the component, in pixels.
UIComponent
 InheritedmeasuredWidth : Number
The default width of the component, in pixels.
UIComponent
 InheritedmenuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection should be used.
ListBase
 InheritedminHeight : Number
The minimum recommended height of the component to be considered by the parent during layout.
UIComponent
 InheritedminWidth : Number
The minimum recommended width of the component to be considered by the parent during layout.
UIComponent
 InheritedmoduleFactory : 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
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedMXMLDescriptor : Array
[read-only]
UIComponent
 InheritedMXMLProperties : Array
[read-only]
UIComponent
  AIR-only nameCompareFunction : Function
A callback Function that you can use to change how file and subdirectory names are compared in order to produce the sort order.
FileSystemList
 InheritednestLevel : int
Depth of this object in the containment hierarchy.
UIComponent
 InheritednonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles.
UIComponent
 InheritednullItemRenderer : IFactory
The custom item renderer for the control.
ListBase
 InheritednumAutomationChildren : int
[read-only] The number of automation children this container has.
UIComponent
 InheritedoffscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used in the layout of the control.
ListBase
 Inheritedowner : DisplayObjectContainer
The owner of this IVisualElement object.
UIComponent
 Inheritedparent : DisplayObjectContainer
[override] [read-only] The parent container or component for this component.
UIComponent
 InheritedparentApplication : Object
[read-only] A reference to the Application object that contains this UIComponent instance.
UIComponent
 InheritedparentDocument : Object
[read-only] A reference to the parent document object for this UIComponent.
UIComponent
 InheritedpercentHeight : Number
Specifies the height of a component as a percentage of its parent's size.
UIComponent
 InheritedpercentWidth : Number
Specifies the width of a component as a percentage of its parent's size.
UIComponent
 InheritedpostLayoutTransformOffsets : 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
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 InheritedrendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item editor.
List
 Inheritedrepeater : IRepeater
[read-only] A reference to the Repeater object in the parent document that produced this UIComponent.
UIComponent
 InheritedrepeaterIndex : int
[read-only] The index of the item in the data provider of the Repeater that produced this UIComponent.
UIComponent
 InheritedrepeaterIndices : 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
 Inheritedrepeaters : Array
An Array containing references to the Repeater objects in the parent document that produced this UIComponent.
UIComponent
 Inheritedright : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedrotation : Number
[override]
UIComponent
 InheritedrotationX : Number
[override] Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationY : Number
[override] Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrotationZ : Number
[override]
UIComponent
 InheritedrowCount : int
Number of rows to be displayed.
ListBase
 InheritedrowHeight : Number
The height of the rows in pixels.
ListBase
 InheritedscaleX : Number
[override] Number that specifies the horizontal scaling factor.
UIComponent
 InheritedscaleY : Number
[override] Number that specifies the vertical scaling factor.
UIComponent
 InheritedscaleZ : Number
[override] Number that specifies the scaling factor along the z axis.
UIComponent
 Inheritedscreen : Rectangle
[read-only] Returns an object that contains the size and position of the base drawing surface for this object.
UIComponent
 InheritedscrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip.
ScrollControlBase
 Inheritedselectable : Boolean
A flag that indicates whether the list shows selected items as selected.
ListBase
 InheritedselectedIndex : int
The index in the data provider of the selected item.
ListBase
 InheritedselectedIndices : Array
An array of indices in the data provider of the selected items.
ListBase
 InheritedselectedItem : Object
A reference to the selected item in the data provider.
ListBase
 InheritedselectedItems : Array
An array of references to the selected items in the data provider.
ListBase
 InheritedselectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property against items in the data provider.
ListBase
  AIR-only selectedPath : String
The nativePath of the File item representing the selected subdirectory or file, or null if no item is selected.
FileSystemList
  AIR-only selectedPaths : Array
An Array of nativePath Strings for the File items representing the selected subdirectories and files.
FileSystemList
 InheritedshowDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows.
ListBase
  AIR-only showExtensions : Boolean
A flag that specifies whether extensions in file names are shown.
FileSystemList
  AIR-only showHidden : Boolean
A flag that specifies whether files and directories that the operating system considers hidden are displayed.
FileSystemList
  AIR-only showIcons : Boolean
A flag that specifies that icons are displayed before the file name.
FileSystemList
 InheritedshowInAutomationHierarchy : Boolean
A flag that determines if an automation object shows in the automation hierarchy.
UIComponent
 InheritedshowScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear near the scroll thumb when it is being dragged.
ScrollControlBase
 Inheritedstates : Array
The view states that are defined for this component.
UIComponent
 InheritedstyleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object.
UIComponent
 InheritedstyleManager : IStyleManager2
[read-only] Returns the StyleManager instance used by this component.
UIComponent
 InheritedstyleName : Object
The class style used by this component.
UIComponent
 InheritedstyleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabFocusEnabled : 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
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 Inheritedtransform : Transform
[override] An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
UIComponent
 InheritedtransformX : Number
Sets the x coordinate for the transform center of the component.
UIComponent
 InheritedtransformY : Number
Sets the y coordinate for the transform center of the component.
UIComponent
 InheritedtransformZ : Number
Sets the z coordinate for the transform center of the component.
UIComponent
 Inheritedtransitions : Array
An Array of Transition objects, where each Transition object defines a set of effects to play when a view state change occurs.
UIComponent
 InheritedtweeningProperties : Array
Array of properties that are currently being tweened on this object.
UIComponent
 Inheriteduid : String
A unique identifier for the object.
UIComponent
 InheritedupdateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases of layout validation (provided that any were required).
UIComponent
 InheritedvalidationSubField : String
Used by a validator to associate a subfield with this component.
UIComponent
 Inheritedvalue : Object
[read-only] The selected item, or the data or label field of the selected item.
ListBase
 InheritedvariableRowHeight : Boolean
A flag that indicates whether the individual rows can have different height.
ListBase
 InheritedverticalCenter : Object
For components, this layout constraint property is a facade on top of the similarly-named style.
UIComponent
 InheritedverticalScrollPolicy : 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
 InheritedverticalScrollPosition : Number
The offset into the content from the top edge.
ScrollControlBase
 InheritedviewMetrics : EdgeMetrics
[read-only] An EdgeMetrics object taking into account the scroll bars, if visible.
ScrollControlBase
 Inheritedvisible : Boolean
[override] Whether or not the display object is visible.
UIComponent
 Inheritedwidth : Number
[override] Number that specifies the width of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedwordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped.
ListBase
 Inheritedx : Number
[override] Number that specifies the component's horizontal position, in pixels, within its parent container.
UIComponent
 Inheritedy : Number
[override] Number that specifies the component's vertical position, in pixels, within its parent container.
UIComponent
 Inheritedz : Number
[override]
UIComponent
Protected Properties
 PropertyDefined By
 InheritedactualCollection : ICollectionView
A copy of the value normally stored in collection used while running data changes effects.
ListBase
 InheritedactualIterator : IViewCursor
A copy of the value normally stored in iterator used while running data changes effects.
ListBase
 InheritedallowItemSizeChangeNotification : Boolean
[write-only] If false, renderers cannot invalidate size of List.
ListBase
 InheritedanchorBookmark : CursorBookmark
A bookmark to the item that is the anchor.
ListBase
 InheritedanchorIndex : int = -1
The offset of the item in the data provider that is the selection anchor point.
ListBase
 Inheritedborder : IFlexDisplayObject
The border object.
ScrollControlBase
 InheritedcachedItemsChangeEffect : IEffect = null
The effect that plays when changes occur in the data provider for the control, set through the itemsChangeEffect style.
ListBase
 InheritedcaretBookmark : CursorBookmark
A bookmark to the item under the caret.
ListBase
 InheritedcaretIndex : int = -1
The offset of the item in the data provider that is the selection caret point.
ListBase
 InheritedcaretIndicator : Sprite
The DisplayObject that contains the graphics that indicate which renderer is the caret.
ListBase
 InheritedcaretItemRenderer : IListItemRenderer
The renderer for the item under the caret.
ListBase
 InheritedcaretUID : String
The UID of the item under the caret.
ListBase
 Inheritedcollection : ICollectionView
An ICollectionView that represents the data provider.
ListBase
 InheritedcurrentCSSState : String
[read-only] The state to be used when matching CSS pseudo-selectors.
UIComponent
 InheriteddataEffectCompleted : Boolean = false
A flag that indicates that the a data change effect has just completed.
ListBase
 InheriteddataItemWrappersByRenderer : Dictionary
A dictionary mapping item renderers to the ItemWrappers used to supply their data.
ListBase
 InheriteddefaultColumnCount : int = 4
The default number of columns to display.
ListBase
 InheriteddefaultRowCount : int = 4
The default number of rows to display.
ListBase
 InheriteddragImage : IUIComponent
[read-only] Gets an instance of a class that displays the visuals during a drag and drop operation.
ListBase
 InheriteddragImageOffsets : Point
[read-only] Gets the offset of the drag image for drag and drop.
ListBase
 InheritedexplicitColumnCount : int = -1
The column count requested by explicitly setting the columnCount property.
ListBase
 InheritedexplicitColumnWidth : Number
The column width requested by explicitly setting the columnWidth.
ListBase
 InheritedexplicitRowCount : int = -1
The row count requested by explicitly setting rowCount.
ListBase
 InheritedexplicitRowHeight : Number
The row height requested by explicitly setting rowHeight.
ListBase
 InheritedfactoryMap : Dictionary
A map of item renderers by factory.
ListBase
 InheritedfreeItemRenderers : Array
A stack of unused item renderers.
ListBase
 InheritedfreeItemRenderersByFactory : Dictionary
A map of free item renderers by factory.
ListBase
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 InheritedhighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted.
ListBase
 InheritedhighlightItemRenderer : IListItemRenderer
The renderer that is currently rolled over or under the caret.
ListBase
 InheritedhighlightUID : String
The UID of the item that is current rolled over or under the caret.
ListBase
 InheritedhorizontalScrollBar : ScrollBar
The horizontal scroll bar.
ScrollControlBase
 InheriteditemsNeedMeasurement : Boolean = true
A flag that indicates whether the columnWidth and rowHeight properties need to be calculated.
ListBase
 InheriteditemsSizeChanged : Boolean = false
A flag that indicates that the size of the renderers may have changed.
ListBase
 Inheritediterator : IViewCursor
The main IViewCursor used to fetch items from the data provider and pass the items to the renderers.
ListBase
 InheritediteratorValid : 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
 InheritedkeySelectionPending : Boolean = false
A flag that indicates if keyboard selection was interrupted by a page fault.
ListBase
 InheritedlastDropIndex : int
The most recently calculated index where the drag item should be added to the drop target.
ListBase
 InheritedlastSeekPending : ListBaseSeekPending
The most recent seek that caused a page fault.
ListBase
 InheritedlistContent : ListBaseContentHolder
An internal display object that parents all of the item renderers, selection and highlighting indicators and other supporting graphics.
ListBase
 InheritedlistContentStyleFilters : Object
[read-only] The set of styles to pass from the ListBase to the listContent.
ListBase
 InheritedlistItems : Array
[read-only] An Array of Arrays that contains the itemRenderer instances that render each data provider item.
ListBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedmeasuringObjects : Dictionary
cache of measuring objects by factory
List
 InheritedmodifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
ListBase
 InheritedoffscreenExtraColumns : int = 0
The target number of extra columns of item renderers used in the layout of the control.
ListBase
 InheritedoffscreenExtraColumnsLeft : int = 0
The number of offscreen columns currently to the left of the leftmost visible column.
ListBase
 InheritedoffscreenExtraColumnsRight : int = 0
The number of offscreen columns currently to the right of the right visible column.
ListBase
 InheritedoffscreenExtraRows : int = 0
The target number of extra rows of item renderers to be used in the layout of the control.
ListBase
 InheritedoffscreenExtraRowsBottom : int = 0
The number of offscreen rows currently below the bottom visible item renderer.
ListBase
 InheritedoffscreenExtraRowsOrColumnsChanged : Boolean = false
A flag indicating that the number of offscreen rows or columns may have changed.
ListBase
 InheritedoffscreenExtraRowsTop : int = 0
The number of offscreen rows currently above the topmost visible row.
ListBase
 InheritedrendererChanged : Boolean = false
A flag that indicates that the renderer changed.
ListBase
 InheritedreservedItemRenderers : Object
A hash map of currently unused item renderers that may be used again in the near future.
ListBase
 InheritedresourceManager : IResourceManager
[read-only] A reference to the object which manages all of the application's localized resources.
UIComponent
 InheritedrowInfo : Array
[read-only] An array of ListRowInfo objects that cache row heights and other tracking information for the rows in listItems.
ListBase
 InheritedrowMap : Object
A hash map of item renderers to their respective ListRowInfo object.
ListBase
 InheritedrunDataEffectNextUpdate : Boolean = false
A flag that indicates if a data effect should be initiated the next time the display is updated.
ListBase
 InheritedrunningDataEffect : Boolean = false
A flag indicating if a data change effect is currently running.
ListBase
 InheritedscrollAreaChanged : Boolean
A flag that the scrolling area changed due to the appearance or disappearance of scrollbars.
ScrollControlBase
 InheritedselectedData : Object
A hash table of ListBaseSelectionData objects that track which items are currently selected.
ListBase
 InheritedselectionIndicators : Object
A hash table of selection indicators.
ListBase
 InheritedselectionLayer : Sprite
The layer in listContent where all selection and highlight indicators are drawn.
ListBase
 InheritedselectionTweens : Object
A hash table of selection tweens.
ListBase
 InheritedshowCaret : Boolean
A flag that indicates whether to show caret.
ListBase
 InheritedunconstrainedRenderers : Dictionary
A hash map of item renderers that are not subject to the layout algorithms of the list.
ListBase
 InheritedunscaledHeight : Number
[read-only] A convenience method for determining the unscaled height of the component.
UIComponent
 InheritedunscaledWidth : 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
 InheritedverticalScrollBar : ScrollBar
The vertical scroll bar.
ScrollControlBase
 InheritedvisibleData : Object
[read-only] A hash table of data provider item renderers currently in view.
ListBase
 InheritedwordWrapChanged : 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
 MethodDefined By
  
Constructor.
FileSystemList
 Inherited
addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running.
ListBase
 Inherited
Adds a non-visual style client to this component instance.
UIComponent
 Inherited
calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added to the drop target.
ListBase
 Inherited
callLater(method:Function, args:Array = null):void
Queues a function to be called later.
UIComponent
  
AIR-only clear():void
Clears this control so that it displays no items.
FileSystemList
 Inherited
clearStyle(styleProp:String):void
Deletes a style property from this component instance.
UIComponent
 Inherited
contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates.
UIComponent
 Inherited
Returns a set of properties that identify the child within this container.
UIComponent
 Inherited
Returns a set of properties as automation IDs that identify the child within this container.
UIComponent
 Inherited
createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the editedItemPosition using the editor specified by the itemEditor property.
List
 Inherited
[override] Get the appropriate renderer, using the default renderer if none is specified.
List
 Inherited
Creates an id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Deletes the id reference to this IUIComponent object on its parent document object.
UIComponent
 Inherited
Closes an item editor that is currently open on an item.
List
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
dispatchEvent(event:Event):Boolean
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component.
UIComponent
 Inherited
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
 Inherited
Called by the effect instance when it stops playing on the component.
UIComponent
 Inherited
Called by the effect instance when it starts playing on the component.
UIComponent
 Inherited
Ends all currently playing effects on the component.
UIComponent
 Inherited
executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination.
UIComponent
  
AIR-only findIndex(nativePath:String):int
Returns the index of the File item with the specified native file system path.
FileSystemList
  
AIR-only findItem(nativePath:String):File
Searches the File instances currently displayed in this control and returns the one with the specified nativePathproperty.
FileSystemList
 Inherited
findString(str:String):Boolean
Finds an item in the list based on a String, and moves the selection to it.
ListBase
 Inherited
finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete.
UIComponent
 Inherited
generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array
UIComponent
 Inherited
generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):*
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size.
UIComponent
 Inherited
Finds the type selectors for this UIComponent instance.
UIComponent
 Inherited
getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as getting the constraint style for this component.
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured height
UIComponent
 Inherited
A convenience method for determining whether to use the explicit or measured width
UIComponent
 Inherited
getFocus():InteractiveObject
Gets the object that currently has focus.
UIComponent
 Inherited
Return the appropriate factory, using the default factory if none specified.
ListBase
 Inherited
getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height.
UIComponent
 Inherited
getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width.
UIComponent
 Inherited
getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen.
UIComponent
 Inherited
getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen.
UIComponent
 Inherited
Returns the transform matrix that is used to calculate the component's layout relative to its siblings.
UIComponent
 Inherited
Returns the layout transform Matrix3D for this element.
UIComponent
 Inherited
getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height.
UIComponent
 Inherited
getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width.
UIComponent
 Inherited
getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height.
UIComponent
 Inherited
getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width.
UIComponent
 Inherited
getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height.
UIComponent
 Inherited
getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width.
UIComponent
 Inherited
getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false to indicates whether the effect should play on the target.
ListBase
 Inherited
getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used by the specified Repeater to produce this Repeater, or null if this Repeater isn't repeated.
UIComponent
 Inherited
getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this component's style lookup chain.
UIComponent
 Inherited
getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user on the screen.
UIComponent
 Inherited
globalToContent(point:Point):Point
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
hasCSSState():Boolean
Returns true if currentCSSState is not null.
UIComponent
 Inherited
hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this UIComponent.
UIComponent
 Inherited
Hides the drop indicator under the mouse pointer that indicates that a drag and drop operation is allowed.
ListBase
 Inherited
horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the drawRoundRect() method as the rot parameter when drawing a horizontal gradient.
UIComponent
 Inherited
Get an item renderer for the index of an item in the data provider, if one exists.
ListBase
 Inherited
indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item at colIndex, rowIndex.
ListBase
 Inherited
initialize():void
Initializes the internal structure of this component.
UIComponent
 Inherited
Initializes various properties which keep track of repeated instances of this component.
UIComponent
 Inherited
Marks a component so that its updateDisplayList() method gets called during a later screen update.
UIComponent
 Inherited
Called by a component's items to indicate that their depth property has changed.
UIComponent
 Inherited
An element must call this method when its layoutDirection changes or when its parent's layoutDirection changes.
UIComponent
 Inherited
Refresh all rows on the next update.
ListBase
 Inherited
Marks a component so that its commitProperties() method gets called during a later screen update.
UIComponent
 Inherited
Marks a component so that its measure() method gets called during a later screen update.
UIComponent
 Inherited
isItemEditable(data:Object):Boolean
Determines if the item renderer for a data provider item is editable.
List
 Inherited
isItemHighlighted(data:Object):Boolean
Determines if the item renderer for a data provider item is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation).
ListBase
 Inherited
isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item is selectable.
ListBase
 Inherited
isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item is selected.
ListBase
 Inherited
isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation.
ListBase
 Inherited
isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer.
ListBase
 Inherited
itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object.
ListBase
 Inherited
Returns the index of the item in the data provider of the item being rendered by this item renderer.
ListBase
 Inherited
itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties.
ListBase
 Inherited
itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item, based on the iconField and iconFunction properties.
ListBase
 Inherited
Returns the item renderer for a given item in the data provider, if there is one.
ListBase
 Inherited
itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties.
ListBase
 Inherited
localToContent(point:Point):Point
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of, the given type.
UIComponent
 Inherited
measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the sum of the heights of those items.
ListBase
 Inherited
measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such as <font> and <b>, assuming that it is displayed in a single-line UITextField using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed in a single-line UITextField (or UIFTETextField) using a UITextFormat determined by the styles of this UIComponent.
UIComponent
 Inherited
measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the current item renderer and returns the maximum width found.
ListBase
 Inherited
move(x:Number, y:Number):void
Moves the component to a specified position within its parent.
UIComponent
  
AIR-only navigateBack(index:int = 0):void
Changes this control to display the contents of a previously-visited directory in the backHistory array.
FileSystemList
  
AIR-only navigateDown():void
Changes this control to display the contents of the selected subdirectory.
FileSystemList
  
AIR-only navigateForward(index:int = 0):void
Changes this control to display the contents of a previously-visited directory in the forwardHistory array.
FileSystemList
  
AIR-only navigateTo(directory:File):void
Changes this control to display the contents of the specified directory.
FileSystemList
  
AIR-only navigateUp():void
Changes this control to display the contents of the next directory up in the hierarchy.
FileSystemList
 Inherited
notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children.
UIComponent
 Inherited
owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
  
AIR-only refresh():void
Re-enumerates the current directory being displayed by this control.
FileSystemList
 Inherited
regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component and, if the recursive parameter is true, for all descendants of this component as well.
UIComponent
 Inherited
registerEffects(effects:Array):void
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running.
ListBase
 Inherited
Removes a non-visual style client from this component instance.
UIComponent
 Inherited
replayAutomatableEvent(event:Event):Boolean
Replays the specified event.
UIComponent
 Inherited
resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided.
UIComponent
 Inherited
[static] Resumes the background processing of methods queued by callLater(), after a call to suspendBackgroundProcessing().
UIComponent
 Inherited
scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible.
ListBase
 Inherited
setActualSize(w:Number, h:Number):void
Sizes the object.
UIComponent
 Inherited
setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as setting the constraint style for this component.
UIComponent
 Inherited
setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state.
UIComponent
 Inherited
setFocus():void
Sets the focus to this component.
UIComponent
 Inherited
setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen.
UIComponent
 Inherited
setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element.
UIComponent
 Inherited
setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout size and position relative to its siblings.
UIComponent
 Inherited
setMXMLDescriptor(value:Array):void
UIComponent
 Inherited
setMXMLProperties(value:Array):void
UIComponent
 Inherited
setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance.
UIComponent
 Inherited
setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes.
UIComponent
 Inherited
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
 Inherited
styleChanged(styleProp:String):void
Detects changes to style properties.
UIComponent
 Inherited
Flex calls the stylesInitialized() method when the styles for a component are first initialized.
UIComponent
 Inherited
[static] Blocks the background processing of methods queued by callLater(), until resumeBackgroundProcessing() is called.
UIComponent
 Inherited
toString():String
[override] Returns a string indicating the location of this object within the hierarchy of DisplayObjects in the Application.
FlexSprite
 Inherited
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
 Inherited
transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local coordinates of this object to its location in the object's parent's coordinates.
UIComponent
 Inherited
unconstrainRenderer(item:Object):void
Called by an UnconstrainItemAction effect as part of a data change effect if the item renderers corresponding to certain data items need to move outside the normal positions of item renderers in the control.
ListBase
 Inherited
Validates the position and size of children and draws other visuals.
UIComponent
 Inherited
Validate and update the properties and layout of this object and redraw it, if necessary.
UIComponent
 Inherited
Used by layout logic to validate the properties of a component by calling the commitProperties() method.
UIComponent
 Inherited
validateSize(recursive:Boolean = false):void
Validates the measured size of the component If the LayoutManager.invalidateSize() method is called with this ILayoutManagerClient, then the validateSize() method is called when it's time to do measurements.
UIComponent
 Inherited
Handles both the valid and invalid events from a validator assigned to this component.
UIComponent
 Inherited
verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
Protected Methods
 MethodDefined By
 Inherited
addDragData(dragSource:Object):void
Adds the selected items to the DragSource object as part of a drag-and-drop operation.
ListBase
 Inherited
addMXMLChildren(comps:Array):void
UIComponent
 Inherited
Adds a renderer to the recycled renderer list, making it invisible and cleaning up references to it.
ListBase
 Inherited
Add a blank row to the beginning of the arrays that store references to the rows.
ListBase
 Inherited
adjustFocusRect(obj:DisplayObject = null):void
Adjust the focus rectangle.
UIComponent
 Inherited
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
Called from the updateDisplayList() method to adjust the size and position of listContent.
ListBase
 Inherited
Commits the computed matrix built from the combination of the layout matrix and the transform offsets to the flash displayObject's transform.
UIComponent
 Inherited
applySelectionEffect(indicator:Sprite, uid:String, itemRenderer:IListItemRenderer):void
Sets up the effect for applying the selection indicator.
ListBase
 Inherited
This is an internal method used by the Flex framework to support the Dissolve effect.
UIComponent
 Inherited
calculateDropIndicatorY(rowCount:Number, rowNum:int):Number
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
ListBase
 Inherited
Determines if the call to the measure() method can be skipped.
UIComponent
 Inherited
Performs any final processing after child objects are created.
UIComponent
 Inherited
clearCaretIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the caret indicator into the given Sprite.
ListBase
 Inherited
clearHighlightIndicator(indicator:Sprite, itemRenderer:IListItemRenderer):void
Clears the highlight indicator in the given Sprite.
ListBase
 Inherited
Removes all selection and highlight and caret indicators.
ListBase
 Inherited
clearSelected(transition:Boolean = false):void
Clears the set of selected items and removes all graphics depicting the selected state of those items.
ListBase
 Inherited
Empty the visibleData hash table.
ListBase
 Inherited
collectionChangeHandler(event:Event):void
Handles CollectionEvents dispatched from the data provider as the data changes.
ListBase
 Inherited
[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
 Inherited
Configures the ScrollBars based on the number of rows and columns and viewable rows and columns.
ListBase
 Inherited
copyItemWithUID(item:Object):Object
Makes a deep copy of the object by calling the ObjectUtil.copy() method, and replaces the copy's uid property (if present) with a new value by calling the UIDUtil.createUID() method.
ListBase
 Inherited
copySelectedItems(useDataField:Boolean = true):Array
Copies the selected items in the order that they were selected.
ListBase
 Inherited
Creates the border for this component.
ScrollControlBase
 Inherited
[override] Creates objects that are children of this ListBase; in this case, the listContent object that will hold all the item renderers.
ListBase
 Inherited
createInFontContext(classObj:Class):Object
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
createInModuleContext(moduleFactory:IFlexModuleFactory, className:String):Object
Creates the object using a given moduleFactory.
UIComponent
 Inherited
destroyRow(i:int, numCols:int):void
Recycle a row that is no longer needed, and remove its indicators.
ListBase
 Inherited
dispatchPropertyChangeEvent(prop:String, oldValue:*, value:*):void
Helper method for dispatching a PropertyChangeEvent when a property is updated.
UIComponent
 Inherited
Handles DragEvent.DRAG_COMPLETE events.
ListBase
 Inherited
Handles DragEvent.DRAG_DROP events.
ListBase
 Inherited
Handles DragEvent.DRAG_ENTER events.
ListBase
 Inherited
Handles DragEvent.DRAG_EXIT events.
ListBase
 Inherited
Handles DragEvent.DRAG_OVER events.
ListBase
 Inherited
dragScroll():void
Interval function that scrolls the list up or down if the mouse goes above or below the list.
ListBase
 Inherited
The default handler for the dragStart event.
ListBase
 Inherited
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
 Inherited
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
 Inherited
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
 Inherited
drawRowBackground(s:Sprite, rowIndex:int, y:Number, height:Number, color:uint, dataIndex:int):void
Draws a row background at the position and height specified.
List
 Inherited
Draws any alternating row colors, borders and backgrounds for the rows.
ListBase
 Inherited
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
 Inherited
endEdit(reason:String):Boolean
Stops the editing of an item in the data provider.
List
 Inherited
findKey(eventCode:int):Boolean
Tries to find the next item in the data provider that starts with the character in the eventCode parameter.
ListBase
 Inherited
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
 Inherited
Sets selected items based on the caretIndex and anchorIndex properties.
ListBase
 Inherited
focusInHandler(event:FocusEvent):void
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
focusOutHandler(event:FocusEvent):void
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
generateMXMLAttributes(data:Array):void
UIComponent
 Inherited
generateMXMLInstances(document:Object, data:Array, recursive:Boolean = true):void
UIComponent
 Inherited
generateMXMLObject(document:Object, data:Array):Object
UIComponent
 Inherited
Retrieves an already-created item renderer not currently in use.
ListBase
 Inherited
indexToColumn(index:int):int
The column for the data provider item at the given index.
ListBase
 Inherited
indexToRow(index:int):int
The row for the data provider item at the given index.
ListBase
 Inherited
Initializes the implementation and storage of some of the less frequently used advanced layout features of a component.
UIComponent
 Inherited
Finalizes the initialization of this component.
UIComponent
 Inherited
Initializes this component's accessibility code.
UIComponent
 Inherited
initiateDataChangeEffect(unscaledWidth:Number, unscaledHeight:Number):void
Initiates a data change effect when there have been changes in the data provider.
ListBase
 Inherited
Helper method to invalidate parent size and display list if this object affects its layout (includeInLayout is true).
UIComponent
 Inherited
isOurFocus(target:DisplayObject):Boolean
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
isRendererUnconstrained(item:Object):Boolean
Returns true if an item renderer is no longer being positioned by the list's layout algorithm while a data change effect is running as a result of a call to the unconstrainRenderer() method.
ListBase
 Inherited
Returns a Point containing the columnIndex and rowIndex of an item renderer.
ListBase
 Inherited
itemToUID(data:Object):String
Determines the UID for a data provider item.
ListBase
 Inherited
keyDownHandler(event:KeyboardEvent):void
The event handler called for a keyDown event.
UIComponent
 Inherited
keyUpHandler(event:KeyboardEvent):void
The event handler called for a keyUp event.
UIComponent
 Inherited
layoutChrome(unscaledWidth:Number, unscaledHeight:Number):void
Responds to size changes by setting the positions and sizes of this control's borders.
ScrollControlBase
 Inherited
layoutEditor(x:int, y:int, w:int, h:int):void
Positions the item editor instance at the suggested position with the suggested dimensions.
List
 Inherited
makeListData(data:Object, uid:String, rowNum:int):BaseListData
Creates a new ListData instance and populates the fields based on the input data provider item.
List
 Inherited
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
 Inherited
measure():void
[override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties.
ListBase
 Inherited
mouseClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDoubleClickHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseDownHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Determines which item renderer is under the mouse.
ListBase
 Inherited
mouseMoveHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOutHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseOverHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers.
ListBase
 Inherited
mouseUpHandler(event:MouseEvent):void
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
mouseWheelHandler(event:MouseEvent):void
[override] Handles mouseWheel events by changing scroll positions.
ListBase
 Inherited
moveIndicatorsHorizontally(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators horizontally.
ListBase
 Inherited
moveIndicatorsVertically(uid:String, moveBlockDistance:Number):void
Move the selection and highlight indicators vertically.
ListBase
 Inherited
moveRowVertically(i:int, numCols:int, moveBlockDistance:Number):void
Move a row vertically, and update the rowInfo record.
ListBase
 Inherited
moveSelectionHorizontally(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
Moves the selection in a horizontal direction in response to the user selecting items using the left arrow or right arrow keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
moveSelectionVertically(code:uint, shiftKey:Boolean, ctrlKey:Boolean):void
Moves the selection in a vertical direction in response to the user selecting items using the up arrow or down arrow Keys and modifiers such as the Shift and Ctrl keys.
ListBase
 Inherited
Prepares the data effect for the collection event.
ListBase
 Inherited
Called by the updateDisplayList() method to remove existing item renderers and clean up various caching structures when the renderer changes.
ListBase
 Inherited
Update the keys in the visibleData hash table.
ListBase
 Inherited
Remove a row from the arrays that store references to the row.
ListBase
 Inherited
removeIndicators(uid:String):void
Cleans up selection highlights and other associated graphics for a given item in the data provider.
ListBase
 Inherited
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
 Inherited
restoreRowArrays(modDeltaPos:int):void
Remove the requested number of rows from the beginning of the arrays that store references to the rows.
ListBase
 Inherited
roomForScrollBar(bar:ScrollBar, unscaledWidth:Number, unscaledHeight:Number):Boolean
Determines if there is enough space in this component to display a given scrollbar.
ScrollControlBase
 Inherited
scrollHandler(event:Event):void
Default event handler for the scroll event.
ScrollControlBase
 Inherited
scrollHorizontally(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
scrollPositionToIndex(horizontalScrollPosition:int, verticalScrollPosition:int):int
Returns the data provider index for the item at the first visible row and column for the given scroll positions.
ListBase
 Inherited
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
Adjusts the renderers in response to a change in scroll position.
ListBase
 Inherited
The default failure handler when a seek fails due to a page fault.
ListBase
 Inherited
The default result handler when a seek fails due to a page fault.
ListBase
 Inherited
seekPositionSafely(index:int):Boolean
Seek to a position, and handle an ItemPendingError if necessary.
ListBase
 Inherited
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
 Inherited
setRowCount(v:int):void
Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows.
ListBase
 Inherited
setRowHeight(v:Number):void
Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows.
ListBase
 Inherited
setScrollBarProperties(totalColumns:int, visibleColumns:int, totalRows:int, visibleRows:int):void
Causes the ScrollControlBase to show or hide scrollbars based on the parameters passed in.
ScrollControlBase
 Inherited
setStretchXY(stretchX:Number, stretchY:Number):void
Specifies a transform stretch factor in the horizontal and vertical direction.
UIComponent
 Inherited
shiftRow(oldIndex:int, newIndex:int, numCols:int, shiftItems:Boolean):void
Shift a row in the arrays that reference rows.
ListBase
 Inherited
stateChanged(oldState:String, newState:String, recursive:Boolean):void
This method is called when a state changes to check whether state-specific styles apply to this component.
UIComponent
 Inherited
sumRowHeights(startRowIdx:int, endRowIdx:int):Number
Determine the height of the requested set of rows.
ListBase
 Inherited
truncateRowArrays(numRows:int):void
Remove all remaining rows from the end of the arrays that store references to the rows.
ListBase
 Inherited
Find an item renderer based on its UID if it is visible.
ListBase
 Inherited
updateDisplayList(unscaledWidth:Number, unscaledHeight:Number):void
[override] Adds or removes item renderers if the number of displayable items changed.
ListBase
 Inherited
updateList():void
Refreshes all rows.
ListBase
Events
 Event Summary Defined By
 InheritedDispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method.UIComponent
 InheritedDispatched when the selectedIndex or selectedItem property changes as a result of user interaction.ListBase
 InheritedDispatched when the component has finished its construction, property processing, measuring, layout, and drawing.UIComponent
 InheritedDispatched after the view state has changed.UIComponent
 InheritedDispatched after the currentState property changes, but before the view state changes.UIComponent
 InheritedDispatched when the data property changes.ListBase
  Dispatched when the directory displayed by this control has changed for any reason.FileSystemList
  Dispatched when the user tries to change the directory displayed by this control.FileSystemList
 InheritedDispatched 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
 InheritedDispatched by the drop target when the user releases the mouse over it.UIComponent
 InheritedDispatched by a component when the user moves the mouse over the component during a drag operation.UIComponent
 InheritedDispatched by the component when the user drags outside the component, but does not drop the data onto the target.UIComponent
 InheritedDispatched by a component when the user moves the mouse while over the component during a drag operation.UIComponent
 InheritedDispatched by the drag initiator when starting a drag operation.UIComponent
 InheritedDispatched after an effect ends.UIComponent
 InheritedDispatched just before an effect starts.UIComponent
 InheritedDispatched after an effect is stopped, which happens only by a call to stop() on the effect.UIComponent
 InheritedDispatched after the component has entered a view state.UIComponent
 InheritedDispatched just before the component exits a view state.UIComponent
  Dispatched when the user chooses a file by double-clicking it or by selecting it and pressing Enter.FileSystemList
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedDispatched when the component has finished its construction and has all initialization properties set.UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation failed.UIComponent
 InheritedDispatched when the user clicks on an item in the control.ListBase
 InheritedDispatched when the user double-clicks on an item in the control.ListBase
 InheritedDispatched when the editedItemPosition property is set and the item can be edited.List
 InheritedDispatched 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
 InheritedDispatched when an item editing session is ending for any reason.List
 InheritedDispatched 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
 InheritedDispatched 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
 InheritedDispatched when the user rolls the mouse pointer out of an item in the control.ListBase
 InheritedDispatched when the user rolls the mouse pointer over an item in the control.ListBase
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it.UIComponent
 InheritedDispatched when the object has moved.UIComponent
 InheritedDispatched at the beginning of the component initialization sequence.UIComponent
 InheritedDispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method.UIComponent
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when the content is scrolled.ScrollControlBase
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched after the component has entered a new state and any state transition animation to that state has finished playing.UIComponent
 InheritedDispatched when a component interrupts a transition to its current state in order to switch to a new state.UIComponent
 InheritedDispatched by the component when it is time to create a ToolTip.UIComponent
 InheritedDispatched by the component when its ToolTip has been hidden and is to be discarded soon.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be hidden.UIComponent
 InheritedDispatched by the component when its ToolTip is about to be shown.UIComponent
 InheritedDispatched by the component when its ToolTip has been shown.UIComponent
 InheritedDispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture.UIComponent
 InheritedA non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture.UIComponent
 InheritedA cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture.UIComponent
 InheritedDispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed).UIComponent
 InheritedDispatched when a component is monitored by a Validator and the validation succeeded.UIComponent
 InheritedDispatched when values are changed programmatically or by user interaction.UIComponent
Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
ScrollControlBase
 InheritedType: Array Format: Color CSS Inheritance: yes
The colors to use for the backgrounds of the items in the list.
ListBase
 InheritedType: Number CSS Inheritance: no Theme: halo
Alpha level of the color defined by the backgroundColor property, of the image or SWF file defined by the backgroundImage style.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo
Background color of a component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Background color of the component when it is disabled.
ScrollControlBase
 InheritedType: Object Format: File CSS Inheritance: no Theme: halo
Background image of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Scales the image specified by backgroundImage to different percentage sizes.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the top edge of the content area to the control's baseline position.
UIComponent
 InheritedType: Number CSS Inheritance: no Theme: spark
Alpha of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: no Theme: halo, spark
Color of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no Theme: halo
Bounding box sides.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Bounding box style.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the bottom edge of the component to the bottom edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component, including the component label.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes Theme: spark
The alpha of the content background for this component.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of the content area of the component.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Radius of component corners.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The directionality of the text displayed by the component.
ScrollControlBase
  
directoryIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the icon that indicates a directory. The default icon is located in the Assets.swf file. In MXML, you can use the following syntax to set this property: directoryIcon="@Embed(source='directoryIcon.jpg');" The default value is TreeNodeIcon.
FileSystemList
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of text in the component if it is disabled.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The skin to use to indicate where a dragged item can be dropped.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Color of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: halo
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: no Theme: spark
Boolean property that specifies whether the component has a visible drop shadow.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
Color of the component highlight when validation fails.
UIComponent
  
fileIcon
Type: Class Format: EmbeddedFile CSS Inheritance: no
Specifies the icon that indicates a file. The default icon is located in the Assets.swf file. In MXML, you can use the following syntax to set this property: fileIcon="@Embed(source='fileIcon.jpg');" The default value is TreeNodeIcon.
FileSystemList
 InheritedType: Number CSS Inheritance: no
Specifies the alpha transparency value of the focus skin.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Blend mode used by the focus rectangle.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of focus ring when the component is in focus.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Specifies which corners of the focus rectangle should be rounded.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
Skin used to draw the focus rectangle.
UIComponent
 InheritedType: Number Format: Length CSS Inheritance: no
Thickness, in pixels, of the focus rectangle outline.
UIComponent
 InheritedType: String CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields.

See also

flash.text.TextField
flash.text.AntiAliasType
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Name of the font to use.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
flash.text.GridFitType
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Height of the text, in pixels.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is italic font.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls.

See also

flash.text.TextField
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: String CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The primary interaction mode for this component.

See also

UIComponent
 InheritedType: Boolean CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false).
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Specifies the desired layout direction of a component.

See also

UIComponent
 InheritedType: Number Format: Length CSS Inheritance: yes
Additional vertical space between lines of text.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the left edge of the component to the left edge of its parent container's content area.
UIComponent
 InheritedType: Number CSS Inheritance: yes
The number of additional pixels to appear between each character.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
The locale of the text displayed by this component.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the bottom of the row and the bottom of the renderer in the row.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's left border and the left edge of its content area.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
Number of pixels between the component's right border and the right edge of its content area.
ListBase
 InheritedType: Number Format: Length CSS Inheritance: no
The number of pixels between the top of the row and the top of the renderer in the row.
ListBase
 InheritedType: String CSS Inheritance: no
The horizontal distance, in pixels, from the right edge of the component to the right edge of its parent container's content area.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background of a renderer when the user rolls over it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background of a renderer when the user selects it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background of a renderer when the component is disabled.
ListBase
 InheritedType: Number Format: Time CSS Inheritance: no
The duration of the selection effect.
ListBase
 InheritedType: Function CSS Inheritance: no
The easingFunction for the selection effect.
ListBase
 InheritedType: String CSS Inheritance: no Theme: halo
Direction of the drop shadow.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: no Theme: halo
Distance of the drop shadow.
ScrollControlBase
 InheritedType: Boolean CSS Inheritance: yes
Show the error border or skin when this component is invalid.
UIComponent
 InheritedType: Boolean CSS Inheritance: yes
Show the error tip when this component is invalid and the user rolls over it.
UIComponent
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Alignment of text within a container.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is underlined.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class implementing IUITextField that is used by this component to render text.
ScrollControlBase
 InheritedType: Number Format: Length CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the text of a renderer when the user rolls over a it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the text of a renderer when the user selects it.
ListBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
 InheritedType: String CSS Inheritance: no
The vertical distance, in pixels, from the top edge of the component to the top edge of its parent container's content area.
UIComponent
 InheritedType: Boolean CSS Inheritance: no
A flag that controls whether items are highlighted as the mouse rolls over them.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical alignment of a renderer in a row.
ListBase
 InheritedType: String CSS Inheritance: no
The vertical distance in pixels from the center of the component's content area to the center of the component.
UIComponent
 InheritedType: String CSS Inheritance: no
Style name for vertical scrollbar.
ScrollControlBase
Effects
 Effect Description Defined By
 Inherited Triggering Event: added
Played when the component is added as a child to a Container.
UIComponent
 Inherited Triggering Event: creationComplete
Played when the component is created.
UIComponent
 Inherited Triggering Event: focusIn
Played when the component gains keyboard focus.
UIComponent
 Inherited Triggering Event: focusOut
Played when the component loses keyboard focus.
UIComponent
 Inherited Triggering Event: hide
Played when the component becomes invisible.
UIComponent
 Inherited 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
 Inherited Triggering Event: mouseDown
Played when the user presses the mouse button while over the component.
UIComponent
 Inherited Triggering Event: mouseUp
Played when the user releases the mouse button while over the component.
UIComponent
 Inherited Triggering Event: move
Played when the component is moved.
UIComponent
 Inherited Triggering Event: removed
Played when the component is removed from a Container.
UIComponent
 Inherited Triggering Event: resize
Played when the component is resized.
UIComponent
 Inherited Triggering Event: rollOut
Played when the user rolls the mouse so it is no longer over the component.
UIComponent
 Inherited Triggering Event: rollOver
Played when the user rolls the mouse over the component.
UIComponent
 Inherited Triggering Event: show
Played when the component becomes visible.
UIComponent
Public Constants
 ConstantDefined By
  AIR-only COMPUTER : File
[static] A constant that can be used as a value for the directory property, representing a pseudo-top level directory named "Computer".
FileSystemList
 InheritedDEFAULT_MAX_HEIGHT : Number = 10000
[static] The default value for the maxHeight property.
UIComponent
 InheritedDEFAULT_MAX_WIDTH : Number = 10000
[static] The default value for the maxWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_HEIGHT : Number = 22
[static] The default value for the measuredHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_HEIGHT : Number = 22
[static] The default value for the measuredMinHeight property.
UIComponent
 InheritedDEFAULT_MEASURED_MIN_WIDTH : Number = 40
[static] The default value for the measuredMinWidth property.
UIComponent
 InheritedDEFAULT_MEASURED_WIDTH : Number = 160
[static] The default value for the measuredWidth property.
UIComponent
Property Detail
AIR-only backHistoryproperty
backHistory:Array  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

An Array of File objects representing directories to which the user can navigate backward.

The first item in this Array is the next directory backward in the history list. The last item is the directory furthest backward in the history list.

This Array may contain a null item, which represents the non-existent directory whose contents are root directories such as C:\ and D:\ on Microsoft Windows.

The following example shows how to use this property along with the FileSystemHistoryButton control to implement a back button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Back"
          enabled="{fileSystemViewer.canNavigateBack}"
          dataProvider="{fileSystemViewer.backHistory}"
          click="fileSystemViewer.navigateBack();"
          itemClick="fileSystemViewer.navigateBack(event.index);"/>

The default value is [].

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


Implementation
    public function get backHistory():Array

See also

AIR-only canNavigateBackproperty 
canNavigateBack:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag which is true if there is at least one directory in the history list to which the user can navigate backward.

The following example shows how to use this property along with the FileSystemHistoryButton control to implement a back button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Back"
          enabled="{fileSystemViewer.canNavigateBack}"
          dataProvider="{fileSystemViewer.backHistory}"
          click="fileSystemViewer.navigateBack();"
          itemClick="fileSystemViewer.navigateBack(event.index);"/>

The default value is false.

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


Implementation
    public function get canNavigateBack():Boolean

See also

AIR-only canNavigateDownproperty 
canNavigateDown:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag which is true if the user can navigate down into a selected directory. This flag is false when there is no selected item or when the selected item is a file rather than a directory.

The following example shows how to use this property along with the Button control:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:Button label="Open"
          enabled="{fileSystemViewer.canNavigateDown}"
          click="fileSystemViewer.navigateDown();"/>

The default value is false.

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


Implementation
    public function get canNavigateDown():Boolean

See also

AIR-only canNavigateForwardproperty 
canNavigateForward:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag which is true if there is at least one directory in the history list to which the user can navigate forward.

The following example shows how to use this property along with the FileSystemHistoryButton control to implement a forward button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Forward"
          enabled="{fileSystemViewer.canNavigateForward}"
          dataProvider="{fileSystemViewer.forwardHistory}"
          click="fileSystemViewer.navigateForward();"
          itemClick="fileSystemViewer.navigateForward(event.index);"/>

The default value is false.

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


Implementation
    public function get canNavigateForward():Boolean

See also

AIR-only canNavigateUpproperty 
canNavigateUp:Boolean  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag which is true if the user can navigate up to a parent directory. This flag is only false when this control is displaying the root directories such as C:\ and D:\ on Microsoft Windows. (This is the case in which the directory property is COMPUTER.)

The following example shows how to use this property along with the Button control:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:Button label="Up"
          enabled="{fileSystemViewer.canNavigateUp}"
          click="fileSystemViewer.navigateUp();"/>

The default value is false.

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


Implementation
    public function get canNavigateUp():Boolean

See also

AIR-only directoryproperty 
directory:File

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The directory whose contents this control displays.

If you set this property to a File object representing an existing directory, the dataProvider immediately becomes null. Later, when this control is revalidated by the LayoutManager, it enumerates that directory's contents and populates the dataProvider property with an ArrayCollection of the resulting File objects for the directory's files and subdirectories.

Setting this to a File which does not represent an existing directory is an error. Setting this to COMPUTER synchronously displays the root directories, such as C: and D: on Windows.

Setting this property deselects any previously selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is COMPUTER.

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


Implementation
    public function get directory():File
    public function set directory(value:File):void
AIR-only enumerationModeproperty 
enumerationMode:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A String specifying whether this control displays only files, only subdirectories, or both. In the case that both are displayed, it also specifies whether the subdirectories are displayed before, after, or mixed in with the files. The possible values are specified by the FileSystemEnumerationMode class.

This property affects which subdirectories and files are displayed in the control, and the order in which they appear. However, it does not affect which File instances are in the dataProvider property; it works by changing the behavior of the filter function that is applied to the dataProvider. Setting it does not cause the current directory to be re-enumerated.

Setting this property deselects any selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is FileSystemEnumerationMode.DIRECTORIES_FIRST.


Implementation
    public function get enumerationMode():String
    public function set enumerationMode(value:String):void

See also

AIR-only extensionsproperty 
extensions:Array

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

An Array of extensions specifying which files can be displayed in this control. If this property is set, for example, to [ ".htm", ".html" ], then only files with these extensions can be displayed.

Extensions are considered case-insensitive and the preceding dot is optional. For example, specifying ".HTML" is equivalent to specifying "html".

Directories are not subject to extension filtering, even if they have names containing dots.

The enumerationMode and filterFunction properties are also involved in determining which files appear in the control. For example, if this property is [ ".htm", ".html" ], an .html file is not displayed if the enumerationMode property is FileSystemEnumerationMode.DIRECTORIES_ONLY, or if the filterFunction returns false for the file.

If this property is null, no extension filtering occurs, and all files are displayed. If this property is an empty Array, all extensions are filtered out and no files with extensions are displayed.

This property affects which files are displayed in the control. However, it does not affect which File instances are in the dataProvider property; it works by changing the behavior of the filter function that is applied to the dataProvider. Setting it does not cause the current directory to be re-enumerated.

Setting this property deselects any selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is null.


Implementation
    public function get extensions():Array
    public function set extensions(value:Array):void
AIR-only filterFunctionproperty 
filterFunction:Function

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A callback Function that you can use to perform additional filtering, after the enumerationMode and extensions properties have been applied, to determine which files and subdirectories are displayed and which are hidden.

This function must have the following signature:

function myFilterFunction(file:File):Boolean
This function should return true to show the specified file or subdirectory and false to hide it.

To ensure that every enumerated file and subdirectory is passed to this function, the enumerationMode property must not be FileSystemEnumerationMode.FILES_ONLY or FileSystemEnumerationMode.DIRECTORIES_ONLY, and the extensions property must be null. Otherwise, these properties cause pre-filtering to occur before this filter function is called.

This property affects which subdirectories and files are displayed in the control. However, it does not affect which File instances are in the dataProvider property; it works by changing the behavior of the filter function that is applied to the dataProvider. Setting it does not cause the current directory to be re-enumerated.

Setting this property deselects any selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is null.


Implementation
    public function get filterFunction():Function
    public function set filterFunction(value:Function):void
AIR-only forwardHistoryproperty 
forwardHistory:Array  [read-only]

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

An Array of File objects representing directories to which the user can navigate forward.

The first item in this Array is the next directory forward in the history list. The last item is the directory furthest forward in the history list.

This Array may contain the special COMPUTER File object, which represents the non-existent directory whose contents are root directories such as C:\ and D:\ on Windows.

The following example shows how to use this property along with the FileSystemHistoryButton control to implement a forward button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Forward"
          enabled="{fileSystemViewer.canNavigateForward}"
          dataProvider="{fileSystemViewer.forwardHistory}"
          click="fileSystemViewer.navigateForward();"
          itemClick="fileSystemViewer.navigateForward(event.index);"/>

The default value is [].

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


Implementation
    public function get forwardHistory():Array

See also

AIR-only nameCompareFunctionproperty 
nameCompareFunction:Function

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A callback Function that you can use to change how file and subdirectory names are compared in order to produce the sort order.

This function must have the following signature:

function myNameCompareFunction(name1:String, name2:String):int

It returns -1 if name1 should sort before name2, 1 if name1 should sort after name2, and 0 if the names are the same.

If you do not set this property, the control performs a case-insensitive, locale-dependent comparison of the two names, by first calling the String method toLocaleLowerCase() on each name and then comparing them with the < and > operators.

If you have set enumerationMode to either FileSystemEnumerationMode.FILES_FIRST or FileSystemEnumerationMode.DIRECTORIES_FIRST, then this method is used to compare names only within the separate groups of files and directories.

This property affects the order in which subdirectories and files are displayed in the control. However, it does not affect which File instances are in the dataProvider property; it works by changing the behavior of the sort that is applied to the dataProvider. Setting it does not cause the current directory to be re-enumerated.

Setting this property deselects any selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is null.


Implementation
    public function get nameCompareFunction():Function
    public function set nameCompareFunction(value:Function):void
AIR-only selectedPathproperty 
selectedPath:String

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

The nativePath of the File item representing the selected subdirectory or file, or null if no item is selected.

If multiple items are selected, getting this property gives the first path in the selectedPaths array.

Setting this property affects the selectedPaths, selectedItem, selectedItems, selectedIndex, and selectedIndices properties.

The default value is null.

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


Implementation
    public function get selectedPath():String
    public function set selectedPath(value:String):void

See also

AIR-only selectedPathsproperty 
selectedPaths:Array

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

An Array of nativePath Strings for the File items representing the selected subdirectories and files. This Array is empty if no items are selected.

Setting this property affects the selectedPaths, selectedItem, selectedItems, selectedIndex, and selectedIndices properties.

The default value is [].

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


Implementation
    public function get selectedPaths():Array
    public function set selectedPaths(value:Array):void

See also

AIR-only showExtensionsproperty 
showExtensions:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag that specifies whether extensions in file names are shown. Set this property to true to show file extensions and to false to hide them. Extensions in directory names are always shown.

Setting this property does not affect which items are displayed, or the order in which they appear. It also does not affect which items are selected, or the scroll position.

The default value is true.


Implementation
    public function get showExtensions():Boolean
    public function set showExtensions(value:Boolean):void
AIR-only showHiddenproperty 
showHidden:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag that specifies whether files and directories that the operating system considers hidden are displayed. Set this property to true to show hidden files and directories and to false to hide them.

Setting this property deselects any selected items and causes the control to reset its scroll position to the upper-left corner.

The default value is false.


Implementation
    public function get showHidden():Boolean
    public function set showHidden(value:Boolean):void
AIR-only showIconsproperty 
showIcons:Boolean

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A flag that specifies that icons are displayed before the file name. Set this property to true to show icons and to false to hide them.

You can set the directoryIcon and fileIcon styles to change the default icons. This control cannot display the actual icon that the operating system displays for a file, because AIR does not support that feature.

Setting this property does not affect which items are displayed, or the order in which they appear. It also does not affect which items are selected, or the scroll position.

The default value is true.


Implementation
    public function get showIcons():Boolean
    public function set showIcons(value:Boolean):void
Constructor Detail
AIR-only FileSystemList()Constructor
public function FileSystemList()

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Constructor.

Method Detail
AIR-only clear()method
public function clear():void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Clears this control so that it displays no items.

This method sets the dataProvider to null but leaves the directory property unchanged. You can call refresh to populate this control again.

AIR-only findIndex()method 
public function findIndex(nativePath:String):int

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Returns the index of the File item with the specified native file system path.

Items which are present in the control's collection but not displayed because of filtering are not searched.

Parameters

nativePath:String — A String specifying the nativePath of a File item.

Returns
int — A zero-based index, or -1 if no File was found with the specified path.

See also

flash.filesystem.File.nativePath
AIR-only findItem()method 
public function findItem(nativePath:String):File

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Searches the File instances currently displayed in this control and returns the one with the specified nativePathproperty.

File instances which are present in the control's collection but not displayed because of filtering are not searched.

Parameters

nativePath:String — A String specifying the nativePath of a File item.

Returns
File — A File instance if one was found with the specified nativePath, or null if none was found.
AIR-only navigateBack()method 
public function navigateBack(index:int = 0):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Changes this control to display the contents of a previously-visited directory in the backHistory array.

If the backHistory array is empty, or if you specify an index that is not in that array, then this method does nothing.

When this method returns, the directory property contains the File instance for the new directory. The dataProvider property is temporarily null until the new directory has been enumerated. After the enumeration, the dataProvider property contains an ArrayCollection of File instances for the new directory's contents.

The history list is left unchanged. However, the current index into it changes, which affects the backHistory and forwardHistory properties. They have new values as soon as this method returns.

The following example shows how to use this method along with the FileSystemHistoryButton control to create a back button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Back"
          enabled="{fileSystemViewer.canNavigateBack}"
          dataProvider="{fileSystemViewer.backHistory}"
          click="fileSystemViewer.navigateBack();"
          itemClick="fileSystemViewer.navigateBack(event.index);"/>

Parameters

index:int (default = 0) — The index in the backHistory array to navigate to. The default is 0, indicating the directory that is "closest back".

See also

AIR-only navigateDown()method 
public function navigateDown():void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Changes this control to display the contents of the selected subdirectory.

If a subdirectory is not selected, this method does nothing.

When this method returns, the directory property contains the File instance for the new directory. The dataProvider property is temporarily null until the new directory has been enumerated. After the enumeration, the dataProvider property contains an ArrayCollection of File instances for the new directory's contents.

The following example shows how to use this method along with the Button control to create an open button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:Button label="Open"
          enabled="{fileSystemViewer.canNavigateDown}"
          click="fileSystemViewer.navigateDown();"/>

See also

AIR-only navigateForward()method 
public function navigateForward(index:int = 0):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Changes this control to display the contents of a previously-visited directory in the forwardHistory array.

If the forwardHistory array is empty, or if you specify an index that is not in that array, then this method does nothing.

When this method returns, the directory property contains the File instance for the new directory. The dataProvider property is temporarily null until the new directory has been enumerated. After the enumeration, the dataProvider property contains an ArrayCollection of File instances for the new directory's contents.

The history list is left unchanged. However, the current index into it changes, which affects the backHistory and forwardHistory properties. They have new values as soon as this method returns.

The following example shows how to use this method along with the FileSystemHistoryButton control to create a forward button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:FileSystemHistoryButton label="Forward"
          enabled="{fileSystemViewer.canNavigateForward}"
          dataProvider="{fileSystemViewer.forwardHistory}"
          click="fileSystemViewer.navigateForward();"
          itemClick="fileSystemViewer.navigateForward(event.index);"/>

Parameters

index:int (default = 0) — The index in the forwardHistory array to navigate to. The default is 0, indicating the directory that is "closest forward".

See also

AIR-only navigateTo()method 
public function navigateTo(directory:File):void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Changes this control to display the contents of the specified directory.

Parameters

directory:File — A file object representing a file or directory.

AIR-only navigateUp()method 
public function navigateUp():void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Changes this control to display the contents of the next directory up in the hierarchy.

If this control is currently displaying root directories (such as C: and D: on Microsoft Windows), this method does nothing.

When this method returns, the directory property contains the File instance for the new directory. The dataProvider property is temporarily null until the new directory has been enumerated. After the enumeration, the dataProvider property contains an ArrayCollection of File instances for the new directory's contents.

The following example shows how to use this method along with the Button control to create an up button:

      <mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
      <mx:Button label="Up"
          enabled="{fileSystemViewer.canNavigateUp}"
          click="fileSystemViewer.navigateUp();"/>

See also

AIR-only refresh()method 
public function refresh():void

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Re-enumerates the current directory being displayed by this control.

Because AIR does not support file system notifications, this control does not automatically refresh if a file or subdirectory is created, deleted, moved, or renamed; in other words, it can display an out-of-date view of the file system. However, you can call refresh() to re-enumerate the current directory so that it is up-to-date. You could, for example, choose to do this when you have performed a file operation that you know causes the control's view to become stale, or when the user deactivates and reactivates your application.

This method preserves any selected items (if they still exist) and the scroll position (if the first visible item still exists).

Event Detail
AIR-only directoryChange Event
Event Object Type: mx.events.FileEvent
FileEvent.type property = mx.events.FileEvent.DIRECTORY_CHANGE

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Dispatched when the directory displayed by this control has changed for any reason.

The FileEvent.DIRECTORY_CHANGE constant defines the value of the type property of the event object for a directoryChange event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
fileThe File object associated with this event.
targetThe 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.
typeFileEvent.DIRECTORY_CHANGE
AIR-only directoryChanging Event  
Event Object Type: mx.events.FileEvent
FileEvent.type property = mx.events.FileEvent.DIRECTORY_OPENING

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Dispatched when the user tries to change the directory displayed by this control.

The user can try to change the directory by double-clicking a subdirectory, by pressing Enter or Ctrl-Down when a subdirectory is selected, by pressing Ctrl-Up when the control isn't displaying the COMPUTER directory, by pressing Ctrl-Left when there is a previous directory in the history list to navigate back to, or by pressing Ctrl-Right when there is a next directory in the history list to navigate forward to.

This event is cancelable. If you call event.preventDefault(), the directory is not changed.

After the directory property has changed and the dataProvider contains File instances for the items in the new directory, the directoryChange event is dispatched.

The FileEvent.DIRECTORY_OPENING constant defines the value of the type property of the event object for a directoryOpening event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelabletrue
currentTargetThe 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.
fileThe File object associated with this event.
targetThe 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.
typeFileEvent.DIRECTORY_OPENING
AIR-only fileChoose Event  
Event Object Type: mx.events.FileEvent
FileEvent.type property = mx.events.FileEvent.FILE_CHOOSE

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

Dispatched when the user chooses a file by double-clicking it or by selecting it and pressing Enter.

The FileEvent.FILE_CHOOSE constant defines the value of the type property of the event object for a fileChoose event.

The properties of the event object have the following values:

PropertyValue
bubblesfalse
cancelablefalse
currentTargetThe 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.
fileThe File object associated with this event.
targetThe 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.
typeFileEvent.FILE_CHOOSE
Constant Detail
AIR-only COMPUTERConstant
public static const COMPUTER:File

Language Version : ActionScript 3.0
Product Version : Flex 3
Runtime Versions : AIR 1.1

A constant that can be used as a value for the directory property, representing a pseudo-top level directory named "Computer". This pseudo-directory contains the root directories (such as C:\ and D:\ on Windows or / on Macintosh).