| Package | mx.controls |
| Class | public class FileSystemList |
| Inheritance | FileSystemList  List ListBase ScrollControlBase UIComponent FlexSprite flash.display.Sprite |
| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
To change the displayed data, rather than using the dataProvider property,
you set the directory property.
The control then automatically populates the dataProvider
property by enumerating the contents of that directory.
You should not set the dataProvider yourself.
You set the directory property to a File instance,
as the following example shows:
<mx:FileSystemList directory="{File.desktopDirectory}"/>
You can set the enumerationMode property to specify
whether to show files, subdirectories, or both.
There are three ways to show both: directories first,
files first, or intermixed.
You can set the extensions property
to filter the displayed items so that only files
with the specified extensions appear.
The showHidden determines whether the control
displays files and subdirectories that the operating system
normally hides.
You can specify an additional filterFunction
to perform custom filtering, and a nameCompareFunction
to perform custom sorting.
Because AIR does not support file system notifications,
this control does not automatically refresh if a file or
subdirectory is created, deleted, moved, or renamed;
in other words, it can display an out-of-date view of the file system.
However, you can call refresh() to re-enumerate
the current directory.
You could, for example, choose to do this when you have
performed a file operation that you know causes the control's
view to become out-of-date, or when the user deactivates
and reactivates your application.
You can use the showIcons property
to show or hide icons, and the showExtensions
property to show or hide file extensions.
The control provides two methods, findItem()
and findIndex(), which you can use to search the
displayed files and subdirectories to find the one
with a specified nativePath.
Two properties, selectedPath
and selectedPaths, work similarly
to selectedItem and selectedItems
or selectedIndex and selectedIndices,
but let you specify the selection via nativePath
strings.
These are very useful if you need to display a directory
with particular items preselected, since in this case
you don't yet have the File items that the control will create
when it enumerates the directory, and you don't know what
their indices will be.
The control allows the user to navigate to other directories
using the mouse or keyboard.
The user can try to change the directory
by double-clicking a subdirectory,
by pressing Enter or Ctrl-Down when a subdirectory is selected,
by pressing Ctrl-Up when the control isn't displaying
the COMPUTER directory, by pressing Ctrl-Left when there is
a "previous" directory to navigate back to, or by pressing Ctrl-Right
when there is a "next" directory to navigate forward to.
If the user attempts to change the directory being displayed,
the control dispatches a cancelable directoryChanging event.
If you don't cancel this event by calling
event.preventDefault(), the control displays the
contents of the new directory and the directory
property changes.
Whenever the directory property changes, for any reason,
the controls dispatches a directoryChange event
to let you know.
In order to support "Up" and "Down" controls, the FileSystemList
has canNavigateUp and canNavigateDown
properties and navigateUp() and navigateDown()
methods. There is also a navigateTo() for navigating
to an arbitrary directory.
The control keeps track of the directories to which the user
has navigated, in order to make it easy for you to support
"Back" and "Forward" controls.
For more information, see the backHistory,
forwardHistory, canNavigateBack,
and canNavigateForward properties, and the
navigateBack() and navigateForward() methods.
Note: The icons displayed for each item are generic file and directory
icons which you can set using the fileIcon
and directoryIcon styles.
Flex's list-based controls currently support displaying
only embedded icons, not icons read at runtime.
Therefore the actual file system icons displayed in the operating system
are not displayed in a FileSystemList, even though they are
accessible in AIR via the icon property of a File.
Hide MXML SyntaxThe <mx:FileSystemList> tag inherits all of the tag
attributes of its superclass and adds the following tag attributes:
Show MXML Syntax
<mx:FileSystemList
Properties
directory="null"
enumerationMode="directoriesFirst"
extensions="null"
filterFunction="null"
nameCompareFunction="null"
selectedPath="null"
selectedPaths="null"
showExtensions="true"
showHidden="false"
showIcons="true"
Styles
directoryIcon="TreeNodeIcon"
fileIcon="TreeNodeIcon"
Events
directoryChange="No default"
directoryChanging="No default"
fileChoose="No default"
/>
Default MXML PropertydataProvider
See also
| Property | Defined By | ||
|---|---|---|---|
 | accessibilityDescription : String
A convenience accessor for the description property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityEnabled : Boolean
A convenience accessor for the silent property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityName : String
A convenience accessor for the name property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| accessibilityShortcut : String
A convenience accessor for the shortcut property
in this UIComponent's accessibilityProperties object. | UIComponent | |
| activeEffects : Array [read-only]
The list of effects that are currently playing on the component,
as an Array of EffectInstance instances. | UIComponent | |
| allowDragSelection : Boolean = false
A flag that indicates whether drag-selection is enabled. | ListBase | |
| allowMultipleSelection : Boolean
A flag that indicates whether you can allow more than one item to be
selected at the same time. | ListBase | |
| automationDelegate : Object
The delegate object that handles the automation-related functionality. | UIComponent | |
| automationEnabled : Boolean [read-only]
True if this component is enabled for automation, false
otherwise. | UIComponent | |
| automationName : String
Name that can be used as an identifier for this object. | UIComponent | |
| automationOwner : DisplayObjectContainer [read-only]
The owner of this component for automation purposes. | UIComponent | |
| automationParent : DisplayObjectContainer [read-only]
The parent of this component for automation purposes. | UIComponent | |
| automationTabularData : Object [read-only]
An implementation of the IAutomationTabularData interface, which
can be used to retrieve the data. | UIComponent | |
| automationValue : Array [read-only]
This value generally corresponds to the rendered appearance of the
object and should be usable for correlating the identifier with
the object as it appears visually within the application. | UIComponent | |
| automationVisible : Boolean [read-only]
True if this component is visible for automation, false
otherwise. | UIComponent | |
 backHistory : Array[read-only]
