Adobe® Flex® 4 Language Reference
Show Packages and Classes List |  Packages  |  Classes  |  Index  |  Appendixes
mx.controls 
FileSystemDataGrid 
Packagemx.controls
Classpublic class FileSystemDataGrid
InheritanceFileSystemDataGrid Inheritance DataGrid Inheritance DataGridBase Inheritance ListBase Inheritance ScrollControlBase Inheritance UIComponent Inheritance FlexSprite Inheritance Sprite Inheritance DisplayObjectContainer Inheritance InteractiveObject Inheritance DisplayObject Inheritance EventDispatcher Inheritance Object

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

The FileSystemDataGrid control lets you display the contents of a single file system directory in a data grid format.

The information displayed for each item consists of its name (with optional generic icon), type, size, creation date, and modification date. To do this, FileSystemDataGrid automatically creates five columns (DataGridColumn instances) -- nameColumn, typeColumn, sizeColumn, creationDateColumn, and modificationDateColumn -- and sets the columns property to an array of these five instances. Each column instance is automatically configured to have an appropriate labelFunction, sortCompareFunction, etc. If you don't want all five columns, or if you want to change the order, reset the columns property. If you want to customize a column, such as by changing its labelFunction, simply reassign that property on the appropriate column object.

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:FileSystemDataGrid 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 property 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 FileSystemDataGrid, even though they are accessible in AIR via the icon property of a File.

MXML SyntaxexpandedHide MXML Syntax

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

  <mx:FileSystemDataGrid
    Properties
    dateFormatString=""
    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



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
 InheritedaccessibilityImplementation : AccessibilityImplementation
The current accessibility implementation (AccessibilityImplementation) for this InteractiveObject instance.
InteractiveObject
 InheritedaccessibilityName : String
A convenience accessor for the name property in this UIComponent's accessibilityProperties object.
UIComponent
 InheritedaccessibilityProperties : AccessibilityProperties
The current accessibility options for this display object.
DisplayObject
 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
 Inheritedalpha : Number
Indicates the alpha transparency value of the object specified.
DisplayObject
 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.
FileSystemDataGrid
 Inheritedbaseline : Object
The vertical distance in pixels from the anchor target to the control's baseline position.
UIComponent
 InheritedbaselinePosition : Number
[read-only] The y-coordinate of the baseline of the first line of text of the component.
UIComponent
 InheritedblendMode : String
A value from the BlendMode class that specifies which blend mode to use.
DisplayObject
 InheritedblendShader : Shader
[write-only] Sets a shader that is used for blending the foreground and background.
DisplayObject
 InheritedborderMetrics : EdgeMetrics
[read-only] Returns an EdgeMetrics object that has four properties: left, top, right, and bottom.
ScrollControlBase
 Inheritedbottom : Object
The vertical distance in pixels from the bottom edge of the component to the anchor target's bottom edge.
UIComponent
 InheritedbuttonMode : Boolean
Specifies the button mode of this sprite.
Sprite
 InheritedcacheAsBitmap : Boolean
If set to true, Flash runtimes cache an internal bitmap representation of the display object.
DisplayObject
 InheritedAIR-only cacheAsBitmapMatrix : Matrix
If non-null, this Matrix object defines how a display object is rendered when cacheAsBitmap is set to true.
DisplayObject
 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.
FileSystemDataGrid
  AIR-only canNavigateDown : Boolean
[read-only] A flag which is true if the user can navigate down into a selected directory.
FileSystemDataGrid
  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.
FileSystemDataGrid
  AIR-only canNavigateUp : Boolean
[read-only] A flag which is true if the user can navigate up to a parent directory.
FileSystemDataGrid
 InheritedclassName : String
[read-only] The name of this instance's class, such as "Button".
UIComponent
 Inheritedcolumns : Array
[override] An array of DataGridColumn objects, one for each column that can be displayed.
DataGrid
 Inheritedconstructor : Object
A reference to the class object or constructor function for a given object instance.
Object
 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
 InheritedcontextMenu : NativeMenu
Specifies the context menu associated with this object.
InteractiveObject
  AIR-only creationDateColumn : DataGridColumn
The DataGridColumn representing the Created column.
FileSystemDataGrid
 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
  AIR-only dateFormatString : String
A String that determines how dates in the Created and Modified columns are formatted.
FileSystemDataGrid
 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.
FileSystemDataGrid
 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
 InheriteddraggableColumns : Boolean
A flag that indicates whether the user is allowed to reorder columns.
DataGrid
 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
 InheriteddropTarget : DisplayObject
[read-only] Specifies the display object over which the sprite is being dragged, or on which the sprite was dropped.
Sprite
 Inheritededitable : Boolean
A flag that indicates whether or not the user can edit items in the data provider.
DataGrid
 InheritededitedItemPosition : Object
The column and row index of the item renderer for the data provider item being edited, if any.
DataGrid
 InheritededitedItemRenderer : IListItemRenderer
[read-only] A reference to the item renderer in the DataGrid control whose item is currently being edited.
DataGrid
 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.
DataGrid
  AIR-only enumerationMode : String
A String specifying whether this control displays only files, only subdirectories, or both.
FileSystemDataGrid
 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.
FileSystemDataGrid
  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.
FileSystemDataGrid
 Inheritedfilters : Array
An indexed array that contains each filter object currently associated with the display object.
DisplayObject
 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
 InheritedfocusRect : Object
Specifies whether this object displays a focus rectangle.
InteractiveObject
 InheritedfontContext : IFlexModuleFactory
The module factory that provides the font context for this component.
DataGridBase
  AIR-only forwardHistory : Array
[read-only] An Array of File objects representing directories to which the user can navigate forward.
FileSystemDataGrid
 Inheritedgraphics : Graphics
[read-only] Specifies the Graphics object that belongs to this sprite where vector drawing commands can occur.
Sprite
 InheritedhasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus.
UIComponent
 InheritedhasLayoutMatrix3D : Boolean
[read-only] Contians true if the element has 3D Matrix.
UIComponent
 InheritedheaderHeight : Number
The height of the header cell of the column, in pixels.
DataGridBase
 Inheritedheight : Number
[override] Number that specifies the height of the component, in pixels, in the parent's coordinates.
UIComponent
 InheritedhitArea : Sprite
Designates another sprite to serve as the hit area for a sprite.
Sprite
 InheritedhorizontalCenter : Object
The horizontal distance in pixels from the center of the component to the center of the anchor target's content area.
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
[override] The offset into the content from the left edge.
DataGrid
 Inheritedid : String
ID of the component.
UIComponent
 InheritedimeMode : String
Specifies the IME (input method editor) mode.
DataGrid
 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
 InheriteditemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor, if it exists.
DataGrid
 InheriteditemRenderer : IFactory
The custom item renderer for the control.
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
The horizontal distance in pixels from the left edge of the component to the anchor target's left edge.
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
 InheritedloaderInfo : LoaderInfo
[read-only] Returns a LoaderInfo object containing information about loading the file to which this display object belongs.
DisplayObject
 InheritedlockedColumnCount : int
The index of the first column in the control that scrolls.
DataGridBase
 InheritedlockedRowCount : int
The index of the first row in the control that scrolls.
DataGridBase
 InheritedmaintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the middle of its bounding box.
UIComponent
 Inheritedmask : DisplayObject
The calling display object is masked by the specified mask object.
DisplayObject
 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
 InheritedminColumnWidth : Number
The minimum width of the columns, in pixels.
DataGrid
 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
  AIR-only modificationDateColumn : DataGridColumn
The DataGridColumn representing the Modified column.
FileSystemDataGrid
 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
 InheritedmouseChildren : Boolean
Determines whether or not the children of the object are mouse, or user input device, enabled.
DisplayObjectContainer
 InheritedmouseEnabled : Boolean
Specifies whether this object receives mouse, or other user input, messages.
InteractiveObject
 InheritedmouseFocusEnabled : Boolean
Whether you can receive focus when clicked on.
UIComponent
 InheritedmouseX : Number
[read-only] Indicates the x coordinate of the mouse or user input device position, in pixels.
DisplayObject
 InheritedmouseY : Number
[read-only] Indicates the y coordinate of the mouse or user input device position, in pixels.
DisplayObject
 Inheritedname : String
Indicates the instance name of the DisplayObject.
DisplayObject
  AIR-only nameColumn : DataGridColumn
The DataGridColumn representing the Name column.
FileSystemDataGrid
  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.
FileSystemDataGrid
 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
 InheritednumChildren : int
[read-only] Returns the number of children of this object.
DisplayObjectContainer
 InheritedopaqueBackground : Object
Specifies whether the display object is opaque with a certain background color.
DisplayObject
 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 : mx.geom:TransformOffsets
Defines a set of adjustments that can be applied to the object's transform in a way that is invisible to its parent's layout.
UIComponent
 InheritedprocessedDescriptors : Boolean
Set to true after immediate or deferred child creation, depending on which one happens.
UIComponent
 Inheritedprototype : Object
[static] A reference to the prototype object of a class or function object.
Object
 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
 InheritedresizableColumns : Boolean = true
A flag that indicates whether the user can change the size of the columns.
DataGrid
 Inheritedright : Object
The horizontal distance in pixels from the right edge of the component to the anchor target's right edge.
UIComponent
 Inheritedroot : DisplayObject
[read-only] For a display object in a loaded SWF file, the root property is the top-most display object in the portion of the display list's tree structure represented by that SWF file.
DisplayObject
 Inheritedrotation : Number
[override] Indicates the rotation of the DisplayObject instance, in degrees, from its original orientation.
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] Indicates the z-axis rotation of the DisplayObject instance, in degrees, from its original orientation relative to the 3D parent container.
UIComponent
 InheritedrowCount : int
Number of rows to be displayed.
ListBase
 InheritedrowHeight : Number
The height of the rows in pixels.
ListBase
 Inheritedscale9Grid : Rectangle
The current scaling grid that is in effect.
DisplayObject
 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
 InheritedscrollRect : Rectangle
The scroll rectangle bounds of the display object.
DisplayObject
 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.
FileSystemDataGrid
  AIR-only selectedPaths : Array
An Array of nativePath Strings for the File items representing the selected subdirectories and files.
FileSystemDataGrid
  AIR-only showExtensions : Boolean
A flag that specifies whether extensions in file names are shown.
FileSystemDataGrid
 InheritedshowHeaders : Boolean
A flag that indicates whether the control should show column headers.
DataGridBase
  AIR-only showHidden : Boolean
A flag that specifies whether files and directories that the operating system considers hidden are displayed.
FileSystemDataGrid
  AIR-only showIcons : Boolean
A flag that specifies that icons are displayed before the file name.
FileSystemDataGrid
 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
  AIR-only sizeColumn : DataGridColumn
The DataGridColumn representing the Size column.
FileSystemDataGrid
  AIR-only sizeDisplayMode : String