An Array of File objects representing directories
to which the user can navigate backward. | FileSystemList | ||
| baseline : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| baselinePosition : Number [read-only]
The y-coordinate of the baseline
of the first line of text of the component. | UIComponent | |
| borderMetrics : EdgeMetrics [read-only]
Returns an EdgeMetrics object that has four properties:
left, top, right,
and bottom. | ScrollControlBase | |
| bottom : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| cacheHeuristic : Boolean [write-only]
Used by Flex to suggest bitmap caching for the object. | UIComponent | |
| cachePolicy : String
Specifies the bitmap caching policy for this object. | UIComponent | |
| canNavigateBack : Boolean [read-only]
A flag which is true if there is at least one directory
in the history list to which the user can navigate backward. | FileSystemList | ||
| canNavigateDown : Boolean [read-only]
A flag which is true if the user can navigate down
into a selected directory. | FileSystemList | ||
| canNavigateForward : Boolean [read-only]
A flag which is true if there is at least one directory
in the history list to which the user can navigate forward. | FileSystemList | ||
| canNavigateUp : Boolean [read-only]
A flag which is true if the user can navigate up
to a parent directory. | FileSystemList | ||
| className : String [read-only]
The name of this instance's class, such as "Button". | UIComponent | |
| columnCount : int
The number of columns to be displayed in a TileList control or items
in a HorizontalList control. | ListBase | |
| columnWidth : Number
The width of the control's columns. | ListBase | |
| contentMouseX : Number [read-only]
Returns the x position of the mouse, in the content coordinate system. | UIComponent | |
| contentMouseY : Number [read-only]
Returns the y position of the mouse, in the content coordinate system. | UIComponent | |
| currentState : String
The current view state of the component. | UIComponent | |
| cursorManager : ICursorManager [read-only]
Gets the CursorManager that controls the cursor for this component
and its peers. | UIComponent | |
| data : Object
The item in the data provider this component should render when
this component is used as an item renderer or item editor. | ListBase | |
| dataProvider : Object
Set of data to be viewed. | ListBase | |
| dataTipField : String
Name of the field in the data provider items to display as the
data tip. | ListBase | |
| dataTipFunction : Function
User-supplied function to run on each item to determine its dataTip. | ListBase | |
| depth : Number
Determines the order in which items inside of containers
are rendered. | UIComponent | |
| descriptor : UIComponentDescriptor
Reference to the UIComponentDescriptor, if any, that was used
by the createComponentFromDescriptor() method to create this
UIComponent instance. | UIComponent | |
| designLayer : DesignLayer
Specifies the optional DesignLayer instance associated with this visual
element. | UIComponent | |
| directory : File
The directory whose contents this control displays. | FileSystemList | ||
| document : Object
A reference to the document object associated with this UIComponent. | UIComponent | |
| doubleClickEnabled : Boolean [override]
Specifies whether the UIComponent object receives doubleClick events. | UIComponent | |
| dragEnabled : Boolean
A flag that indicates whether you can drag items out of
this control and drop them on other controls. | ListBase | |
| dragMoveEnabled : Boolean
A flag that indicates whether items can be moved instead
of just copied from the control as part of a drag-and-drop
operation. | ListBase | |
| dropEnabled : Boolean
A flag that indicates whether dragged items can be dropped onto the
control. | ListBase | |
| editable : Boolean
A flag that indicates whether or not the user can edit
items in the data provider. | List | |
| editedItemPosition : Object
The column and row index of the item renderer for the
data provider item being edited, if any. | List | |
| editedItemRenderer : IListItemRenderer [read-only]
A reference to the item renderer
in the DataGrid control whose item is currently being edited. | List | |
| editorDataField : String = text
The name of the property of the item editor that contains the new
data for the list item. | List | |
| editorHeightOffset : Number = 0
The height of the item editor, in pixels, relative to the size of the
item renderer. | List | |
| editorUsesEnterKey : Boolean = false
A flag that indicates whether the item editor uses Enter key. | List | |
| editorWidthOffset : Number = 0
The width of the item editor, in pixels, relative to the size of the
item renderer. | List | |
| editorXOffset : Number = 0
The x location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | List | |
| editorYOffset : Number = 0
The y location of the upper-left corner of the item editor,
in pixels, relative to the upper-left corner of the item. | List | |
| enabled : Boolean
Whether the component can accept user interaction. | UIComponent | |
| enableIME : Boolean [read-only]
A flag that indicates whether the IME should
be enabled when the component receives focus. | List | |
| enumerationMode : String
A String specifying whether this control displays
only files, only subdirectories, or both. | FileSystemList | ||
| errorString : String
The text that displayed by a component's error tip when a
component is monitored by a Validator and validation fails. | UIComponent | |
| explicitHeight : Number
Number that specifies the explicit height of the component,
in pixels, in the component's coordinates. | UIComponent | |
| explicitMaxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMaxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| explicitMinWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| explicitWidth : Number
Number that specifies the explicit width of the component,
in pixels, in the component's coordinates. | UIComponent | |
| extensions : Array
An Array of extensions specifying which files
can be displayed in this control. | FileSystemList | ||
| filterFunction : Function
A callback Function that you can use to perform additional filtering,
after the enumerationMode and extensions
properties have been applied, to determine which files
and subdirectories are displayed and which are hidden. | FileSystemList | ||
| flexContextMenu : IFlexContextMenu
The context menu for this UIComponent. | UIComponent | |
| focusEnabled : Boolean
Indicates whether the component can receive focus when tabbed to. | UIComponent | |
| focusManager : IFocusManager
Gets the FocusManager that controls focus for this component
and its peers. | UIComponent | |
| focusPane : Sprite
The focus pane associated with this object. | UIComponent | |
| forwardHistory : Array [read-only]
An Array of File objects representing directories
to which the user can navigate forward. | FileSystemList | ||
| hasFocusableChildren : Boolean
A flag that indicates whether child objects can receive focus. | UIComponent | |
| hasLayoutMatrix3D : Boolean [read-only]
Contains true if the element has 3D Matrix. | UIComponent | |
| height : Number [override]
Number that specifies the height of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| horizontalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| horizontalScrollPolicy : String
A property that indicates whether the horizontal scroll
bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| horizontalScrollPosition : Number
The offset into the content from the left edge. | ScrollControlBase | |
| iconField : String
The name of the field in the data provider object that determines what to
display as the icon. | ListBase | |
| iconFunction : Function
A user-supplied function to run on each item to determine its icon. | ListBase | |
| id : String
ID of the component. | UIComponent | |
| imeMode : String
Specifies the IME (input method editor) mode. | List | |
| includeInLayout : Boolean
Specifies whether this component is included in the layout of the
parent container. | UIComponent | |
| inheritingStyles : Object
The beginning of this component's chain of inheriting styles. | UIComponent | |
| initialized : Boolean
A flag that determines if an object has been through all three phases
of layout: commitment, measurement, and layout (provided that any were required). | UIComponent | |
| instanceIndex : int [read-only]
The index of a repeated component. | UIComponent | |
| instanceIndices : Array
An Array containing the indices required to reference
this UIComponent object from its parent document. | UIComponent | |
| is3D : Boolean [read-only]
Contains true when the element is in 3D. | UIComponent | |
| isDocument : Boolean [read-only]
Contains true if this UIComponent instance is a document object. | UIComponent | |
| isPopUp : Boolean
Set to true by the PopUpManager to indicate
that component has been popped up. | UIComponent | |
| itemEditor : IFactory
The class factory for the item editor to use for the control, if the
editable property is set to true. | List | |
| itemEditorInstance : IListItemRenderer
A reference to the currently active instance of the item editor,
if it exists. | List | |
| itemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| labelField : String
The name of the field in the data provider items to display as the label. | ListBase | |
| labelFunction : Function
A user-supplied function to run on each item to determine its label. | ListBase | |
| layoutMatrix3D : Matrix3D [write-only]
The transform matrix that is used to calculate a component's layout
relative to its siblings. | UIComponent | |
| left : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| listData : BaseListData
When a component is used as a drop-in item renderer or drop-in
item editor, Flex initializes the listData property
of the component with the additional data from the list control. | ListBase | |
| liveScrolling : Boolean = true
A flag that indicates whether scrolling is live as the
scrollbar thumb is moved
or the view is not updated until the thumb is released. | ScrollControlBase | |
| maintainProjectionCenter : Boolean
When true, the component keeps its projection matrix centered on the
middle of its bounding box. | UIComponent | |
| maxHeight : Number
The maximum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| maxHorizontalScrollPosition : Number
The maximum value for the horizontalScrollPosition property. | ScrollControlBase | |
| maxVerticalScrollPosition : Number
The maximum value for the verticalScrollPosition property. | ScrollControlBase | |
| maxWidth : Number
The maximum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| measuredHeight : Number
The default height of the component, in pixels. | UIComponent | |
| measuredMinHeight : Number
The default minimum height of the component, in pixels. | UIComponent | |
| measuredMinWidth : Number
The default minimum width of the component, in pixels. | UIComponent | |
| measuredWidth : Number
The default width of the component, in pixels. | UIComponent | |
| menuSelectionMode : Boolean = false
A flag that indicates whether menu-style selection
should be used. | ListBase | |
| minHeight : Number
The minimum recommended height of the component to be considered
by the parent during layout. | UIComponent | |
| minWidth : Number
The minimum recommended width of the component to be considered
by the parent during layout. | UIComponent | |
| moduleFactory : IFlexModuleFactory
A module factory is used as context for using embedded fonts and for
finding the style manager that controls the styles for this
component. | UIComponent | |
| mouseFocusEnabled : Boolean
Whether you can receive focus when clicked on. | UIComponent | |
| MXMLDescriptor : Array [read-only] | UIComponent | |
| MXMLProperties : Array [read-only] | UIComponent | |
| nameCompareFunction : Function
A callback Function that you can use to change how file and subdirectory
names are compared in order to produce the sort order. | FileSystemList | ||
| nestLevel : int
Depth of this object in the containment hierarchy. | UIComponent | |
| nonInheritingStyles : Object
The beginning of this component's chain of non-inheriting styles. | UIComponent | |
| nullItemRenderer : IFactory
The custom item renderer for the control. | ListBase | |
| numAutomationChildren : int [read-only]
The number of automation children this container has. | UIComponent | |
| offscreenExtraRowsOrColumns : int
The target number of extra rows or columns of item renderers to be used
in the layout of the control. | ListBase | |
| owner : DisplayObjectContainer
The owner of this IVisualElement object. | UIComponent | |
| parent : DisplayObjectContainer [override] [read-only]
The parent container or component for this component. | UIComponent | |
| parentApplication : Object [read-only]
A reference to the Application object that contains this UIComponent
instance. | UIComponent | |
| parentDocument : Object [read-only]
A reference to the parent document object for this UIComponent. | UIComponent | |
| percentHeight : Number
Specifies the height of a component as a percentage
of its parent's size. | UIComponent | |
| percentWidth : Number
Specifies the width of a component as a percentage
of its parent's size. | UIComponent | |
| postLayoutTransformOffsets : TransformOffsets
Defines a set of adjustments that can be applied to the object's
transform in a way that is invisible to its parent's layout. | UIComponent | |
| processedDescriptors : Boolean
Set to true after immediate or deferred child creation,
depending on which one happens. | UIComponent | |
| rendererIsEditor : Boolean = false
Specifies whether the item renderer is also an item
editor. | List | |
| repeater : IRepeater [read-only]
A reference to the Repeater object
in the parent document that produced this UIComponent. | UIComponent | |
| repeaterIndex : int [read-only]
The index of the item in the data provider
of the Repeater that produced this UIComponent. | UIComponent | |
| repeaterIndices : Array
An Array containing the indices of the items in the data provider
of the Repeaters in the parent document that produced this UIComponent. | UIComponent | |
| repeaters : Array
An Array containing references to the Repeater objects
in the parent document that produced this UIComponent. | UIComponent | |
| right : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| rotation : Number [override] | UIComponent | |
| rotationX : Number [override]
Indicates the x-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationY : Number [override]
Indicates the y-axis rotation of the DisplayObject instance, in degrees, from its original orientation
relative to the 3D parent container. | UIComponent | |
| rotationZ : Number [override]
| UIComponent | |
| rowCount : int
Number of rows to be displayed. | ListBase | |
| rowHeight : Number
The height of the rows in pixels. | ListBase | |
| scaleX : Number [override]
Number that specifies the horizontal scaling factor. | UIComponent | |
| scaleY : Number [override]
Number that specifies the vertical scaling factor. | UIComponent | |
| scaleZ : Number [override]
Number that specifies the scaling factor along the z axis. | UIComponent | |
| screen : Rectangle [read-only]
Returns an object that contains the size and position of the base
drawing surface for this object. | UIComponent | |
| scrollTipFunction : Function
A function that computes the string to be displayed as the ScrollTip. | ScrollControlBase | |
| selectable : Boolean
A flag that indicates whether the list shows selected items
as selected. | ListBase | |
| selectedIndex : int
The index in the data provider of the selected item. | ListBase | |
| selectedIndices : Array
An array of indices in the data provider of the selected items. | ListBase | |
| selectedItem : Object
A reference to the selected item in the data provider. | ListBase | |
| selectedItems : Array
An array of references to the selected items in the data provider. | ListBase | |
| selectedItemsCompareFunction : Function
A function used to compare items in the selectedItems property
against items in the data provider. | ListBase | |
| selectedPath : String
The nativePath of the File item
representing the selected subdirectory or file,
or null if no item is selected. | FileSystemList | ||
| selectedPaths : Array
An Array of nativePath Strings for the File items
representing the selected subdirectories and files. | FileSystemList | ||
| showDataTips : Boolean
A flag that indicates whether dataTips are displayed for text in the rows. | ListBase | |
| showExtensions : Boolean
A flag that specifies whether extensions in file names are shown. | FileSystemList | ||
| showHidden : Boolean
A flag that specifies whether files and directories
that the operating system considers hidden are displayed. | FileSystemList | ||
| showIcons : Boolean
A flag that specifies that icons are displayed
before the file name. | FileSystemList | ||
| showInAutomationHierarchy : Boolean
A flag that determines if an automation object
shows in the automation hierarchy. | UIComponent | |
| showScrollTips : Boolean = false
A flag that indicates whether a tooltip should appear
near the scroll thumb when it is being dragged. | ScrollControlBase | |
| states : Array
The view states that are defined for this component. | UIComponent | |
| styleDeclaration : CSSStyleDeclaration
Storage for the inline inheriting styles on this object. | UIComponent | |
| styleManager : IStyleManager2 [read-only]
Returns the StyleManager instance used by this component. | UIComponent | |
| styleName : Object
The class style used by this component. | UIComponent | |
| styleParent : IAdvancedStyleClient
A component's parent is used to evaluate descendant selectors. | UIComponent | |
| systemManager : ISystemManager
Returns the SystemManager object used by this component. | UIComponent | |
| tabFocusEnabled : Boolean
A flag that indicates whether this object can receive focus
via the TAB key
This is similar to the tabEnabled property
used by the Flash Player.
This is usually true for components that
handle keyboard input, but some components in controlbars
have them set to false because they should not steal
focus from another component like an editor. | UIComponent | |
| toolTip : String
Text to display in the ToolTip. | UIComponent | |
| top : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| transform : Transform [override]
An object with properties pertaining to a display object's matrix, color transform,
and pixel bounds. | UIComponent | |
| transformX : Number
Sets the x coordinate for the transform center of the component. | UIComponent | |
| transformY : Number
Sets the y coordinate for the transform center of the component. | UIComponent | |
| transformZ : Number
Sets the z coordinate for the transform center of the component. | UIComponent | |
| transitions : Array
An Array of Transition objects, where each Transition object defines a
set of effects to play when a view state change occurs. | UIComponent | |
| tweeningProperties : Array
Array of properties that are currently being tweened on this object. | UIComponent | |
| uid : String
A unique identifier for the object. | UIComponent | |
| updateCompletePendingFlag : Boolean
A flag that determines if an object has been through all three phases
of layout validation (provided that any were required). | UIComponent | |
| validationSubField : String
Used by a validator to associate a subfield with this component. | UIComponent | |
| value : Object [read-only]
The selected item, or the data or label field of the selected item. | ListBase | |
| variableRowHeight : Boolean
A flag that indicates whether the individual rows can have different
height. | ListBase | |
| verticalCenter : Object
For components, this layout constraint property is a
facade on top of the similarly-named style. | UIComponent | |
| verticalScrollPolicy : String
A property that indicates whether the vertical scroll bar is always on, always off,
or automatically changes based on the parameters passed to the
setScrollBarProperties() method. | ScrollControlBase | |
| verticalScrollPosition : Number
The offset into the content from the top edge. | ScrollControlBase | |
| viewMetrics : EdgeMetrics [read-only]
An EdgeMetrics object taking into account the scroll bars,
if visible. | ScrollControlBase | |
| visible : Boolean [override]
Whether or not the display object is visible. | UIComponent | |
| width : Number [override]
Number that specifies the width of the component, in pixels,
in the parent's coordinates. | UIComponent | |
| wordWrap : Boolean
A flag that indicates whether text in the row should be word wrapped. | ListBase | |
| x : Number [override]
Number that specifies the component's horizontal position,
in pixels, within its parent container. | UIComponent | |
| y : Number [override]
Number that specifies the component's vertical position,
in pixels, within its parent container. | UIComponent | |
| z : Number [override]
| UIComponent | |
| Method | Defined By | ||
|---|---|---|---|
Constructor. | FileSystemList | ||
| addDataEffectItem(item:Object):void
Adds an item renderer if a data change effect is running. | ListBase | |
| addStyleClient(styleClient:IAdvancedStyleClient):void
Adds a non-visual style client to this component instance. | UIComponent | |
| calculateDropIndex(event:DragEvent = null):int
Returns the index where the dropped items should be added
to the drop target. | ListBase | |
| callLater(method:Function, args:Array = null):void
Queues a function to be called later. | UIComponent | |
| clear():void
Clears this control so that it displays no items. | FileSystemList | ||
| clearStyle(styleProp:String):void
Deletes a style property from this component instance. | UIComponent | |
| contentToGlobal(point:Point):Point
Converts a Point object from content coordinates to global coordinates. | UIComponent | |
| contentToLocal(point:Point):Point
Converts a Point object from content to local coordinates. | UIComponent | |
| createAutomationIDPart(child:IAutomationObject):Object
Returns a set of properties that identify the child within
this container. | UIComponent | |
| createAutomationIDPartWithRequiredProperties(child:IAutomationObject, properties:Array):Object
Returns a set of properties as automation IDs that identify the child within
this container. | UIComponent | |
| createItemEditor(colIndex:int, rowIndex:int):void
Creates the item editor for the item renderer at the
editedItemPosition using the editor
specified by the itemEditor property. | List | |
| createItemRenderer(data:Object):IListItemRenderer [override]
Get the appropriate renderer, using the default renderer if none is specified. | List | |
| createReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Creates an id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| deleteReferenceOnParentDocument(parentDocument:IFlexDisplayObject):void
Deletes the id reference to this IUIComponent object
on its parent document object. | UIComponent | |
| destroyItemEditor():void
Closes an item editor that is currently open on an item. | List | |
|
Returns a UITextFormat object corresponding to the text styles
for this UIComponent. | UIComponent | |
| dispatchEvent(event:Event):Boolean [override]
Dispatches an event into the event flow. | UIComponent | |
| drawFocus(isFocused:Boolean):void
Shows or hides the focus indicator around this component. | UIComponent | |
| drawRoundRect(x:Number, y:Number, w:Number, h:Number, r:Object = null, c:Object = null, alpha:Object = null, rot:Object = null, gradient:String = null, ratios:Array = null, hole:Object = null):void
Programmatically draws a rectangle into this skin's Graphics object. | UIComponent | |
| effectFinished(effectInst:IEffectInstance):void
Called by the effect instance when it stops playing on the component. | UIComponent | |
| effectStarted(effectInst:IEffectInstance):void
Called by the effect instance when it starts playing on the component. | UIComponent | |
| endEffectsStarted():void
Ends all currently playing effects on the component. | UIComponent | |
| executeBindings(recurse:Boolean = false):void
Executes all the bindings for which the UIComponent object is the destination. | UIComponent | |
| findIndex(nativePath:String):int
Returns the index of the File item with the specified
native file system path. | FileSystemList | ||
| findItem(nativePath:String):File
Searches the File instances currently displayed in this control
and returns the one with the specified nativePathproperty. | FileSystemList | ||
| findString(str:String):Boolean
Finds an item in the list based on a String,
and moves the selection to it. | ListBase | |
| finishPrint(obj:Object, target:IFlexDisplayObject):void
Called after printing is complete. | UIComponent | |
| generateMXMLArray(document:Object, data:Array, recursive:Boolean = true):Array | UIComponent | |
| generateMXMLVector(document:Object, data:Array, recursive:Boolean = true):* | UIComponent | |
| getAutomationChildAt(index:int):IAutomationObject
Provides the automation object at the specified index. | UIComponent | |
| getAutomationChildren():Array
Provides the automation object list . | UIComponent | |
| getBoundsXAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the x coordinate of the element's bounds at the specified element size. | UIComponent | |
| getBoundsYAtSize(width:Number, height:Number, postLayoutTransform:Boolean = true):Number
Returns the y coordinate of the element's bounds at the specified element size. | UIComponent | |
| getClassStyleDeclarations():Array
Finds the type selectors for this UIComponent instance. | UIComponent | |
| getConstraintValue(constraintName:String):*
Returns a layout constraint value, which is the same as
getting the constraint style for this component. | UIComponent | |
| getExplicitOrMeasuredHeight():Number
A convenience method for determining whether to use the
explicit or measured height
| UIComponent | |
| getExplicitOrMeasuredWidth():Number
A convenience method for determining whether to use the
explicit or measured width
| UIComponent | |
| getFocus():InteractiveObject
Gets the object that currently has focus. | UIComponent | |
| getItemRendererFactory(data:Object):IFactory
Return the appropriate factory, using the default factory if none specified. | ListBase | |
| getLayoutBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's layout height. | UIComponent | |
| getLayoutBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's layout width. | UIComponent | |
| getLayoutBoundsX(postLayoutTransform:Boolean = true):Number
Returns the x coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutBoundsY(postLayoutTransform:Boolean = true):Number
Returns the y coordinate that the element uses to draw on screen. | UIComponent | |
| getLayoutMatrix():Matrix
Returns the transform matrix that is used to calculate the component's
layout relative to its siblings. | UIComponent | |
| getLayoutMatrix3D():Matrix3D
Returns the layout transform Matrix3D for this element. | UIComponent | |
| getMaxBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's maximum height. | UIComponent | |
| getMaxBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's maximum width. | UIComponent | |
| getMinBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's minimum height. | UIComponent | |
| getMinBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's minimum width. | UIComponent | |
| getPreferredBoundsHeight(postLayoutTransform:Boolean = true):Number
Returns the element's preferred height. | UIComponent | |
| getPreferredBoundsWidth(postLayoutTransform:Boolean = true):Number
Returns the element's preferred width. | UIComponent | |
| getRendererSemanticValue(target:Object, semanticProperty:String):Object
Returns true or false
to indicates whether the effect should play on the target. | ListBase | |
| getRepeaterItem(whichRepeater:int = -1):Object
Returns the item in the dataProvider that was used
by the specified Repeater to produce this Repeater, or
null if this Repeater isn't repeated. | UIComponent | |
| getStyle(styleProp:String):*
Gets a style property that has been set anywhere in this
component's style lookup chain. | UIComponent | |
| getVisibleRect(targetParent:DisplayObject = null):Rectangle
Get the bounds of this object that are visible to the user
on the screen. | UIComponent | |
| globalToContent(point:Point):Point
Converts a Point object from global to content coordinates. | UIComponent | |
| hasCSSState():Boolean
Returns true if currentCSSState is not null. | UIComponent | |
| hasState(stateName:String):Boolean
Determines whether the specified state has been defined on this
UIComponent. | UIComponent | |
| hideDropFeedback(event:DragEvent):void
Hides the drop indicator under the mouse pointer that indicates that a
drag and drop operation is allowed. | ListBase | |
| horizontalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to the
drawRoundRect() method
as the rot parameter when drawing a horizontal gradient. | UIComponent | |
| indexToItemRenderer(index:int):IListItemRenderer
Get an item renderer for the index of an item in the data provider,
if one exists. | ListBase | |
| indicesToIndex(rowIndex:int, colIndex:int):int
Computes the offset into the data provider of the item
at colIndex, rowIndex. | ListBase | |
| initialize():void
Initializes the internal structure of this component. | UIComponent | |
| initializeRepeaterArrays(parent:IRepeaterClient):void
Initializes various properties which keep track of repeated instances
of this component. | UIComponent | |
| invalidateDisplayList():void
Marks a component so that its updateDisplayList()
method gets called during a later screen update. | UIComponent | |
| invalidateLayering():void
Called by a component's items to indicate that their depth
property has changed. | UIComponent | |
| invalidateLayoutDirection():void
An element must call this method when its layoutDirection changes or
when its parent's layoutDirection changes. | UIComponent | |
| invalidateList():void
Refresh all rows on the next update. | ListBase | |
| invalidateProperties():void
Marks a component so that its commitProperties()
method gets called during a later screen update. | UIComponent | |
| invalidateSize():void
Marks a component so that its measure()
method gets called during a later screen update. | UIComponent | |
| isItemEditable(data:Object):Boolean
Determines if the item renderer for a data provider item
is editable. | List | |
| isItemHighlighted(data:Object):Boolean
Determines if the item renderer for a data provider item
is highlighted (is rolled over via the mouse or under the caret due to keyboard navigation). | ListBase | |
| isItemSelectable(data:Object):Boolean
Determines if the item renderer for a data provider item
is selectable. | ListBase | |
| isItemSelected(data:Object):Boolean
Determines if the item renderer for a data provider item
is selected. | ListBase | |
| isItemShowingCaret(data:Object):Boolean
Determines if the item renderer for a data provider item
is the item under the caret due to keyboard navigation. | ListBase | |
| isItemVisible(item:Object):Boolean
Determines if an item is being displayed by a renderer. | ListBase | |
| itemRendererContains(renderer:IListItemRenderer, object:DisplayObject):Boolean
Determines whether a renderer contains (or owns) a display object. | ListBase | |
| itemRendererToIndex(itemRenderer:IListItemRenderer):int
Returns the index of the item in the data provider of the item
being rendered by this item renderer. | ListBase | |
| itemToDataTip(data:Object):String
Returns the dataTip string the renderer would display for the given
data object based on the dataTipField and dataTipFunction properties. | ListBase | |
| itemToIcon(data:Object):Class
Returns the class for an icon, if any, for a data item,
based on the iconField and iconFunction properties. | ListBase | |
| itemToItemRenderer(item:Object):IListItemRenderer
Returns the item renderer for a given item in the data provider,
if there is one. | ListBase | |
| itemToLabel(data:Object):String
Returns the string the renderer would display for the given data object
based on the labelField and labelFunction properties. | ListBase | |
| localToContent(point:Point):Point
Converts a Point object from local to content coordinates. | UIComponent | |
| matchesCSSState(cssState:String):Boolean
Returns true if cssState matches currentCSSState. | UIComponent | |
| matchesCSSType(cssType:String):Boolean
Determines whether this instance is the same as, or is a subclass of,
the given type. | UIComponent | |
| measureHeightOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using the
current item renderer and returns the sum of the heights
of those items. | ListBase | |
| measureHTMLText(htmlText:String):TextLineMetrics
Measures the specified HTML text, which can contain HTML tags such
as <font> and <b>,
assuming that it is displayed
in a single-line UITextField using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| measureText(text:String):TextLineMetrics
Measures the specified text, assuming that it is displayed
in a single-line UITextField (or UIFTETextField) using a UITextFormat
determined by the styles of this UIComponent. | UIComponent | |
| measureWidthOfItems(index:int = -1, count:int = 0):Number
Measures a set of items from the data provider using
the current item renderer and returns the
maximum width found. | ListBase | |
| move(x:Number, y:Number):void
Moves the component to a specified position within its parent. | UIComponent | |
| navigateBack(index:int = 0):void
Changes this control to display the contents of a previously-visited
directory in the backHistory array. | FileSystemList | ||
| navigateDown():void
Changes this control to display the contents
of the selected subdirectory. | FileSystemList | ||
| navigateForward(index:int = 0):void
Changes this control to display the contents of a previously-visited
directory in the forwardHistory array. | FileSystemList | ||
| navigateTo(directory:File):void
Changes this control to display the contents of the specified
directory. | FileSystemList | ||
| navigateUp():void
Changes this control to display the contents of the next directory
up in the hierarchy. | FileSystemList | ||
| notifyStyleChangeInChildren(styleProp:String, recursive:Boolean):void
Propagates style changes to the children. | UIComponent | |
| owns(child:DisplayObject):Boolean
Returns true if the chain of owner properties
points from child to this UIComponent. | UIComponent | |
| parentChanged(p:DisplayObjectContainer):void
Called by Flex when a UIComponent object is added to or removed from a parent. | UIComponent | |
| prepareToPrint(target:IFlexDisplayObject):Object
Prepares an IFlexDisplayObject for printing. | UIComponent | |
| refresh():void
Re-enumerates the current directory being displayed by this control. | FileSystemList | ||
| regenerateStyleCache(recursive:Boolean):void
Builds or rebuilds the CSS style cache for this component
and, if the recursive parameter is true,
for all descendants of this component as well. | UIComponent | |
| registerEffects(effects:Array):void
For each effect event, registers the EffectManager
as one of the event listeners. | UIComponent | |
| removeDataEffectItem(item:Object):void
Removes an item renderer if a data change effect is running. | ListBase | |
| removeStyleClient(styleClient:IAdvancedStyleClient):void
Removes a non-visual style client from this component instance. | UIComponent | |
| replayAutomatableEvent(event:Event):Boolean
Replays the specified event. | UIComponent | |
| resolveAutomationIDPart(criteria:Object):Array
Resolves a child by using the id provided. | UIComponent | |
| resumeBackgroundProcessing():void [static]
Resumes the background processing of methods
queued by callLater(), after a call to
suspendBackgroundProcessing(). | UIComponent | |
| scrollToIndex(index:int):Boolean
Ensures that the data provider item at the given index is visible. | ListBase | |
| setActualSize(w:Number, h:Number):void
Sizes the object. | UIComponent | |
| setConstraintValue(constraintName:String, value:*):void
Sets a layout constraint value, which is the same as
setting the constraint style for this component. | UIComponent | |
| setCurrentState(stateName:String, playTransition:Boolean = true):void
Set the current state. | UIComponent | |
| setFocus():void
Sets the focus to this component. | UIComponent | |
| setLayoutBoundsPosition(x:Number, y:Number, postLayoutTransform:Boolean = true):void
Sets the coordinates that the element uses to draw on screen. | UIComponent | |
| setLayoutBoundsSize(width:Number, height:Number, postLayoutTransform:Boolean = true):void
Sets the layout size of the element. | UIComponent | |
| setLayoutMatrix(value:Matrix, invalidateLayout:Boolean):void
Sets the transform Matrix that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setLayoutMatrix3D(value:Matrix3D, invalidateLayout:Boolean):void
Sets the transform Matrix3D that is used to calculate the component's layout
size and position relative to its siblings. | UIComponent | |
| setMXMLDescriptor(value:Array):void | UIComponent | |
| setMXMLProperties(value:Array):void | UIComponent | |
| setStyle(styleProp:String, newValue:*):void
Sets a style property on this component instance. | UIComponent | |
| setVisible(value:Boolean, noEvent:Boolean = false):void
Called when the visible property changes. | UIComponent | |
| showDropFeedback(event:DragEvent):void
Displays a drop indicator under the mouse pointer to indicate that a
drag and drop operation is allowed and where the items will
be dropped. | ListBase | |
| styleChanged(styleProp:String):void
Detects changes to style properties. | UIComponent | |
| stylesInitialized():void
Flex calls the stylesInitialized() method when
the styles for a component are first initialized. | UIComponent | |
| suspendBackgroundProcessing():void [static]
Blocks the background processing of methods
queued by callLater(),
until resumeBackgroundProcessing() is called. | UIComponent | |
| toString():String [override]
Returns a string indicating the location of this object
within the hierarchy of DisplayObjects in the Application. | FlexSprite | |
| transformAround(transformCenter:Vector3D, scale:Vector3D = null, rotation:Vector3D = null, translation:Vector3D = null, postLayoutScale:Vector3D = null, postLayoutRotation:Vector3D = null, postLayoutTranslation:Vector3D = null, invalidateLayout:Boolean = true):void
A utility method to update the rotation, scale, and translation of the
transform while keeping a particular point, specified in the component's
own coordinate space, fixed in the parent's coordinate space. | UIComponent | |
| transformPointToParent(localPosition:Vector3D, position:Vector3D, postLayoutPosition:Vector3D):void
A utility method to transform a point specified in the local
coordinates of this object to its location in the object's parent's
coordinates. | UIComponent | |
| unconstrainRenderer(item:Object):void
Called by an UnconstrainItemAction effect
as part of a data change effect if the item renderers corresponding
to certain data items need to move outside the normal positions
of item renderers in the control. | ListBase | |
| validateDisplayList():void
Validates the position and size of children and draws other
visuals. | UIComponent | |
| validateNow():void
Validate and update the properties and layout of this object
and redraw it, if necessary. | UIComponent | |
| validateProperties():void
Used by layout logic to validate the properties of a component
by calling the commitProperties() method. | UIComponent | |
| validateSize(recursive:Boolean = false):void
Validates the measured size of the component
If the LayoutManager.invalidateSize() method is called with
this ILayoutManagerClient, then the validateSize() method
is called when it's time to do measurements. | UIComponent | |
| validationResultHandler(event:ValidationResultEvent):void
Handles both the valid and invalid events from a
validator assigned to this component. | UIComponent | |
| verticalGradientMatrix(x:Number, y:Number, width:Number, height:Number):Matrix
Returns a box Matrix which can be passed to drawRoundRect()
as the rot parameter when drawing a vertical gradient. | UIComponent | |
| Event | Summary | Defined By | ||
|---|---|---|---|---|
| Dispatched when the component is added to a container as a content child by using the addChild(), addChildAt(), addElement(), or addElementAt() method. | UIComponent | ||
| Dispatched when the selectedIndex or selectedItem property changes as a result of user interaction. | ListBase | ||
| Dispatched when the component has finished its construction, property processing, measuring, layout, and drawing. | UIComponent | ||
| Dispatched after the view state has changed. | UIComponent | ||
| Dispatched after the currentState property changes, but before the view state changes. | UIComponent | ||
| Dispatched when the data property changes. | ListBase | ||
| Dispatched when the directory displayed by this control has changed for any reason. | FileSystemList | |||
| Dispatched when the user tries to change the directory displayed by this control. | FileSystemList | |||
| Dispatched by the drag initiator (the component that is the source of the data being dragged) when the drag operation completes, either when you drop the dragged data onto a drop target or when you end the drag-and-drop operation without performing a drop. | UIComponent | ||
| Dispatched by the drop target when the user releases the mouse over it. | UIComponent | ||
| Dispatched by a component when the user moves the mouse over the component during a drag operation. | UIComponent | ||
| Dispatched by the component when the user drags outside the component, but does not drop the data onto the target. | UIComponent | ||
| Dispatched by a component when the user moves the mouse while over the component during a drag operation. | UIComponent | ||
| Dispatched by the drag initiator when starting a drag operation. | UIComponent | ||
| Dispatched after an effect ends. | UIComponent | ||
| Dispatched just before an effect starts. | UIComponent | ||
| Dispatched after an effect is stopped, which happens only by a call to stop() on the effect. | UIComponent | ||
| Dispatched after the component has entered a view state. | UIComponent | ||
| Dispatched just before the component exits a view state. | UIComponent | ||
| Dispatched when the user chooses a file by double-clicking it or by selecting it and pressing Enter. | FileSystemList | |||
| Dispatched when an object's state changes from visible to invisible. | UIComponent | ||
| Dispatched when the component has finished its construction and has all initialization properties set. | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation failed. | UIComponent | ||
| Dispatched when the user clicks on an item in the control. | ListBase | ||
| Dispatched when the user double-clicks on an item in the control. | ListBase | ||
| Dispatched when the editedItemPosition property is set and the item can be edited. | List | ||
| Dispatched when the user releases the mouse button while over an item, tabs to the List or within the List, or in any other way attempts to edit an item. | List | ||
| Dispatched when an item editing session is ending for any reason. | List | ||
| Dispatched when an item renderer gets focus, which can occur if the user clicks on an item in the List control or navigates to the item using a keyboard. | List | ||
| Dispatched when an item renderer loses the focus, which can occur if the user clicks another item in the List control or outside the list, or uses the keyboard to navigate to another item in the List control or outside the List control. | List | ||
| Dispatched when the user rolls the mouse pointer out of an item in the control. | ListBase | ||
| Dispatched when the user rolls the mouse pointer over an item in the control. | ListBase | ||
| Dispatched from a component opened using the PopUpManager when the user clicks outside it. | UIComponent | ||
| Dispatched from a component opened using the PopUpManager when the user scrolls the mouse wheel outside it. | UIComponent | ||
| Dispatched when the object has moved. | UIComponent | ||
| Dispatched at the beginning of the component initialization sequence. | UIComponent | ||
| Dispatched when the component is removed from a container as a content child by using the removeChild(), removeChildAt(), removeElement(), or removeElementAt() method. | UIComponent | ||
| Dispatched when the component is resized. | UIComponent | ||
| Dispatched when the content is scrolled. | ScrollControlBase | ||
| Dispatched when an object's state changes from invisible to visible. | UIComponent | ||
| Dispatched after the component has entered a new state and any state transition animation to that state has finished playing. | UIComponent | ||
| Dispatched when a component interrupts a transition to its current state in order to switch to a new state. | UIComponent | ||
| Dispatched by the component when it is time to create a ToolTip. | UIComponent | ||
| Dispatched by the component when its ToolTip has been hidden and is to be discarded soon. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be hidden. | UIComponent | ||
| Dispatched by the component when its ToolTip is about to be shown. | UIComponent | ||
| Dispatched by the component when its ToolTip has been shown. | UIComponent | ||
| Dispatched by a component whose toolTip property is set, as soon as the user moves the mouse over it. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it is done responding to a touch interaction user gesture. | UIComponent | ||
| A non-cancellable event, dispatched by a component when it starts responding to a touch interaction user gesture. | UIComponent | ||
| A cancellable event, dispatched by a component in an attempt to respond to a touch interaction user gesture. | UIComponent | ||
| Dispatched when an object has had its commitProperties(), measure(), and updateDisplayList() methods called (if needed). | UIComponent | ||
| Dispatched when a component is monitored by a Validator and the validation succeeded. | UIComponent | ||
| Dispatched when values are changed programmatically or by user interaction. | UIComponent | ||
| Style | Description | Defined By | ||
|---|---|---|---|---|
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Accent color used by component skins. | ScrollControlBase | ||
| Type: Array Format: Color CSS Inheritance: yes The colors to use for the backgrounds of the items in the list. | ListBase | ||
| Type: 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 | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo Background color of a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Background color of the component when it is disabled. | ScrollControlBase | ||
| Type: Object Format: File CSS Inheritance: no Theme: halo Background image of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Scales the image specified by backgroundImage to different percentage sizes. | ScrollControlBase | ||
| Type: String CSS Inheritance: no The vertical distance in pixels from the top edge of the content area to the control's baseline position. | UIComponent | ||
| Type: Number CSS Inheritance: no Theme: spark Alpha of the border. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: no Theme: halo, spark Color of the border. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Theme: halo Bounding box sides. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The border skin class of the component. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Bounding box style. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Bounding box thickness. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Visibility of the border. | ScrollControlBase | ||
| Type: 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 | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark The main color for a component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component, including the component label. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Theme: spark The alpha of the content background for this component. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of the content area of the component. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Radius of component corners. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The directionality of the text displayed by the component. | ScrollControlBase | ||
directoryIcon | Type: Class Format: EmbeddedFile CSS Inheritance: no Specifies the icon that indicates a directory. The default icon is located in the Assets.swf file. In MXML, you can use the following syntax to set this property: directoryIcon="@Embed(source='directoryIcon.jpg');"
The default value is TreeNodeIcon. | FileSystemList | ||
| Type: uint Format: Color CSS Inheritance: yes Color of text in the component if it is disabled. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The skin to use to indicate where a dragged item can be dropped. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Color of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: halo Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: no Theme: spark Boolean property that specifies whether the component has a visible drop shadow. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes Color of the component highlight when validation fails. | UIComponent | ||
fileIcon | Type: Class Format: EmbeddedFile CSS Inheritance: no Specifies the icon that indicates a file. The default icon is located in the Assets.swf file. In MXML, you can use the following syntax to set this property: fileIcon="@Embed(source='fileIcon.jpg');"
The default value is TreeNodeIcon. | FileSystemList | ||
| Type: Number CSS Inheritance: no Specifies the alpha transparency value of the focus skin. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Blend mode used by the focus rectangle. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of focus ring when the component is in focus. | ScrollControlBase | ||
| Type: String CSS Inheritance: no Specifies which corners of the focus rectangle should be rounded. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no Skin used to draw the focus rectangle. | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: no Thickness, in pixels, of the focus rectangle outline. | UIComponent | ||
| Type: String CSS Inheritance: yes Sets the antiAliasType property of internal TextFields.See also flash.text.TextField flash.text.AntiAliasType | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Name of the font to use. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Sets the gridFitType property of internal TextFields that represent text in Flex controls.See also flash.text.TextField flash.text.GridFitType | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the sharpness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Height of the text, in pixels. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is italic font. | ScrollControlBase | ||
| Type: Number CSS Inheritance: yes Sets the thickness property of internal TextFields that represent text in Flex controls.See also flash.text.TextField | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is boldface. | ScrollControlBase | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Style name for horizontal scrollbar. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The primary interaction mode for this component. See also | UIComponent | ||
| Type: Boolean CSS Inheritance: yes A Boolean value that indicates whether kerning is enabled ( true) or disabled (false). | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Specifies the desired layout direction of a component. See also | UIComponent | ||
| Type: Number Format: Length CSS Inheritance: yes Additional vertical space between lines of text. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Number CSS Inheritance: yes The number of additional pixels to appear between each character. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes The locale of the text displayed by this component. | ScrollControlBase | ||
| Type: 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 | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's left border and the left edge of its content area. | ListBase | ||
| Type: Number Format: Length CSS Inheritance: no Number of pixels between the component's right border and the right edge of its content area. | ListBase | ||
| Type: 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 | ||
| Type: 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 | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the user rolls over it. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the user selects it. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the background of a renderer when the component is disabled. | ListBase | ||
| Type: Number Format: Time CSS Inheritance: no The duration of the selection effect. | ListBase | ||
| Type: Function CSS Inheritance: no The easingFunction for the selection effect. | ListBase | ||
| Type: String CSS Inheritance: no Theme: halo Direction of the drop shadow. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: no Theme: halo Distance of the drop shadow. | ScrollControlBase | ||
| Type: Boolean CSS Inheritance: yes Show the error border or skin when this component is invalid. | UIComponent | ||
| Type: Boolean CSS Inheritance: yes Show the error tip when this component is invalid and the user rolls over it. | UIComponent | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: spark Color of any symbol of a component. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Alignment of text within a container. | ScrollControlBase | ||
| Type: String CSS Inheritance: yes Determines whether the text is underlined. | ScrollControlBase | ||
| Type: Class CSS Inheritance: no The class implementing IUITextField that is used by this component to render text. | ScrollControlBase | ||
| Type: Number Format: Length CSS Inheritance: yes Offset of first line of text from the left side of the container, in pixels. | ScrollControlBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the text of a renderer when the user rolls over a it. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes The color of the text of a renderer when the user selects it. | ListBase | ||
| Type: uint Format: Color CSS Inheritance: yes Theme: halo Theme color of a component. | UIComponent | ||
| Type: 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 | ||
| Type: Boolean CSS Inheritance: no A flag that controls whether items are highlighted as the mouse rolls over them. | ListBase | ||
| Type: String CSS Inheritance: no The vertical alignment of a renderer in a row. | ListBase | ||
| Type: 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 | ||
| Type: String CSS Inheritance: no Style name for vertical scrollbar. | ScrollControlBase | ||
| Constant | Defined By | ||
|---|---|---|---|
| COMPUTER : File [static]
A constant that can be used as a value for the directory property,
representing a pseudo-top level directory named "Computer". | FileSystemList | ||
| DEFAULT_MAX_HEIGHT : Number = 10000 [static]
The default value for the maxHeight property. | UIComponent | |
| DEFAULT_MAX_WIDTH : Number = 10000 [static]
The default value for the maxWidth property. | UIComponent | |
| DEFAULT_MEASURED_HEIGHT : Number = 22 [static]
The default value for the measuredHeight property. | UIComponent | |
| DEFAULT_MEASURED_MIN_HEIGHT : Number = 22 [static]
The default value for the measuredMinHeight property. | UIComponent | |
| DEFAULT_MEASURED_MIN_WIDTH : Number = 40 [static]
The default value for the measuredMinWidth property. | UIComponent | |
| DEFAULT_MEASURED_WIDTH : Number = 160 [static]
The default value for the measuredWidth property. | UIComponent | |
| 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:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Back"
enabled="{fileSystemViewer.canNavigateBack}"
dataProvider="{fileSystemViewer.backHistory}"
click="fileSystemViewer.navigateBack();"
itemClick="fileSystemViewer.navigateBack(event.index);"/>
The default value is [].
This property can be used as the source for data binding.
public function get backHistory():ArraySee also
| 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:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Back"
enabled="{fileSystemViewer.canNavigateBack}"
dataProvider="{fileSystemViewer.backHistory}"
click="fileSystemViewer.navigateBack();"
itemClick="fileSystemViewer.navigateBack(event.index);"/>
The default value is false.
This property can be used as the source for data binding.
public function get canNavigateBack():BooleanSee also
| 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:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:Button label="Open"
enabled="{fileSystemViewer.canNavigateDown}"
click="fileSystemViewer.navigateDown();"/>
The default value is false.
This property can be used as the source for data binding.
public function get canNavigateDown():BooleanSee also
| 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:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Forward"
enabled="{fileSystemViewer.canNavigateForward}"
dataProvider="{fileSystemViewer.forwardHistory}"
click="fileSystemViewer.navigateForward();"
itemClick="fileSystemViewer.navigateForward(event.index);"/>
The default value is false.
This property can be used as the source for data binding.
public function get canNavigateForward():BooleanSee also
| 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:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:Button label="Up"
enabled="{fileSystemViewer.canNavigateUp}"
click="fileSystemViewer.navigateUp();"/>
The default value is false.
This property can be used as the source for data binding.
public function get canNavigateUp():BooleanSee also
| 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.
The default value is COMPUTER.
This property can be used as the source for data binding.
public function get directory():File public function set directory(value:File):void| 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.
public function get enumerationMode():String public function set enumerationMode(value:String):voidSee also
| 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.
public function get extensions():Array public function set extensions(value:Array):void| 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):BooleanThis 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.
public function get filterFunction():Function public function set filterFunction(value:Function):void| 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 the special COMPUTER File object,
which represents the non-existent directory whose contents
are root directories such as C:\ and D:\ on Windows.
The following example shows how to use this property along with the FileSystemHistoryButton control to implement a forward button:
<mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Forward"
enabled="{fileSystemViewer.canNavigateForward}"
dataProvider="{fileSystemViewer.forwardHistory}"
click="fileSystemViewer.navigateForward();"
itemClick="fileSystemViewer.navigateForward(event.index);"/>
The default value is [].
This property can be used as the source for data binding.
public function get forwardHistory():ArraySee also
| 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.
public function get nameCompareFunction():Function public function set nameCompareFunction(value:Function):void| 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.
public function get selectedPath():String public function set selectedPath(value:String):voidSee also
| 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.
public function get selectedPaths():Array public function set selectedPaths(value:Array):voidSee also
| 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.
The default value is true.
public function get showExtensions():Boolean public function set showExtensions(value:Boolean):void| 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.
The default value is false.
public function get showHidden():Boolean public function set showHidden(value:Boolean):void| 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 AIR does not support that feature.
Setting this property does not affect which items are displayed, or the order in which they appear. It also does not affect which items are selected, or the scroll position.
The default value is true.
public function get showIcons():Boolean public function set showIcons(value:Boolean):void| FileSystemList | () | Constructor |
public function FileSystemList()| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Constructor.
| 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.
| 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.
|
int — A zero-based index, or -1
if no File was found with the specified path.
|
See also
| 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.
|
File — A File instance if one was found with the specified
nativePath, or null if none was found.
|
| navigateBack | () | method |
public function navigateBack(index:int = 0):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Changes this control to display the contents of a previously-visited
directory in the backHistory array.
If the backHistory array is empty, or if you specify
an index that is not in that array, then this method does nothing.
When this method returns, the directory property
contains the File instance for the new directory.
The dataProvider property is temporarily
null until the new directory has been enumerated.
After the enumeration, the dataProvider property
contains an ArrayCollection of File instances
for the new directory's contents.
The history list is left unchanged. However, the current index
into it changes, which affects the backHistory
and forwardHistory properties.
They have new values as soon as this method returns.
The following example shows how to use this method along with the FileSystemHistoryButton control to create a back button:
<mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Back"
enabled="{fileSystemViewer.canNavigateBack}"
dataProvider="{fileSystemViewer.backHistory}"
click="fileSystemViewer.navigateBack();"
itemClick="fileSystemViewer.navigateBack(event.index);"/>
Parameters
index:int (default = 0)backHistory array
to navigate to.
The default is 0, indicating the directory that is "closest back".
|
See also
| navigateDown | () | method |
public function navigateDown():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Changes this control to display the contents of the selected subdirectory.
If a subdirectory is not selected, this method does nothing.
When this method returns, the directory property
contains the File instance for the new directory.
The dataProvider property is temporarily
null until the new directory has been enumerated.
After the enumeration, the dataProvider property
contains an ArrayCollection of File instances
for the new directory's contents.
The following example shows how to use this method along with the Button control to create an open button:
<mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:Button label="Open"
enabled="{fileSystemViewer.canNavigateDown}"
click="fileSystemViewer.navigateDown();"/>
See also
| navigateForward | () | method |
public function navigateForward(index:int = 0):void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Changes this control to display the contents of a previously-visited
directory in the forwardHistory array.
If the forwardHistory array is empty, or if you specify
an index that is not in that array, then this method does nothing.
When this method returns, the directory property
contains the File instance for the new directory.
The dataProvider property is temporarily
null until the new directory has been enumerated.
After the enumeration, the dataProvider property
contains an ArrayCollection of File instances
for the new directory's contents.
The history list is left unchanged. However, the current index
into it changes, which affects the backHistory
and forwardHistory properties.
They have new values as soon as this method returns.
The following example shows how to use this method along with the FileSystemHistoryButton control to create a forward button:
<mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:FileSystemHistoryButton label="Forward"
enabled="{fileSystemViewer.canNavigateForward}"
dataProvider="{fileSystemViewer.forwardHistory}"
click="fileSystemViewer.navigateForward();"
itemClick="fileSystemViewer.navigateForward(event.index);"/>
Parameters
index:int (default = 0)forwardHistory array
to navigate to.
The default is 0, indicating the directory that is "closest forward".
|
See also
| 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.
|
| navigateUp | () | method |
public function navigateUp():void| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Changes this control to display the contents of the next directory up in the hierarchy.
If this control is currently displaying root directories (such as C: and D: on Microsoft Windows), this method does nothing.
When this method returns, the directory property
contains the File instance for the new directory.
The dataProvider property is temporarily
null until the new directory has been enumerated.
After the enumeration, the dataProvider property
contains an ArrayCollection of File instances
for the new directory's contents.
The following example shows how to use this method along with the Button control to create an up button:
<mx:FileSystemList id="fileSystemViewer" directory="{File.desktopDirectory}"/>
<mx:Button label="Up"
enabled="{fileSystemViewer.canNavigateUp}"
click="fileSystemViewer.navigateUp();"/>
See also
| 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).
| directoryChange | Event |
mx.events.FileEventmx.events.FileEvent.DIRECTORY_CHANGE| Language Version : | ActionScript 3.0 |
| Product Version : | Flex 3 |
| Runtime Versions : | AIR 1.1 |
Dispatched when the directory displayed by this control has changed for any reason.
The FileEvent.DIRECTORY_CHANGE constant defines the value of thetype property of the event object for a
directoryChange event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FileEvent.DIRECTORY_CHANGE |
| directoryChanging | Event |
mx.events.FileEventmx.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.
type property of the event object for a
directoryOpening event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | true |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FileEvent.DIRECTORY_OPENING |
| fileChoose | Event |
mx.events.FileEventmx.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 thetype property of the event object for a
fileChoose event.
The properties of the event object have the following values:
| Property | Value |
|---|---|
bubbles | false |
cancelable | false |
currentTarget | The Object that defines the
event listener that handles the event. For example, if you use
myButton.addEventListener() to register an event listener,
myButton is the value of the currentTarget. |
file | The File object associated with this event. |
target | The Object that dispatched the event;
it is not always the Object listening for the event.
Use the currentTarget property to always access the
Object listening for the event. |
type | FileEvent.FILE_CHOOSE |
| 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).