A String specifying whether the Size column displays file sizes in bytes or rounded up to the nearest kilobyte, where a kilobyte is 1024 bytes.
FileSystemDataGrid
 InheritedsortableColumns : Boolean = true
A flag that indicates whether the user can sort the data provider items by clicking on a column header cell.
DataGrid
 InheritedsoundTransform : flash.media:SoundTransform
Controls sound within this sprite.
Sprite
 Inheritedstage : Stage
[read-only] The Stage of the display object.
DisplayObject
 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
[read-only] A component's parent is used to evaluate descendant selectors.
UIComponent
 InheritedsystemManager : ISystemManager
Returns the SystemManager object used by this component.
UIComponent
 InheritedtabChildren : Boolean
Determines whether the children of the object are tab enabled.
DisplayObjectContainer
 InheritedtabEnabled : Boolean
Specifies whether this object is in the tab order.
InteractiveObject
 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
 InheritedtabIndex : int
Specifies the tab ordering of objects in a SWF file.
InteractiveObject
 InheritedtextSnapshot : flash.text:TextSnapshot
[read-only] Returns a TextSnapshot object for this DisplayObjectContainer instance.
DisplayObjectContainer
 InheritedtoolTip : String
Text to display in the ToolTip.
UIComponent
 Inheritedtop : Object
The vertical distance in pixels from the top edge of the component to the anchor target's top edge.
UIComponent
 Inheritedtransform : flash.geom:Transform
An object with properties pertaining to a display object's matrix, color transform, and pixel bounds.
DisplayObject
 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
  AIR-only typeColumn : DataGridColumn
The DataGridColumn representing the Type column.
FileSystemDataGrid
 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
 InheriteduseHandCursor : Boolean
A Boolean value that indicates whether the pointing hand (hand cursor) appears when the pointer rolls over a sprite in which the buttonMode property is set to true.
Sprite
 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
The vertical distance in pixels from the center of the component to the center of the anchor target's content area.
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] Indicates the z coordinate position along the z-axis of the DisplayObject instance relative to the 3D parent container.
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
 InheritedcolumnCaretIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is the caret for lockedColumns.
DataGridBase
 InheritedcolumnHighlightIndicator : Sprite
The DisplayObject that contains the graphics that indicates which renderer is highlighted for lockedColumns.
DataGridBase
 InheritedcolumnMap : Object
A map of item renderes to columns.
DataGridBase
 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
 InheritedfreeItemRenderersTable : Dictionary
A per-column table of unused item renderers.
DataGridBase
 InheritedhasComplexLayoutMatrix : Boolean
[read-only] Returns true if the UIComponent has any non-translation (x,y) transform properties.
UIComponent
 Inheritedheader : DataGridHeaderBase
The header sub-component.
DataGridBase
 InheritedheaderMask : Shape
DataGridBase
 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
 InheritedlockedColumnAndRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows for locked columns.
DataGridBase
 InheritedlockedColumnContent : ListBaseContentHolder
The sub-component that contains locked columns.
DataGridBase
 InheritedlockedColumnHeader : DataGridHeaderBase
The header sub-component for locked columns.
DataGridBase
 InheritedlockedRowContent : DataGridLockedRowContentHolder
The sub-component that contains locked rows.
DataGridBase
 InheritedmaskShape : Shape
The mask.
ScrollControlBase
 InheritedmodifiedCollectionView : ModifiedCollectionView
The collection view that temporarily preserves previous data provider state to facilitate running data change effects.
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.
FileSystemDataGrid
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds a child DisplayObject instance to this DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Adds an item renderer if a data change effect is running.
ListBase
 Inherited
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Registers an event listener object with an EventDispatcher object so that the listener receives notification of an event.
EventDispatcher
 Inherited
Indicates whether the security restrictions would cause any display objects to be omitted from the list returned by calling the DisplayObjectContainer.getObjectsUnderPoint() method with the specified point point.
DisplayObjectContainer
 Inherited
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
  
Clears this control so that it displays no items.
FileSystemDataGrid
 Inherited
Deletes a style property from this component instance.
UIComponent
 Inherited
Determines whether the specified display object is a child of the DisplayObjectContainer instance or the instance itself.
DisplayObjectContainer
 Inherited
Converts a Point object from content coordinates to global coordinates.
UIComponent
 Inherited
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 that identify the child within this container.
UIComponent
 Inherited
Returns the item renderer for a column cell or for a column header.
DataGridBase
 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.
DataGrid
 Inherited
Creates an item renderer given the data object.
ListBase
 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
This method closes an item editor currently open on an item renderer.
DataGrid
 Inherited
Returns a UITextFormat object corresponding to the text styles for this UIComponent.
UIComponent
 Inherited
[override] Dispatches an event into the event flow.
UIComponent
 Inherited
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.
FileSystemDataGrid
  
AIR-only findItem(nativePath:String):File
Searches the File instances currently displayed in this control and returns the one with the specified nativePathproperty.
FileSystemDataGrid
 Inherited
Finds an item in the list based on a String, and moves the selection to it.
ListBase
 Inherited
Called after printing is complete.
UIComponent
 Inherited
Provides the automation object at the specified index.
UIComponent
 Inherited
Provides the automation object list .
UIComponent
 Inherited
getBounds(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the area of the display object relative to the coordinate system of the targetCoordinateSpace object.
DisplayObject
 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
Returns the child display object instance that exists at the specified index.
DisplayObjectContainer
 Inherited
Returns the child display object that exists with the specified name.
DisplayObjectContainer
 Inherited
Returns the index position of a child DisplayObject instance.
DisplayObjectContainer
 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
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
Returns an array of objects that lie under the specified point and are children (or grandchildren, and so on) of this DisplayObjectContainer instance.
DisplayObjectContainer
 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
getRect(targetCoordinateSpace:DisplayObject):Rectangle
Returns a rectangle that defines the boundary of the display object, based on the coordinate system defined by the targetCoordinateSpace parameter, excluding any strokes on shapes.
DisplayObject
 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
Converts a Point object from global to content coordinates.
UIComponent
 Inherited
Converts the point object from the Stage (global) coordinates to the display object's (local) coordinates.
DisplayObject
 Inherited
Converts a two-dimensional point from the Stage (global) coordinates to a three-dimensional display object's (local) coordinates.
DisplayObject
 Inherited
Checks whether the EventDispatcher object has any listeners registered for a specific type of event.
EventDispatcher
 Inherited
Indicates whether an object has a specified property defined.
Object
 Inherited
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
Evaluates the bounding box of the display object to see if it overlaps or intersects with the bounding box of the obj display object.
DisplayObject
 Inherited
hitTestPoint(x:Number, y:Number, shapeFlag:Boolean = false):Boolean
Evaluates the display object to see if it overlaps or intersects with the point specified by the x and y parameters.
DisplayObject
 Inherited
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
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
Determines whether to allow editing of a dataprovider item on a per-row basis.
DataGrid
 Inherited
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
Determines if the item renderer for a data provider item is selectable.
ListBase
 Inherited
Determines if the item renderer for a data provider item is selected.
ListBase
 Inherited
Determines if the item renderer for a data provider item is the item under the caret due to keyboard navigation.
ListBase
 Inherited
Determines if an item is being displayed by a renderer.
ListBase
 Inherited
Indicates whether an instance of the Object class is in the prototype chain of the object specified as the parameter.
Object
 Inherited
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
Returns the dataTip string the renderer would display for the given data object based on the dataTipField and dataTipFunction properties.
ListBase
 Inherited
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
Returns the string the renderer would display for the given data object based on the labelField and labelFunction properties.
ListBase
 Inherited
Converts a three-dimensional point of the three-dimensional display object's (local) coordinates to a two-dimensional point in the Stage (global) coordinates.
DisplayObject
 Inherited
Converts a Point object from local to content coordinates.
UIComponent
 Inherited
Converts the point object from the display object's (local) coordinates to the Stage (global) coordinates.
DisplayObject
 Inherited
Returns true if cssState matches currentCSSState.
UIComponent
 Inherited
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
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
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
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.
FileSystemDataGrid
  
Changes this control to display the contents of the selected subdirectory.
FileSystemDataGrid
  
AIR-only navigateForward(index:int = 0):void
Changes this control to display the contents of a previously-visited directory in the forwardHistory array.
FileSystemDataGrid
  
AIR-only navigateTo(directory:File):void
Changes this control to display the contents of the specified directory.
FileSystemDataGrid
  
Changes this control to display the contents of the next directory up in the hierarchy.
FileSystemDataGrid
 Inherited
Propagates style changes to the children.
UIComponent
 Inherited
Returns true if the chain of owner properties points from child to this UIComponent.
UIComponent
 Inherited
Called by Flex when a UIComponent object is added to or removed from a parent.
UIComponent
 Inherited
Prepares an IFlexDisplayObject for printing.
UIComponent
 Inherited
Indicates whether the specified property exists and is enumerable.
Object
  
Re-enumerates the current directory being displayed by this control.
FileSystemDataGrid
 Inherited
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
For each effect event, registers the EffectManager as one of the event listeners.
UIComponent
 Inherited
Removes the specified child DisplayObject instance from the child list of the DisplayObjectContainer instance.
DisplayObjectContainer
 Inherited
Removes a child DisplayObject from the specified index position in the child list of the DisplayObjectContainer.
DisplayObjectContainer
 Inherited
Removes an item renderer if a data change effect is running.
ListBase
 Inherited
removeEventListener(type:String, listener:Function, useCapture:Boolean = false):void
Removes a listener from the EventDispatcher object.
EventDispatcher
 Inherited
Replays the specified event.
UIComponent
 Inherited
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
Ensures that the data provider item at the given index is visible.
ListBase
 Inherited
Sizes the object.
UIComponent
 Inherited
Changes the position of an existing child in the display object container.
DisplayObjectContainer
 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
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
Sets the availability of a dynamic property for loop operations.
Object
 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
startDrag(lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite.
Sprite
 Inherited
startTouchDrag(touchPointID:int, lockCenter:Boolean = false, bounds:Rectangle = null):void
Lets the user drag the specified sprite on a touch-enabled device.
Sprite
 Inherited
Ends the startDrag() method.
Sprite
 Inherited
stopTouchDrag(touchPointID:int):void
Ends the startTouchDrag() method, for use with touch-enabled devices.
Sprite
 Inherited
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
Swaps the z-order (front-to-back order) of the two specified child objects.
DisplayObjectContainer
 Inherited
swapChildrenAt(index1:int, index2:int):void
Swaps the z-order (front-to-back order) of the child objects at the two specified index positions in the child list.
DisplayObjectContainer
 Inherited
Returns the string representation of this object, formatted according to locale-specific conventions.
Object
 Inherited
[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
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
Returns the primitive value of the specified object.
Object
 Inherited
Returns a box Matrix which can be passed to drawRoundRect() as the rot parameter when drawing a vertical gradient.
UIComponent
 Inherited
Checks whether an event listener is registered with this EventDispatcher object or any of its ancestors for the specified event type.
EventDispatcher
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
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
Adjust the focus rectangle.
UIComponent
 Inherited
adjustListContent(unscaledWidth:Number = -1, unscaledHeight:Number = -1):void
[override] Called from the updateDisplayList() method to adjust the size and position of listContent.
DataGrid
 Inherited
adjustRow(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number):void
Adjusts the size and positions of the renderers for the given rowNum, row position and height.
DataGridBase
 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
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
Calculates the y position of the drop indicator when performing a drag-and-drop operation.
ListBase
 Inherited
calculateRowHeight(data:Object, hh:Number, skipVisible:Boolean = false):Number
Calculates the row height of columns in a row.
DataGridBase
 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
Clears the caret indicator into the given Sprite.
ListBase
 Inherited
Clears the highlight indicator in the given Sprite.
ListBase
 Inherited
Removes all selection and highlight and caret indicators.
ListBase
 Inherited
clearRow(contentHolder:ListBaseContentHolder, rowNum:int):void
Removes renderers from a row that should be empty for the given rowNum.
DataGridBase
 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
Removes column header separators that the user normally uses to resize columns.
DataGrid
 Inherited
Empty the visibleData hash table.
ListBase
 Inherited
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
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
Creates a new object using a context based on the embedded font being used.
UIComponent
 Inherited
Creates the object using a given moduleFactory.
UIComponent
 Inherited
deriveComplexFieldReference(data:Object, complexFieldNameComponents:Array):Object
DataGrid
 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
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
drawColumnBackground(s:Sprite, columnIndex:int, color:uint, column:DataGridColumn):void
Draws a column background for a column with the suggested color.
DataGrid
 Inherited
Draws the background of the headers into the given UIComponent.
DataGrid
 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
drawHorizontalLine(s:Sprite, rowIndex:int, color:uint, y:Number):void
Draws a line between rows.
DataGrid
 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
Draw lines between columns, and column backgrounds.
DataGrid
 Inherited
drawLinesAndColumnGraphics(contentHolder:ListBaseContentHolder, visibleColumns:Array, separators:Object):void
Draw lines between columns, and column backgrounds.
DataGrid
 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 using the color specified.
DataGrid
 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
Creates and displays the column header separators that the user normally uses to resize columns.
DataGrid
 Inherited
drawVerticalLine(s:Sprite, colIndex:int, color:uint, x:Number):void
Draw lines between columns.
DataGrid
 Inherited
drawVisibleItem(uid:String, selected:Boolean = false, highlighted:Boolean = false, caret:Boolean = false, transition:Boolean = false):void
Draws an item if it is visible.
DataGridBase
 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
[override] Sets selected items based on the caretIndex and anchorIndex properties.
DataGridBase
 Inherited
The event handler called when a UIComponent object gets focus.
UIComponent
 Inherited
The event handler called when a UIComponent object loses focus.
UIComponent
 Inherited
DataGrid
 Inherited
Retrieves an already-created item renderer not currently in use.
ListBase
 Inherited
The column for the data provider item at the given index.
ListBase
 Inherited
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
DataGrid
 Inherited
Typically overridden by components containing UITextField objects, where the UITextField object gets focus.
UIComponent
 Inherited
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
[override] Returns a Point object that defines the columnIndex and rowIndex properties of an item renderer.
DataGridBase
 Inherited
Determines the UID for a data provider item.
ListBase
 Inherited
The event handler called for a keyDown event.
UIComponent
 Inherited
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
Sizes and temporarily positions an itemRenderer for a column, returning its size as a Point.
DataGridBase
 Inherited
makeListData(data:Object, uid:String, rowNum:int, columnNum:int, column:DataGridColumn):BaseListData
Creates a new DataGridListData instance and populates the fields based on the input data provider item.
DataGridBase
 Inherited
makeRow(contentHolder:ListBaseContentHolder, rowNum:int, left:Number, right:Number, yy:Number, data:Object, uid:String):Number
Creates the renderers for the given rowNum, dataObject and uid.
DataGridBase
 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
[override] Calculates the measured width and height of the component based on the rowCount, columnCount, rowHeight and columnWidth properties.
ListBase
 Inherited
Handles MouseEvent.MOUSE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_DOUBLE_CLICK events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
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
Handles MouseEvent.MOUSE_MOVE events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_OUT events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_OVER events from any mouse targets contained in the list, including the renderers.
ListBase
 Inherited
Handles MouseEvent.MOUSE_DOWN events from any mouse targets contained in the list including the renderers.
ListBase
 Inherited
[override] Handles mouseWheel events by changing scroll positions.
ListBase
 Inherited
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
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
[override] Moves the selection in a vertical direction in response to the user selecting items with the up arrow or down arrow keys and modifiers such as the Shift and Ctrl keys.
DataGridBase
 Inherited
Draws the sort arrow graphic on the column that is the current sort key.
DataGrid
 Inherited
Prepares the data effect for the collection event.
ListBase
 Inherited
Ensures that there is a slot in the row arrays for the given row number.
DataGridBase
 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
Removes extra row from the end of the contentHolder.
DataGridBase
 Inherited
Remove a row from the arrays that store references to the row.
ListBase
 Inherited
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
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
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
[override] Returns the data provider index for the item at the first visible row and column for the given scroll positions.
DataGrid
 Inherited
scrollVertically(pos:int, deltaPos:int, scrollUp:Boolean):void
[override] Adjusts the renderers in response to a change in scroll position.
DataGrid
 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
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
setNewValue(data:Object, property:String, value:Object, columnIndex:int):Boolean
DataGrid
 Inherited
Sets the rowCount property without causing invalidation or setting the explicitRowCount property, which permanently locks in the number of rows.
ListBase
 Inherited
Sets the rowHeight property without causing invalidation or setting of explicitRowHeight which permanently locks in the height of the rows.
ListBase
 Inherited
setRowInfo(contentHolder:ListBaseContentHolder, rowNum:int, yy:Number, hh:Number, uid:String):void
Sets the rowInfo for the given rowNum, row position and height.
DataGridBase
 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
Sets up an item renderer for a column and put it in the listItems array at the requested position.
DataGridBase
 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
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
Refreshes all rows.
ListBase
 Inherited
Redraws the renderer synchronously.
DataGridBase
Events
 Event Summary Defined By
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application gains operating system focus and becomes active.EventDispatcher
 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 a display object is added to the display list.DisplayObject
 InheritedDispatched when a display object is added to the on stage display list, either directly or through the addition of a sub tree in which the display object is contained.DisplayObject
 InheritedDispatched when the selectedIndex or selectedItem property changes as a result of user interaction.ListBase
 InheritedDispatched when the user selects 'Clear' (or 'Delete') from the text context menu.InteractiveObject
 InheritedDispatched when a user presses and releases the main button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user changes the width of a column, indicating that the amount of data displayed in that column may have changed.DataGrid
 InheritedDispatched when a user gesture triggers the context menu associated with this interactive object in an AIR application.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a copy operation or selects 'Copy' from the text context menu.InteractiveObject
 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 user activates the platform specific accelerator key combination for a cut operation or selects 'Cut' from the text context menu.InteractiveObject
 InheritedDispatched when the data property changes.ListBase
 Inherited[broadcast event] Dispatched when the Flash Player or AIR application operating loses system focus and is becoming inactive.EventDispatcher
  Dispatched when the selected directory displayed by this control changes for any reason.FileSystemDataGrid
  Dispatched when the user tries to change the directory displayed by this control.FileSystemDataGrid
 InheritedDispatched when a user presses and releases the main button of a pointing device twice in rapid succession over the same InteractiveObject when that object's doubleClickEnabled flag is set to true.InteractiveObject
 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
 Inherited[broadcast event] Dispatched when the playhead is entering a new frame.DisplayObject
 InheritedDispatched after the component has entered a view state.UIComponent
 Inherited[broadcast event] Dispatched when the playhead is exiting the current frame.DisplayObject
 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.FileSystemDataGrid
 InheritedDispatched after a display object gains focus.InteractiveObject
 InheritedDispatched after a display object loses focus.InteractiveObject
 Inherited[broadcast event] Dispatched after the constructors of frame display objects have run but before frame scripts have run.DisplayObject
 InheritedDispatched when the user moves a point of contact over the InteractiveObject instance on a touch-enabled device (such as moving a fingers from left to right over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user creates a point of contact with an InteractiveObject instance, then taps on a touch-enabled device (such as placing several fingers over a display object to open a menu and then taps one finger to select a menu item on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a rotation gesture at a point of contact with an InteractiveObject instance (such as touching two fingers and rotating them over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a swipe gesture at a point of contact with an InteractiveObject instance (such as touching three fingers to a screen and then moving them in parallel over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user presses two points of contact over the same InteractiveObject instance on a touch-enabled device (such as presses and releases two fingers over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user performs a zoom gesture at a point of contact with an InteractiveObject instance (such as touching two fingers to a screen and then quickly spreading the fingers apart over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user releases the mouse button on a column header to request the control to sort the grid contents based on the contents of the column.DataGrid
 InheritedDispatched when the user releases the mouse button on a column header after having dragged the column to a new location resulting in shifting the column to a new index.DataGrid
 InheritedDispatched when an object's state changes from visible to invisible.UIComponent
 InheritedThis event is dispatched to any client app that supports inline input with an IMEInteractiveObject
 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 has been set and the item can be edited.DataGrid
 InheritedDispatched when the user releases the mouse button while over an item renderer, tabs to the DataGrid control or within the DataGrid control, or in any other way attempts to edit an item.DataGrid
 InheritedDispatched when an item editing session ends for any reason.DataGrid
 InheritedDispatched when the item editor has just been instantiated.DataGrid
 InheritedDispatched when an item renderer gets focus, which can occur if the user clicks on an item in the DataGrid control or navigates to the item using a keyboard.DataGrid
 InheritedDispatched when an item renderer loses focus, which can occur if the user clicks another item in the DataGrid control or clicks outside the control, or uses the keyboard to navigate to another item in the DataGrid control or outside the control.DataGrid
 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 when the user presses a key.InteractiveObject
 InheritedDispatched when the user attempts to change focus by using keyboard navigation.InteractiveObject
 InheritedDispatched when the user releases a key.InteractiveObject
 InheritedDispatched when a user presses and releases the middle button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the middle pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched from a component opened using the PopUpManager when the user clicks outside it.UIComponent
 InheritedDispatched when the user attempts to change focus by using a pointer device.InteractiveObject
 InheritedDispatched when a user moves the pointing device while it is over an InteractiveObject.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a mouse wheel is spun over an InteractiveObject instance.InteractiveObject
 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 by the drag initiator InteractiveObject when the user releases the drag gesture.InteractiveObject
 InheritedDispatched by the target InteractiveObject when a dragged object is dropped on it and the drop has been accepted with a call to DragManager.acceptDragDrop().InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture enters its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject when a drag gesture leaves its boundary.InteractiveObject
 InheritedDispatched by an InteractiveObject continually while a drag gesture remains within its boundary.InteractiveObject
 InheritedDispatched at the beginning of a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched during a drag operation by the InteractiveObject that is specified as the drag initiator in the DragManager.doDrag() call.InteractiveObject
 InheritedDispatched when the user activates the platform specific accelerator key combination for a paste operation or selects 'Paste' from the text context menu.InteractiveObject
 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 a display object is about to be removed from the display list.DisplayObject
 InheritedDispatched when a display object is about to be removed from the display list, either directly or through the removal of a sub tree in which the display object is contained.DisplayObject
 Inherited[broadcast event] Dispatched when the display list is about to be updated and rendered.DisplayObject
 InheritedDispatched when the component is resized.UIComponent
 InheritedDispatched when a user presses and releases the right button of the user's pointing device over the same InteractiveObject.InteractiveObject
 InheritedDispatched when a user presses the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when a user releases the pointing device button over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device away from an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the user moves a pointing device over an InteractiveObject instance.InteractiveObject
 InheritedDispatched when the content is scrolled.ScrollControlBase
 InheritedDispatched when the user activates the platform specific accelerator key combination for a select all operation or selects 'Select All' from the text context menu.InteractiveObject
 InheritedDispatched when an object's state changes from invisible to visible.UIComponent
 InheritedDispatched when the value of the object's tabChildren flag changes.InteractiveObject
 InheritedDispatched when the object's tabEnabled flag changes.InteractiveObject
 InheritedDispatched when the value of the object's tabIndex property changes.InteractiveObject
 InheritedDispatched when a user enters one or more characters of text.InteractiveObject
 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
 InheritedDispatched when the user first contacts a touch-enabled device (such as touches a finger to a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user removes contact with a touch-enabled device (such as lifts a finger off a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact with a touch-enabled device (such as drags a finger across a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from InteractiveObject instance on a touch-enabled device (such as drags a finger from one display object to another on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact away from an InteractiveObject instance on a touch-enabled device (such as drags a finger from over a display object to a point outisde the display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user moves the point of contact over an InteractiveObject instance on a touch-enabled device (such as drags a finger from a point outside a display object to a point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 InheritedDispatched when the user lifts the point of contact over the same InteractiveObject instance on which the contact was initiated on a touch-enabled device (such as presses and releases a finger from a single point over a display object on a mobile phone or tablet with a touch screen).InteractiveObject
 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

Styles are either common or associated with a specific theme. If the style is common, it can be used with any theme. If a style is associated with a specific theme, it can only be used if your application uses that theme.

Common Styles
 Style Description Defined By
 InheritedType: Array Format: Color CSS Inheritance: yes
The colors to use for the backgrounds of the items in the list.
ListBase
 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: Class CSS Inheritance: no
The border skin class of the component.
ScrollControlBase
 InheritedType: String CSS Inheritance: no
Bounding box style.
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
Color of text in the component, including the component label.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that indicates that a column can be dropped in the current location.
DataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin for a column that is being resized.
DataGrid
 InheritedType: Class CSS Inheritance: no
Name of the class of the itemEditor to be used if one is not specified for a column.
DataGrid
 InheritedType: Class CSS Inheritance: no
Name of the class of the itemRenderer to be used if one is not specified for a column or its header.
DataGrid
 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.
FileSystemDataGrid
 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
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.
FileSystemDataGrid
 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: 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.
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.
ScrollControlBase
 InheritedType: Number CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls.
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.
ScrollControlBase
 InheritedType: String CSS Inheritance: yes
Determines whether the text is boldface.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the background of the column headers in a DataGrid control.
DataGrid
 InheritedType: String CSS Inheritance: no
The name of a CSS style declaration for controlling aspects of the appearance of column when the user is dragging it to another location.
DataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between column headers in a DataGrid control.
DataGrid
 InheritedType: String CSS Inheritance: no
The name of a CSS style declaration for controlling other aspects of the appearance of the column headers.
DataGrid
 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: uint Format: Color CSS Inheritance: yes
The color of the horizontal grid lines.
DataGrid
 InheritedType: Boolean CSS Inheritance: no
A flag that indicates whether to show horizontal grid lines between the rows.
DataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between the locked and unlocked rows in a DataGrid control.
DataGrid
 InheritedType: String CSS Inheritance: no
Style name for horizontal scrollbar.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between rows in a DataGrid control.
DataGrid
 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.
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 row background when the user rolls over the row.
DataGrid
 InheritedType: uint Format: Color CSS Inheritance: yes
The color of the background for the row when the user selects an item renderer in the row.
DataGrid
 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: Class CSS Inheritance: no
The class to use as the skin for the arrow that indicates the column sort direction.
DataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin for the cursor that indicates that a column can be resized.
DataGrid
 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: 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: uint Format: Color CSS Inheritance: yes
The color of the vertical grid lines.
DataGrid
 InheritedType: Boolean CSS Inheritance: no
A flag that indicates whether to show vertical grid lines between the columns.
DataGrid
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separator between the locked and unlocked columns in a DataGrid control.
DataGrid
 InheritedType: String CSS Inheritance: no
Style name for vertical scrollbar.
ScrollControlBase
 InheritedType: Class CSS Inheritance: no
The class to use as the skin that defines the appearance of the separators between columns in a DataGrid control.
DataGrid
Spark Theme Styles
 Style Description Defined By
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Accent color used by component skins.
ScrollControlBase
 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: Boolean CSS Inheritance: no Theme: spark
Visibility of the border.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
The main color for a component.
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: 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 Theme: spark
Color of focus ring when the component is in focus
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: spark
Color of any symbol of a component.
ScrollControlBase
Halo Theme Styles
 Style Description Defined By
 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: 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: Number Format: Length CSS Inheritance: no Theme: halo
Bounding box thickness.
ScrollControlBase
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
The color for the icon in a disabled skin.
DataGrid
 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: Array Format: Color CSS Inheritance: yes Theme: halo
An array of two colors used to draw the header background gradient.
DataGrid
 InheritedType: uint Format: Color CSS Inheritance: yes Theme: halo
The color for the icon in a skin.
DataGrid
 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: uint Format: Color CSS Inheritance: yes Theme: halo
Theme color of a component.
UIComponent
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: 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".
FileSystemDataGrid
 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 

backHistory

property
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:FileSystemDataGrid 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. When this property is modified, it dispatches the historyChanged event.



Implementation
    public function get backHistory():Array

See also

AIR-only 

canNavigateBack

property 
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:FileSystemDataGrid 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. When this property is modified, it dispatches the historyChanged event.



Implementation
    public function get canNavigateBack():Boolean

See also

AIR-only 

canNavigateDown

property 
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:FileSystemDataGrid 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. When this property is modified, it dispatches the directoryChanged event.



Implementation
    public function get canNavigateDown():Boolean

See also

AIR-only 

canNavigateForward

property 
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:FileSystemDataGrid 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. When this property is modified, it dispatches the historyChanged event.



Implementation
    public function get canNavigateForward():Boolean

See also

AIR-only 

canNavigateUp

property 
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:FileSystemDataGrid 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. When this property is modified, it dispatches the directoryChanged event.



Implementation
    public function get canNavigateUp():Boolean

See also

AIR-only 

creationDateColumn

property 
public var creationDateColumn:DataGridColumn

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

The DataGridColumn representing the Created column. The FileSystemDataGrid control automatically creates this column.

You can set properties such as creationDateColumn.width to customize this column. To remove this column entirely, or to change the column order, set the columns property to an array such as [ nameColumn, modificationDateColumn, sizeColumn ].

AIR-only 

dateFormatString

property 
dateFormatString:String

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

A String that determines how dates in the Created and Modified columns are formatted. Setting this property sets the formatString of an internal DateFormatter that this control creates.



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

See also

AIR-only 

directory

property 
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.

This property can be used as the source for data binding. When this property is modified, it dispatches the directoryChanged event.



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

enumerationMode

property 
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 

extensions

property 
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 

filterFunction

property 
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 

forwardHistory

property 
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 a null item, 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:FileSystemDataGrid 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. When this property is modified, it dispatches the historyChanged event.



Implementation
    public function get forwardHistory():Array

See also

AIR-only 

modificationDateColumn

property 
public var modificationDateColumn:DataGridColumn

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

The DataGridColumn representing the Modified column. The FileSystemDataGrid control automatically creates this column.

You can set properties such as modificationDateColumn.width to customize this column. To remove this column entirely, or to change the column order, set the columns property to an array such as [ nameColumn, modificationDateColumn, sizeColumn ].

AIR-only 

nameColumn

property 
public var nameColumn:DataGridColumn

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

The DataGridColumn representing the Name column. The FileSystemDataGrid control automatically creates this column.

You can set properties such as nameColumn.width to customize this column. To remove this column entirely, or to change the column order, set the columns property to an array such as [ nameColumn, modificationDateColumn, sizeColumn ].

AIR-only 

nameCompareFunction

property 
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 

selectedPath

property 
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. When this property is modified, it dispatches the directoryChanged event.



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

See also

AIR-only 

selectedPaths

property 
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. When this property is modified, it dispatches the directoryChanged event.



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

See also

AIR-only 

showExtensions

property 
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.



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

showHidden

property 
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.



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

showIcons

property 
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 Apollo M2 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.



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

sizeColumn

property 
public var sizeColumn:DataGridColumn

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

The DataGridColumn representing the Size column. The FileSystemDataGrid control automatically creates this column.

You can set properties such as sizeColumn.width to customize this column. To remove this column entirely, or to change the column order, set the columns property to an array such as [ nameColumn, modificationDateColumn, sizeColumn ].

AIR-only 

sizeDisplayMode

property 
sizeDisplayMode:String

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

A String specifying whether the Size column displays file sizes in bytes or rounded up to the nearest kilobyte, where a kilobyte is 1024 bytes. The possible values are specified by the FileSystemSizeDisplayMode class.



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

See also

AIR-only 

typeColumn

property 
public var typeColumn:DataGridColumn

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

The DataGridColumn representing the Type column. The FileSystemDataGrid control automatically creates this column.

You can set properties such as typeColumn.width to customize this column. To remove this column entirely, or to change the column order, set the columns property to an array such as [ nameColumn, modificationDateColumn, sizeColumn ].

Constructor Detail
AIR-only 

FileSystemDataGrid

()Constructor
public function FileSystemDataGrid()

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.

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:FileSystemDataGrid 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:FileSystemDataGrid 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:FileSystemDataGrid 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 property along with the Button control to create an up button:

      <mx:FileSystemDataGrid 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
property FileEvent.type = mx.events.FileEvent.DIRECTORY_CHANGE

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

Dispatched when the selected directory displayed by this control changes 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
property FileEvent.type = 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
property FileEvent.type = 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 

COMPUTER

Constant
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).